Skip to content

Add RSA/ECC key loading, backup restore, backup passphrase, and firmware loading #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0c-coder wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add RSA/ECC key loading, backup restore, backup passphrase, and firmware loading #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4ecaf2
Add RSA/ECC key loading from PGP files, backup restore, and backup pa…
Mar 17, 2026
5a15745
Add firmware loading support via OKFWUPDATE protocol
Mar 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 153 additions & 0 deletions onlykey/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,6 +495,84 @@ def prompt_pin():
only_key.setslot(1, MessageField.LOCKBUTTON, int(sys.argv[2]))
elif sys.argv[1] == 'hmackeymode':
only_key.setslot(1, MessageField.HMACMODE, int(sys.argv[2]))
elif sys.argv[1] == 'loadkey':
try:
# loadkey <keyfile> [slot] [features]
# slot: RSA1-RSA4, ECC1-ECC16, or 'auto' (default)
# features: d (decryption), s (signing), b (backup)
keyfile = sys.argv[2]
slot = 99 # auto by default
features = ''
if len(sys.argv) > 3:
slot_arg = sys.argv[3]
if slot_arg == 'auto':
slot = 99
elif slot_arg.startswith('RSA'):
slot = int(slot_arg[3:])
elif slot_arg.startswith('ECC'):
slot = 100 + int(slot_arg[3:])
else:
slot = int(slot_arg)
if len(sys.argv) > 4:
features = sys.argv[4]
with open(keyfile, 'r') as f:
key_data = f.read()
passphrase = prompt('Passphrase: ',
is_password=Condition(lambda: hidden[0]),
key_bindings=key_bindings)
only_key.loadkey(key_data, passphrase, slot=slot, key_features=features)
except Exception as e:
print('Error loading key: {}'.format(str(e)))
print('Usage: onlykey-cli loadkey <keyfile> [slot] [features]')
print(' slot: RSA1-RSA4, ECC1-ECC16, or auto (default)')
print(' features: d (decryption), s (signing), b (backup)')
return
elif sys.argv[1] == 'restore':
try:
backupfile = sys.argv[2]
with open(backupfile, 'r') as f:
backup_data = f.read()
only_key.restore_from_backup(backup_data)
except IndexError:
print('Usage: onlykey-cli restore <backupfile>')
return
except Exception as e:
print('Error restoring backup: {}'.format(str(e)))
return
elif sys.argv[1] == 'backuppassphrase':
try:
print('Type Control-T to toggle passphrase visible.')
passphrase1 = prompt('Backup Passphrase: ',
is_password=Condition(lambda: hidden[0]),
key_bindings=key_bindings)
passphrase2 = prompt('Confirm Passphrase: ',
is_password=Condition(lambda: hidden[0]),
key_bindings=key_bindings)
if passphrase1 != passphrase2:
print('Error: Passphrases do not match')
return
only_key.set_backup_passphrase(passphrase1)
except Exception as e:
print('Error setting backup passphrase: {}'.format(str(e)))
return
elif sys.argv[1] == 'loadfirmware':
try:
fwfile = sys.argv[2]
with open(fwfile, 'r') as f:
fw_data = f.read()
print('WARNING: Loading firmware will update your OnlyKey device.')
print('Do NOT disconnect the device during the update!')
confirm = input('Type YES to continue: ')
if confirm.strip() != 'YES':
print('Firmware update cancelled.')
return
only_key.load_firmware(fw_data)
except IndexError:
print('Usage: onlykey-cli loadfirmware <firmware_file>')
return
except Exception as e:
print('Error loading firmware: {}'.format(str(e)))
return
elif sys.argv[1] == 'version':
print('OnlyKey CLI v1.2.10')
elif sys.argv[1] == 'fwversion':
Expand Down Expand Up @@ -1071,6 +1149,81 @@ def mprompt():
only_key.setslot(1, MessageField.HMACMODE, int(data[1]))
except:
continue
elif data[0] == 'loadkey':
try:
keyfile = data[1]
slot = 99
features = ''
if len(data) > 2:
slot_arg = data[2]
if slot_arg == 'auto':
slot = 99
elif slot_arg.startswith('RSA'):
slot = int(slot_arg[3:])
elif slot_arg.startswith('ECC'):
slot = 100 + int(slot_arg[3:])
else:
slot = int(slot_arg)
if len(data) > 3:
features = data[3]
with open(keyfile, 'r') as f:
key_data = f.read()
passphrase = prompt('Passphrase: ',
is_password=Condition(lambda: hidden[0]),
key_bindings=key_bindings)
only_key.loadkey(key_data, passphrase, slot=slot, key_features=features)
except Exception as e:
print('Error loading key: {}'.format(str(e)))
print('Usage: loadkey <keyfile> [slot] [features]')
print(' slot: RSA1-RSA4, ECC1-ECC16, or auto (default)')
print(' features: d (decryption), s (signing), b (backup)')
continue
elif data[0] == 'restore':
try:
backupfile = data[1]
with open(backupfile, 'r') as f:
backup_data = f.read()
only_key.restore_from_backup(backup_data)
except IndexError:
print('Usage: restore <backupfile>')
continue
except Exception as e:
print('Error restoring backup: {}'.format(str(e)))
continue
elif data[0] == 'backuppassphrase':
try:
print('Type Control-T to toggle passphrase visible.')
passphrase1 = prompt('Backup Passphrase: ',
is_password=Condition(lambda: hidden[0]),
key_bindings=key_bindings)
passphrase2 = prompt('Confirm Passphrase: ',
is_password=Condition(lambda: hidden[0]),
key_bindings=key_bindings)
if passphrase1 != passphrase2:
print('Error: Passphrases do not match')
continue
only_key.set_backup_passphrase(passphrase1)
except Exception as e:
print('Error setting backup passphrase: {}'.format(str(e)))
continue
elif data[0] == 'loadfirmware':
try:
fwfile = data[1]
with open(fwfile, 'r') as f:
fw_data = f.read()
print('WARNING: Loading firmware will update your OnlyKey device.')
print('Do NOT disconnect the device during the update!')
confirm = input('Type YES to continue: ')
if confirm.strip() != 'YES':
print('Firmware update cancelled.')
continue
only_key.load_firmware(fw_data)
except IndexError:
print('Usage: loadfirmware <firmware_file>')
continue
except Exception as e:
print('Error loading firmware: {}'.format(str(e)))
continue
elif data[0] == 'version':
try:
print('OnlyKey CLI v1.2.10')
Expand Down
Loading