Skip to content
This repository has been archived by the owner on Jun 19, 2024. It is now read-only.

Latest commit

 

History

History
301 lines (223 loc) · 11.4 KB

APDUSPEC.md

File metadata and controls

301 lines (223 loc) · 11.4 KB
Raw

Edgeware App

General structure

The general structure of commands and responses is as follows:

Commands

Field Type Content Note
CLA byte (1) Application Identifier 0x94
INS byte (1) Instruction ID
P1 byte (1) Parameter 1
P2 byte (1) Parameter 2
L byte (1) Bytes in payload
PAYLOAD byte (L) Payload

Response

Field Type Content Note
ANSWER byte (?) Answer depends on the command
SW1-SW2 byte (2) Return code see list of return codes

Return codes

Return code Description
0x6400 Execution Error
0x6982 Empty buffer
0x6983 Output buffer too small
0x6986 Command not allowed
0x6D00 INS not supported
0x6E00 CLA not supported
0x6F00 Unknown
0x9000 Success

Command definition

GET_VERSION

Command

Field Type Content Expected
CLA byte (1) Application Identifier 0x94
INS byte (1) Instruction ID 0x00
P1 byte (1) Parameter 1 ignored
P2 byte (1) Parameter 2 ignored
L byte (1) Bytes in payload 0

Response

Field Type Content Note
TEST byte (1) Test Mode 0xFF means test mode is enabled
MAJOR byte (2) Version Major 0..65535
MINOR byte (2) Version Minor 0..65535
PATCH byte (2) Version Patch 0..65535
LOCKED byte (1) Device is locked
SW1-SW2 byte (2) Return code see list of return codes

INS_GET_ADDR_ED25519

Command

Field Type Content Expected
CLA byte (1) Application Identifier 0x94
INS byte (1) Instruction ID 0x01
P1 byte (1) Request User confirmation No = 0
P2 byte (1) Parameter 2 ignored
L byte (1) Bytes in payload (depends)
Path[0] byte (4) Derivation Path Data 0x80000000
Path[1] byte (4) Derivation Path Data 0x80000000
Path[2] byte (4) Derivation Path Data ?
Path[3] byte (4) Derivation Path Data ?
Path[4] byte (4) Derivation Path Data ?

Response

Field Type Content Note
PK byte (32) Public Key
ADDR byte (??) address
SW1-SW2 byte (2) Return code see list of return codes

INS_GET_ADDR_SR25519

Command

Field Type Content Expected
CLA byte (1) Application Identifier 0x94
INS byte (1) Instruction ID 0x11
P1 byte (1) Request User confirmation No = 0
P2 byte (1) Parameter 2 ignored
L byte (1) Bytes in payload (depends)
Path[0] byte (4) Derivation Path Data 0x80000000
Path[1] byte (4) Derivation Path Data 0x80000000
Path[2] byte (4) Derivation Path Data ?
Path[3] byte (4) Derivation Path Data ?
Path[4] byte (4) Derivation Path Data ?

Response

Field Type Content Note
PK byte (32) Public Key
ADDR byte (??) DOT address
SW1-SW2 byte (2) Return code see list of return codes

INS_SIGN_ED25519

Command

Field Type Content Expected
CLA byte (1) Application Identifier 0x94
INS byte (1) Instruction ID 0x02
P1 byte (1) Payload desc 0 = init
1 = add
2 = last
P2 byte (1) ---- not used
L byte (1) Bytes in payload (depends)

The first packet/chunk includes only the derivation path

All other packets/chunks contain data chunks that are described below

First Packet
Field Type Content Expected
Path[0] byte (4) Derivation Path Data 44
Path[1] byte (4) Derivation Path Data 523
Path[2] byte (4) Derivation Path Data ?
Path[3] byte (4) Derivation Path Data ?
Path[4] byte (4) Derivation Path Data ?
Other Chunks/Packets
Field Type Content Expected
Message bytes... Message to Sign

Response

Field Type Content Note
SIG byte (65) Signature
SW1-SW2 byte (2) Return code see list of return codes

INS_SIGN_SR25519

Command

Field Type Content Expected
CLA byte (1) Application Identifier 0x94
INS byte (1) Instruction ID 0x12
P1 byte (1) Payload desc 0 = init
1 = add
2 = last
P2 byte (1) ---- not used
L byte (1) Bytes in payload (depends)

The first packet/chunk includes only the derivation path

All other packets/chunks contain data chunks that are described below

First Packet
Field Type Content Expected
Path[0] byte (4) Derivation Path Data 44
Path[1] byte (4) Derivation Path Data 523
Path[2] byte (4) Derivation Path Data ?
Path[3] byte (4) Derivation Path Data ?
Path[4] byte (4) Derivation Path Data ?
Other Chunks/Packets
Field Type Content Expected
Message bytes... Message to Sign

Response

Field Type Content Note
SIG byte (65) Signature
SW1-SW2 byte (2) Return code see list of return codes

INS_ALLOWLIST_GET_PUBKEY

Command

Field Type Content Expected
CLA byte (1) Application Identifier 0x94
INS byte (1) Instruction ID 0x90
P1 byte (1) Request User confirmation No = 0
P2 byte (1) Parameter 2 ignored
L byte (1) Bytes in payload 0

Response

Field Type Content Note
PUBKEY byte (32) Master pubkey
SW1-SW2 byte (2) Return code see list of return codes

INS_ALLOWLIST_SET_PUBKEY

Command

Field Type Content Expected
CLA byte (1) Application Identifier 0x94
INS byte (1) Instruction ID 0x91
P1 byte (1) Request User confirmation No = 0
P2 byte (1) Parameter 2 ignored
L byte (1) Bytes in payload 32
PUBKEY byte (32) Master pubkey

Response

Field Type Content Note
SW1-SW2 byte (2) Return code see list of return codes

INS_ALLOWLIST_GET_HASH

Command

Field Type Content Expected
CLA byte (1) Application Identifier 0x94
INS byte (1) Instruction ID 0x92
P1 byte (1) Request User confirmation No = 0
P2 byte (1) Parameter 2 ignored
L byte (1) Bytes in payload 0

Response

Field Type Content Note
HASH byte (32) Public Key
SW1-SW2 byte (2) Return code see list of return codes

INS_ALLOWLIST_UPLOAD

Command

Field Type Content Expected
CLA byte (1) Application Identifier 0x94
INS byte (1) Instruction ID 0x93
P1 byte (1) Payload desc 0 = init
1 = add
2 = last
P2 byte (1) ---- not used
L byte (1) Bytes in payload (depends)

Packets/chunks contain data chunks that are described below

Chunks/Packets
  • Chunk idx = 0 (init is expected to be empty)
Field Type Content Expected
Chunk byte (?) Allow List ...
Allow List Structure
Field Type Content Expected
Nonce bytes (4) Monotonically increasing number
Item Count (N) bytes (4) Number of items in the list
Signature bytes (64) Ed25519 Signature
Item x N bytes (32) * N Pubkeys to allow

Response

Field Type Content Note
SW1-SW2 byte (2) Return code see list of return codes