README.md
1# keycard
2
3`keycard` is a command line tool you can use to initialize a smartcard with the [Status Keycard](https://github.com/status-im/status-keycard).
4
5## Dependencies
6
7To install `keycard-go` you need `go` in your system.
8
9MacOSX:
10
11`brew install go`
12
13## Installation
14
15`go get -u github.com/status-im/keycard-go/cmd/keycard`
16
17The executable will be installed in `$GOPATH/bin`.
18Check your `$GOPATH` with `go env`.
19
20## Usage
21
22### Install the keycard applet
23
24The install command will install an applet to the card.
25You can download the status `cap` file from the [status-im/status-keycard releases page](https://github.com/status-im/status-keycard/releases).
26
27```bash
28keycard install -l debug -a PATH_TO_CAP_FILE
29```
30
31In case the applet is already installed and you want to force a new installation you can pass the `-f` flag.
32
33### Card info
34
35```bash
36keycard info -l debug
37```
38
39The `info` command will print something like this:
40
41```
42Installed: true
43Initialized: false
44InstanceUID: 0x
45PublicKey: 0x112233...
46Version: 0x
47AvailableSlots: 0x
48KeyUID: 0x
49```
50
51### Card initialization
52
53
54```bash
55keycard init -l debug
56```
57
58The `init` command initializes the card and generates the secrets needed to pair the card to a device.
59
60```
61PIN 123456
62PUK 123456789012
63Pairing password: RandomPairingPassword
64```
65
66### Deleting the applet from the card
67
68:warning: **WARNING! This command will remove the applet and all the keys from the card.** :warning:
69
70```bash
71keycard delete -l debug
72```
73
74### Pairing
75
76```bash
77keycard pair -l debug
78```
79
80The process will ask for `PairingPassword` and `PIN` and will generate a pairing key you can use to interact with the card.
81