SFT-974: unwrapped miniscript parsing recursion, added default policy
What changed, and why it matters
This firmware update changes how the Passport hardware wallet handles complex Bitcoin wallet policies. The main visible change is replacing a recursive parser walk with an iterative one, which prevents the device from crashing due to excessive recursion on deeply nested policies. It also adds automatic default names for imported policies and tweaks the import flow so users without external signers skip an unnecessary step. There is no direct evidence in the commit that this fixes an exploitable security vulnerability; it appears to be a robustness and usability improvement.
Treat as a routine robustness/usability patch. Review whether removing the explicit `validate()` call changes any security invariants, and verify that `compile_miniscript()` covers all previously validated constraints. No urgent security response is indicated by the diff alone.
Security signals we found
Recursion in miniscript parsing replaced with explicit stack to avoid RecursionError on deeply nested templates
Policy validation path changed: explicit `validate()` call removed, safety now enforced via `compile_miniscript()` during registration
Default empty policy name now auto-populated from descriptor checksum to avoid unnamed policies
Policy ID calculation switched to incremental SHA-256; no semantic change observed
UI import flow adjusted to skip signer naming when no external signers are present
Evidence from the diff
The commit modifies miniscript parsing, wallet policy identity calculation, policy transport decoding, and the wallet import UI flow. The _walk generator in miniscript.py is rewritten iteratively to avoid Python recursion limits on deep miniscript trees. wallet_policy.py removes a separate validate() call and relies on compile_miniscript() for policy safety checks, adds a shared format_policy_descriptor() helper, and switches calculate_id() to use an incremental SHA-256 digest. policy_transport.py now derives a default policy name from the descriptor checksum when none is supplied. wallet_policy_flow.py skips the external-key naming step when no external keys exist. Tests are added for long templates, unnamed imports, and UI flow behavior.
Changed components
ports/stm32/boards/Passport/modules/miniscript.pyports/stm32/boards/Passport/modules/wallet_policy.pyports/stm32/boards/Passport/modules/policy_transport.pyports/stm32/boards/Passport/modules/flows/wallet_policy_flow.pyInspect captured patch +160 / −21
### ports/stm32/boards/Passport/modules/flows/wallet_policy_flow.py
@@ -68,7 +68,7 @@ async def choose_name(self):
self.goto(self.show_error)
return
self.key_name_position = 0
- self.goto(self.choose_key_name)
+ self.goto(self.choose_key_name if self.external_key_indexes else self.show_overview)
async def choose_key_name(self):
import microns
### ports/stm32/boards/Passport/modules/miniscript.py
@@ -504,11 +504,14 @@ def analyze(node, context='wsh'):
def _walk(node):
- yield node
- for arg in node.args:
- if isinstance(arg, Node):
- for child in _walk(arg):
- yield child
+ pending = [node]
+ while pending:
+ node = pending.pop()
+ yield node
+ for index in range(len(node.args) - 1, -1, -1):
+ child = node.args[index]
+ if isinstance(child, Node):
+ pending.append(child)
def iter_policy_keys(node):
### ports/stm32/boards/Passport/modules/policy_transport.py
@@ -17,7 +17,7 @@
from policy_errors import PolicyMismatchError, PolicyParseError, PolicyResourceError
from wallet_policy import (KeyInfo, MiniscriptPolicy,
- descriptor_to_policy_template)
+ descriptor_to_policy_template, format_policy_descriptor)
TRANSPORT_FORMAT = 'passport-wallet-policy'
@@ -92,7 +92,7 @@ def _transport_text(data, invalid_utf8_message):
def decode_policy_transport(data, chain, master_xfp, derive_node,
- default_name='Wallet Policy'):
+ default_name=''):
data = _transport_text(data, 'Wallet policy file is not UTF-8 text')
if not isinstance(data, str):
raise PolicyParseError('Wallet policy transport must be text')
@@ -134,6 +134,9 @@ def decode_policy_transport(data, chain, master_xfp, derive_node,
if network != getattr(chain, 'ctype', None):
raise PolicyMismatchError(_network_mismatch_message(network))
owned = discover_owned_key(keys, chain, master_xfp, derive_node)
+ if not name:
+ from descriptor import descriptor_checksum
+ name = descriptor_checksum(format_policy_descriptor(template, keys)).upper()
policy = MiniscriptPolicy(name, network, template, keys, owned)
gc.collect()
policy.validate_extended_keys(chain)
### ports/stm32/boards/Passport/modules/tests/host/test_wallet_policy.py
@@ -6,6 +6,7 @@
import builtins
import os
import sys
+import struct
import types
import pytest
@@ -190,6 +191,7 @@ def test_full_descriptor_converter_rejects_non_bip388_derivation(descriptor):
def test_policy_id_is_stable_across_rename_but_contents_are_validated():
policy = make_policy()
+ assert policy.policy_id == '938faed5cd17836ad2a5642d2227e304bc93aa2fb98f16f5e5c3932c49995323'
renamed = policy.rename('Inheritance')
assert renamed.policy_id == policy.policy_id
record = policy.serialize()
@@ -199,6 +201,22 @@ def test_policy_id_is_stable_across_rename_but_contents_are_validated():
MiniscriptPolicy.deserialize(record)
+def test_policy_identity_preserves_compact_size_for_long_templates():
+ template = 'wsh(' + 'and_v(v:older(16),' * 14 + 'pk(@0/**)' + ')' * 14 + ')'
+ assert 253 <= len(template) <= 512
+ policy = MiniscriptPolicy('Long template', 'BTC', template, (KEY_INFO,), (0,))
+ payload = (b'Passport Wallet Policy\x00\x01\x03BTC' +
+ b'\xfd' + struct.pack('<H', len(template)) + template.encode('ascii') +
+ b'\x01' + bytes([len(KEY_INFO)]) + KEY_INFO.encode('ascii'))
+ assert policy.policy_id == hashlib.sha256(payload).hexdigest()
+
+
+def test_registration_rejects_unsigned_policy():
+ with pytest.raises(PolicyTypeError, match='require a signature'):
+ MiniscriptPolicy('Unsigned', 'BTC', 'wsh(or_i(pk(@0/**),older(10)))',
+ (KEY_INFO,), (0,))
+
+
def test_local_key_names_are_migration_safe_and_do_not_change_policy_identity():
policy = make_policy()
legacy_record = policy.serialize()
@@ -252,6 +270,7 @@ def deserialize_node(xpub, address_format):
policy = decode_policy_transport(
descriptor, chain, my_xfp, lambda path: OwnedNode(owned_xpub),
default_name='Liana Multisig')
+ assert policy.name == 'Liana Multisig'
review_pages = policy.format_review_pages()
assert review_pages
assert any('Passport' in page for page in review_pages)
@@ -422,9 +441,30 @@ def test_policy_transport_round_trip_rediscovers_owned_key():
int.from_bytes(bytes.fromhex('6738736c'), 'little'),
lambda path: OwnedNode(XPUB))
assert decoded.policy_id == policy.policy_id
+ assert decoded.name == policy.name
assert decoded.owned_key_indexes == (0,)
+@pytest.mark.parametrize('transport', ('descriptor', 'missing-name', 'empty-name'))
+def test_unnamed_policy_import_uses_descriptor_checksum(transport):
+ policy = make_policy()
+ if transport == 'descriptor':
+ data = policy.full_descriptor()
+ else:
+ envelope = json.loads(encode_policy_transport(policy))
+ if transport == 'missing-name':
+ del envelope['name']
+ else:
+ envelope['name'] = ''
+ data = json.dumps(envelope)
+ decoded = decode_policy_transport(
+ data, DerivationChain(),
+ int.from_bytes(bytes.fromhex('6738736c'), 'little'),
+ lambda path: OwnedNode(XPUB))
+ assert decoded.name == decoded.descriptor_check() == policy.descriptor_check()
+ assert decoded.policy_id == policy.policy_id
+
+
def test_policy_transport_accepts_ur_bytearray():
policy = make_policy()
encoded = bytearray(encode_policy_transport(policy), 'utf-8')
### ports/stm32/boards/Passport/modules/tests/host/test_wallet_policy_flows.py
@@ -239,3 +239,87 @@ async def show(self):
asyncio.run(flow_method('wallet_policy_flow.py', 'VerifyWalletPolicyAddressFlow', 'verify')(flow))
assert results == [result]
assert calls == ['verify' if exists else 'missing']
+
+
+@pytest.mark.parametrize('key_count', [1, 2])
+def test_policy_import_starts_with_wallet_name_prompt(monkeypatch, key_count):
+ class Flow:
+ def __init__(self, initial_state, name):
+ self.state = initial_state
+
+ monkeypatch.setitem(sys.modules, 'flows', SimpleNamespace(Flow=Flow, SaveToMicroSDFlow=object))
+ module = load_module(MODULES / 'flows' / 'wallet_policy_flow.py')
+ policy = SimpleNamespace(keys=[None] * key_count, key_names=[''] * key_count,
+ owned_key_indexes=(0,))
+ flow = module.ImportWalletPolicyFlow(policy)
+ assert flow.state.__name__ == 'choose_name'
+
+
+def test_policy_import_can_go_back_from_review_without_external_signers(monkeypatch):
+ class Series:
+ def __init__(self, *args):
+ pass
+
+ async def run(self):
+ return False
+
+ monkeypatch.setitem(sys.modules, 'flows', SimpleNamespace(SeriesOfPagesFlow=Series))
+ monkeypatch.setitem(sys.modules, 'pages', SimpleNamespace(LongTextPage=object))
+ results = []
+ flow = SimpleNamespace(policy=SimpleNamespace(format_review_pages=lambda: ['Review']),
+ external_key_indexes=(), back=lambda: results.append('back'))
+ asyncio.run(flow_method('wallet_policy_flow.py', 'ImportWalletPolicyFlow', 'show_overview')(flow))
+ assert results == ['back']
+
+
+def test_policy_import_can_go_back_from_first_signer_name(monkeypatch):
+ class TextInputPage:
+ def __init__(self, **kwargs):
+ pass
+
+ async def show(self):
+ return None
+
+ monkeypatch.setitem(sys.modules, 'microns', SimpleNamespace(Back=None, Checkmark=None))
+ monkeypatch.setitem(sys.modules, 'pages', SimpleNamespace(ErrorPage=object, TextInputPage=TextInputPage))
+ monkeypatch.setitem(sys.modules, 'policy_display', SimpleNamespace(
+ format_fingerprint=lambda value: value, suggested_key_name=lambda policy, index: 'Signer'))
+ results = []
+ flow = SimpleNamespace(policy=SimpleNamespace(keys=[SimpleNamespace(fingerprint='12345678')]),
+ external_key_indexes=(0,), key_names=[''], key_name_position=0,
+ back=lambda: results.append('back'))
+ asyncio.run(flow_method('wallet_policy_flow.py', 'ImportWalletPolicyFlow', 'choose_key_name')(flow))
+ assert results == ['back']
+
+
+@pytest.mark.parametrize('name,response', [
+ ('HQ3FM2R2', 'HQ3FM2R2'),
+ ('Supplied name', 'Supplied name'),
+ ('HQ3FM2R2', 'My wallet'),
+ ('HQ3FM2R2', None),
+])
+@pytest.mark.parametrize('external_keys', [(), (1,)])
+def test_policy_name_prompt_preserves_prefill_editing_and_cancel(monkeypatch, name, response, external_keys):
+ class TextInputPage:
+ def __init__(self, **kwargs):
+ assert kwargs['initial_text'] == name
+
+ async def show(self):
+ return response
+
+ monkeypatch.setitem(sys.modules, 'microns', SimpleNamespace(Cancel=None, Checkmark=None))
+ monkeypatch.setitem(sys.modules, 'pages', SimpleNamespace(TextInputPage=TextInputPage))
+ policy = MiniscriptPolicy(name, 'BTC', 'wsh(pk(@0/**))', (KEY_INFO,), (0,))
+ states = []
+ results = []
+ flow = SimpleNamespace(policy=policy, external_key_indexes=external_keys,
+ choose_key_name='signers', show_overview='overview',
+ goto=states.append, set_result=results.append)
+ asyncio.run(flow_method('wallet_policy_flow.py', 'ImportWalletPolicyFlow', 'choose_name')(flow))
+ if response is None:
+ assert results == [False]
+ assert states == []
+ else:
+ assert flow.policy.name == response
+ assert flow.policy.policy_id == policy.policy_id
+ assert states == ['signers' if external_keys else 'overview']
### ports/stm32/boards/Passport/modules/wallet_policy.py
@@ -15,7 +15,7 @@
from descriptor import split_checksum
from miniscript import (MAX_KEYS, MAX_TEMPLATE_LENGTH, Parser,
- compile_miniscript, iter_policy_keys, validate)
+ compile_miniscript, iter_policy_keys)
from policy_errors import (PolicyMismatchError, PolicyParseError,
PolicyResourceError, UnsupportedPolicyError, WalletPolicyError)
@@ -251,6 +251,14 @@ def descriptor_to_policy_template(descriptor, require_checksum=True):
return template, tuple(key_values)
+def format_policy_descriptor(template, keys):
+ """Expand a policy template into a full descriptor without its checksum."""
+ # Replace higher indexes first so @1 cannot match the start of @10.
+ for index in range(len(keys) - 1, -1, -1):
+ template = template.replace('@{}'.format(index), keys[index].canonical())
+ return template
+
+
class DerivedPolicyOutput:
__slots__ = ('policy_id', 'branch', 'index', 'witness_script',
'redeem_script', 'script_pubkey', 'address')
@@ -293,7 +301,6 @@ def __init__(self, name, network, template, keys, owned_key_indexes,
if template.startswith('wsh(') and template.endswith(')'):
context = 'wsh'
miniscript = Parser(template[4:-1]).parse()
- validate(miniscript, context)
# Script size and opcode costs do not depend on derived key bytes.
# Reject unsafe policies before registration, not just at derivation.
compile_miniscript(miniscript, lambda *_: b'\x02' + bytes(32), 0, 0,
@@ -425,13 +432,19 @@ def deserialize(cls, record):
return policy
def calculate_id(self):
- payload = b'Passport Wallet Policy\x00' + bytes([POLICY_FORMAT_VERSION])
- payload += _encode_field(self.network)
- payload += _encode_field(self.template)
- payload += _compact_size(len(self.keys))
+ try:
+ from trezorcrypto import sha256
+ except ImportError: # pragma: no cover - CPython host tests
+ from hashlib import sha256
+
+ digest = sha256(b'Passport Wallet Policy\x00')
+ digest.update(bytes([POLICY_FORMAT_VERSION]))
+ digest.update(_encode_field(self.network))
+ digest.update(_encode_field(self.template))
+ digest.update(_compact_size(len(self.keys)))
for key in self.keys:
- payload += _encode_field(key.canonical())
- return hexlify(_sha256(payload)).decode('ascii')
+ digest.update(_encode_field(key.canonical()))
+ return hexlify(digest.digest()).decode('ascii')
def serialize(self):
record = {
@@ -482,11 +495,7 @@ def format_details(self):
return '\n\n'.join(lines)
def full_descriptor(self, with_checksum=True):
- descriptor = self.template
- # Replace higher indexes first so @1 cannot match the start of @10.
- for index in range(len(self.keys) - 1, -1, -1):
- descriptor = descriptor.replace('@{}'.format(index),
- self.keys[index].canonical())
+ descriptor = format_policy_descriptor(self.template, self.keys)
if with_checksum:
from descriptor import append_checksum
return append_checksum(descriptor)Why this scored 32/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.