Struct ssh_key::Signature

source · [−]

pub struct Signature { /* private fields */ }

Available on crate feature alloc only.

Expand description

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

source

impl Signature

source

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.

source

impl Signature

source

pub fn algorithm(&self) -> Algorithm

Get the Algorithm associated with this signature.

source

pub fn as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

Get the raw signature as bytes.

Trait Implementations

source

impl AsRef<[u8 ]> for Signature

source

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

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

source

impl Clone for Signature

source

fn clone(&self) -> Signature

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Signature

source

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

Formats the value using the given formatter. Read more

source

impl LowerHex for Signature

source

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

Formats the value using the given formatter.

source

impl Ord for Signature

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl PartialEq<Signature> for Signature

source

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

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

source

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

This method tests for !=.

source

impl PartialOrd<Signature> for Signature

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl Signature for Signature

source

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

Parse a signature from its byte representation

source

fn as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

Borrow a byte slice representing the serialized form of this signature

source

impl Signer<Signature> for PrivateKey

source

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. Read more

source

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

Sign the given message and return a digital signature

source

impl Signer<Signature> for KeypairData

source

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. Read more

source

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

Sign the given message and return a digital signature

source

impl Signer<Signature> for Ed25519Keypair

Available on crate feature ed25519 only.

source

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. Read more

source

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

Sign the given message and return a digital signature

source

impl Signer<Signature> for EcdsaKeypair

Available on crate feature p256 only.

source

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. Read more

source

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

Sign the given message and return a digital signature

source

impl Signer<Signature> for EcdsaPrivateKey<32>

Available on crate feature p256 only.

source

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. Read more

source

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

Sign the given message and return a digital signature

source

impl Signer<Signature> for RsaKeypair

Available on crate feature rsa only.

source

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. Read more

source

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

Sign the given message and return a digital signature

source

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.

source

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

Performs the conversion.

source

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.

source

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

Performs the conversion.

source

impl TryFrom<&'_ Signature> for Signature

Available on crate feature ed25519 only.

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<&'_ Signature> for Signature

Available on crate feature p256 only.

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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.

source

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

Performs the conversion.

source

impl TryFrom<Signature> for Signature

Available on crate feature ed25519 only.

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<Signature> for Signature

Available on crate feature p256 only.

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl UpperHex for Signature

source

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

Formats the value using the given formatter.

source

impl Verifier<Signature> for PublicKey

source

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

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

source

impl Verifier<Signature> for KeyData

source

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

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

source

impl Verifier<Signature> for Ed25519PublicKey

Available on crate feature ed25519 only.

source

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

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

source

impl Verifier<Signature> for EcdsaPublicKey

Available on crate feature p256 only.

source

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

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

source

impl Verifier<Signature> for RsaPublicKey

Available on crate feature rsa only.

source

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

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

source

impl Eq for Signature

source

impl StructuralEq for Signature

source

impl StructuralPartialEq for Signature

Auto Trait Implementations

impl RefUnwindSafe for Signature

impl Send for Signature

impl Sync for Signature

impl Unpin for Signature

impl UnwindSafe for Signature

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ssh_key::Signature

Implementations

impl Signature

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

Returns

impl Signature

pub fn algorithm(&self) -> Algorithm

pub fn as_bytes(&self) -> &[u8]ⓘNotable traits for &'_ mut [u8]impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

Trait Implementations

impl AsRef<[u8]> for Signature

fn as_ref(&self) -> &[u8]ⓘNotable traits for &'_ mut [u8]impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

impl Clone for Signature

fn clone(&self) -> Signature

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

impl Debug for Signature

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

impl LowerHex for Signature

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

impl Ord for Signature

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

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

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

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

impl PartialEq<Signature> for Signature

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

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

impl PartialOrd<Signature> for Signature

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

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

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

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

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

impl Signature for Signature

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

fn as_bytes(&self) -> &[u8]ⓘNotable traits for &'_ mut [u8]impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

impl Signer<Signature> for PrivateKey

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

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

impl Signer<Signature> for KeypairData

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

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

impl Signer<Signature> for Ed25519Keypair

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

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

impl Signer<Signature> for EcdsaKeypair

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

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

impl Signer<Signature> for EcdsaPrivateKey<32>

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

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

impl Signer<Signature> for RsaKeypair

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

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

impl TryFrom<&'_ [u8]> for Signature

type Error = Error

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

impl TryFrom<&'_ Signature<NistP256>> for Signature

type Error = Error

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

impl TryFrom<&'_ Signature> for Signature

type Error = Error

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

impl TryFrom<&'_ Signature> for Signature

type Error = Error

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

impl TryFrom<Signature<NistP256>> for Signature

type Error = Error

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

impl TryFrom<Signature> for Signature

type Error = Error

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

impl TryFrom<Signature> for Signature

type Error = Error

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

impl UpperHex for Signature

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

impl Verifier<Signature> for PublicKey

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

impl Verifier<Signature> for KeyData

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

pub fn as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

impl AsRef<[u8 ]> for Signature

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

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

fn as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

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

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

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

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

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

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

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

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

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

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

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

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

impl TryFrom<&'_ [u8 ]> for Signature

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,