Struct Signature

#[repr(C)]
pub struct Signature { /* private fields */ }

Ed25519 signature.

This type represents a container for the byte serialization of an Ed25519 signature, and does not necessarily represent well-formed field or curve elements.

Signature verification libraries are expected to reject invalid field elements at the time a signature is verified.

Implementations

impl Signature

pub const BYTE_SIZE: usize = 64usize

Size of an encoded Ed25519 signature in bytes.

pub fn from_bytes(bytes: &[u8; 64]) -> Signature

Parse an Ed25519 signature from a byte slice.

pub fn from_components(R: [u8; 32], s: [u8; 32]) -> Signature

Parse an Ed25519 signature from its R and s components.

pub fn from_slice(bytes: &[u8]) -> Result<Signature, Error>

Parse an Ed25519 signature from a byte slice.

Returns

• Ok on success
• Err if the input byte slice is not 64-bytes

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

Bytes for the R component of a signature.

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

Bytes for the s component of a signature.

pub fn to_bytes(&self) -> [u8; 64]

Return the inner byte array.

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Signature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl<D> DigestSigner<D, Signature> for Context<'_, '_, SigningKey>

where D: Digest<OutputSize = U64>,

Equivalent to SigningKey::sign_prehashed with context set to Some containing self.value().

Note

The RFC only permits SHA-512 to be used for prehashing. This function technically works, and is probably safe to use, with any secure hash function with 512-bit digests, but anything outside of SHA-512 is NOT specification-compliant. We expose crate::Sha512 for user convenience.

fn try_sign_digest(&self, msg_digest: D) -> Result<Signature, SignatureError>

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> DigestSigner<D, Signature> for SigningKey

where D: Digest<OutputSize = U64>,

Equivalent to SigningKey::sign_prehashed with context set to None.

Note

The RFC only permits SHA-512 to be used for prehashing. This function technically works, and is probably safe to use, with any secure hash function with 512-bit digests, but anything outside of SHA-512 is NOT specification-compliant. We expose crate::Sha512 for user convenience.

fn try_sign_digest(&self, msg_digest: D) -> Result<Signature, SignatureError>

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<MsgDigest> DigestVerifier<MsgDigest, Signature> for Context<'_, '_, VerifyingKey>

where MsgDigest: Digest<OutputSize = U64>,

Equivalent to VerifyingKey::verify_prehashed with context set to Some containing self.value().

fn verify_digest( &self, msg_digest: MsgDigest, signature: &Signature, ) -> Result<(), SignatureError>

Verify the signature against the given Digest output.

impl<MsgDigest> DigestVerifier<MsgDigest, Signature> for VerifyingKey

where MsgDigest: Digest<OutputSize = U64>,

Equivalent to VerifyingKey::verify_prehashed with context set to None.

fn verify_digest( &self, msg_digest: MsgDigest, signature: &Signature, ) -> Result<(), SignatureError>

Verify the signature against the given Digest output.

impl Display for Signature

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

Formats the value using the given formatter.

impl From<&[u8; 64]> for Signature

fn from(bytes: &[u8; 64]) -> Signature

Converts to this type from the input type.

impl From<[u8; 64]> for Signature

fn from(bytes: [u8; 64]) -> Signature

Converts to this type from the input type.

impl FromStr for Signature

Decode a signature from hexadecimal.

Upper and lower case hexadecimal are both accepted, however mixed case is rejected.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(hex: &str) -> Result<Signature, Error>

Parses a string s to return a value of this type.

impl LowerHex for Signature

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

Formats the value using the given formatter.

impl PartialEq for Signature

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

type Repr = [u8; 64]

Byte representation of a signature.

fn to_bytes(&self) -> [u8; 64]

Encode signature as its byte representation.

fn to_vec(&self) -> Vec<u8>

Encode signature as a byte vector.

fn encoded_len(&self) -> usize

Get the length of this signature when encoded.

impl Signer<Signature> for SigningKey

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

Sign a message with this signing key’s secret key.

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

Sign the given message and return a digital signature

impl TryFrom<&[u8]> for Signature

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Signature, Error>

Performs the conversion.

impl UpperHex for Signature

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

Formats the value using the given formatter.

impl Verifier<Signature> for SigningKey

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

Verify a signature on a message with this signing key’s public key.

impl Verifier<Signature> for VerifyingKey

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

Verify a signature on a message with this keypair’s public key.

Return

Returns Ok(()) if the signature is valid, and Err otherwise.

impl Copy for Signature

impl Eq for Signature

impl StructuralPartialEq for Signature