diff --git a/tools/rpi-otp-private-key b/tools/rpi-otp-private-key index 3a17a17..68e8013 100755 --- a/tools/rpi-otp-private-key +++ b/tools/rpi-otp-private-key @@ -6,6 +6,8 @@ FORCE=0 READ_KEY="" WRITE_KEY="" OUTPUT_BINARY=0 +ROW_COUNT=8 +ROW_OFFSET=0 die() { echo "$@" >&2 @@ -25,10 +27,12 @@ usage() { N.B. OTP bits can never change from 1 to 0. -w Writes the new key to OTP memory. -y Skip the confirmation prompt when writing to OTP. + -l Specify key length in words. Defaults to 8 words (32 bytes). Pi 5 supports up to 16 words (64 bytes). + -o word Offset into the keystore to use, e.g. 0-7 for Pi 4, 0-15 for Pi 5. Defaults to zero. - is a 64 digit hex number (256 bit) e.g. to generate a 256 random number run 'openssl rand -hex 32' + is usually a 64 digit hex number (256 bit) e.g. to generate a 256 random number run 'openssl rand -hex 32' - IMPORTANT: Raspberry Pi 4 and earlier revisions do not have a hardware secure key store. These OTP rows are visible + IMPORTANT: Raspberry Pi 5 and earlier revisions do not have a hardware secure key store. These OTP rows are visible to any user in the 'video' group via vcmailbox. Therefore this functionality is only suitable for key storage if the OS has already been restricted using the signed boot functionality. @@ -46,8 +50,8 @@ check_key_set() { } read_key() { - out=READ_KEY="$(vcmailbox 0x00030081 40 40 0 8 0 0 0 0 0 0 0 0)" || die "Failed to read the current key from OTP" - READ_KEY="$(echo "${out}" | sed 's/0x//g' | awk '{for(i=8;i<16;i++) printf $i; print ""}')" + out=READ_KEY="$(vcmailbox 0x00030081 $((8 + $ROW_COUNT * 4)) $((8 + $ROW_COUNT * 4)) $ROW_OFFSET $ROW_COUNT 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0)" || die "Failed to read the current key from OTP" + READ_KEY="$(echo "${out}" | sed 's/0x//g' | awk -v last=$((8 + $ROW_COUNT)) '{for(i=8;i /dev/null; then + BOARD_INFO="$(vcgencmd otp_dump | grep '30:' | sed 's/.*://')" +else + die "No Raspberry Pi board info found" +fi +if [ $(((0x$BOARD_INFO >> 23) & 1)) = 0 ]; then + die "Chip not supported" +fi +if [ $(((0x$BOARD_INFO >> 12) & 15)) = 3 ]; then + MAX_ROW_COUNT=8 +elif [ $(((0x$BOARD_INFO >> 12) & 15)) = 4 ]; then + MAX_ROW_COUNT=16 +else + die "Chip not supported" +fi +if [ -z "$ROW_COUNT" ] || [ "$ROW_COUNT" -ne "$ROW_COUNT" ] 2>/dev/null; then + die "Key length not a number" +fi +if [ $ROW_COUNT -lt 1 ]; then + die "Length too small" +fi +if [ $ROW_COUNT -gt $MAX_ROW_COUNT ]; then + die "Length too big" +fi +if [ -z "$ROW_OFFSET" ] || [ "$ROW_OFFSET" -ne "$ROW_OFFSET" ] 2>/dev/null; then + die "Offset is not a number" +fi +if [ $ROW_OFFSET -lt 0 ]; then + die "Offset too small" +fi +if [ ${ROW_OFFSET} -gt $(($MAX_ROW_COUNT - $ROW_COUNT)) ]; then + die "Offset too big" +fi +if [ -z $(which vcmailbox) ]; then + die "vcmailbox command missing" +fi +if [ -z $(which xxd) ] && [ "$OUTPUT_BINARY" -eq "1" ]; then + die "xxd command missing" +fi + if [ -n "${WRITE_KEY}" ]; then if [ "${FORCE}" = 0 ] && check_key_set; then die "Current key is non-zero. Specify -f to write anyway"