status-im
/
keycard-cli
mirror of https://github.com/status-im/keycard-cli.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
A command line tool and shell to manage keycards https://keycard.tech
62 Commits 3 Branches 25 Tags 6.1 MiB
Go 85.2%
Shell 9.8%
Makefile 3.9%
Dockerfile 1.1%
Go to file
Andrea Franz 0bb56e9716
add version command 		2019-04-03 12:09:48 +02:00
_assets update docs about ci 2019-03-27 14:27:48 +01:00
vendor update keycard-go 2019-03-28 14:45:38 +01:00
.gitignore add .gitignore 2019-03-18 19:50:13 +01:00
Gopkg.lock update keycard-go 2019-03-28 14:45:38 +01:00
Gopkg.toml add unused go pkgs from go-ethereum to keep c files 2019-03-21 12:58:59 +01:00
LICENSE.md add LICENSE 2019-03-18 19:57:48 +01:00
Makefile add Jenkinsfile and improve docker image creation 2019-03-27 14:06:39 +01:00
README.md update docs about ci 2019-03-27 14:27:48 +01:00
VERSION bump version 2019-04-03 12:07:45 +02:00
initializer.go update using keycard/io pkg 2019-03-28 14:45:39 +01:00
installer.go update using keycard/io pkg 2019-03-28 14:45:39 +01:00
main.go add version command 2019-04-03 12:09:48 +02:00
shell.go fix raw response log 2019-04-03 12:01:36 +02:00

README.md

keycard-cli

keycard-cli is a command line tool to manage Status Keycards.

Dependencies

To install keycard-cli you need go in your system.

MacOSX:

brew install go

Installation

go get -u github.com/status-im/keycard-cli

The executable will be installed in $GOPATH/bin. Check your $GOPATH with go env.

Continuous Integration

Jenkins builds provide:

  • PR Builds - Run only the test and build targets.
  • Manual Builds - Create GitHub release draft with binaries for 3 platforms.

Successful PR builds are mandatory.

Usage

Card info

keycard-cli info -l debug

The info command will print something like this:

Installed: true
Initialized: false
InstanceUID: 0x
PublicKey: 0x112233...
Version: 0x
AvailableSlots: 0x
KeyUID: 0x

Keycard applet installation

The install command will install an applet to the card. You can download the status cap file from the status-im/status-keycard releases page.

keycard-cli install -l debug -a PATH_TO_CAP_FILE

In case the applet is already installed and you want to force a new installation you can pass the -f flag.

Card initialization

keycard-cli init -l debug

The init command initializes the card and generates the secrets needed to pair the card to a device.

PIN 123456
PUK 123456789012
Pairing password: RandomPairingPassword

Deleting the applet

⚠️ WARNING! This command will remove the applet and all the keys from the card. ⚠️

keycard-cli delete -l debug

Keycard shell

TODO