feat(core): add Zcash Rust primitives

core/.changelog.d/2510.added

@@ -0,0 +1 @@
+Add Zcash Rust primitives

core/SConscript.firmware

@@ -12,6 +12,7 @@ FEATURE_FLAGS = {
     "RDI": True,
     "SECP256K1_ZKP": True,  # required for trezor.crypto.curve.bip340 (BIP340/Taproot)
     "SYSTEM_VIEW": False,
+    "ZCASH_SHIELDED": False,
 }
 
 CCFLAGS_MOD = ''
@@ -202,6 +203,10 @@ if UI2:
     SOURCE_MOD += [
         'embed/extmod/rustmods/modtrezorui2.c',
     ]
+if FEATURE_FLAGS["ZCASH_SHIELDED"]:
+    SOURCE_MOD += [
+        'embed/extmod/rustmods/modtrezorzcashprimitives.c'
+    ]
 
 # modutime
 SOURCE_MOD += [
@@ -678,7 +683,7 @@ if FROZEN:
         SOURCE_PY.extend(Glob(SOURCE_PY_DIR + 'apps/bitcoin/sign_tx/zcash_v4.py'))
         SOURCE_PY.extend(Glob(SOURCE_PY_DIR + 'trezor/enums/Zcash*.py'))
 
-    source_mpy = env.FrozenModule(source=SOURCE_PY, source_dir=SOURCE_PY_DIR, bitcoin_only=BITCOIN_ONLY)
+    source_mpy = env.FrozenModule(source=SOURCE_PY, source_dir=SOURCE_PY_DIR, bitcoin_only=BITCOIN_ONLY, zcash_shielded=FEATURE_FLAGS['ZCASH_SHIELDED'])
 
     source_mpyc = env.FrozenCFile(
         target='frozen_mpy.c', source=source_mpy, qstr_header=qstr_preprocessed)
@@ -720,6 +725,8 @@ def cargo_build():
         features.append('ui')
         if PYOPT == '0':
             features.append('ui_debug')
+    if FEATURE_FLAGS["ZCASH_SHIELDED"]:
+        features.append("zcash_shielded")
 
     cargo_opts = [
         f'--target={RUST_TARGET}',

core/SConscript.unix

@@ -10,6 +10,7 @@ UI2 = ARGUMENTS.get('UI2', '0') == '1' or TREZOR_MODEL in ('1', 'R')
 
 FEATURE_FLAGS = {
     "SECP256K1_ZKP": True,  # required for trezor.crypto.curve.bip340 (BIP340/Taproot)
+    "ZCASH_SHIELDED": EVERYTHING,
 }
 
 CCFLAGS_MOD = ''
@@ -202,6 +203,10 @@ if UI2:
     SOURCE_MOD += [
         'embed/extmod/rustmods/modtrezorui2.c',
     ]
+if FEATURE_FLAGS["ZCASH_SHIELDED"]:
+    SOURCE_MOD += [
+        'embed/extmod/rustmods/modtrezorzcashprimitives.c'
+    ]
 
 # modutime
 SOURCE_MOD += [
@@ -634,7 +639,7 @@ if FROZEN:
         SOURCE_PY.extend(Glob(SOURCE_PY_DIR + 'apps/bitcoin/sign_tx/zcash_v4.py'))
         SOURCE_PY.extend(Glob(SOURCE_PY_DIR + 'trezor/enums/Zcash*.py'))
 
-    source_mpy = env.FrozenModule(source=SOURCE_PY, source_dir=SOURCE_PY_DIR, bitcoin_only=BITCOIN_ONLY)
+    source_mpy = env.FrozenModule(source=SOURCE_PY, source_dir=SOURCE_PY_DIR, bitcoin_only=BITCOIN_ONLY, zcash_shielded=FEATURE_FLAGS['ZCASH_SHIELDED'])
 
     source_mpyc = env.FrozenCFile(
         target='frozen_mpy.c', source=source_mpy, qstr_header=qstr_preprocessed)
@@ -674,6 +679,8 @@ def cargo_build():
         features.append('ui')
         if PYOPT == '0':
             features.append('debug')
+    if FEATURE_FLAGS["ZCASH_SHIELDED"]:
+        features.append('zcash_shielded')
 
     return f'cd embed/rust; cargo build --profile {RUST_PROFILE} --target-dir=../../build/unix/rust --no-default-features --features "{" ".join(features)}"'
 

core/embed/extmod/modtrezorutils/modtrezorutils.c

@@ -243,6 +243,7 @@ STATIC mp_obj_str_t mod_trezorutils_revision_obj = {
 /// MODEL: str
 /// EMULATOR: bool
 /// BITCOIN_ONLY: bool
+/// ZCASH_SHIELDED: bool
 
 STATIC const mp_rom_map_elem_t mp_module_trezorutils_globals_table[] = {
     {MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_trezorutils)},
@@ -283,6 +284,11 @@ STATIC const mp_rom_map_elem_t mp_module_trezorutils_globals_table[] = {
 #else
     {MP_ROM_QSTR(MP_QSTR_BITCOIN_ONLY), mp_const_false},
 #endif
+#ifdef ZCASH_SHIELDED
+    {MP_ROM_QSTR(MP_QSTR_ZCASH_SHIELDED), mp_const_true},
+#elif TREZOR_EMULATOR
+    {MP_ROM_QSTR(MP_QSTR_ZCASH_SHIELDED), mp_const_false},
+#endif
 };
 
 STATIC MP_DEFINE_CONST_DICT(mp_module_trezorutils_globals,

core/embed/extmod/rustmods/modtrezorzcashprimitives.c

@@ -0,0 +1,32 @@
+/*
+ * This file is part of the Trezor project, https://trezor.io/
+ *
+ * Copyright (c) SatoshiLabs
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "py/runtime.h"
+
+#include "librust.h"
+
+#if MICROPY_PY_TREZORPALLAS
+MP_REGISTER_MODULE(MP_QSTR_trezorpallas, mp_module_trezorpallas,
+                   MICROPY_PY_TREZORPALLAS);
+#endif  // MICROPY_PY_TREZORPALLAS
+
+#if MICROPY_PY_TREZORPOSEIDON
+MP_REGISTER_MODULE(MP_QSTR_trezorposeidon, mp_module_trezorposeidon,
+                   MICROPY_PY_TREZORPOSEIDON);
+#endif  // MICROPY_PY_TREZORPOSEIDON

core/embed/firmware/mpconfigport.h

@@ -160,6 +160,8 @@
 #define MICROPY_PY_TREZORUTILS      (1)
 #define MICROPY_PY_TREZORPROTO      (1)
 #define MICROPY_PY_TREZORUI2        (1)
+#define MICROPY_PY_TREZORPALLAS     (1)
+#define MICROPY_PY_TREZORPOSEIDON   (1)
 
 #ifdef SYSTEM_VIEW
 #define MP_PLAT_PRINT_STRN(str, len) segger_print(str, len)

core/embed/rust/Cargo.toml

@@ -8,6 +8,9 @@ build = "build.rs"
 [features]
 default = ["model_tt"]
 bitcoin_only = []
+zcash_shielded = [
+    "micropython", "pasta_curves", "blake2b_simd",
+]
 model_tt = ["touch"]
 model_t1 = ["buttons"]
 model_tr = ["buttons"]
@@ -19,7 +22,7 @@ buttons = []
 touch = []
 clippy = []
 debug = ["ui_debug"]
-test = ["cc", "glob", "micropython", "protobuf", "ui", "ui_debug"]
+test = ["cc", "glob", "micropython", "protobuf", "ui", "ui_debug", "zcash_shielded"]
 
 [lib]
 crate-type = ["staticlib"]
@@ -53,6 +56,16 @@ default_features = false
 version = "0.2.4"
 default_features = false
 
+[dependencies.blake2b_simd]
+optional = true
+version = "1"
+default_features = false
+
+[dependencies.pasta_curves]
+optional = true
+version = "0.4.0"
+default-features = false
+
 # Build dependencies
 
 [build-dependencies.bindgen]
@@ -69,3 +82,10 @@ version = "1.0.69"
 [build-dependencies.glob]
 optional = true
 version = "0.3.0"
+
+[patch.crates-io.blake2b_simd]
+path = "./blake2b_hal"
+
+[patch.crates-io.pasta_curves]
+git = "https://github.com/jarys/pasta_curves"
+rev = "a4f755013aad344982383c9f5af362697d928325"

core/embed/rust/blake2b_hal/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "blake2b_simd"
+version = "1.0.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+cty = "0.2.2"

core/embed/rust/blake2b_hal/src/ffi.rs

@@ -0,0 +1,43 @@
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct __blake2b_state {
+    pub h: [u64; 8usize],
+    pub t: [u64; 2usize],
+    pub f: [u64; 2usize],
+    pub buf: [u8; 128usize],
+    pub buflen: usize,
+    pub outlen: usize,
+    pub last_node: u8,
+}
+#[allow(non_camel_case_types)]
+pub type blake2b_state = __blake2b_state;
+extern "C" {
+    pub fn blake2b_Init(S: *mut blake2b_state, outlen: usize) -> cty::c_int;
+}
+extern "C" {
+    pub fn blake2b_InitKey(
+        S: *mut blake2b_state,
+        outlen: usize,
+        key: *const cty::c_void,
+        keylen: usize,
+    ) -> cty::c_int;
+}
+extern "C" {
+    pub fn blake2b_InitPersonal(
+        S: *mut blake2b_state,
+        outlen: usize,
+        personal: *const cty::c_void,
+        personal_len: usize,
+    ) -> cty::c_int;
+}
+extern "C" {
+    pub fn blake2b_Update(
+        S: *mut blake2b_state,
+        pin: *const cty::c_void,
+        inlen: usize,
+    ) -> cty::c_int;
+}
+extern "C" {
+    pub fn blake2b_Final(S: *mut blake2b_state, out: *mut cty::c_void, outlen: usize)
+        -> cty::c_int;
+}