Merge commit 'refs/pull/1229/head' of https://github.com/BitBoxSwiss/bitbox02-firmware

Author: benma

CHANGELOG.md

@@ -15,6 +15,7 @@ customers cannot upgrade their bootloader, its changes are recorded separately.
 - Bitcoin: allow spendung UTXOs at very high BIP-44 address indices
 - Ethereum: allow signing EIP-712 messages containing multi-line strings
 - Allow exiting the screen asking to insert the microSD card
+- HWW: add initialized status byte to _api_info response
 
 ### 9.18.0
 - Add support for deriving BIP-39 mnemonics according to BIP-85

CMakeLists.txt

@@ -96,8 +96,8 @@ endif()
 #
 # Versions MUST contain three parts and start with lowercase 'v'.
 # Example 'v1.0.0'. They MUST not contain a pre-release label such as '-beta'.
-set(FIRMWARE_VERSION "v9.19.0")
-set(FIRMWARE_BTC_ONLY_VERSION "v9.19.0")
+set(FIRMWARE_VERSION "v9.20.0")
+set(FIRMWARE_BTC_ONLY_VERSION "v9.20.0")
 set(BOOTLOADER_VERSION "v1.0.6")
 
 find_package(PythonInterp 3.6 REQUIRED)

py/bitbox02/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## [Unreleased]
 
+# 7.0.0
+- get_info: add optional device initialized boolean to returned tuple
+
 # 6.3.0
 - Allow infering product and version via API call instead of via USB descriptor
 - Accept EIP1559 transactions in `eth_sign()` - requires BitBox02 firmware v9.16.0

py/bitbox02/bitbox02/bitbox02/__init__.py

@@ -16,7 +16,7 @@
 from __future__ import print_function
 import sys
 
-__version__ = "6.3.0"
+__version__ = "7.0.0"
 
 if sys.version_info.major != 3 or sys.version_info.minor < 6:
     print(

py/bitbox02/bitbox02/communication/bitbox_api_protocol.py

@@ -546,7 +546,7 @@ def __init__(
             elif device_info["product_string"] == BITBOX02BTC:
                 edition = BitBox02Edition.BTCONLY
         else:
-            version, _, edition, _ = self.get_info(transport)
+            version, _, edition, _, _ = self.get_info(transport)
 
         self.edition = edition
         try:
@@ -680,11 +680,14 @@ def reboot(
         return True
 
     @staticmethod
-    def get_info(transport: TransportLayer) -> Tuple[str, Platform, Union[BitBox02Edition], bool]:
+    def get_info(
+        transport: TransportLayer,
+    ) -> Tuple[str, Platform, Union[BitBox02Edition], bool, Optional[bool]]:
         """
-        Returns (version, platform, edition, unlocked).
-        This is useful to get the version of the firmware when a usb descriptor is not available
-        (via BitBoxBridge, etc.).
+        Returns (version, platform, edition, unlocked, initialized).
+        This is useful to get the version of the firmware or the device unlocked/initialized status
+        when a usb descriptor is not available (via BitBoxBridge, etc.). The initialized status is
+        supported from firmware v9.20.0 (it is None if not supported).
         This call does not use a versioned BitBoxProtocol for communication, as the version is not
         available (this call is used to get the version), so it must work for all firmware versions.
         """
@@ -704,9 +707,14 @@ def get_info(transport: TransportLayer) -> Tuple[str, Platform, Union[BitBox02Ed
         else:
             raise Exception("Unknown platform: {}".format(platform))
 
-        unlocked_byte = response[0]
+        unlocked_byte, response = response[0], response[1:]
         unlocked = {0x00: False, 0x01: True}[unlocked_byte]
-        return (version_str, platform, edition, unlocked)
+
+        initialized = None
+        if parse_device_version(version_str) >= semver.VersionInfo(9, 20, 0):
+            initialized_byte = response[0]
+            initialized = {0x00: False, 0x01: True}[initialized_byte]
+        return (version_str, platform, edition, unlocked, initialized)
 
     def check_min_version(self) -> None:
         """

src/hww.c

@@ -16,6 +16,7 @@
 
 #include <hardfault.h>
 #include <keystore.h>
+#include <memory/memory.h>
 
 #include <platform_config.h>
 #include <rust/rust.h>
@@ -65,6 +66,7 @@ typedef struct {
  * - For the BitBoxBase platform (deprecated):
  " - 0x00 - Standard
  * 1 byte: 0x00 if the device is locked, 0x01 if the device is unlocked.
+ * 1 byte: 0x00 if the device is uninitialized, 0x01 if the device is initialized.
  * @param[out] buf serialize info to this buffer.
  * @return number of bytes written
  */
@@ -97,6 +99,10 @@ static size_t _api_info(uint8_t* buf)
     *current = keystore_is_locked() ? 0x00 : 0x01;
     current++;
 
+    // 1 byte initialized status
+    *current = memory_is_initialized() ? 0x01 : 0x00;
+    current++;
+
     return current - buf;
 }