mirror of
https://github.com/saymrwulf/xous-core.git
synced 2026-11-20 09:03:28 +00:00
add warnings & support for fused devices
burning a generic image to a fused device will surely lead to a brick, so, try to keep a user from shooting themselves in the foot.
This commit is contained in:
parent
c2f7a63f97
commit
e42c4c7b33
1 changed files with 215 additions and 32 deletions
|
|
@ -12,6 +12,12 @@ import urllib.request
|
||||||
import re
|
import re
|
||||||
|
|
||||||
from progressbar.bar import ProgressBar
|
from progressbar.bar import ProgressBar
|
||||||
|
from bip_utils import (
|
||||||
|
Bip39MnemonicValidator, Bip39MnemonicDecoder
|
||||||
|
)
|
||||||
|
from Crypto.Cipher import AES
|
||||||
|
from Crypto.Hash import SHA256
|
||||||
|
from Crypto.Random import get_random_bytes
|
||||||
|
|
||||||
class PrecursorUsb:
|
class PrecursorUsb:
|
||||||
def __init__(self, dev):
|
def __init__(self, dev):
|
||||||
|
|
@ -415,6 +421,163 @@ class PrecursorUsb:
|
||||||
|
|
||||||
self.ping_wdt()
|
self.ping_wdt()
|
||||||
|
|
||||||
|
def bitflip(data_block, bitwidth=32):
|
||||||
|
if bitwidth == 0:
|
||||||
|
return data_block
|
||||||
|
bytewidth = bitwidth // 8
|
||||||
|
bitswapped = bytearray()
|
||||||
|
i = 0
|
||||||
|
while i < len(data_block):
|
||||||
|
data = int.from_bytes(data_block[i:i+bytewidth], byteorder='big', signed=False)
|
||||||
|
b = '{:0{width}b}'.format(data, width=bitwidth)
|
||||||
|
bitswapped.extend(int(b[::-1], 2).to_bytes(bytewidth, byteorder='big'))
|
||||||
|
i = i + bytewidth
|
||||||
|
return bytes(bitswapped)
|
||||||
|
|
||||||
|
# assumes a, b are the same length eh?
|
||||||
|
def xor_bytes(a, b):
|
||||||
|
i = 0
|
||||||
|
y = bytearray()
|
||||||
|
while i < len(a):
|
||||||
|
y.extend((a[i] ^ b[i]).to_bytes(1, byteorder='little'))
|
||||||
|
i = i + 1
|
||||||
|
|
||||||
|
return bytes(y)
|
||||||
|
|
||||||
|
def try_key_to_bytes(input):
|
||||||
|
if len(input.split(' ')) == 24: # 24 words is BIP-39
|
||||||
|
# Get if a mnemonic is valid with automatic language detection, return bool
|
||||||
|
assert(Bip39MnemonicValidator().IsValid(input))
|
||||||
|
# Like before with automatic language detection
|
||||||
|
key_bytes = Bip39MnemonicDecoder().Decode(input)
|
||||||
|
else:
|
||||||
|
key_bytes = int(input, 16).to_bytes(32, byteorder='big')
|
||||||
|
return key_bytes
|
||||||
|
|
||||||
|
# binfile should be the input SoC file, already read in as bytes()
|
||||||
|
# returns the encrypted version of binfile
|
||||||
|
def encrypt_to_efuse(binfile, key):
|
||||||
|
print("Encrypting gateware to target-specific key...")
|
||||||
|
# extract the keys
|
||||||
|
key_bytes = bytes([0] * 32)
|
||||||
|
new_key = try_key_to_bytes(key)
|
||||||
|
new_hmac = get_random_bytes(32)
|
||||||
|
new_iv = get_random_bytes(16)
|
||||||
|
|
||||||
|
# search for structure
|
||||||
|
# 0x3001_6004 -> specifies the CBC key
|
||||||
|
# 4 words of CBC IV
|
||||||
|
# 0x3003_4001 -> ciphertext len
|
||||||
|
# 1 word of ciphertext len
|
||||||
|
# then ciphertext
|
||||||
|
|
||||||
|
position = 0
|
||||||
|
iv_pos = 0
|
||||||
|
while position < len(binfile):
|
||||||
|
cwd = int.from_bytes(binfile[position:position+4], 'big')
|
||||||
|
if cwd == 0x3001_6004:
|
||||||
|
iv_pos = position+4
|
||||||
|
if cwd == 0x3003_4001:
|
||||||
|
break
|
||||||
|
position = position + 1
|
||||||
|
|
||||||
|
position = position + 4
|
||||||
|
|
||||||
|
ciphertext_len = 4* int.from_bytes(binfile[position:position+4], 'big')
|
||||||
|
position = position + 4
|
||||||
|
|
||||||
|
active_area = binfile[position : position+ciphertext_len]
|
||||||
|
postamble = binfile[position+ciphertext_len:]
|
||||||
|
|
||||||
|
iv_bytes = bitflip(binfile[iv_pos : iv_pos+0x10]) # note that the IV is embedded in the file
|
||||||
|
|
||||||
|
cipher = AES.new(key_bytes, AES.MODE_CBC, iv_bytes)
|
||||||
|
plain_bitstream = cipher.decrypt(bitflip(active_area))
|
||||||
|
|
||||||
|
# now construct the output file and its hashes
|
||||||
|
plaintext = bytearray()
|
||||||
|
f = bytearray()
|
||||||
|
|
||||||
|
# fixed header that sets 66MHz config speed, x1, 1.8V, eFuse target
|
||||||
|
device_header = [
|
||||||
|
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
|
||||||
|
0xaa, 0x99, 0x55, 0x66, 0x20, 0x00, 0x00, 0x00, 0x30, 0x03, 0xe0, 0x01, 0x00, 0x00, 0x00, 0x0b,
|
||||||
|
0x30, 0x00, 0x80, 0x01, 0x00, 0x00, 0x00, 0x12, 0x20, 0x00, 0x00, 0x00, 0x30, 0x00, 0xc0, 0x01,
|
||||||
|
0x80, 0x00, 0x00, 0x40, 0x30, 0x00, 0xa0, 0x01, 0x80, 0x00, 0x00, 0x40, 0x30, 0x01, 0xc0, 0x01,
|
||||||
|
0x00, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00,
|
||||||
|
0x20, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00,
|
||||||
|
0x20, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00,
|
||||||
|
0x20, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x30, 0x01, 0x60, 0x04,
|
||||||
|
]
|
||||||
|
|
||||||
|
for item in device_header: # add the cleartext header
|
||||||
|
f.extend(bytes([item]))
|
||||||
|
|
||||||
|
f.extend(bitflip(new_iv)) # insert the IV
|
||||||
|
|
||||||
|
ciphertext_header = [
|
||||||
|
0x30, 0x03, 0x40, 0x01, 0x00, 0x08, 0x5b, 0x98,
|
||||||
|
]
|
||||||
|
for item in ciphertext_header: # add the cleartext length-of-ciphertext field before the ciphertext
|
||||||
|
f.extend(bytes([item]))
|
||||||
|
|
||||||
|
# generate the header and footer hash keys.
|
||||||
|
header = int(0x6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C6C).to_bytes(32, byteorder='big')
|
||||||
|
keyed_header = xor_bytes(header, new_hmac)
|
||||||
|
footer = int(0x3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A3A).to_bytes(32, byteorder='big')
|
||||||
|
keyed_footer = xor_bytes(footer, new_hmac)
|
||||||
|
|
||||||
|
# add the header
|
||||||
|
plaintext.extend(keyed_header)
|
||||||
|
plaintext.extend(header)
|
||||||
|
|
||||||
|
# insert the bitstream plaintext, skipping the header and the trailing HMAC.
|
||||||
|
plaintext.extend(plain_bitstream[64:-160])
|
||||||
|
|
||||||
|
# compute first HMAC of stream with new HMAC key
|
||||||
|
h1 = SHA256.new()
|
||||||
|
k = 0
|
||||||
|
while k < len(plaintext) - 320: # HMAC does /not/ cover the whole file, it stops 320 bytes short of the end
|
||||||
|
h1.update(bitflip(plaintext[k:k+16], 32))
|
||||||
|
k = k + 16
|
||||||
|
h1_digest = h1.digest()
|
||||||
|
|
||||||
|
# add the footer
|
||||||
|
plaintext.extend(keyed_footer)
|
||||||
|
plaintext.extend(footer)
|
||||||
|
plaintext.extend(bytes(32)) # empty spot where hash #1 would be stored
|
||||||
|
hash_pad = [ # sha-256 padding for the zero'd hash #1, which is in the bitstream and seems necessary for verification
|
||||||
|
0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
||||||
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xc0, 0x00, 0x00,
|
||||||
|
]
|
||||||
|
plaintext.extend(hash_pad)
|
||||||
|
|
||||||
|
# compute the hash of the hash, presumably to prevent length extension attacks?
|
||||||
|
h2 = SHA256.new()
|
||||||
|
h2.update(bitflip(keyed_footer))
|
||||||
|
h2.update(bitflip(footer))
|
||||||
|
h2.update(h1_digest)
|
||||||
|
h2_digest = h2.digest()
|
||||||
|
|
||||||
|
# commit the final HMAC to the bitstream plaintext
|
||||||
|
plaintext.extend(bitflip(h2_digest))
|
||||||
|
|
||||||
|
# encrypt the bitstream
|
||||||
|
newcipher = AES.new(new_key, AES.MODE_CBC, new_iv)
|
||||||
|
|
||||||
|
# finally generate the ciphertext block, which encapsulates the HMACs
|
||||||
|
ciphertext = newcipher.encrypt(bytes(plaintext))
|
||||||
|
|
||||||
|
# add ciphertext to the bitstream
|
||||||
|
f.extend(bitflip(ciphertext))
|
||||||
|
|
||||||
|
# add the cleartext postamble to the bitstream. These are a series of NOP commands + all of the csr.csv data & signatures
|
||||||
|
f.extend(postamble)
|
||||||
|
print("Encryption success! {} bytes generated.".format(len(f)))
|
||||||
|
assert len(f) == 2621440, "Encryption length is incorrect; aborting!"
|
||||||
|
|
||||||
|
return f
|
||||||
|
|
||||||
def auto_int(x):
|
def auto_int(x):
|
||||||
return int(x, 0)
|
return int(x, 0)
|
||||||
|
|
||||||
|
|
@ -489,6 +652,9 @@ def main():
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--dump-file", required=False, help="Name out output file for dump. Required if --dump is specified.", type=str,
|
"--dump-file", required=False, help="Name out output file for dump. Required if --dump is specified.", type=str,
|
||||||
)
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--key", help="Backup key in hex or BIP-39 format. Used to factory-reset efused devices", type=str
|
||||||
|
)
|
||||||
args = parser.parse_args()
|
args = parser.parse_args()
|
||||||
|
|
||||||
if not len(sys.argv) > 1:
|
if not len(sys.argv) > 1:
|
||||||
|
|
@ -615,29 +781,35 @@ def main():
|
||||||
if args.soc == None:
|
if args.soc == None:
|
||||||
print("Must provide both a soc and loader image")
|
print("Must provide both a soc and loader image")
|
||||||
print("Enabling boot with {} and {}".format(args.loader, args.soc))
|
print("Enabling boot with {} and {}".format(args.loader, args.soc))
|
||||||
print("Programming loader image {}".format(args.loader))
|
print("WARNING: if you have burned a backup key into your device,\nyou MUST specify the key with `--key`, or else your device will be bricked.")
|
||||||
with open(args.loader, "rb") as f:
|
print("Continue? (y/n)")
|
||||||
image = f.read()
|
confirm = input()
|
||||||
pc_usb.flash_program(locs['LOC_LOADER'][0], image, verify=verify)
|
if len(confirm) > 0 and confirm.lower()[:1] == 'y':
|
||||||
print("Programming SoC gateware".format(args.soc))
|
print("Programming loader image {}".format(args.loader))
|
||||||
with open(args.soc, "rb") as f:
|
with open(args.loader, "rb") as f:
|
||||||
image = f.read()
|
image = f.read()
|
||||||
if verify == True:
|
pc_usb.flash_program(locs['LOC_LOADER'][0], image, verify=verify)
|
||||||
print("Note: SoC verification is not possible as readback is locked for security purposes")
|
print("Programming SoC gateware".format(args.soc))
|
||||||
pc_usb.flash_program(locs['LOC_SOC'][0], image, verify=False)
|
with open(args.soc, "rb") as f:
|
||||||
|
image = f.read()
|
||||||
|
if args.key is not None:
|
||||||
|
image = encrypt_to_efuse(image, args.key)
|
||||||
|
if verify == True:
|
||||||
|
print("Note: SoC verification is not possible as readback is locked for security purposes")
|
||||||
|
pc_usb.flash_program(locs['LOC_SOC'][0], image, verify=False)
|
||||||
|
|
||||||
print("Erasing PDDB root structures")
|
print("Erasing PDDB root structures")
|
||||||
pc_usb.erase_region(locs['LOC_PDDB'][0], 1024 * 1024)
|
pc_usb.erase_region(locs['LOC_PDDB'][0], 1024 * 1024)
|
||||||
|
|
||||||
print("Resuming CPU.")
|
print("Resuming CPU.")
|
||||||
pc_usb.poke(vexdbg_addr, 0x02000000)
|
pc_usb.poke(vexdbg_addr, 0x02000000)
|
||||||
|
|
||||||
print("Resetting SOC...")
|
print("Resetting SOC...")
|
||||||
try:
|
try:
|
||||||
pc_usb.poke(pc_usb.register('reboot_soc_reset'), 0xac, display=False)
|
pc_usb.poke(pc_usb.register('reboot_soc_reset'), 0xac, display=False)
|
||||||
except usb.core.USBError:
|
except usb.core.USBError:
|
||||||
pass # we expect an error because we reset the SOC and that includes the USB core
|
pass # we expect an error because we reset the SOC and that includes the USB core
|
||||||
exit(0)
|
exit(0)
|
||||||
|
|
||||||
if args.enable_boot_update:
|
if args.enable_boot_update:
|
||||||
if args.loader == None:
|
if args.loader == None:
|
||||||
|
|
@ -708,6 +880,7 @@ def main():
|
||||||
|
|
||||||
if args.soc != None:
|
if args.soc != None:
|
||||||
if args.force == True:
|
if args.force == True:
|
||||||
|
print("`--force` specified; all checks disabled, you may brick your device!")
|
||||||
print("Programming SoC gateware {}".format(args.soc))
|
print("Programming SoC gateware {}".format(args.soc))
|
||||||
with open(args.soc, "rb") as f:
|
with open(args.soc, "rb") as f:
|
||||||
image = f.read()
|
image = f.read()
|
||||||
|
|
@ -717,12 +890,16 @@ def main():
|
||||||
print("Erasing PDDB root structures")
|
print("Erasing PDDB root structures")
|
||||||
pc_usb.erase_region(locs['LOC_PDDB'][0], 1024 * 1024)
|
pc_usb.erase_region(locs['LOC_PDDB'][0], 1024 * 1024)
|
||||||
else:
|
else:
|
||||||
print("This will overwrite any secret keys in your device and erase PDDB keys. Continue? (y/n)")
|
print("This will overwrite any secret keys in your device and erase PDDB keys.")
|
||||||
|
print("WARNING: if you have burned a backup key into your device,\nyou MUST specify the key with `--key`, or else your device will be bricked.")
|
||||||
|
print("Continue? (y/n)")
|
||||||
confirm = input()
|
confirm = input()
|
||||||
if len(confirm) > 0 and confirm.lower()[:1] == 'y':
|
if len(confirm) > 0 and confirm.lower()[:1] == 'y':
|
||||||
print("Programming SoC gateware {}".format(args.soc))
|
print("Programming SoC gateware {}".format(args.soc))
|
||||||
with open(args.soc, "rb") as f:
|
with open(args.soc, "rb") as f:
|
||||||
image = f.read()
|
image = f.read()
|
||||||
|
if args.key is not None:
|
||||||
|
image = encrypt_to_efuse(image, args.key)
|
||||||
if verify == True:
|
if verify == True:
|
||||||
print("Note: SoC verification is not possible as readback is locked for security purposes")
|
print("Note: SoC verification is not possible as readback is locked for security purposes")
|
||||||
pc_usb.flash_program(locs['LOC_SOC'][0], image, verify=False)
|
pc_usb.flash_program(locs['LOC_SOC'][0], image, verify=False)
|
||||||
|
|
@ -740,17 +917,23 @@ def main():
|
||||||
pc_usb.flash_program(locs['LOC_AUDIO'][0], image, verify=verify)
|
pc_usb.flash_program(locs['LOC_AUDIO'][0], image, verify=verify)
|
||||||
|
|
||||||
if args.factory_new:
|
if args.factory_new:
|
||||||
base_url = "https://ci.betrusted.io/releases/v0.9.5/"
|
print("WARNING: if you have burned a backup key into your device,\nyou MUST specify the key with `--key`, or else your device will be bricked.")
|
||||||
# erase the entire flash
|
print("Continue? (y/n)")
|
||||||
pc_usb.erase_region(0, 0x800_0000)
|
confirm = input()
|
||||||
# burn the gateware
|
if len(confirm) > 0 and confirm.lower()[:1] == 'y':
|
||||||
for sections in locs.values():
|
base_url = "https://ci.betrusted.io/releases/v0.9.5/"
|
||||||
if sections[1] != 'pass':
|
# erase the entire flash
|
||||||
print('retrieving {}'.format(base_url + sections[1]))
|
pc_usb.erase_region(0, 0x800_0000)
|
||||||
with urllib.request.urlopen(base_url + sections[1]) as f:
|
# burn the gateware
|
||||||
print('burning at {:x}'.format(sections[0]))
|
for sections in locs.values():
|
||||||
image = f.read()
|
if sections[1] != 'pass':
|
||||||
pc_usb.flash_program(sections[0], image, verify=False)
|
print('retrieving {}'.format(base_url + sections[1]))
|
||||||
|
with urllib.request.urlopen(base_url + sections[1]) as f:
|
||||||
|
print('burning at {:x}'.format(sections[0]))
|
||||||
|
image = f.read()
|
||||||
|
if sections[1] == "soc_csr.bin" and args.key is not None:
|
||||||
|
image = encrypt_to_efuse(image, args.key)
|
||||||
|
pc_usb.flash_program(sections[0], image, verify=False)
|
||||||
|
|
||||||
|
|
||||||
print("Resuming CPU.")
|
print("Resuming CPU.")
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue