process: whitelist reply message function calls
What changed, and why it matters
This commit adds a whitelist of approved functions that can be used when sending reply messages from the Jade hardware wallet to a connected computer or phone. Previously, any function could be passed in, which could allow a bug or malicious code path to craft unexpected replies. Now only a specific list of known-safe reply-building functions is accepted. The change is defensive hardening rather than a clear fix for an active attack.
Treat as a security-hardening patch. Review whether any legitimate reply callbacks were omitted from the whitelist, as omissions could cause assertion failures. Consider whether additional reply paths (e.g., `jade_process_reply_to_message_ex`) should receive similar callback validation. No immediate incident response is indicated by the diff alone.
Security signals we found
Function-pointer whitelist added to reply path
Multiple static reply helpers made global to enable whitelist comparison
Assertion tightened to validate callback before use
Defensive hardening of inter-process message serialization
Evidence from the diff
The patch introduces reply_fn_is_allowed() in main/process.c, which enumerates allowed cbor_encoder_fn_t callbacks and rejects any other function pointer passed to jade_process_reply_to_message_result_with_id(). It also changes many previously static reply helper functions in individual process files to void (non-static) so their symbols are visible and can be compared by function-pointer equality in the whitelist. The assertion in jade_process_reply_to_message_result_with_id() now includes reply_fn_is_allowed(cb). This is a narrowing of the reply API surface.
Changed components
main/process.clibjade/libjade.cmain/process/get_bip85_entropy.cmain/process/get_commitments.cmain/process/get_registered_descriptor.cmain/process/get_registered_descriptors.cmain/process/get_registered_multisig.cmain/process/get_registered_multisigs.cmain/process/get_shared_nonce.cmain/process/ota_util.cmain/process/sign_attestation.cmain/process/sign_bip85_digest.cmain/process/sign_identity.cInspect captured patch +53 / −15
### libjade/libjade.c
@@ -381,7 +381,7 @@ void libjade_set_log_level(int level)
#endif
}
-static void build_display_size_reply(const void* ctx, CborEncoder* container)
+void build_display_size_reply(const void* ctx, CborEncoder* container)
{
JADE_ASSERT(ctx && container);
CborEncoder map_encoder;
### main/process.c
@@ -111,6 +111,46 @@ static bool inbound_reader_is_allowed(const inbound_message_reader_fn_t reader)
return reader == process_cbor_msg || reader == handle_in_bin_data;
}
+// jade_process_reply_to_message_result_with_id whitelist
+void cbor_result_boolean_cb(const void* ctx, CborEncoder* container);
+void cbor_result_bytes_cb(const void* ctx, CborEncoder* container);
+void cbor_result_string_cb(const void* ctx, CborEncoder* container);
+void cbor_result_uint64_cb(const void* ctx, CborEncoder* container);
+void build_version_info_reply(const void* ctx, CborEncoder* container);
+void client_data_request_reply(const void* ctx, CborEncoder* container);
+void reply_bip85_data(const void* ctx, CborEncoder* container);
+void reply_commitments(const void* ctx, CborEncoder* container);
+void reply_nonce_and_pubkey(const void* ctx, CborEncoder* container);
+void reply_ok(const void* ctx, CborEncoder* container);
+void reply_registered_descriptor(const void* ctx, CborEncoder* container);
+void reply_registered_descriptors(const void* ctx, CborEncoder* container);
+void reply_registered_multisig(const void* ctx, CborEncoder* container);
+void reply_registered_multisigs(const void* ctx, CborEncoder* container);
+void reply_signature_and_pubkey(const void* ctx, CborEncoder* container);
+void reply_signatures(const void* ctx, CborEncoder* container);
+#if defined(CONFIG_IDF_TARGET_ESP32S3) || defined(CONFIG_LIBJADE)
+void reply_attestation(const void* ctx, CborEncoder* container);
+#endif
+#ifdef CONFIG_LIBJADE
+void build_display_size_reply(const void* ctx, CborEncoder* container);
+#endif
+
+static bool reply_fn_is_allowed(const cbor_encoder_fn_t fn)
+{
+ return fn == cbor_result_boolean_cb || fn == cbor_result_bytes_cb || fn == cbor_result_string_cb
+ || fn == cbor_result_uint64_cb || fn == build_version_info_reply || fn == client_data_request_reply
+ || fn == reply_bip85_data || fn == reply_commitments || fn == reply_nonce_and_pubkey || fn == reply_ok
+ || fn == reply_registered_descriptor || fn == reply_registered_descriptors || fn == reply_registered_multisig
+ || fn == reply_registered_multisigs || fn == reply_signature_and_pubkey || fn == reply_signatures
+#if defined(CONFIG_IDF_TARGET_ESP32S3) || defined(CONFIG_LIBJADE)
+ || fn == reply_attestation
+#endif
+#ifdef CONFIG_LIBJADE
+ || fn == build_display_size_reply
+#endif
+ ;
+}
+
// Deferred void(*)(void*) function
struct _jade_deferred_fn_t {
void_fn_t fn;
@@ -561,9 +601,7 @@ void jade_process_reply_to_message_ex(jade_msg_source_t source, const uint8_t* r
void jade_process_reply_to_message_result_with_id(const char* id, uint8_t* output, const size_t output_size,
const jade_msg_source_t source, const void* cbctx, cbor_encoder_fn_t cb)
{
- JADE_ASSERT(id);
- JADE_ASSERT(output);
- JADE_ASSERT(cb);
+ JADE_ASSERT(id && output && reply_fn_is_allowed(cb));
CborEncoder root_encoder;
cbor_encoder_init(&root_encoder, output, output_size, 0);
### main/process/get_bip85_entropy.c
@@ -45,7 +45,7 @@ static void populate_bip85_reply_data(CborEncoder* container, const bip85_data_t
JADE_ASSERT(cberr == CborNoError);
}
-static void reply_bip85_data(const void* ctx, CborEncoder* container)
+void reply_bip85_data(const void* ctx, CborEncoder* container)
{
const bip85_data_t* const bip85_data = (const bip85_data_t*)ctx;
populate_bip85_reply_data(container, bip85_data);
### main/process/get_commitments.c
@@ -11,7 +11,7 @@
#include "process_utils.h"
-static void reply_commitments(const void* ctx, CborEncoder* container)
+void reply_commitments(const void* ctx, CborEncoder* container)
{
JADE_ASSERT(ctx);
### main/process/get_registered_descriptor.c
@@ -14,7 +14,7 @@ typedef struct {
descriptor_data_t* descriptor_data;
} descriptor_details_t;
-static void reply_registered_descriptor(const void* ctx, CborEncoder* container)
+void reply_registered_descriptor(const void* ctx, CborEncoder* container)
{
JADE_ASSERT(ctx);
### main/process/get_registered_descriptors.c
@@ -20,7 +20,7 @@ typedef struct {
size_t num_descriptors;
} descriptor_descriptions_t;
-static void reply_registered_descriptors(const void* ctx, CborEncoder* container)
+void reply_registered_descriptors(const void* ctx, CborEncoder* container)
{
JADE_ASSERT(ctx);
### main/process/get_registered_multisig.c
@@ -16,7 +16,7 @@ typedef struct {
signer_t* signer_details;
} multisig_details_t;
-static void reply_registered_multisig(const void* ctx, CborEncoder* container)
+void reply_registered_multisig(const void* ctx, CborEncoder* container)
{
JADE_ASSERT(ctx);
### main/process/get_registered_multisigs.c
@@ -24,7 +24,7 @@ typedef struct {
size_t num_multisigs;
} multisig_descriptions_t;
-static void reply_registered_multisigs(const void* ctx, CborEncoder* container)
+void reply_registered_multisigs(const void* ctx, CborEncoder* container)
{
JADE_ASSERT(ctx);
### main/process/get_shared_nonce.c
@@ -17,7 +17,7 @@ typedef struct {
const size_t pubkey_len;
} nonce_pubkey_data_t;
-static void reply_nonce_and_pubkey(const void* ctx, CborEncoder* container)
+void reply_nonce_and_pubkey(const void* ctx, CborEncoder* container)
{
JADE_ASSERT(ctx);
### main/process/ota_util.c
@@ -65,7 +65,7 @@ static const char* ota_get_status_text(const ota_status_t status)
}
}
-static void reply_ok(const void* ctx, CborEncoder* container)
+void reply_ok(const void* ctx, CborEncoder* container)
{
JADE_ASSERT(ctx);
### main/process/sign_attestation.c
@@ -16,7 +16,7 @@ typedef struct {
size_t ext_signature_len;
} attestation_reply_t;
-static void reply_attestation(const void* ctx, CborEncoder* container)
+void reply_attestation(const void* ctx, CborEncoder* container)
{
JADE_ASSERT(ctx);
const attestation_reply_t* data = (const attestation_reply_t*)ctx;
### main/process/sign_bip85_digest.c
@@ -16,7 +16,7 @@ typedef struct {
size_t num_signatures;
} signatures_t;
-static void reply_signatures(const void* ctx, CborEncoder* container)
+void reply_signatures(const void* ctx, CborEncoder* container)
{
JADE_ASSERT(ctx);
### main/process/sign_identity.c
@@ -23,7 +23,7 @@ typedef struct {
uint8_t pubkey[EC_PUBLIC_KEY_UNCOMPRESSED_LEN];
} signature_and_pubkey_t;
-static void reply_signature_and_pubkey(const void* ctx, CborEncoder* container)
+void reply_signature_and_pubkey(const void* ctx, CborEncoder* container)
{
JADE_ASSERT(ctx);
const signature_and_pubkey_t* data = (const signature_and_pubkey_t*)ctx;Why this scored 57/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.