Struct ssh_key::Signature

pub struct Signature { /* private fields */ }

Available on crate feature alloc only.

Digital signature (e.g. DSA, ECDSA, Ed25519).

These are used as part of the OpenSSH certificate format to represent signatures by certificate authorities (CAs).

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::Length if the signature is not the correct length.

impl Signature

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 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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Signature> 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<Signature> 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 Signature for Signature

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

Parse a signature from its byte representation

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

Borrow a byte slice representing the serialized form of this signature

impl Signer<Signature> for EcdsaKeypair

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<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 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> 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<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> 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 UpperHex for Signature

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

Formats the value using the given formatter.

impl Verifier<Signature> for EcdsaPublicKey

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 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 Eq for Signature

impl StructuralEq for Signature

impl StructuralPartialEq for Signature