Skip to main content

SigningKey

Enum SigningKey 

Source
#[non_exhaustive]
pub enum SigningKey { Ed25519(Ed25519SigningKey), Rsa(RsaSigningKey), }
Expand description

A key capable of producing detached signatures.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Ed25519(Ed25519SigningKey)

Ed25519 backend.

§

Rsa(RsaSigningKey)

RSA PKCS#1 v1.5 backend.

Implementations§

Source§

impl SigningKey

Source

pub fn generate_ed25519() -> Self

Generates a fresh Ed25519 signing key using the system RNG.

§Panics

Panics if aws-lc-rs cannot draw bytes from the operating system. Every platform we support (Linux, macOS, Windows, the major BSDs) guarantees this succeeds, so a panic here indicates a broken host. Callers that prefer to handle this failure gracefully can call Ed25519SigningKey::generate directly.

Source

pub fn generate_rsa(bits: RsaBits) -> Result<Self, Error>

Generates a fresh RSA signing key of the requested width.

§Errors

Returns Error::KeyGeneration on RNG or key-scheduling failure.

Source

pub fn from_pem(pem_text: &str) -> Result<Self, Error>

Loads a signing key from a PEM document, autodetecting the algorithm from the embedded OID.

§Errors

Returns Error::InvalidPem, Error::UnexpectedPemLabel or Error::UnsupportedAlgorithm as appropriate.

Source

pub fn to_pem(&self) -> String

Encodes the signing key as a PKCS#8 PRIVATE KEY PEM.

Source

pub const fn algorithm(&self) -> Algorithm

Returns the algorithm identifier for this key.

Source

pub fn verifying_key(&self) -> VerifyingKey

Returns the verifying half of this key pair.

Source

pub fn sign(&self, message: &[u8]) -> Result<Vec<u8>, Error>

Signs message and returns the raw signature bytes.

§Errors

Returns Error::Crypto if the underlying primitive fails.

Trait Implementations§

Source§

impl Debug for SigningKey

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more