Merge branch 'bb02p-product-string'

Author: benma

py/bitbox02/CHANGELOG.md

@@ -8,6 +8,7 @@
 - SD card: Remove API to prompt removal of the microSD card from the device
 - Add support for regtest (supported from firmware version v9.21.0)
 - btc_sign: allow identifying outputs belonging to different accounts of the same keystore
+- Detect BitBox02 Plus
 
 # 6.3.0
 - Allow infering product and version via API call instead of via USB descriptor

py/bitbox02/bitbox02/bitbox02/bootloader.py

@@ -23,7 +23,14 @@
 
 from bitbox02.communication import TransportLayer
 
-from bitbox02.communication.devices import DeviceInfo, parse_device_version
+from bitbox02.communication.devices import (
+    DeviceInfo,
+    parse_device_version,
+    BB02MULTI_BOOTLOADER,
+    BB02BTC_BOOTLOADER,
+    BITBOX02PLUS_MULTI_BOOTLOADER,
+    BITBOX02PLUS_BTC_BOOTLOADER,
+)
 
 BOOTLOADER_CMD = 0x80 + 0x40 + 0x03
 NUM_ROOT_KEYS = 3
@@ -35,9 +42,10 @@
 assert MAX_FIRMWARE_SIZE % CHUNK_SIZE == 0
 FIRMWARE_CHUNKS = MAX_FIRMWARE_SIZE // CHUNK_SIZE
 
-SIGDATA_MAGIC_STANDARD = struct.pack(">I", 0x653F362B)
-SIGDATA_MAGIC_BTCONLY = struct.pack(">I", 0x11233B0B)
-SIGDATA_MAGIC_BITBOXBASE_STANDARD = struct.pack(">I", 0xAB6BD345)
+SIGDATA_MAGIC_BITBOX02_MULTI = struct.pack(">I", 0x653F362B)
+SIGDATA_MAGIC_BITBOX02_BTCONLY = struct.pack(">I", 0x11233B0B)
+SIGDATA_MAGIC_BITBOX02PLUS_MULTI = struct.pack(">I", 0x5B648CEB)
+SIGDATA_MAGIC_BITBOX02PLUS_BTCONLY = struct.pack(">I", 0x48714774)
 
 MAGIC_LEN = 4
 
@@ -69,9 +77,10 @@ def parse_signed_firmware(firmware: bytes) -> typing.Tuple[bytes, bytes, bytes]:
         raise ValueError("firmware too small")
     magic, firmware = firmware[:MAGIC_LEN], firmware[MAGIC_LEN:]
     if magic not in (
-        SIGDATA_MAGIC_STANDARD,
-        SIGDATA_MAGIC_BTCONLY,
-        SIGDATA_MAGIC_BITBOXBASE_STANDARD,
+        SIGDATA_MAGIC_BITBOX02_MULTI,
+        SIGDATA_MAGIC_BITBOX02_BTCONLY,
+        SIGDATA_MAGIC_BITBOX02PLUS_MULTI,
+        SIGDATA_MAGIC_BITBOX02PLUS_BTCONLY,
     ):
         raise ValueError("invalid magic")
 
@@ -87,9 +96,10 @@ class Bootloader:
     def __init__(self, transport: TransportLayer, device_info: DeviceInfo):
         self._transport = transport
         self.expected_magic = {
-            "bb02-bootloader": SIGDATA_MAGIC_STANDARD,
-            "bb02btc-bootloader": SIGDATA_MAGIC_BTCONLY,
-            "bitboxbase-bootloader": SIGDATA_MAGIC_BITBOXBASE_STANDARD,
+            BB02MULTI_BOOTLOADER: SIGDATA_MAGIC_BITBOX02_MULTI,
+            BB02BTC_BOOTLOADER: SIGDATA_MAGIC_BITBOX02_BTCONLY,
+            BITBOX02PLUS_MULTI_BOOTLOADER: SIGDATA_MAGIC_BITBOX02PLUS_MULTI,
+            BITBOX02PLUS_BTC_BOOTLOADER: SIGDATA_MAGIC_BITBOX02PLUS_BTCONLY,
         }.get(device_info["product_string"])
         self.version = parse_device_version(device_info["serial_number"])
         # Delete the prelease part, as it messes with the comparison (e.g. 3.0.0-pre < 3.0.0 is

py/bitbox02/bitbox02/communication/bitbox_api_protocol.py

@@ -31,7 +31,7 @@
 from .devices import parse_device_version, DeviceInfo
 
 from .communication import TransportLayer
-from .devices import BITBOX02MULTI, BITBOX02BTC
+from .devices import BITBOX02MULTI, BITBOX02BTC, BITBOX02PLUS_MULTI, BITBOX02PLUS_BTC
 
 try:
     from .generated import hww_pb2 as hww
@@ -182,6 +182,7 @@ class Platform(enum.Enum):
     """Available hardware platforms"""
 
     BITBOX02 = "bitbox02"
+    BITBOX02PLUS = "bitbox02-plus"
 
 
 class BitBox02Edition(enum.Enum):
@@ -541,9 +542,9 @@ def __init__(
 
         if device_info is not None:
             version = device_info["serial_number"]
-            if device_info["product_string"] == BITBOX02MULTI:
+            if device_info["product_string"] in (BITBOX02MULTI, BITBOX02PLUS_MULTI):
                 edition = BitBox02Edition.MULTI
-            elif device_info["product_string"] == BITBOX02BTC:
+            elif device_info["product_string"] in (BITBOX02BTC, BITBOX02PLUS_BTC):
                 edition = BitBox02Edition.BTCONLY
         else:
             version, _, edition, _, _ = self.get_info(transport)
@@ -696,11 +697,11 @@ def get_info(
         version_str = version.rstrip(b"\0").decode("ascii")
 
         platform_byte, response = response[0], response[1:]
-        platform = {0x00: Platform.BITBOX02}[platform_byte]
+        platform = {0x00: Platform.BITBOX02, 0x02: Platform.BITBOX02PLUS}[platform_byte]
 
         edition_byte, response = response[0], response[1:]
         edition: Union[BitBox02Edition]
-        if platform == Platform.BITBOX02:
+        if platform in (Platform.BITBOX02, Platform.BITBOX02PLUS):
             edition = {0x00: BitBox02Edition.MULTI, 0x01: BitBox02Edition.BTCONLY}[edition_byte]
         else:
             raise Exception("Unknown platform: {}".format(platform))

py/bitbox02/bitbox02/communication/devices.py

@@ -26,6 +26,11 @@
 BITBOX02MULTI = "BitBox02"
 BITBOX02BTC = "BitBox02BTC"
 
+BITBOX02PLUS_MULTI_BOOTLOADER = "bb02p-bl-multi"
+BITBOX02PLUS_BTC_BOOTLOADER = "bb02p-bl-btconly"
+BITBOX02PLUS_MULTI = "bb02p-multi"
+BITBOX02PLUS_BTC = "bb02p-btconly"
+
 
 class TooManyFoundException(Exception):
     def __init__(self, count: int) -> None:
@@ -111,6 +116,8 @@ def get_any_bitbox02s() -> List[DeviceInfo]:
     """
     devices = get_bitbox02multi_devices()
     devices.extend(get_bitbox02btc_devices())
+    devices.extend(get_devices(BITBOX02PLUS_MULTI))
+    devices.extend(get_devices(BITBOX02PLUS_BTC))
     return devices
 
 
@@ -138,6 +145,8 @@ def get_any_bitbox02_bootloaders() -> List[DeviceInfo]:
     """
     devices = get_bitbox02multi_bootloaders()
     devices.extend(get_bitbox02btc_bootloaders())
+    devices.extend(get_devices(BITBOX02PLUS_MULTI_BOOTLOADER))
+    devices.extend(get_devices(BITBOX02PLUS_BTC_BOOTLOADER))
     return devices
 
 

src/CMakeLists.txt

@@ -162,10 +162,10 @@ set(SECURECHIP-SOURCES
 )
 set(SECURECHIP-SOURCES ${SECURECHIP-SOURCES} PARENT_SCOPE)
 
-set(FIRMWARE-DRIVER-SOURCES
+set(FIRMWARE-U2F-DRIVER-SOURCES
   ${CMAKE_SOURCE_DIR}/src/usb/class/hid/u2f/hid_u2f.c
 )
-set(FIRMWARE-DRIVER-SOURCES ${FIRMWARE-DRIVER-SOURCES} PARENT_SCOPE)
+set(FIRMWARE-U2F-DRIVER-SOURCES ${FIRMWARE-U2F-DRIVER-SOURCES} PARENT_SCOPE)
 
 set(FIRMWARE-U2F-SOURCES
   ${CMAKE_SOURCE_DIR}/src/u2f.c
@@ -193,7 +193,6 @@ set(INCLUDES ${INCLUDES} PARENT_SCOPE)
 set(FIRMWARE-SOURCES
   ${DBB-FIRMWARE-SOURCES}
   ${DBB-FIRMWARE-UI-SOURCES}
-  ${FIRMWARE-DRIVER-SOURCES}
   ${DRIVER-SOURCES}
   ${QTOUCH-SOURCES}
   ${SECURECHIP-SOURCES}
@@ -515,7 +514,7 @@ if(CMAKE_CROSSCOMPILING)
 
   target_sources(firmware.elf PRIVATE firmware.c)
   target_compile_definitions(firmware.elf PRIVATE PRODUCT_BITBOX_MULTI "APP_BTC=1" "APP_LTC=1" "APP_ETH=1" "APP_U2F=1")
-  target_sources(firmware.elf PRIVATE ${FIRMWARE-U2F-SOURCES} ${PLATFORM-BITBOX02-SOURCES})
+  target_sources(firmware.elf PRIVATE ${FIRMWARE-U2F-SOURCES} ${FIRMWARE-U2F-DRIVER-SOURCES} ${PLATFORM-BITBOX02-SOURCES})
 
   target_sources(firmware-btc.elf PRIVATE firmware.c)
   target_compile_definitions(firmware-btc.elf PRIVATE PRODUCT_BITBOX_BTCONLY "APP_BTC=1" "APP_LTC=0" "APP_ETH=0" "APP_U2F=0")

src/hww.c

@@ -17,7 +17,9 @@
 #include <hardfault.h>
 #include <keystore.h>
 #include <memory/memory.h>
+#include <version.h>
 
+#include <memory/memory_shared.h>
 #include <platform_config.h>
 #include <rust/rust.h>
 #include <usb/usb_packet.h>
@@ -59,8 +61,9 @@ typedef struct {
  * 1 byte: platform code:
  * - 0x00 - BitBox02
  * - 0x01 - BitBoxBase (deprecated)
+ * - 0x02 - BitBox02Plus
  * 1 byte: edition code:
- * - For the BitBox02 edition:
+ * - For the BitBox02 and BitBox02Plus edition:
  * - - 0x00 - Multi
  * - - 0x01 - Bitcoin-only
  * - For the BitBoxBase platform (deprecated):
@@ -83,14 +86,21 @@ static size_t _api_info(uint8_t* buf)
     memcpy((char*)current, DIGITAL_BITBOX_VERSION_SHORT, version_string_len);
     current += version_string_len;
 
-    // 1 byte platform code and 1 byte edition code
-#if PRODUCT_BITBOX_MULTI == 1 || PRODUCT_BITBOX02_FACTORYSETUP == 1
-    *current = 0x00;
+    // 1 byte platform code
+    switch (memory_get_platform()) {
+    case MEMORY_PLATFORM_BITBOX02_PLUS:
+        *current = 0x02;
+        break;
+    default:
+        *current = 0x00;
+        break;
+    }
     current++;
+
+    // 1 byte edition code
+#if PRODUCT_BITBOX_MULTI == 1 || PRODUCT_BITBOX02_FACTORYSETUP == 1
     *current = 0x00;
 #elif PRODUCT_BITBOX_BTCONLY == 1
-    *current = 0x00;
-    current++;
     *current = 0x01;
 #endif
     current++;

src/memory/memory_shared.c

@@ -65,3 +65,17 @@ uint8_t memory_get_securechip_type(void)
         return MEMORY_SECURECHIP_TYPE_ATECC;
     }
 }
+
+uint8_t memory_get_platform(void)
+{
+    chunk_shared_t chunk = {0};
+    memory_read_shared_bootdata(&chunk);
+    uint8_t platform = chunk.fields.platform;
+    util_zero(&chunk, sizeof(chunk));
+    switch (platform) {
+    case MEMORY_PLATFORM_BITBOX02_PLUS:
+        return platform;
+    default:
+        return MEMORY_PLATFORM_BITBOX02;
+    }
+}

src/memory/memory_shared.h

@@ -80,6 +80,8 @@ typedef union {
         uint8_t io_protection_key_split[32];
         uint8_t authorization_key_split[32];
         uint8_t encryption_key_split[32];
+        uint8_t platform;
+        uint8_t reserved[3]; // align to 4 bytes
     } fields;
     uint8_t bytes[FLASH_SHARED_DATA_LEN];
 } chunk_shared_t;
@@ -106,4 +108,8 @@ USE_RESULT uint8_t memory_get_screen_type(void);
 #define MEMORY_SECURECHIP_TYPE_OPTIGA 0x01
 USE_RESULT uint8_t memory_get_securechip_type(void);
 
+#define MEMORY_PLATFORM_BITBOX02 0xFF
+#define MEMORY_PLATFORM_BITBOX02_PLUS 0x01
+USE_RESULT uint8_t memory_get_platform(void);
+
 #endif

src/u2f.c

@@ -32,6 +32,7 @@
 #include <usb/u2f/u2f_keys.h>
 #include <usb/usb_packet.h>
 #include <usb/usb_processing.h>
+#include <version.h>
 #include <wally_crypto.h>
 
 #ifndef TESTING

src/usb/class/hid/u2f/hid_u2f.c

@@ -14,7 +14,8 @@
 
 #include "hid_u2f.h"
 #include "usb/usb_processing.h"
-#include "usb_desc.h"
+#include "usb_size.h"
+#include "usb_u2f_desc.h"
 #include <queue.h>
 #include <string.h>
 #include <u2f/u2f_packet.h>