Struct signatory::ed25519::Seed

pub struct Seed(pub [u8; 32]);

Ed25519 seeds: derivation secrets for Ed25519 private scalars/nonce prefixes

Methods

impl Seed

pub fn new(bytes: [u8; 32]) -> Self

Create an Ed25519 seed from a 32-byte array

pub fn generate() -> Self

Generate a new Ed25519 seed using the operating system's cryptographically secure random number generator

pub fn from_bytes<B>(bytes: B) -> Option<Self> where
    B: AsRef<[u8]>, 

Create an Ed25519 seed from a byte slice, returning KeyInvalid if the slice is not the correct size (32-bytes)

pub fn from_keypair(keypair: &[u8]) -> Option<Self>

Create an Ed25519 seed from a keypair: i.e. a seed and its assocaited public key (i.e. compressed Edwards-y coordinate)

pub fn decode_keypair<E: Encoding>(
    encoded_keypair: &[u8],
    encoding: &E
) -> Result<Self, Error>

Decode a Seed from an encoded (hex or Base64) Ed25519 keypair

pub fn as_secret_slice(&self) -> &[u8]

Expose the secret values of the Seed as a byte slice

Trait Implementations

impl Decode for Seed

fn decode<E: Encoding>(encoded_seed: &[u8], encoding: &E) -> Result<Self, Error>

Decode an Ed25519 seed from a byte slice with the given encoding (e.g. hex, Base64)

fn decode_from_str<S, E>(encoded_str: S, encoding: &E) -> Result<Self, Error> where
    S: AsRef<str>,
    E: Encoding, 

Decode the given string-alike type with the provided Encoding, returning the decoded value or a Error.

fn decode_from_reader<R, E>(reader: &mut R, encoding: &E) -> Result<Self, Error> where
    R: Read,
    E: Encoding, 

Decode the data read from the given io::Read type with the provided Encoding, returning the decoded value or a Error.

fn decode_from_file<P, E>(path: P, encoding: &E) -> Result<Self, Error> where
    P: AsRef<Path>,
    E: Encoding, 

Read a file at the given path, decoding the data it contains using the provided Encoding, returning the decoded value or a Error.

impl Encode for Seed

fn encode<E: Encoding>(&self, encoding: &E) -> Vec<u8>

Encode an Ed25519 seed with the given encoding (e.g. hex, Base64)

fn encode_to_string<E: Encoding>(&self, encoding: &E) -> Result<String, Error>

Encode self to a String using the provided Encoding, returning the encoded value or a Error.

fn encode_to_writer<W, E>(
    &self,
    writer: &mut W,
    encoding: &E
) -> Result<usize, Error> where
    W: Write,
    E: Encoding, 

Encode self with the given Encoding, writing the result to the supplied io::Write type, returning the number of bytes written or a Error.

fn encode_to_file<P, E>(&self, path: P, encoding: &E) -> Result<File, Error> where
    P: AsRef<Path>,
    E: Encoding, 

Encode self and write it to a file at the given path, returning the resulting File or a Error.

impl From<[u8; 32]> for Seed

fn from(bytes: [u8; 32]) -> Self

Performs the conversion.

impl Drop for Seed

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for Seed

fn clone(&self) -> Seed

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.