Struct SecretUri

pub struct SecretUri {
    pub phrase: SecretBox<str>,
    pub password: Option<SecretBox<str>>,
    pub junctions: Vec<DeriveJunction>,
}

A secret uri (SURI) that can be used to generate a key pair.

The SURI can be parsed from a string. The string takes this form:

phrase/path0/path1///password
111111 22222 22222   33333333

Where:

• 1 denotes a phrase or hex string. If this is not provided, the DEV_PHRASE is used instead.
• 2’s denote optional “derivation junctions” which are used to derive keys. Each of these is separated by “/”. A derivation junction beginning with “/” (ie “//” in the original string) is a “hard” path.
• 3 denotes an optional password which is used in conjunction with the phrase provided in 1 to generate an initial key. If hex is provided for 1, it’s ignored.

Notes:

• If 1 is a 0x prefixed 64-digit hex string, then we’ll interpret it as hex, and treat the hex bytes as a seed/MiniSecretKey directly, ignoring any password.
• Else if the phrase part is a valid BIP-39 phrase, we’ll use the phrase (and password, if provided) to generate a seed/MiniSecretKey.
• Uris like “//Alice” correspond to keys derived from a DEV_PHRASE, since no phrase part is given.

There is no correspondence mapping between SURI strings and the keys they represent. Two different non-identical strings can actually lead to the same secret being derived. Notably, integer junction indices may be legally prefixed with arbitrary number of zeros. Similarly an empty password (ending the SURI with ///) is perfectly valid and will generally be equivalent to no password at all.

Examples

Parse DEV_PHRASE secret URI with junction:

let suri = SecretUri::from_str("//Alice").expect("Parse SURI");

assert_eq!(vec![DeriveJunction::from("Alice").harden()], suri.junctions);
assert_eq!(DEV_PHRASE, suri.phrase.expose_secret());
assert!(suri.password.is_none());

Parse DEV_PHRASE secret URI with junction and password:

let suri = SecretUri::from_str("//Alice///SECRET_PASSWORD").expect("Parse SURI");

assert_eq!(vec![DeriveJunction::from("Alice").harden()], suri.junctions);
assert_eq!(DEV_PHRASE, suri.phrase.expose_secret());
assert_eq!("SECRET_PASSWORD", suri.password.unwrap().expose_secret());

Parse DEV_PHRASE secret URI with hex phrase and junction:

let suri = SecretUri::from_str("0xe5be9a5092b81bca64be81d212e7f2f9eba183bb7a90954f7b76361f6edb5c0a//Alice").expect("Parse SURI");

assert_eq!(vec![DeriveJunction::from("Alice").harden()], suri.junctions);
assert_eq!("0xe5be9a5092b81bca64be81d212e7f2f9eba183bb7a90954f7b76361f6edb5c0a", suri.phrase.expose_secret());
assert!(suri.password.is_none());

Fields

phrase: SecretBox<str>

The phrase to derive the private key.

This can either be a 64-bit hex string or a BIP-39 key phrase.

password: Option<SecretBox<str>>

Optional password as given as part of the uri.

junctions: Vec<DeriveJunction>

The junctions as part of the uri.

Trait Implementations

impl FromStr for SecretUri

type Err = SecretUriError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SecretUri, <SecretUri as FromStr>::Err>

Parses a string s to return a value of this type.

impl SecretUriExt for SecretUri

fn from_str(value: &str) -> Result<SecretUri, String>