Struct PrivateKey

pub struct PrivateKey(/* private fields */);

Available on crate feature ed25519 only.

Implementations

impl PrivateKey

pub fn from_pem(pem: &str) -> Result<Self, Error>

Available on crate feature pem only.

pub fn from_der(der: &[u8]) -> Result<Self, Error>

Available on crate feature pem only.

pub fn to_pem(&self) -> String

Available on crate feature pem only.

Methods from Deref<Target = SecretKey>

pub const BYTES: usize = 64usize

pub fn public_key(&self) -> PublicKey

Returns the public counterpart of a secret key.

pub fn seed(&self) -> Seed

Returns the seed of a secret key.

pub fn validate_public_key(&self, pk: &PublicKey) -> Result<(), Error>

Returns Ok(()) if the given public key is the public counterpart of this secret key. Returns Err(Error::InvalidPublicKey) otherwise. The public key is recomputed (not just copied) from the secret key, so this will detect corruption of the secret key.

pub fn sign_incremental(&self, noise: Noise) -> SigningState

Sign a multi-part message (streaming API). It is critical for noise to never repeat.

pub fn sign(&self, message: impl AsRef<[u8]>, noise: Option<Noise>) -> Signature

Computes a signature for the message message using the secret key. The noise parameter is optional, but recommended in order to mitigate fault attacks.

pub fn to_der(&self) -> Vec<u8>

Export a secret key as an OpenSSL-compatible DER file.

pub fn to_pem(&self) -> String

Export a secret key as an OpenSSL-compatible PEM file.

Trait Implementations

impl AsRef<SecretKey> for PrivateKey

fn as_ref(&self) -> &SecretKey

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

impl Borrow<SecretKey> for PrivateKey

fn borrow(&self) -> &SecretKey

Immutably borrows from an owned value.

impl Clone for PrivateKey

fn clone(&self) -> PrivateKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateKey

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

Formats the value using the given formatter.

impl Deref for PrivateKey

type Target = SecretKey

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl EcSign for PrivateKey

type Sig = Signature

fn sign(&self, msg: impl AsRef<[u8]>) -> Signature

fn cert(&self) -> Result<Cert<Self::Sig>, EcSkInvalid>

impl EcSk for PrivateKey

type Pk = PublicKey

fn generate_keypair() -> (Self, Self::Pk)

where Self: Sized,

fn to_pk(&self) -> Result<PublicKey, EcSkInvalid>

impl From<PrivateKey> for SecretKey

fn from(wrapped: PrivateKey) -> Self

Converts to this type from the input type.

impl From<SecretKey> for PrivateKey

fn from(v: SecretKey) -> Self

Converts to this type from the input type.

impl Hash for PrivateKey

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PrivateKey

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PrivateKey

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for PrivateKey

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Wrapper for PrivateKey

type Inner = SecretKey

Inner type wrapped by the current newtype

fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

where Self::Inner: Clone,

Clones inner data of the wrapped type and return them

fn copy(&self) -> Self

where Self: Sized, Self::Inner: Copy,

Copies the wrapped type

impl Eq for PrivateKey

impl StructuralPartialEq for PrivateKey