|
| 1 | +//! BIP-39 mnemonic and BIP-32 derivation primitives. |
| 2 | +//! |
| 3 | +//! Thin C-ABI wrappers over the `key-wallet` crate — the surface that |
| 4 | +//! `key-wallet-ffi` used to provide before it was dropped from this repo. |
| 5 | +
|
| 6 | +use crate::error::*; |
| 7 | +use crate::{check_ptr, unwrap_result_or_return}; |
| 8 | +use dash_network::ffi::FFINetwork; |
| 9 | +use key_wallet::mnemonic::{Language, Mnemonic}; |
| 10 | +use std::ffi::CStr; |
| 11 | +use std::os::raw::c_char; |
| 12 | + |
| 13 | +/// BIP-39 wordlist language. Mirrors `key_wallet::mnemonic::Language`. |
| 14 | +#[repr(C)] |
| 15 | +#[derive(Debug, Clone, Copy)] |
| 16 | +pub enum FFILanguage { |
| 17 | + English = 0, |
| 18 | + ChineseSimplified = 1, |
| 19 | + ChineseTraditional = 2, |
| 20 | + Czech = 3, |
| 21 | + French = 4, |
| 22 | + Italian = 5, |
| 23 | + Japanese = 6, |
| 24 | + Korean = 7, |
| 25 | + Portuguese = 8, |
| 26 | + Spanish = 9, |
| 27 | +} |
| 28 | + |
| 29 | +impl From<FFILanguage> for Language { |
| 30 | + fn from(language: FFILanguage) -> Self { |
| 31 | + match language { |
| 32 | + FFILanguage::English => Language::English, |
| 33 | + FFILanguage::ChineseSimplified => Language::ChineseSimplified, |
| 34 | + FFILanguage::ChineseTraditional => Language::ChineseTraditional, |
| 35 | + FFILanguage::Czech => Language::Czech, |
| 36 | + FFILanguage::French => Language::French, |
| 37 | + FFILanguage::Italian => Language::Italian, |
| 38 | + FFILanguage::Japanese => Language::Japanese, |
| 39 | + FFILanguage::Korean => Language::Korean, |
| 40 | + FFILanguage::Portuguese => Language::Portuguese, |
| 41 | + FFILanguage::Spanish => Language::Spanish, |
| 42 | + } |
| 43 | + } |
| 44 | +} |
| 45 | + |
| 46 | +/// Generate a fresh BIP-39 mnemonic of `word_count` words (12, 15, 18, |
| 47 | +/// 21, or 24) in `language`. Writes a heap C string into `out_mnemonic` |
| 48 | +/// (caller frees via `platform_wallet_string_free`). |
| 49 | +/// |
| 50 | +/// # Safety |
| 51 | +/// `out_mnemonic` must be a valid writable `*mut c_char` location. |
| 52 | +#[no_mangle] |
| 53 | +pub unsafe extern "C" fn platform_wallet_generate_mnemonic( |
| 54 | + word_count: u32, |
| 55 | + language: FFILanguage, |
| 56 | + out_mnemonic: *mut *mut c_char, |
| 57 | +) -> PlatformWalletFFIResult { |
| 58 | + check_ptr!(out_mnemonic); |
| 59 | + let phrase = unwrap_result_or_return!(Mnemonic::generate(word_count as usize, language.into())); |
| 60 | + let c_str = unwrap_result_or_return!(std::ffi::CString::new(phrase.to_string())); |
| 61 | + *out_mnemonic = c_str.into_raw(); |
| 62 | + PlatformWalletFFIResult::ok() |
| 63 | +} |
| 64 | + |
| 65 | +/// Convert a BIP-39 mnemonic to its 64-byte seed. Returns 0 on success |
| 66 | +/// (seed written to `seed_out`, length to `seed_len`), -1 on failure. |
| 67 | +/// |
| 68 | +/// # Safety |
| 69 | +/// - `mnemonic` must be a valid NUL-terminated C string. |
| 70 | +/// - `passphrase` may be null or a NUL-terminated C string. |
| 71 | +/// - `seed_out` must point at >= 64 writable bytes; `seed_len` at a writable `usize`. |
| 72 | +#[no_mangle] |
| 73 | +pub unsafe extern "C" fn platform_wallet_mnemonic_to_seed( |
| 74 | + mnemonic: *const c_char, |
| 75 | + passphrase: *const c_char, |
| 76 | + seed_out: *mut u8, |
| 77 | + seed_len: *mut usize, |
| 78 | +) -> i32 { |
| 79 | + if mnemonic.is_null() || seed_out.is_null() || seed_len.is_null() { |
| 80 | + return -1; |
| 81 | + } |
| 82 | + let Ok(mnemonic_str) = CStr::from_ptr(mnemonic).to_str() else { |
| 83 | + return -1; |
| 84 | + }; |
| 85 | + let passphrase_str = if passphrase.is_null() { |
| 86 | + "" |
| 87 | + } else { |
| 88 | + let Ok(s) = CStr::from_ptr(passphrase).to_str() else { |
| 89 | + return -1; |
| 90 | + }; |
| 91 | + s |
| 92 | + }; |
| 93 | + let Ok(parsed) = Mnemonic::from_phrase(mnemonic_str, Language::English) else { |
| 94 | + return -1; |
| 95 | + }; |
| 96 | + let seed = parsed.to_seed(passphrase_str); |
| 97 | + let seed_bytes: &[u8] = seed.as_ref(); |
| 98 | + if seed_bytes.len() > 64 { |
| 99 | + return -1; |
| 100 | + } |
| 101 | + *seed_len = seed_bytes.len(); |
| 102 | + std::ptr::copy_nonoverlapping(seed_bytes.as_ptr(), seed_out, seed_bytes.len()); |
| 103 | + 0 |
| 104 | +} |
| 105 | + |
| 106 | +/// Build the DIP-9 identity-authentication path |
| 107 | +/// `m/9'/<coin>'/5'/0'/identity_index'/key_index'`. Writes a heap C |
| 108 | +/// string into `out_path` (caller frees via `platform_wallet_string_free`). |
| 109 | +/// Returns 0 on success, -1 on failure. |
| 110 | +/// |
| 111 | +/// # Safety |
| 112 | +/// `out_path` must be a valid writable `*mut c_char` location. |
| 113 | +#[no_mangle] |
| 114 | +pub unsafe extern "C" fn platform_wallet_derive_identity_authentication_path( |
| 115 | + network: FFINetwork, |
| 116 | + identity_index: u32, |
| 117 | + key_index: u32, |
| 118 | + out_path: *mut *mut c_char, |
| 119 | +) -> i32 { |
| 120 | + if out_path.is_null() { |
| 121 | + return -1; |
| 122 | + } |
| 123 | + use key_wallet::bip32::{DerivationPath, KeyDerivationType}; |
| 124 | + let net: key_wallet::Network = network.into(); |
| 125 | + let derivation = DerivationPath::identity_authentication_path( |
| 126 | + net, |
| 127 | + KeyDerivationType::ECDSA, |
| 128 | + identity_index, |
| 129 | + key_index, |
| 130 | + ); |
| 131 | + let path_str = format!("{}", derivation); |
| 132 | + let Ok(c_str) = std::ffi::CString::new(path_str) else { |
| 133 | + return -1; |
| 134 | + }; |
| 135 | + *out_path = c_str.into_raw(); |
| 136 | + 0 |
| 137 | +} |
0 commit comments