[−][src]Trait substrate_primitives::crypto::Pair

pub trait Pair: Sized {
    type Public;
    type Seed;
    type Signature;
    type DeriveError;
    fn generate() -> Self;

    fn generate_with_phrase(password: Option<&str>) -> (Self, String);

    fn from_phrase(
        phrase: &str, 
        password: Option<&str>
    ) -> Result<Self, SecretStringError>;

    fn derive<Iter: Iterator<Item = DeriveJunction>>(
        &self, 
        path: Iter
    ) -> Result<Self, Self::DeriveError>;

    fn from_seed(seed: Self::Seed) -> Self;

    fn from_seed_slice(seed: &[u8]) -> Result<Self, SecretStringError>;

    fn from_standard_components<I: Iterator<Item = DeriveJunction>>(
        phrase: &str, 
        password: Option<&str>, 
        path: I
    ) -> Result<Self, SecretStringError>;

    fn sign(&self, message: &[u8]) -> Self::Signature;

    fn verify<P: AsRef<Self::Public>, M: AsRef<[u8]>>(
        sig: &Self::Signature, 
        message: M, 
        pubkey: P
    ) -> bool;

    fn verify_weak<P: AsRef<[u8]>, M: AsRef<[u8]>>(
        sig: &[u8], 
        message: M, 
        pubkey: P
    ) -> bool;

    fn public(&self) -> Self::Public;

    fn from_string(
        s: &str, 
        password_override: Option<&str>
    ) -> Result<Self, SecretStringError> { ... }
}

Trait suitable for typical cryptographic PKI key pair type.

For now it just specifies how to create a key from a phrase and derivation path.

Associated Types

type Public

TThe type which is used to encode a public key.

type Seed

The type used to (minimally) encode the data required to securely create a new key pair.

type Signature

The type used to represent a signature. Can be created from a key pair and a message and verified with the message and a public key.

type DeriveError

Error returned from the derive function.

Loading content...

Required methods

fn generate() -> Self

Generate new secure (random) key pair.

This is only for ephemeral keys really, since you won't have access to the secret key for storage. If you want a persistent key pair, use generate_with_phrase instead.

fn generate_with_phrase(password: Option<&str>) -> (Self, String)

Generate new secure (random) key pair and provide the recovery phrase.

You can recover the same key later with from_phrase.

This is generally slower than generate(), so prefer that unless you need to persist the key from the current session.

fn from_phrase(
    phrase: &str,
    password: Option<&str>
) -> Result<Self, SecretStringError>

Returns the KeyPair from the English BIP39 seed phrase, or None if it's invalid.

fn derive<Iter: Iterator<Item = DeriveJunction>>(
    &self,
    path: Iter
) -> Result<Self, Self::DeriveError>

Derive a child key from a series of given junctions.

fn from_seed(seed: Self::Seed) -> Self

Generate new key pair from the provided seed.

@WARNING: THIS WILL ONLY BE SECURE IF THE seed IS SECURE. If it can be guessed by an attacker then they can also derive your key.

fn from_seed_slice(seed: &[u8]) -> Result<Self, SecretStringError>

Make a new key pair from secret seed material. The slice must be the correct size or it will return None.

@WARNING: THIS WILL ONLY BE SECURE IF THE seed IS SECURE. If it can be guessed by an attacker then they can also derive your key.

fn from_standard_components<I: Iterator<Item = DeriveJunction>>(
    phrase: &str,
    password: Option<&str>,
    path: I
) -> Result<Self, SecretStringError>

Construct a key from a phrase, password and path.

fn sign(&self, message: &[u8]) -> Self::Signature

Sign a message.

fn verify<P: AsRef<Self::Public>, M: AsRef<[u8]>>(
    sig: &Self::Signature,
    message: M,
    pubkey: P
) -> bool

Verify a signature on a message. Returns true if the signature is good.

fn verify_weak<P: AsRef<[u8]>, M: AsRef<[u8]>>(
    sig: &[u8],
    message: M,
    pubkey: P
) -> bool

Verify a signature on a message. Returns true if the signature is good.

fn public(&self) -> Self::Public

Get the public key.

Loading content...

Provided methods

fn from_string(
    s: &str,
    password_override: Option<&str>
) -> Result<Self, SecretStringError>

Interprets the string s in order to generate a key Pair.

This takes a helper function to do the key generation from a phrase, password and junction iterator.

  • If s is a possibly 0x prefixed 64-digit hex string, then it will be interpreted directly as a MiniSecretKey (aka "seed" in subkey).
  • If s is a valid BIP-39 key phrase of 12, 15, 18, 21 or 24 words, then the key will be derived from it. In this case:
    • the phrase may be followed by one or more items delimited by / characters.
    • the path may be followed by ///, in which case everything after the /// is treated as a password.
  • If s begins with a / character it is prefixed with the Substrate public DEV_PHRASE and interpreted as above.

In this case they are interpreted as HDKD junctions; purely numeric items are interpreted as integers, non-numeric items as strings. Junctions prefixed with / are interpreted as soft junctions, and with // as hard junctions.

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.

None is returned if no matches are found.

Loading content...

Implementors

impl Pair for substrate_primitives::ed25519::Pair[src]

type Public = Public

type Seed = [u8; 32]

type Signature = Signature

type DeriveError = DeriveError

fn generate() -> Pair[src]

Generate new secure (random) key pair.

This is only for ephemeral keys really, since you won't have access to the secret key for storage. If you want a persistent key pair, use generate_with_phrase instead.

fn generate_with_phrase(password: Option<&str>) -> (Pair, String)[src]

Generate new secure (random) key pair and provide the recovery phrase.

You can recover the same key later with from_phrase.

fn from_phrase(
    phrase: &str,
    password: Option<&str>
) -> Result<Pair, SecretStringError>[src]

Generate key pair from given recovery phrase and password.

fn from_seed(seed: [u8; 32]) -> Pair[src]

Make a new key pair from secret seed material.

You should never need to use this; generate(), generate_with_phrasee

fn from_seed_slice(seed_slice: &[u8]) -> Result<Pair, SecretStringError>[src]

Make a new key pair from secret seed material. The slice must be 32 bytes long or it will return None.

You should never need to use this; generate(), generate_with_phrase

fn derive<Iter: Iterator<Item = DeriveJunction>>(
    &self,
    path: Iter
) -> Result<Pair, DeriveError>[src]

Derive a child key from a series of given junctions.

fn from_standard_components<I: Iterator<Item = DeriveJunction>>(
    phrase: &str,
    password: Option<&str>,
    path: I
) -> Result<Pair, SecretStringError>[src]

Generate a key from the phrase, password and derivation path.

fn public(&self) -> Public[src]

Get the public key.

fn sign(&self, message: &[u8]) -> Signature[src]

Sign a message.

fn verify<P: AsRef<Self::Public>, M: AsRef<[u8]>>(
    sig: &Self::Signature,
    message: M,
    pubkey: P
) -> bool[src]

Verify a signature on a message. Returns true if the signature is good.

fn verify_weak<P: AsRef<[u8]>, M: AsRef<[u8]>>(
    sig: &[u8],
    message: M,
    pubkey: P
) -> bool[src]

Verify a signature on a message. Returns true if the signature is good.

This doesn't use the type system to ensure that sig and pubkey are the correct size. Use it only if you're coming from byte buffers and need the speed.

impl Pair for substrate_primitives::sr25519::Pair[src]

type Public = Public

type Seed = [u8; 32]

type Signature = Signature

type DeriveError = Infallible

fn generate() -> Pair[src]

Generate new secure (random) key pair.

fn from_seed(seed: [u8; 32]) -> Pair[src]

Make a new key pair from raw secret seed material.

This is generated using schnorrkel's Mini-Secret-Keys.

A MiniSecretKey is literally what Ed25519 calls a SecretKey, which is just 32 random bytes.

fn public(&self) -> Public[src]

Get the public key.

fn from_seed_slice(seed: &[u8]) -> Result<Pair, SecretStringError>[src]

Make a new key pair from secret seed material. The slice must be 32 bytes long or it will return None.

You should never need to use this; generate(), generate_with_phrase(), from_phrase()

fn from_standard_components<I: Iterator<Item = DeriveJunction>>(
    phrase: &str,
    password: Option<&str>,
    path: I
) -> Result<Pair, SecretStringError>[src]

Generate a key from the phrase, password and derivation path.

fn verify<P: AsRef<Self::Public>, M: AsRef<[u8]>>(
    sig: &Self::Signature,
    message: M,
    pubkey: P
) -> bool[src]

Verify a signature on a message. Returns true if the signature is good.

fn verify_weak<P: AsRef<[u8]>, M: AsRef<[u8]>>(
    sig: &[u8],
    message: M,
    pubkey: P
) -> bool[src]

Verify a signature on a message. Returns true if the signature is good.

Loading content...