Struct SigningKey

pub struct SigningKey { /* private fields */ }

Available on crate feature signing only.

Signing key for Ed448

Implementations

impl SigningKey

pub fn generate(rng: impl CryptoRngCore) -> Self

Generate a cryptographically random SigningKey.

pub fn to_bytes(&self) -> SecretKey

Serialize this SigningKey as bytes.

pub fn as_bytes(&self) -> &SecretKey

Serialize this SigningKey as a byte reference.

pub fn to_scalar(&self) -> Scalar

Return the clamped Scalar for this SigningKey.

This is the scalar that is actually used for signing. Be warned, this is secret material that should be handled with care.

pub fn verifying_key(&self) -> VerifyingKey

Get the VerifyingKey for this SigningKey.

pub fn with_context<'k, 'v>( &'k self, context: &'v [u8], ) -> Context<'k, 'v, Self>

Create a signing context that can be used for Ed448ph with [DigestSigner]

pub fn sign_raw(&self, message: &[u8]) -> Signature

Sign a message with this SigningKey using the Ed448 algorithm defined in RFC8032 §5.2.

pub fn sign_ctx( &self, context: &[u8], message: &[u8], ) -> Result<Signature, Error>

Sign a message in the given context with this SigningKey using the Ed448ph algorithm defined in RFC8032 §5.2.

pub fn sign_prehashed<D>( &self, context: Option<&[u8]>, prehashed_message: D, ) -> Result<Signature, Error>

where D: PreHash,

Sign a prehashed_message with this SigningKey using the Ed448ph algorithm defined in RFC8032 §5.2.

Trait Implementations

impl Clone for SigningKey

fn clone(&self) -> SigningKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for SigningKey

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for SigningKey

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

Formats the value using the given formatter.

impl<D> DigestSigner<D, Signature> for SigningKey

where D: Digest,

fn try_sign_digest(&self, digest: D) -> Result<Signature, Error>

Attempt to sign the given prehashed message Digest, returning a digital signature on success, or an error if something went wrong.

fn sign_digest(&self, digest: D) -> S

Sign the given prehashed message Digest, returning a signature.

impl<D> DigestVerifier<D, Signature> for SigningKey

where D: Digest,

fn verify_digest(&self, msg: D, signature: &Signature) -> Result<(), Error>

Verify the signature against the given Digest output.

impl Drop for SigningKey

fn drop(&mut self)

Executes the destructor for this type.

impl DynSignatureAlgorithmIdentifier for SigningKey

Available on (crate features alloc or std) and crate feature pkcs8 only.

fn signature_algorithm_identifier(&self) -> Result<AlgorithmIdentifierOwned>

AlgorithmIdentifier for the corresponding singature system.

impl EncodePrivateKey for SigningKey

Available on (crate features alloc or std) and crate feature pkcs8 only.

fn to_pkcs8_der(&self) -> Result<SecretDocument>

Serialize a SecretDocument containing a PKCS#8-encoded private key.

fn to_pkcs8_pem( &self, line_ending: LineEnding, ) -> Result<Zeroizing<String>, Error>

Serialize this private key as PEM-encoded PKCS#8 with the given LineEnding.

impl From<&GenericArray<u8, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B1>, B0>, B0>, B1>>> for SigningKey

fn from(secret_scalar: &SecretKey) -> Self

Converts to this type from the input type.

impl From<&SigningKey> for KeypairBytes

Available on crate feature pkcs8 only.

fn from(signing_key: &SigningKey) -> Self

Converts to this type from the input type.

impl From<GenericArray<u8, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B1>, B0>, B0>, B1>>> for SigningKey

fn from(secret_scalar: SecretKey) -> Self

Converts to this type from the input type.

impl PartialEq for SigningKey

fn eq(&self, other: &Self) -> 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 PrehashSigner<Signature> for SigningKey

fn sign_prehash(&self, prehash: &[u8]) -> Result<Signature, Error>

Attempt to sign the given message digest, returning a digital signature on success, or an error if something went wrong.

impl Signer<Signature> for SigningKey

fn try_sign(&self, msg: &[u8]) -> Result<Signature, Error>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign(&self, msg: &[u8]) -> S

Sign the given message and return a digital signature

impl TryFrom<&[u8]> for SigningKey

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&KeypairBytes> for SigningKey

Available on crate feature pkcs8 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &KeypairBytes) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Vec<u8>> for SigningKey

Available on crate features alloc or std only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Box<[u8]>> for SigningKey

Available on crate features alloc or std only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: Box<[u8]>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<KeypairBytes> for SigningKey

Available on crate feature pkcs8 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: KeypairBytes) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PrivateKeyInfo<'_>> for SigningKey

Available on crate feature pkcs8 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PrivateKeyInfo<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for SigningKey

Available on crate features alloc or std only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Verifier<Signature> for SigningKey

fn verify(&self, msg: &[u8], signature: &Signature) -> Result<(), Error>

Use Self to verify that the provided signature for a given message bytestring is authentic.

impl Zeroize for SigningKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for SigningKey

impl ZeroizeOnDrop for SigningKey