trezor-firmware/core/src/apps/cardano/seed.py

from typing import TYPE_CHECKING

from storage import cache, device
from trezor import wire
from trezor.crypto import bip32, cardano
from trezor.enums import CardanoDerivationType

from apps.common import mnemonic
from apps.common.seed import derive_and_store_roots, get_seed

from .helpers import paths

if TYPE_CHECKING:
    from typing import Callable, Awaitable, TypeVar, Union

    from apps.common.paths import Bip32Path
    from apps.common.keychain import MsgOut, Handler

    from trezor.messages import (
        CardanoGetAddress,
        CardanoGetPublicKey,
        CardanoGetNativeScriptHash,
        CardanoSignTxInit,
    )

    CardanoMessages = Union[
        CardanoGetAddress,
        CardanoGetPublicKey,
        CardanoGetNativeScriptHash,
        CardanoSignTxInit,
    ]
    MsgIn = TypeVar("MsgIn", bound=CardanoMessages)

    HandlerWithKeychain = Callable[[wire.Context, MsgIn, "Keychain"], Awaitable[MsgOut]]


class Keychain:
    """
    Cardano keychain hard-coded to 44 (Byron), 1852 (Shelley), 1854 (multi-sig) and 1855 (token minting)
    seed namespaces.
    """

    def __init__(self, root: bip32.HDNode) -> None:
        self.byron_root = self._derive_path(root, paths.BYRON_ROOT)
        self.shelley_root = self._derive_path(root, paths.SHELLEY_ROOT)
        self.multisig_root = self._derive_path(root, paths.MULTISIG_ROOT)
        self.minting_root = self._derive_path(root, paths.MINTING_ROOT)
        root.__del__()

    @staticmethod
    def _derive_path(root: bip32.HDNode, path: Bip32Path) -> bip32.HDNode:
        """Clone and derive path from the root."""
        node = root.clone()
        node.derive_path(path)
        return node

    def verify_path(self, path: Bip32Path) -> None:
        if not self.is_in_keychain(path):
            raise wire.DataError("Forbidden key path")

    def _get_path_root(self, path: Bip32Path) -> bip32.HDNode:
        if is_byron_path(path):
            return self.byron_root
        elif is_shelley_path(path):
            return self.shelley_root
        elif is_multisig_path(path):
            return self.multisig_root
        elif is_minting_path(path):
            return self.minting_root
        else:
            raise wire.DataError("Forbidden key path")

    def is_in_keychain(self, path: Bip32Path) -> bool:
        return (
            is_byron_path(path)
            or is_shelley_path(path)
            or is_multisig_path(path)
            or is_minting_path(path)
        )

    def derive(self, node_path: Bip32Path) -> bip32.HDNode:
        self.verify_path(node_path)
        path_root = self._get_path_root(node_path)

        # this is true now, so for simplicity we don't branch on path type
        assert (
            len(paths.BYRON_ROOT) == len(paths.SHELLEY_ROOT)
            and len(paths.MULTISIG_ROOT) == len(paths.SHELLEY_ROOT)
            and len(paths.MINTING_ROOT) == len(paths.SHELLEY_ROOT)
        )
        suffix = node_path[len(paths.SHELLEY_ROOT) :]

        # derive child node from the root
        return self._derive_path(path_root, suffix)

    # XXX the root node remains in session cache so we should not delete it
    # def __del__(self) -> None:
    #     self.root.__del__()


def is_byron_path(path: Bip32Path) -> bool:
    return path[: len(paths.BYRON_ROOT)] == paths.BYRON_ROOT


def is_shelley_path(path: Bip32Path) -> bool:
    return path[: len(paths.SHELLEY_ROOT)] == paths.SHELLEY_ROOT


def is_multisig_path(path: Bip32Path) -> bool:
    return path[: len(paths.MULTISIG_ROOT)] == paths.MULTISIG_ROOT


def is_minting_path(path: Bip32Path) -> bool:
    return path[: len(paths.MINTING_ROOT)] == paths.MINTING_ROOT


def derive_and_store_secrets(passphrase: str) -> None:
    assert device.is_initialized()
    assert cache.get(cache.APP_COMMON_DERIVE_CARDANO)

    if not mnemonic.is_bip39():
        # nothing to do for SLIP-39, where we can derive the root from the main seed
        return

    icarus_secret = mnemonic.derive_cardano_icarus(passphrase, trezor_derivation=False)

    words = mnemonic.get_secret()
    assert words is not None, "Mnemonic is not set"
    # count ASCII spaces, add 1 to get number of words
    words_count = sum(c == 0x20 for c in words) + 1

    if words_count == 24:
        icarus_trezor_secret = mnemonic.derive_cardano_icarus(
            passphrase, trezor_derivation=True
        )
    else:
        icarus_trezor_secret = icarus_secret

    cache.set(cache.APP_CARDANO_ICARUS_SECRET, icarus_secret)
    cache.set(cache.APP_CARDANO_ICARUS_TREZOR_SECRET, icarus_trezor_secret)


async def _get_secret(ctx: wire.Context, cache_entry: int) -> bytes:
    secret = cache.get(cache_entry)
    if secret is None:
        await derive_and_store_roots(ctx)
        secret = cache.get(cache_entry)
        assert secret is not None
    return secret


async def _get_keychain_bip39(
    ctx: wire.Context, derivation_type: CardanoDerivationType
) -> Keychain:
    if not device.is_initialized():
        raise wire.NotInitialized("Device is not initialized")

    if derivation_type == CardanoDerivationType.LEDGER:
        seed = await get_seed(ctx)
        return Keychain(cardano.from_seed_ledger(seed))

    if not cache.get(cache.APP_COMMON_DERIVE_CARDANO):
        raise wire.ProcessError("Cardano derivation is not enabled for this session")

    if derivation_type == CardanoDerivationType.ICARUS:
        cache_entry = cache.APP_CARDANO_ICARUS_SECRET
    else:
        cache_entry = cache.APP_CARDANO_ICARUS_TREZOR_SECRET

    secret = await _get_secret(ctx, cache_entry)
    root = cardano.from_secret(secret)
    return Keychain(root)


async def get_keychain(
    ctx: wire.Context, derivation_type: CardanoDerivationType
) -> Keychain:
    if mnemonic.is_bip39():
        return await _get_keychain_bip39(ctx, derivation_type)
    else:
        # derive the root node via SLIP-0023 https://github.com/satoshilabs/slips/blob/master/slip-0022.md
        seed = await get_seed(ctx)
        return Keychain(cardano.from_seed_slip23(seed))


def with_keychain(func: HandlerWithKeychain[MsgIn, MsgOut]) -> Handler[MsgIn, MsgOut]:
    async def wrapper(ctx: wire.Context, msg: MsgIn) -> MsgOut:
        keychain = await get_keychain(ctx, msg.derivation_type)
        return await func(ctx, msg, keychain)

    return wrapper