refactor(core): Clean up Optiga error handling.

[no changelog]
trezor · Jul 1, 2024 · fc09379 · fc09379
1 parent 99c3d35
commit fc09379
Show file tree

Hide file tree

Showing 6 changed files with 304 additions and 241 deletions.
diff --git a/core/embed/extmod/modtrezorcrypto/modtrezorcrypto-optiga.h b/core/embed/extmod/modtrezorcrypto/modtrezorcrypto-optiga.h
@@ -90,11 +90,12 @@ STATIC mp_obj_t mod_trezorcrypto_optiga_sign(mp_obj_t key_index,
   vstr_t sig = {0};
   vstr_init_len(&sig, MAX_DER_SIGNATURE_SIZE);
   size_t sig_size = 0;
-  int ret = optiga_sign(idx, (const uint8_t *)dig.buf, dig.len,
-                        ((uint8_t *)sig.buf), sig.alloc, &sig_size);
-  if (ret != 0) {
+  optiga_sign_result ret =
+      optiga_sign(idx, (const uint8_t *)dig.buf, dig.len, ((uint8_t *)sig.buf),
+                  sig.alloc, &sig_size);
+  if (ret != OPTIGA_SIGN_SUCCESS) {
     vstr_clear(&sig);
-    if (ret == OPTIGA_ERR_ACCESS_COND_NOT_SAT) {
+    if (ret == OPTIGA_SIGN_INACCESSIBLE) {
       mp_raise_msg(&mp_type_SigningInaccessible, "Signing inaccessible.");
     } else {
       mp_raise_msg(&mp_type_OptigaError, "Signing failed.");

diff --git a/core/embed/trezorhal/optiga.h b/core/embed/trezorhal/optiga.h
@@ -28,16 +28,20 @@
 
 #define OPTIGA_DEVICE_CERT_INDEX 1
 #define OPTIGA_DEVICE_ECC_KEY_INDEX 0
-#define OPTIGA_COMMAND_ERROR_OFFSET 0x100
 
-// Error code 0x07: Access conditions not satisfied
-#define OPTIGA_ERR_ACCESS_COND_NOT_SAT (OPTIGA_COMMAND_ERROR_OFFSET + 0x07)
+typedef enum _optiga_pin_result {
+  OPTIGA_PIN_SUCCESS = 0,       // The operation completed successfully.
+  OPTIGA_PIN_INVALID,           // The PIN is invalid.
+  OPTIGA_PIN_COUNTER_EXCEEDED,  // The PIN try counter limit was exceeded.
+  OPTIGA_PIN_ERROR,             // Optiga processing or communication error.
+} optiga_pin_result;
 
-// Error code 0x0E: Counter threshold limit exceeded
-#define OPTIGA_ERR_COUNTER_EXCEEDED (OPTIGA_COMMAND_ERROR_OFFSET + 0x0E)
-
-// Error code 0x2F: Authorization failure
-#define OPTIGA_ERR_AUTH_FAIL (OPTIGA_COMMAND_ERROR_OFFSET + 0x2F)
+typedef enum _optiga_sign_result {
+  OPTIGA_SIGN_SUCCESS = 0,   // The operation completed successfully.
+  OPTIGA_SIGN_INACCESSIBLE,  // The signing key is inaccessible.
+  OPTIGA_SIGN_ERROR,         // Invalid parameters or Optiga processing or
+                             // communication error.
+} optiga_sign_result;
 
 // Size of secrets used in PIN processing, e.g. salted PIN, master secret etc.
 #define OPTIGA_PIN_SECRET_SIZE 32
@@ -50,9 +54,9 @@
 
 typedef secbool (*OPTIGA_UI_PROGRESS)(uint32_t elapsed_ms);
 
-int __wur optiga_sign(uint8_t index, const uint8_t *digest, size_t digest_size,
-                      uint8_t *signature, size_t max_sig_size,
-                      size_t *sig_size);
+optiga_sign_result __wur optiga_sign(uint8_t index, const uint8_t *digest,
+                                     size_t digest_size, uint8_t *signature,
+                                     size_t max_sig_size, size_t *sig_size);
 
 bool __wur optiga_cert_size(uint8_t index, size_t *cert_size);
 
@@ -63,15 +67,17 @@ bool __wur optiga_read_sec(uint8_t *sec);
 
 bool __wur optiga_random_buffer(uint8_t *dest, size_t size);
 
-int __wur optiga_pin_set(OPTIGA_UI_PROGRESS ui_progress,
-                         uint8_t stretched_pin[OPTIGA_PIN_SECRET_SIZE]);
+bool __wur optiga_pin_set(OPTIGA_UI_PROGRESS ui_progress,
+                          uint8_t stretched_pin[OPTIGA_PIN_SECRET_SIZE]);
 
-int __wur optiga_pin_verify(OPTIGA_UI_PROGRESS ui_progress,
-                            uint8_t stretched_pin[OPTIGA_PIN_SECRET_SIZE]);
+optiga_pin_result __wur
+optiga_pin_verify(OPTIGA_UI_PROGRESS ui_progress,
+                  uint8_t stretched_pin[OPTIGA_PIN_SECRET_SIZE]);
 
-int __wur optiga_pin_verify_v4(OPTIGA_UI_PROGRESS ui_progress,
-                               const uint8_t pin_secret[OPTIGA_PIN_SECRET_SIZE],
-                               uint8_t out_secret[OPTIGA_PIN_SECRET_SIZE]);
+optiga_pin_result __wur
+optiga_pin_verify_v4(OPTIGA_UI_PROGRESS ui_progress,
+                     const uint8_t pin_secret[OPTIGA_PIN_SECRET_SIZE],
+                     uint8_t out_secret[OPTIGA_PIN_SECRET_SIZE]);
 
 int __wur optiga_pin_get_fails_v4(uint32_t *ctr);