Expand description
§keyteleport
keyteleport implements the parts of the COLDCARD Key Teleport protocol
that Cove uses.
§Support
| Protocol data | Send | Receive |
|---|---|---|
| English BIP39 mnemonic | Yes | Yes |
| Mainnet master XPRV | Yes | Yes |
| Secure Notes & Passwords | No | Yes |
| Seed Vault entry | No | Recognized |
| Full COLDCARD backup | No | Recognized |
| Multisig PSBT | Packet framing only | Packet framing only |
The crate supports single-part, uncompressed Base32 BBQr packets and keyteleport.com URLs.
§Security
This crate implements a device interoperability protocol. It is not a general encryption API. Send each transfer password through a different channel from its encrypted packet. Treat receiver session keys, passwords, mnemonics, XPRVs, secure notes, and decrypted payloads as secrets.
§Not included
This version does not include multipart BBQr joining, lossless unknown payloads, Seed Vault or backup codecs, Secure Notes encoding, or multisig PSBT encryption and decryption.
Structs§
- Note
Record - A decoded COLDCARD free-form secure note
- Notes
Payload - A decoded collection of COLDCARD Secure Notes & Passwords records
- Numeric
Code - An eight-digit receiver code used to establish a KeyTeleport session
- Password
Record - A decoded COLDCARD structured password record
- Payload
- A secret payload that can be transferred by COLDCARD KeyTeleport
- Pending
Payload - A sender payload awaiting password-based decryption
- Psbt
Packet - A PSBT payload transported in a KeyTeleport-compatible BBQr packet
- Receive
Request - A receiver request containing the numeric code and packet to share
- Receiver
Packet - A validated receiver request packet
- Receiver
Session - A receiver-side KeyTeleport session
- Send
Response - An encrypted sender packet and its decryption password
- Sender
Packet - A validated encrypted sender response packet
- Sender
Session - A sender-side KeyTeleport session
- Teleport
Password - A five-byte password used to decrypt a KeyTeleport sender response
- Xprv
Payload - A validated master extended private key transferred by KeyTeleport
Enums§
- Decoded
Payload - A payload decoded from a sender response
- Error
- An error produced while processing a KeyTeleport transfer
- Notes
Record - A decoded COLDCARD secure note or password record
- Packet
- A decoded KeyTeleport packet
- Unsupported
Payload Kind - A recognized KeyTeleport payload type that this crate cannot decode
Type Aliases§
- Result
- A KeyTeleport operation result