Skip to content

Update README with usage examples - #89

Merged
mmlado merged 2 commits into
mainfrom
59-update-readme
Oct 11, 2026
Merged

mmlado merged 2 commits into
mainfrom
59-update-readme

Conversation

@mmlado

@mmlado mmlado commented Oct 11, 2026

Copy link
Copy Markdown
Owner

Closes #59

  • README: requirements, installation, connecting and choosing a reader, opening the secure channel on 4.x (Keycard CA trust, Test CA for development cards) and 3.x (pairing, reusing a stored pairing)
  • README: keys, mnemonics, export, ECDSA and Schnorr signing, the 4.x commands (GET CHALLENGE, BIP-85, ECDH, LEE), 3.x/4.x differences, errors and hardware tests
  • The README and example use a PUK that doesn't start with the PIN: without an Alternate PIN the card uses the PUK's first 6 digits as one, and VERIFY checks it first
  • example/example.py runs on 3.x and 4.x, branching on the secure channel version; it prints the generated Key UID instead of a mislabelled key and reports a card without an Identity Certificate instead of failing on IDENT
  • README snippets and the example checked on a 3.2 and a 4.0 card

- Connecting, selecting and choosing a reader
- Opening the secure channel on 4.x (Keycard CA trust) and 3.x (pairing)
- Keys, mnemonics, export, ECDSA and Schnorr signing
- Applet 4.x features: GET CHALLENGE, BIP-85, ECDH, LEE
- Differences between 3.x and 4.x, errors, hardware tests
- One walkthrough that branches on the secure channel version
- 4.x: Schnorr, GET CHALLENGE, BIP-85, ECDH and LEE
- Use a PUK that doesn't start with the PIN, so VERIFY unlocks the main keys
- Print the generated Key UID instead of a mislabelled key
@mmlado mmlado linked an issue Oct 11, 2026 that may be closed by this pull request
@mmlado mmlado self-assigned this Oct 11, 2026
@mmlado
mmlado merged commit 1b6dfdf into main Oct 11, 2026
6 checks passed
@mmlado
mmlado deleted the 59-update-readme branch October 11, 2026 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update readme

1 participant