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
74 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 abea3c0a87
pass build version with ldflags 		2019-04-16 15:54:22 +02:00
_assets clean using cleanWs() and explicitly set GOPATH for tests (#4) 2019-04-16 12:37:11 +02:00
vendor update keycard-go and bump version 2019-04-16 12:44:19 +02:00
.gitignore add .gitignore 2019-03-18 19:50:13 +01:00
Gopkg.lock update keycard-go and bump version 2019-04-16 12:44:19 +02: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 pass build version with ldflags 2019-04-16 15:54:22 +02:00
README.md Update README.md 2019-04-09 16:09:31 +02:00
VERSION pass build version with ldflags 2019-04-16 15:54:22 +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 pass build version with ldflags 2019-04-16 15:54:22 +02:00
shell.go add keycard-sign-message command 2019-04-16 15:50:56 +02:00

README.md

keycard-cli

keycard is a command line tool to manage Status Keycards.

Dependencies

On linux you need to install and run the pcsc daemon.

Installation

Download the binary for your platform from the releases page.

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 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 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 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