Merge pull request #415 from cbouvet-ledger/cbo-ledger-update

ledger: handle 0.0.8 new apdu format
This commit is contained in:
Roman Zeyde
2023-02-04 18:04:50 +02:00
committed by GitHub

View File

@@ -36,6 +36,22 @@ def _convert_public_key(ecdsa_curve_name, result):
class LedgerNanoS(interface.Device): class LedgerNanoS(interface.Device):
"""Connection to Ledger Nano S device.""" """Connection to Ledger Nano S device."""
LEDGER_APP_NAME = "SSH/PGP Agent"
ledger_app_version = None
ledger_app_supports_end_of_frame_byte = True
def get_app_name_and_version(self, dongle):
device_version_answer = dongle.exchange(binascii.unhexlify('B001000000'))
offset = 1
app_name_length = struct.unpack_from("B", device_version_answer, offset)[0]
offset += 1
app_name = device_version_answer[offset: offset + app_name_length]
offset += app_name_length
app_version_length = struct.unpack_from("B", device_version_answer, offset)[0]
offset += 1
app_version = device_version_answer[offset: offset + app_version_length]
log.debug("running app {}, version {}".format(app_name, app_version))
return (app_name.decode(), app_version.decode())
@classmethod @classmethod
def package_name(cls): def package_name(cls):
@@ -45,10 +61,21 @@ class LedgerNanoS(interface.Device):
def connect(self): def connect(self):
"""Enumerate and connect to the first USB HID interface.""" """Enumerate and connect to the first USB HID interface."""
try: try:
return comm.getDongle() dongle = comm.getDongle(debug=True)
(app_name, self.ledger_app_version) = self.get_app_name_and_version(dongle)
self.ledger_app_version = self.ledger_app_version.split(".")
if self.ledger_app_version[0] == "0" and self.ledger_app_version[1] == "0" and int(self.ledger_app_version[2]) <= 7:
self.ledger_app_supports_end_of_frame_byte = False
if app_name != LedgerNanoS.LEDGER_APP_NAME:
# we could launch the app here if we are in the dashboard
raise interface.DeviceError('{} is not running {}'.format(self, LedgerNanoS.LEDGER_APP_NAME))
return dongle
except comm.CommException as e: except comm.CommException as e:
raise interface.NotFoundError( raise interface.DeviceError(
'{} not connected: "{}"'.format(self, e)) 'Error ({}) communicating with {}'.format(e, self))
def pubkey(self, identity, ecdh=False): def pubkey(self, identity, ecdh=False):
"""Get PublicKey object for specified BIP32 address and elliptic curve.""" """Get PublicKey object for specified BIP32 address and elliptic curve."""
@@ -72,23 +99,43 @@ class LedgerNanoS(interface.Device):
def sign(self, identity, blob): def sign(self, identity, blob):
"""Sign given blob and return the signature (as bytes).""" """Sign given blob and return the signature (as bytes)."""
path = _expand_path(identity.get_bip32_address(ecdh=False)) path = _expand_path(identity.get_bip32_address(ecdh=False))
offset = 0
result = None
while offset != len(blob):
data = bytes()
if offset == 0:
data += bytearray([len(path) // 4]) + path
chunk_size = min(len(blob) - offset, 255 - len(data))
data += blob[offset : offset + chunk_size]
if identity.identity_dict['proto'] == 'ssh': if identity.identity_dict['proto'] == 'ssh':
ins = '04' ins = '04'
p1 = '00'
else: else:
ins = '08' ins = '08'
p1 = '00'
if identity.curve_name == 'nist256p1': if identity.curve_name == 'nist256p1':
p2 = '81' if identity.identity_dict['proto'] == 'ssh' else '01' p2 = '81' if identity.identity_dict['proto'] == 'ssh' else '01'
else: else:
p2 = '82' if identity.identity_dict['proto'] == 'ssh' else '02' p2 = '82' if identity.identity_dict['proto'] == 'ssh' else '02'
apdu = '80' + ins + p1 + p2
apdu = binascii.unhexlify(apdu) if offset == 0:
apdu += bytearray([len(blob) + len(path) + 1]) p1 = "00"
apdu += bytearray([len(path) // 4]) + path elif ((offset + chunk_size) == len(blob)) and self.ledger_app_supports_end_of_frame_byte:
apdu += blob p1 = "81" # end of frame byte only handled in 0.0.8+
else:
p1 = "01"
apdu = binascii.unhexlify('80' + ins + p1 + p2) + len(data).to_bytes(1, 'little') + data
log.debug('apdu: %r', apdu) log.debug('apdu: %r', apdu)
try:
result = bytearray(self.conn.exchange(bytes(apdu))) result = bytearray(self.conn.exchange(bytes(apdu)))
except comm.CommException as e:
raise interface.DeviceError(
'Error ({}) communicating with {}'.format(e, self))
offset += chunk_size
log.debug('result: %r', result) log.debug('result: %r', result)
if identity.curve_name == 'nist256p1': if identity.curve_name == 'nist256p1':
offset = 3 offset = 3
@@ -119,7 +166,11 @@ class LedgerNanoS(interface.Device):
apdu += bytearray([len(path) // 4]) + path apdu += bytearray([len(path) // 4]) + path
apdu += pubkey apdu += pubkey
log.debug('apdu: %r', apdu) log.debug('apdu: %r', apdu)
try:
result = bytearray(self.conn.exchange(bytes(apdu))) result = bytearray(self.conn.exchange(bytes(apdu)))
except comm.CommException as e:
raise interface.DeviceError(
'Error ({}) communicating with {}'.format(e, self))
log.debug('result: %r', result) log.debug('result: %r', result)
assert result[0] == 0x04 assert result[0] == 0x04
return bytes(result) return bytes(result)