-
Notifications
You must be signed in to change notification settings - Fork 46
/
service.py
337 lines (295 loc) · 12.1 KB
/
service.py
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
import base64
import logging
import time
import os
from operator import attrgetter
from entity import (
Issuer,
Operation,
ReaderKeyResponse,
ReaderKeyRequest,
HardwareFinishResponse,
HardwareFinishColor,
DeviceCredentialRequest,
DeviceCredentialResponse,
Endpoint,
Enrollments,
Enrollment,
OperationStatus,
SupportedConfigurationResponse,
ControlPointRequest,
ControlPointResponse,
)
from homekey import read_homekey, ProtocolError
from repository import Repository
from util.bfclf import (
BroadcastFrameContactlessFrontend,
RemoteTarget,
activate,
ISODEPTag,
)
from util.digital_key import DigitalKeyFlow, DigitalKeyTransactionType
from util.ecp import ECP
from util.iso7816 import ISO7816Tag
from util.threads import create_runner
from util.structable import pack_into_base64_string, unpack_from_base64_string
log = logging.getLogger()
class Service:
def __init__(
self,
clf: BroadcastFrameContactlessFrontend,
repository: Repository,
express: bool = True,
finish: str = "silver",
flow: str = "fast",
) -> None:
self.repository = repository
self.clf = clf
self.express = express in (True, "True", "true", "1")
try:
self.hardware_finish_color = HardwareFinishColor[finish.upper()]
except KeyError:
self.hardware_finish_color = HardwareFinishColor.BLACK
log.warning(
f"HardwareFinish {finish} is not supported. Falling back to {self.hardware_finish_color}"
)
try:
self.flow = DigitalKeyFlow[flow.upper()]
except KeyError:
self.flow = DigitalKeyFlow.FAST
log.warning(
f"Digital Key flow {flow} is not supported. Falling back to {self.flow}"
)
self._run_flag = True
self._runner = None
def on_endpoint_authenticated(self, endpoint):
"""This method will be called when an endpoint is authenticated"""
# Currently overwritten by accessory.py
def start(self):
self._runner = create_runner(
name="homekey",
target=self.run,
flag=attrgetter("_run_flag"),
delay=0,
exception_delay=5,
start=True,
)
def stop(self):
self._run_flag = False
if self._runner is not None:
self._runner.join()
def update_hap_pairings(self, issuer_public_keys):
issuers = {
issuer.public_key: issuer for issuer in self.repository.get_all_issuers()
}
for issuer in issuers.values():
if issuer.public_key in issuer_public_keys:
continue
log.info(f"Removing issuer {issuer} as their pairing has been removed")
self.repository.remove_issuer(issuer)
for issuer_public_key in issuer_public_keys:
if issuer_public_key in issuers:
continue
issuer = Issuer(public_key=issuer_public_key, endpoints=[])
log.info(f"Adding issuer {issuer} based on paired clients")
self.repository.upsert_issuer(issuer)
def _read_homekey(self):
start = time.monotonic()
remote_target = self.clf.sense(
RemoteTarget("106A"),
broadcast=ECP.home(
identifier=self.repository.get_reader_group_identifier(),
flag_2=self.express,
).pack(),
)
if remote_target is None:
return
target = activate(self.clf, remote_target)
if target is None:
return
if not isinstance(target, ISODEPTag):
log.info(
f"Found non-ISODEP Tag with UID: {target.identifier.hex().upper()}"
)
while self.clf.sense(RemoteTarget("106A")) is not None:
log.info("Waiting for target to leave the field...")
time.sleep(0.5)
return
log.info(f"Got NFC tag {target}")
tag = ISO7816Tag(target)
try:
result_flow, new_issuers_state, endpoint = read_homekey(
tag,
issuers=self.repository.get_all_issuers(),
preferred_versions=[b"\x02\x00"],
flow=self.flow,
transaction_code=DigitalKeyTransactionType.UNLOCK,
reader_identifier=self.repository.get_reader_group_identifier()
+ self.repository.get_reader_identifier(),
reader_private_key=self.repository.get_reader_private_key(),
key_size=16,
)
if new_issuers_state is not None and len(new_issuers_state):
self.repository.upsert_issuers(new_issuers_state)
log.info(f"Authenticated endpoint via {result_flow!r}: {endpoint}")
end = time.monotonic()
log.info(f"Transaction took {(end - start) * 1000} ms")
if endpoint is not None:
self.on_endpoint_authenticated(endpoint)
except ProtocolError as e:
log.info(f'Could not authenticate device due to protocol error "{e}"')
# Let device cool down, wait for ISODEP to drop to consider comms finished
while target.is_present:
log.info("Waiting for device to leave the field...")
time.sleep(0.5)
log.info("Device left the field. Continuing in 2 seconds...")
time.sleep(2)
log.info("Waiting for next device...")
def run(self):
if self.repository.get_reader_private_key() in (None, b""):
raise Exception("Device is not configured via HAP. NFC inactive")
log.exception("Connecting to the NFC reader...")
self.clf.device = None
self.clf.open(self.clf.path)
if self.clf.device is None:
raise Exception(
f"Could not connect to NFC device {self.clf} at {self.clf.path}"
)
while self._run_flag:
self._read_homekey()
def get_reader_key(self, request: ReaderKeyRequest) -> ReaderKeyResponse:
response = ReaderKeyResponse(
key_identifier=self.repository.get_reader_group_identifier(),
)
return response
def add_reader_key(self, request: ReaderKeyRequest) -> ReaderKeyResponse:
changed = False
if self.repository.get_reader_private_key() != request.reader_private_key:
changed = True
self.repository.set_reader_private_key(request.reader_private_key)
if self.repository.get_reader_identifier() != request.unique_reader_identifier:
changed = True
self.repository.set_reader_identifier(request.unique_reader_identifier)
response = ReaderKeyResponse(
status=OperationStatus.SUCCESS if changed else OperationStatus.DUPLICATE
)
return response
def remove_reader_key(self, request: ReaderKeyRequest) -> ReaderKeyResponse:
if request.key_identifier == self.repository.get_reader_group_identifier():
self.repository.set_reader_private_key(bytes.fromhex("00" * 32))
response = ReaderKeyResponse(
status=OperationStatus.SUCCESS
if request.key_identifier == self.repository.get_reader_group_identifier()
else OperationStatus.DOES_NOT_EXIST
)
return response
def get_device_credential(
self, request: DeviceCredentialRequest
) -> DeviceCredentialResponse:
log.info(f"*** get_device_credential request={request}")
def add_device_credential(
self, request: DeviceCredentialRequest
) -> DeviceCredentialResponse:
endpoint = self.repository.get_endpoint_by_public_key(
b"\x04" + request.credential_public_key
)
log.info(f"*** add_device_credential endpoint={endpoint}")
if endpoint is not None:
if endpoint.enrollments.hap is None:
issuer = self.repository.get_issuer_by_id(request.issuer_key_identifier)
endpoint.enrollments.hap = Enrollment(
at=int(time.time()),
payload=base64.b64encode(request.pack()).decode(),
)
self.repository.upsert_endpoint(issuer.id, endpoint)
return DeviceCredentialResponse(
key_identifier=self.repository.get_reader_group_identifier(),
status=OperationStatus.DUPLICATE,
)
issuer = self.repository.get_issuer_by_id(request.issuer_key_identifier)
log.info(f"*** add_device_credential issuer={issuer}")
if issuer is None:
return DeviceCredentialResponse(
key_identifier=self.repository.get_reader_group_identifier(),
status=OperationStatus.DOES_NOT_EXIST,
)
self.repository.upsert_endpoint(
issuer.id,
Endpoint(
last_used_at=0,
counter=0,
key_type=request.key_type,
public_key=b"\x04" + request.credential_public_key,
persistent_key=os.urandom(32),
enrollments=Enrollments(
hap=Enrollment(
at=int(time.time()),
payload=base64.b64encode(request.pack()).decode(),
),
attestation=None,
),
),
)
return DeviceCredentialResponse(
issuer_key_identifier=issuer.id, status=OperationStatus.DUPLICATE
)
def remove_device_credential(
self, request: DeviceCredentialRequest
) -> DeviceCredentialResponse:
log.info(f"*** remove_device_credential request={request}")
def get_hardware_finish(self):
result = pack_into_base64_string(
HardwareFinishResponse(color=self.hardware_finish_color)
)
log.info(f"get_hardware_finish={result}")
return result
def get_nfc_access_supported_configuration(self):
result = pack_into_base64_string(
SupportedConfigurationResponse(
number_of_issuer_keys=16, number_of_inactive_credentials=16
)
)
log.info(f"TODO get_nfc_access_supported_configuration={result}")
return result
def get_nfc_access_control_point(self):
log.info("get_nfc_access_control_point")
return ""
def set_nfc_access_control_point(self, value):
log.info(f"<-- (B64) {value}")
request_packed_tlv = unpack_from_base64_string(value)
log.info(f"<-- (TLV) {request_packed_tlv.hex()}")
request: ControlPointRequest = ControlPointRequest.unpack(request_packed_tlv)
log.info(f"<-- (OBJ) {request}")
operation = request.operation
response = ControlPointResponse()
if request.device_credential_request is not None:
subrequest: DeviceCredentialRequest = request.device_credential_request
response.device_credential_response = (
self.get_device_credential(subrequest)
if operation == Operation.GET
else self.add_device_credential(subrequest)
if operation == Operation.ADD
else self.remove_device_credential(subrequest)
if operation == Operation.REMOVE
else None
)
elif request.reader_key_request is not None:
subrequest: ReaderKeyRequest = request.reader_key_request
response.reader_key_response = (
self.get_reader_key(subrequest)
if operation == Operation.GET
else self.add_reader_key(subrequest)
if operation == Operation.ADD
else self.remove_reader_key(subrequest)
if operation == Operation.REMOVE
else None
)
log.info(f"--> (OBJ) {response}")
packed_tlv_response = response.pack()
log.info(f"--> (TLV) {packed_tlv_response.hex()}")
response = pack_into_base64_string(packed_tlv_response)
log.info(f"--> (B64) {response}")
return response
def get_configuration_state(self):
log.info("get_configuration_state")
return 0