Ed25519PrivateKey

Struct Ed25519PrivateKey 

Source
pub struct Ed25519PrivateKey(/* private fields */);
Expand description

An Ed25519 private key for creating digital signatures.

Ed25519 is a public-key signature system based on the Edwards curve over the finite field GF(2^255 - 19). It provides the following features:

  • Fast single-signature verification
  • Fast key generation
  • High security level (equivalent to 128 bits of symmetric security)
  • Collision resilience - hash function collisions don’t break security
  • Protection against side-channel attacks
  • Small signatures (64 bytes) and small keys (32 bytes)

This implementation allows:

  • Creating random Ed25519 private keys
  • Deriving the corresponding public key
  • Signing messages
  • Converting between various formats

Implementations§

Source§

impl Ed25519PrivateKey

Source

pub fn new() -> Self

Creates a new random Ed25519 private key.

Source

pub fn new_using(rng: &mut impl RandomNumberGenerator) -> Self

Creates a new random Ed25519 private key using the given random number generator.

Source

pub fn data(&self) -> &[u8; 32]

Returns the Ed25519 private key as an array of bytes.

Source

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

Get the Ed25519 private key as a byte slice.

Source

pub const fn from_data(data: [u8; 32]) -> Self

Restores an Ed25519 private key from an array of bytes.

Source

pub fn from_data_ref(data: impl AsRef<[u8]>) -> Result<Self>

Restores an Ed25519 private key from a reference to an array of bytes.

Source

pub fn derive_from_key_material(key_material: impl AsRef<[u8]>) -> Self

Derives a new SigningPrivateKey from the given key material.

Source

pub fn hex(&self) -> String

Source

pub fn from_hex(hex: impl AsRef<str>) -> Result<Self>

Source§

impl Ed25519PrivateKey

Source

pub fn public_key(&self) -> Ed25519PublicKey

Derives the public key from this Ed25519 private key.

Source

pub fn sign(&self, message: impl AsRef<[u8]>) -> [u8; 64]

Trait Implementations§

Source§

impl AsRef<[u8]> for Ed25519PrivateKey

Implements AsRef<u8> to allow Ed25519PrivateKey to be treated as a byte slice.

Source§

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for Ed25519PrivateKey

Source§

fn clone(&self) -> Ed25519PrivateKey

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Ed25519PrivateKey

Implements Debug to output the key with a type label.

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Ed25519PrivateKey

Implements Default to create a new random Ed25519PrivateKey.

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for Ed25519PrivateKey

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'a> From<&'a Ed25519PrivateKey> for &'a [u8]

Implements conversion from an Ed25519PrivateKey reference to a byte slice.

Source§

fn from(value: &'a Ed25519PrivateKey) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<&'a Ed25519PrivateKey> for &'a [u8; 32]

Implements conversion from an Ed25519PrivateKey reference to a byte array reference.

Source§

fn from(value: &'a Ed25519PrivateKey) -> Self

Converts to this type from the input type.
Source§

impl From<[u8; 32]> for Ed25519PrivateKey

Implements conversion from a byte array to an Ed25519PrivateKey.

Source§

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

Converts to this type from the input type.
Source§

impl Hash for Ed25519PrivateKey

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Ed25519PrivateKey

Source§

fn eq(&self, other: &Ed25519PrivateKey) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl ReferenceProvider for Ed25519PrivateKey

Source§

fn reference(&self) -> Reference

Returns a cryptographic reference that uniquely identifies this object. Read more
Source§

fn ref_hex(&self) -> String

Returns the reference data as a hexadecimal string. Read more
Source§

fn ref_data_short(&self) -> [u8; 4]

Returns the first four bytes of the reference. Read more
Source§

fn ref_hex_short(&self) -> String

Returns the first four bytes of the reference as a hexadecimal string. Read more
Source§

fn ref_bytewords(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as upper-case ByteWords. Read more
Source§

fn ref_bytemoji(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as Bytemoji. Read more
Source§

impl Eq for Ed25519PrivateKey

Source§

impl StructuralPartialEq for Ed25519PrivateKey

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToHex for T
where T: AsRef<[u8]>,

Source§

fn encode_hex<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Lower case letters are used (e.g. f9b4ca)
Source§

fn encode_hex_upper<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Upper case letters are used (e.g. F9B4CA)
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> ErasedDestructor for T
where T: 'static,