api: return securechip model in DeviceInfo

Author: benma

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## [Unreleased]
 - Attempt to fix flaky SD behavior
+- Add securechip_model to DeviceInfo: ATECCC608A or ATECC608B.
 
 ## 9.5.0 [released 2021-03-10]
 - RestoreFrommnemonic: ported to Rust. Will now return UserAbortError on user abort instead of GenericError.

CMakeLists.txt

@@ -89,9 +89,9 @@ 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.5.0")
-set(FIRMWARE_BTC_ONLY_VERSION "v9.5.0")
-set(FIRMWARE_BITBOXBASE_VERSION "v9.5.0")
+set(FIRMWARE_VERSION "v9.6.0")
+set(FIRMWARE_BTC_ONLY_VERSION "v9.6.0")
+set(FIRMWARE_BITBOXBASE_VERSION "v9.6.0")
 set(BOOTLOADER_VERSION "v1.0.3")
 
 find_package(PythonInterp 3.6 REQUIRED)

py/bitbox02/bitbox02/bitbox02/bitbox02.py

@@ -135,13 +135,17 @@ def device_info(self) -> Dict[str, Any]:
         device_info_request = bitbox02_system.DeviceInfoRequest()
         request.device_info.CopyFrom(device_info_request)
         response = self._msg_query(request, expected_response="device_info")
-        return {
+        result = {
             "name": response.device_info.name,
             "version": response.device_info.version,
             "initialized": response.device_info.initialized,
             "mnemonic_passphrase_enabled": response.device_info.mnemonic_passphrase_enabled,
             "monotonic_increments_remaining": response.device_info.monotonic_increments_remaining,
         }
+        if self.version >= semver.VersionInfo(9, 6, 0):
+            result["securechip_model"] = response.device_info.securechip_model
+
+        return result
 
     def set_device_name(self, device_name: str) -> None:
         # pylint: disable=no-member

src/CMakeLists.txt

@@ -344,6 +344,8 @@ add_custom_target(rust-bindgen
     --whitelist-function securechip_attestation_sign
     --whitelist-function securechip_monotonic_increments_remaining
     --whitelist-function securechip_u2f_counter_set
+    --whitelist-function securechip_model
+    --rustified-enum securechip_model_t
     --whitelist-function keystore_is_locked
     --whitelist-function keystore_unlock
     --whitelist-function keystore_unlock_bip39

src/rust/bitbox02-rust/src/hww/api/device_info.rs

@@ -26,5 +26,9 @@ pub fn process() -> Result<Response, Error> {
         version: bitbox02::version_short().into(),
         mnemonic_passphrase_enabled: memory::is_mnemonic_passphrase_enabled(),
         monotonic_increments_remaining: securechip::monotonic_increments_remaining()?,
+        securechip_model: match securechip::model()? {
+            securechip::Model::SECURECHIP_ATECC608A => "ATECC608A".into(),
+            securechip::Model::SECURECHIP_ATECC608B => "ATECC608B".into(),
+        },
     }))
 }

src/rust/bitbox02/src/securechip.rs

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+pub use bitbox02_sys::securechip_model_t as Model;
+
 pub fn attestation_sign(challenge: &[u8; 32], signature: &mut [u8; 64]) -> Result<(), ()> {
     match unsafe {
         bitbox02_sys::securechip_attestation_sign(challenge.as_ptr(), signature.as_mut_ptr())
@@ -49,3 +51,11 @@ pub fn u2f_counter_set(counter: u32) -> Result<(), ()> {
 pub fn u2f_counter_set(_counter: u32) -> Result<(), ()> {
     unimplemented!();
 }
+
+pub fn model() -> Result<Model, ()> {
+    let mut ver = core::mem::MaybeUninit::uninit();
+    match unsafe { bitbox02_sys::securechip_model(ver.as_mut_ptr()) } {
+        true => Ok(unsafe { ver.assume_init() }),
+        false => Err(()),
+    }
+}

src/securechip/securechip.c

@@ -764,3 +764,13 @@ bool securechip_u2f_counter_inc(uint32_t* counter)
     return _write_data_slot_block(&data.bytes[0], SECURECHIP_SLOT_DATA0, 0);
 }
 #endif
+
+bool securechip_model(securechip_model_t* model_out)
+{
+    uint8_t revision[4] = {0};
+    if (atcab_info(revision) != ATCA_SUCCESS) {
+        return false;
+    }
+    *model_out = revision[3] >= 0x03 ? SECURECHIP_ATECC608B : SECURECHIP_ATECC608A;
+    return true;
+}

src/securechip/securechip.h

@@ -159,4 +159,16 @@ USE_RESULT bool securechip_u2f_counter_set(uint32_t counter);
 USE_RESULT bool securechip_u2f_counter_inc(uint32_t* counter);
 #endif
 
+typedef enum {
+    SECURECHIP_ATECC608A,
+    SECURECHIP_ATECC608B,
+} securechip_model_t;
+
+/**
+ * Output the securechip model.
+ * @param[out] model_out securechip model
+ * @return True if success
+ */
+USE_RESULT bool securechip_model(securechip_model_t* model_out);
+
 #endif

test/unit-test/framework/mock_securechip.c

@@ -70,3 +70,8 @@ bool securechip_monotonic_increments_remaining(uint32_t* remaining_out)
 {
     return false;
 }
+
+bool securechip_model(securechip_model_t* model_out)
+{
+    return false;
+}