1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
|
from dataclasses import dataclass
from typing import List, Tuple, Optional, Union, Literal
from io import BytesIO
from ledgercomm.interfaces.hid_device import HID
from .transport import Transport
from .common import Chain
from .command_builder import DefaultInsType
from .exception import DeviceException
from .wallet import WalletPolicy
from .psbt import PSBT
from ._serialize import deser_string
try:
from speculos.client import ApduException
except ImportError:
# Speculos package not available, we use our own class
class ApduException(Exception):
def __init__(self, sw: int, data: bytes) -> None:
super().__init__(f"Exception: invalid status 0x{sw:x}")
self.sw = sw
self.data = data
class TransportClient:
def __init__(self, interface: Literal['hid', 'tcp'] = "tcp", *, server: str = "127.0.0.1", port: int = 9999, path: Optional[str] = None, hid: Optional[HID] = None, debug: bool = False):
self.transport = Transport('hid', path=path, hid=hid, debug=debug) if interface == 'hid' else Transport(
interface, server=server, port=port, debug=debug)
def apdu_exchange(
self, cla: int, ins: int, data: bytes = b"", p1: int = 0, p2: int = 0
) -> bytes:
sw, data = self.transport.exchange(cla, ins, p1, p2, None, data)
if sw != 0x9000:
raise ApduException(sw, data)
return data
def apdu_exchange_nowait(
self, cla: int, ins: int, data: bytes = b"", p1: int = 0, p2: int = 0
):
raise NotImplementedError()
def stop(self) -> None:
self.transport.close()
def print_apdu(apdu_dict: dict) -> None:
serialized_apdu = b''.join([
apdu_dict["cla"].to_bytes(1, byteorder='big'),
apdu_dict["ins"].to_bytes(1, byteorder='big'),
apdu_dict["p1"].to_bytes(1, byteorder='big'),
apdu_dict["p2"].to_bytes(1, byteorder='big'),
len(apdu_dict["data"]).to_bytes(1, byteorder='big'),
apdu_dict["data"]
])
print(f"=> {serialized_apdu.hex()}")
def print_response(sw: int, data: bytes) -> None:
print(f"<= {data.hex()}{sw.to_bytes(2, byteorder='big').hex()}")
@dataclass(frozen=True)
class PartialSignature:
"""Represents a partial signature returned by sign_psbt. Such objects can be added to the PSBT.
It always contains a pubkey and a signature.
The pubkey is a compressed 33-byte for legacy and segwit Scripts, or 32-byte x-only key for taproot.
The signature is in the format it would be pushed on the scriptSig or the witness stack, therefore of
variable length, and possibly concatenated with the SIGHASH flag byte if appropriate.
The tapleaf_hash is also filled if signing for a tapscript.
Note: not to be confused with 'partial signature' of protocols like MuSig2;
"""
pubkey: bytes
signature: bytes
tapleaf_hash: Optional[bytes] = None
@dataclass(frozen=True)
class MusigPubNonce:
"""Represents a pubnonce returned by sign_psbt during the first round of a Musig2 signing session.
It always contains
- the participant_pubkey, a 33-byte compressed pubkey;
- aggregate_pubkey, the 33-byte compressed pubkey key that is the aggregate of all the participant
pubkeys, with the necessary tweaks; its x-only version is the key present in the Script;
- the 66-byte pubnonce.
The tapleaf_hash is also filled if signing for a tapscript; `None` otherwise.
"""
participant_pubkey: bytes
aggregate_pubkey: bytes
tapleaf_hash: Optional[bytes]
pubnonce: bytes
@dataclass(frozen=True)
class MusigPartialSignature:
"""Represents a partial signature returned by sign_psbt during the second round of a Musig2 signing session.
It always contains
- the participant_pubkey, a 33-byte compressed pubkey;
- aggregate_pubkey, the 33-byte compressed pubkey key that is the aggregate of all the participant
pubkeys, with the necessary tweaks; its x-only version is the key present in the Script;
- the partial_signature, the 32-byte partial signature for this participant.
The tapleaf_hash is also filled if signing for a tapscript; `None` otherwise
"""
participant_pubkey: bytes
aggregate_pubkey: bytes
tapleaf_hash: Optional[bytes]
partial_signature: bytes
SignPsbtYieldedObject = Union[PartialSignature,
MusigPubNonce, MusigPartialSignature]
class Client:
def __init__(self, transport_client: TransportClient, chain: Chain = Chain.MAIN, debug: bool = False) -> None:
self.transport_client = transport_client
self.chain = chain
self.debug = debug
def _apdu_exchange(self, apdu: dict) -> Tuple[int, bytes]:
try:
if self.debug:
print_apdu(apdu)
response = self.transport_client.apdu_exchange(**apdu)
if self.debug:
print_response(0x9000, response)
return 0x9000, response
except ApduException as e:
if self.debug:
print_response(e.sw, e.data)
return e.sw, e.data
def _make_request(self, apdu: dict) -> Tuple[int, bytes]:
return self._apdu_exchange(apdu)
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.transport_client.stop()
def stop(self) -> None:
"""Stops the transport_client."""
self.transport_client.stop()
def get_version(self) -> Tuple[str, str, bytes]:
"""Queries the hardware wallet for the currently running app's name, version and state flags.
Returns
-------
Tuple[str, str, bytes]
The first element is the app's name, as a short string.
The second element is the app's version.
The third element is a binary string representing the platform's global state (pin lock etc).
"""
sw, response = self._make_request(
{"cla": 0xB0, "ins": DefaultInsType.GET_VERSION, "p1": 0, "p2": 0, "data": b''})
if sw != 0x9000:
raise DeviceException(
error_code=sw, ins=DefaultInsType.GET_VERSION)
r = BytesIO(response)
format = r.read(1)
app_name = deser_string(r)
app_version = deser_string(r)
app_flags = deser_string(r)
if format != b'\1' or app_name == b'' or app_version == b'' or app_flags == b'':
raise DeviceException(error_code=sw, ins=DefaultInsType.GET_VERSION,
message="Invalid format returned by GET_VERSION")
return app_name.decode(), app_version.decode(), app_flags
def get_extended_pubkey(self, path: str, display: bool = False) -> str:
"""Gets the serialized extended public key for certain BIP32 path. Optionally, validate with the user.
Parameters
----------
path : str
BIP32 path of the public key you want.
display : bool
Whether you want to display address and ask confirmation on the device.
Returns
-------
str
The requested serialized extended public key.
"""
raise NotImplementedError
def register_wallet(self, wallet: WalletPolicy) -> Tuple[bytes, bytes]:
"""Registers a wallet policy with the user. After approval returns the wallet id and hmac to be stored on the client.
Parameters
----------
wallet : WalletPolicy
The Wallet policy to register on the device.
Returns
-------
Tuple[bytes, bytes]
The first element the tuple is the 32-bytes wallet id.
The second element is the hmac.
"""
raise NotImplementedError
def get_wallet_address(
self,
wallet: WalletPolicy,
wallet_hmac: Optional[bytes],
change: int,
address_index: int,
display: bool,
) -> str:
"""For a given wallet that was already registered on the device (or a standard wallet that does not need registration),
returns the address for a certain `change`/`address_index` combination.
Parameters
----------
wallet : WalletPolicy
The registered wallet policy, or a standard wallet policy.
wallet_hmac: Optional[bytes]
For a registered wallet, the hmac obtained at wallet registration. `None` for a standard wallet policy.
change: int
0 for a standard receive address, 1 for a change address. Other values are invalid.
address_index: int
The address index in the last step of the BIP32 derivation.
display: bool
Whether you want to display address and ask confirmation on the device.
Returns
-------
str
The requested address.
"""
raise NotImplementedError
def sign_psbt(self, psbt: Union[PSBT, bytes, str], wallet: WalletPolicy, wallet_hmac: Optional[bytes]) -> List[Tuple[int, SignPsbtYieldedObject]]:
"""Signs a PSBT using a registered wallet (or a standard wallet that does not need registration).
Signature requires explicit approval from the user.
Parameters
----------
psbt : PSBT | bytes | str
A PSBT of version 0 or 2, with all the necessary information to sign the inputs already filled in; what the
required fields changes depending on the type of input.
The non-witness UTXO must be present for both legacy and SegWit inputs, or the hardware wallet will reject
signing (this will change for Taproot inputs).
The argument can be either a `PSBT` object, or `bytes`, or a base64-encoded `str`.
wallet : WalletPolicy
The registered wallet policy, or a standard wallet policy.
wallet_hmac: Optional[bytes]
For a registered wallet, the hmac obtained at wallet registration. `None` for a standard wallet policy.
Returns
-------
List[Tuple[int, PartialSignature]]
A list of tuples returned by the hardware wallets, where each element is a tuple of:
- an integer, the index of the input being signed;
- an instance of `PartialSignature`.
"""
raise NotImplementedError
def get_master_fingerprint(self) -> bytes:
"""Gets the fingerprint of the master public key, as per BIP-32.
Returns
-------
bytes
The fingerprint of the master public key, as an array of 4 bytes.
"""
raise NotImplementedError
def sign_message(self, message: Union[str, bytes], bip32_path: str) -> str:
"""
Sign a message (bitcoin message signing).
Signs a message using the legacy Bitcoin Core signed message format.
The message is signed with the key at the given path.
:param message: The message to be signed. First encoded as bytes if not already.
:param bip32_path: The BIP 32 derivation for the key to sign the message with.
:return: The signature
"""
raise NotImplementedError
|