Struct ssh_key::Signature

pub struct Signature { /* private fields */ }

Available on crate feature alloc only.

Low-level digital signature (e.g. DSA, ECDSA, Ed25519).

These are low-level signatures used as part of the OpenSSH certificate format to represent signatures by certificate authorities (CAs), as well as the higher-level SshSig format, which provides general-purpose signing functionality using SSH keys.

From OpenSSH’s PROTOCOL.certkeys specification:

Signatures are computed and encoded according to the rules defined for the CA’s public key algorithm (RFC4253 section 6.6 for ssh-rsa and ssh-dss, RFC5656 for the ECDSA types, and RFC8032 for Ed25519).

RSA signature support is implemented using the SHA2 family extensions as described in RFC8332.

Implementations

impl Signature

pub fn new(algorithm: Algorithm, data: impl Into<Vec<u8>>) -> Result<Self>

Create a new signature with the given algorithm and raw signature data.

See specifications in toplevel Signature documentation for how to format the raw signature data for a given algorithm.

Returns

• Error::Encoding if the signature is not the correct length.

pub fn algorithm(&self) -> Algorithm

Get the Algorithm associated with this signature.

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

Get the raw signature as bytes.

Trait Implementations

impl AsRef<[u8]> for Signature

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

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

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

Formats the value using the given formatter.

impl Decode for Signature

type Error = Error

Type returned in the event of a decoding error.

fn decode(reader: &mut impl Reader) -> Result<Self>

Attempt to decode a value of this type using the provided Reader.

impl Encode for Signature

fn encoded_len(&self) -> Result<usize>

Get the length of this type encoded in bytes, prior to Base64 encoding.

fn encode(&self, writer: &mut impl Writer) -> Result<()>

Encode this value using the provided Writer.

fn encoded_len_prefixed(&self) -> Result<usize, Error>

Return the length of this type after encoding when prepended with a uint32 length prefix.

fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error>

Encode this value, first prepending a uint32 length prefix set to Encode::encoded_len.

impl LowerHex for Signature

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

Formats the value using the given formatter.

impl Ord for Signature

fn cmp(&self, other: &Signature) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Signature

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Signature

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl SignatureEncoding for Signature

type Repr = Vec<u8>

Byte representation of a signature.

fn to_bytes(&self) -> Self::Repr

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 DsaKeypair

Available on crate feature dsa only.

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

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 Signer<Signature> for EcdsaKeypair

Available on crate features p256 or p384 or p521 only.

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

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 Signer<Signature> for EcdsaPrivateKey<32>

Available on crate feature p256 only.

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

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 Signer<Signature> for EcdsaPrivateKey<48>

Available on crate feature p384 only.

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

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 Signer<Signature> for EcdsaPrivateKey<66>

Available on crate feature p521 only.

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

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 Signer<Signature> for Ed25519Keypair

Available on crate feature ed25519 only.

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

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 Signer<Signature> for KeypairData

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

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 Signer<Signature> for PrivateKey

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

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 Signer<Signature> for RsaKeypair

Available on crate feature rsa only.

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

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 Signature

Decode Signature from an Algorithm-prefixed OpenSSH-encoded bytestring.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self>

Performs the conversion.

impl TryFrom<&Signature<NistP256>> for Signature

Available on crate feature p256 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: &Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<&Signature<NistP384>> for Signature

Available on crate feature p384 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: &Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<&Signature<NistP521>> for Signature

Available on crate feature p521 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: &Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<&Signature> for Signature

Available on crate feature ed25519 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: &Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<&Signature> for Signature

Available on crate feature p256 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: &Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<&Signature> for Signature

Available on crate feature p384 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: &Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<&Signature> for Signature

Available on crate feature p521 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: &Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<Signature<NistP256>> for Signature

Available on crate feature p256 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<Signature<NistP384>> for Signature

Available on crate feature p384 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<Signature<NistP521>> for Signature

Available on crate feature p521 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<Signature> for Signature

Available on crate feature ed25519 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<Signature> for Signature

Available on crate feature p256 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<Signature> for Signature

Available on crate feature p384 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<Signature> for Signature

Available on crate feature p521 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: Signature) -> Result<Signature>

Performs the conversion.

impl TryFrom<Signature> for Vec<u8>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(signature: Signature) -> Result<Vec<u8>>

Performs the conversion.

impl UpperHex for Signature

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

Formats the value using the given formatter.

impl Verifier<Signature> for DsaPublicKey

Available on crate feature dsa only.

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

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

impl Verifier<Signature> for EcdsaPublicKey

Available on crate features p256 or p384 or p521 only.

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

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

impl Verifier<Signature> for Ed25519PublicKey

Available on crate feature ed25519 only.

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

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

impl Verifier<Signature> for KeyData

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

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

impl Verifier<Signature> for PublicKey

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

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

impl Verifier<Signature> for RsaPublicKey

Available on crate feature rsa only.

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

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

impl Verifier<Signature> for SkEcdsaSha2NistP256

Available on crate feature p256 only.

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

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

impl Verifier<Signature> for SkEd25519

Available on crate feature ed25519 only.

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

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

impl Eq for Signature

impl StructuralPartialEq for Signature