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
|
"""ledgercomm.transport module."""
import enum
import logging
import struct
from typing import Union, Tuple, Optional, Literal, cast
from ledgercomm.interfaces.tcp_client import TCPClient
from ledgercomm.interfaces.hid_device import HID
from ledgercomm.log import LOG
class TransportType(enum.Enum):
"""Type of interface available."""
HID = 1
TCP = 2
class Transport:
"""Transport class to send APDUs.
Allow to communicate using HID device such as Nano S/X or through TCP
socket with the Speculos emulator.
Parameters
----------
interface : str
Either "hid" or "tcp" for the underlying communication interface.
server : str
IP adress of the TCP server if interface is "tcp".
port : int
Port of the TCP server if interface is "tcp".
debug : bool
Whether you want debug logs or not.
Attributes
----------
interface : TransportType
Either TransportType.HID or TransportType.TCP.
com : Union[TCPClient, HID]
Communication interface to send/receive APDUs.
"""
def __init__(self,
interface: Literal["hid", "tcp"] = "tcp",
server: str = "127.0.0.1",
port: int = 9999,
debug: bool = False) -> None:
"""Init constructor of Transport."""
if debug:
LOG.setLevel(logging.DEBUG)
# create console handler and set level to debug
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)
# create formatter
formatter = logging.Formatter('%(name)s - %(levelname)s - %(message)s')
# add formatter to ch
ch.setFormatter(formatter)
# add ch to logger
LOG.addHandler(ch)
self.interface: TransportType
try:
self.interface = TransportType[interface.upper()]
except KeyError as exc:
raise KeyError(f"Unknown interface '{interface}'!") from exc
self.com: Union[TCPClient, HID] = (TCPClient(server=server, port=port)
if self.interface == TransportType.TCP else HID())
self.com.open()
@staticmethod
def apdu_header(cla: int,
ins: Union[int, enum.IntEnum],
p1: int = 0,
p2: int = 0,
opt: Optional[int] = None,
lc: int = 0) -> bytes:
"""Pack the APDU header as bytes.
Parameters
----------
cla : int
Instruction class: CLA (1 byte)
ins : Union[int, IntEnum]
Instruction code: INS (1 byte)
p1 : int
Instruction parameter: P1 (1 byte).
p2 : int
Instruction parameter: P2 (1 byte).
opt : Optional[int]
Optional parameter: Opt (1 byte).
lc : int
Number of bytes in the payload: Lc (1 byte).
Returns
-------
bytes
APDU header packed with parameters.
"""
ins = cast(int, ins.value) if isinstance(ins, enum.IntEnum) else cast(int, ins)
if opt:
return struct.pack(
"BBBBBB",
cla,
ins,
p1,
p2,
1 + lc, # add option to length
opt)
return struct.pack("BBBBB", cla, ins, p1, p2, lc)
def send(self,
cla: int,
ins: Union[int, enum.IntEnum],
p1: int = 0,
p2: int = 0,
option: Optional[int] = None,
cdata: bytes = b"") -> int:
"""Send structured APDUs through `self.com`.
Parameters
----------
cla : int
Instruction class: CLA (1 byte)
ins : Union[int, IntEnum]
Instruction code: INS (1 byte)
p1 : int
Instruction parameter: P1 (1 byte).
p2 : int
Instruction parameter: P2 (1 byte).
option : Optional[int]
Optional parameter: Opt (1 byte).
cdata : bytes
Command data (variable length).
Returns
-------
int
Total lenght of the APDU sent.
"""
header: bytes = Transport.apdu_header(cla, ins, p1, p2, option, len(cdata))
return self.com.send(header + cdata)
def send_raw(self, apdu: Union[str, bytes]) -> int:
"""Send raw bytes `apdu` through `self.com`.
Parameters
----------
apdu : Union[str, bytes]
Hexstring or bytes within APDU to be sent through `self.com`.
Returns
-------
Optional[int]
Total lenght of APDU sent if any.
"""
if isinstance(apdu, str):
apdu = bytes.fromhex(apdu)
return self.com.send(apdu)
def recv(self) -> Tuple[int, bytes]:
"""Receive data from `self.com`.
Blocking IO.
Returns
-------
Tuple[int, bytes]
A pair (sw, rdata) for the status word (2 bytes represented
as int) and the reponse data (variable lenght).
"""
return self.com.recv()
def exchange(self,
cla: int,
ins: Union[int, enum.IntEnum],
p1: int = 0,
p2: int = 0,
option: Optional[int] = None,
cdata: bytes = b"") -> Tuple[int, bytes]:
"""Send structured APDUs and wait to receive datas from `self.com`.
Parameters
----------
cla : int
Instruction class: CLA (1 byte)
ins : Union[int, IntEnum]
Instruction code: INS (1 byte)
p1 : int
Instruction parameter: P1 (1 byte).
p2 : int
Instruction parameter: P2 (1 byte).
option : Optional[int]
Optional parameter: Opt (1 byte).
cdata : bytes
Command data (variable length).
Returns
-------
Tuple[int, bytes]
A pair (sw, rdata) for the status word (2 bytes represented
as int) and the reponse data (bytes of variable lenght).
"""
header: bytes = Transport.apdu_header(cla, ins, p1, p2, option, len(cdata))
return self.com.exchange(header + cdata)
def exchange_raw(self, apdu: Union[str, bytes]) -> Tuple[int, bytes]:
"""Send raw bytes `apdu` and wait to receive datas from `self.com`.
Parameters
----------
apdu : Union[str, bytes]
Hexstring or bytes within APDU to send through `self.com`.
Returns
-------
Tuple[int, bytes]
A pair (sw, rdata) for the status word (2 bytes represented
as int) and the reponse (bytes of variable lenght).
"""
if isinstance(apdu, str):
apdu = bytes.fromhex(apdu)
return self.com.exchange(apdu)
def close(self) -> None:
"""Close `self.com` interface.
Returns
-------
None
"""
self.com.close()
|
