/rust-cktap

Coinkite Tap Protocol implementation for use with SATSCARD™ and TAPSIGNER™ products

Primary LanguageRustMIT LicenseMIT

rust-cktap

License CI rustc

A Rust implementation of the Coinkite Tap Protocol (cktap) for use with SATSCARD, TAPSIGNER, and SATSCHIP products.

This project provides PC/SC APDU message encoding and decoding, cvc authentication, certificate chain verification, and card response verification.

It is up to the crate user to send and receive the raw cktap APDU messages via NFC to the card by implementing the CkTransport trait. An example implementation is provided using the optional rust pcsc crate. Mobile users are expected to implement CkTransport using the iOS or Android provided libraries.

Supported Features

Shared Commands

SATSCARD-Only Commands

TAPSIGNER-Only Commands

Automated Testing with Emulator

  1. Install and start cktap emulator
    • TapSigner: ./ecard.py emulate -t --no-init
    • SatsCard: ./ecard.py emulate -s
  2. run tests: cargo test --features emulator

Manual Testing with real cards

Prerequisites

  1. USB PCSC NFC card reader, for example:
  2. Coinkite SATSCARD, TAPSIGNER, or SATSCHIP cards Install vendor PCSC driver
  3. Connect NFC reader to desktop system
  4. Place SATSCARD, TAPSIGNER, or SATSCHIP on reader

Run CLI

cargo run -p cktap-cli -- --help
cargo run -p cktap-cli -- certs
cargo run -p cktap-cli -- read