-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add final pepper derivation to the pepper service and add address to …
…the response (#13132) * add final pepper derivation to the pepper service * rename to PINKAS_SECRET_KEY_BASE_SEED * clean up * update dst * fix seed * add address to the response and tests to slip 10 * update example client * fmt * clippy * toml sort update * machete * remove encrypted pepper from v1 * fix machete * fix lint
- Loading branch information
1 parent
5433163
commit 5fac1ad
Showing
9 changed files
with
361 additions
and
49 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,3 +27,4 @@ pub trait VUF { | |
| /// | ||
| /// TODO: better name? | ||
| pub mod bls12381_g1_bls; | ||
| pub mod slip_10; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| // Copyright (c) Aptos Foundation | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| pub extern crate derivation_path; | ||
| pub extern crate ed25519_dalek; | ||
|
|
||
| use anyhow::{bail, Result}; | ||
| use aptos_types::keyless::Pepper; | ||
| use core::fmt; | ||
| pub use derivation_path::{ChildIndex, DerivationPath}; | ||
| pub use ed25519_dalek::{PublicKey, SecretKey}; | ||
| use hmac::{Hmac, Mac}; | ||
| use regex::Regex; | ||
| use sha2_0_10_6::Sha512; | ||
| use std::str::FromStr; | ||
|
|
||
| const PEPPER_SLIP_10_NAME: &str = "32 bytes"; | ||
|
|
||
| /// Errors thrown while deriving secret keys | ||
| #[derive(Debug)] | ||
| pub enum Error { | ||
| Ed25519, | ||
| ExpectedHardenedIndex(ChildIndex), | ||
| } | ||
|
|
||
| impl fmt::Display for Error { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| match self { | ||
| Self::Ed25519 => f.write_str("ed25519 error"), | ||
| Self::ExpectedHardenedIndex(index) => { | ||
| f.write_fmt(format_args!("expected hardened child index: {}", index)) | ||
| }, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[cfg(feature = "std")] | ||
| impl std::error::Error for Error {} | ||
|
|
||
| /// An expanded pepper with chain code and meta data | ||
| #[derive(Debug)] | ||
| pub struct ExtendedPepper { | ||
| /// How many derivations this key is from the root (0 for root) | ||
| pub depth: u8, | ||
| /// Child index of the key used to derive from parent (`Normal(0)` for root) | ||
| pub child_index: ChildIndex, | ||
| /// 32 byte extended Pepper. Not exposed as get_pepper() should be used to get the 31 byte version | ||
| pepper: [u8; 32], | ||
| /// Chain code | ||
| pub chain_code: [u8; 32], | ||
| } | ||
|
|
||
| type HmacSha512 = Hmac<Sha512>; | ||
|
|
||
| /// A convenience wrapper for a [`core::result::Result`] with an [`Error`] | ||
| // pub type Result<T, E = Error> = core::result::Result<T, E>; | ||
|
|
||
| pub fn get_aptos_derivation_path(s: &str) -> Result<DerivationPath> { | ||
| let re = Regex::new(r"^m\/44'\/637'\/[0-9]+'\/[0-9]+'\/[0-9]+'?$").unwrap(); | ||
| if re.is_match(s) { | ||
| println!("Valid path"); | ||
| } else { | ||
| bail!(format!("Invalid derivation path: {}", s)) | ||
| } | ||
| Ok(DerivationPath::from_str(s)?) | ||
| } | ||
|
|
||
| impl ExtendedPepper { | ||
| pub fn get_pepper(&self) -> Pepper { | ||
| let mut pepper = [0; 31]; | ||
| pepper.copy_from_slice(&self.pepper[..31]); | ||
| Pepper::new(pepper[0..31].try_into().unwrap()) | ||
| } | ||
|
|
||
| /// Create a new extended secret key from a seed | ||
| pub fn from_seed(seed: &[u8]) -> Result<Self> { | ||
| let mut mac = HmacSha512::new_from_slice(PEPPER_SLIP_10_NAME.as_ref()).unwrap(); | ||
| mac.update(seed); | ||
| let bytes = mac.finalize().into_bytes(); | ||
|
|
||
| let mut pepper = [0; 32]; | ||
| pepper.copy_from_slice(&bytes[..32]); | ||
| let mut chain_code = [0; 32]; | ||
| chain_code.copy_from_slice(&bytes[32..]); | ||
|
|
||
| Ok(Self { | ||
| depth: 0, | ||
| child_index: ChildIndex::Normal(0), | ||
| pepper, | ||
| chain_code, | ||
| }) | ||
| } | ||
|
|
||
| /// Derive an extended secret key fom the current using a derivation path | ||
| pub fn derive<P: AsRef<[ChildIndex]>>(&self, path: &P) -> Result<Self> { | ||
| let mut path = path.as_ref().iter(); | ||
| let mut next = match path.next() { | ||
| Some(index) => self.derive_child(*index)?, | ||
| None => self.clone(), | ||
| }; | ||
| for index in path { | ||
| next = next.derive_child(*index)?; | ||
| } | ||
| Ok(next) | ||
| } | ||
|
|
||
| /// Derive a child extended secret key with an index | ||
| pub fn derive_child(&self, index: ChildIndex) -> Result<Self> { | ||
| if index.is_normal() { | ||
| bail!(format!("expected hardened child index: {}", index)) | ||
| } | ||
|
|
||
| let mut mac = HmacSha512::new_from_slice(&self.chain_code).unwrap(); | ||
| mac.update(&[0u8]); | ||
| mac.update(self.pepper.as_ref()); | ||
| mac.update(index.to_bits().to_be_bytes().as_ref()); | ||
| let bytes = mac.finalize().into_bytes(); | ||
|
|
||
| let mut pepper = [0; 32]; | ||
| pepper.copy_from_slice(&bytes[..32]); | ||
| let mut chain_code = [0; 32]; | ||
| chain_code.copy_from_slice(&bytes[32..]); | ||
|
|
||
| Ok(Self { | ||
| depth: self.depth + 1, | ||
| child_index: index, | ||
| pepper, | ||
| chain_code, | ||
| }) | ||
| } | ||
|
|
||
| #[inline] | ||
| fn clone(&self) -> Self { | ||
| Self { | ||
| depth: self.depth, | ||
| child_index: self.child_index, | ||
| pepper: self.pepper, | ||
| chain_code: self.chain_code, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
|
|
||
| #[test] | ||
| fn test_pepper_derivation() { | ||
| let derive_path = "m/44'/637'/0'/0'/0'"; | ||
| let checked_derivation_path = get_aptos_derivation_path(derive_path).unwrap(); | ||
| let master_pepper = "9b543408c1a90aac54e5130e61c7fbc30994d86aea62782b477448e585d194"; | ||
| let derived_pepper = | ||
| ExtendedPepper::from_seed(hex::decode(master_pepper).unwrap().as_slice()) | ||
| .unwrap() | ||
| .derive(&checked_derivation_path) | ||
| .unwrap() | ||
| .get_pepper(); | ||
|
|
||
| let pepper_hex = "06f449a8c833c95ddcbfe345541ada065667c4e2e25030f88380bac26f30844f"; | ||
| let expected_pepper = | ||
| Pepper::new(hex::decode(pepper_hex).unwrap()[0..31].try_into().unwrap()); | ||
| println!("expected: {:?}", hex::encode(expected_pepper.to_bytes())); | ||
| println!("actual: {:?}", hex::encode(derived_pepper.to_bytes())); | ||
| assert_eq!(expected_pepper, derived_pepper); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_pepper_derivation_second_account() { | ||
| let derive_path = "m/44'/637'/1'/0'/0'"; | ||
| let checked_derivation_path = get_aptos_derivation_path(derive_path).unwrap(); | ||
| let master_pepper = "9b543408c1a90aac54e5130e61c7fbc30994d86aea62782b477448e585d194"; | ||
| let derived_pepper = | ||
| ExtendedPepper::from_seed(hex::decode(master_pepper).unwrap().as_slice()) | ||
| .unwrap() | ||
| .derive(&checked_derivation_path) | ||
| .unwrap() | ||
| .get_pepper(); | ||
|
|
||
| let pepper_hex = "81d5647372c2762fd50993f7556025211768e6ac72dbc7294ad462d447c161f2"; | ||
| let expected_pepper = | ||
| Pepper::new(hex::decode(pepper_hex).unwrap()[0..31].try_into().unwrap()); | ||
| println!("expected: {:?}", hex::encode(expected_pepper.to_bytes())); | ||
| println!("actual: {:?}", hex::encode(derived_pepper.to_bytes())); | ||
| assert_eq!(expected_pepper, derived_pepper); | ||
| } | ||
| } |
Oops, something went wrong.