Skip to main content

SigningKey

Struct SigningKey 

Source
pub struct SigningKey(/* private fields */);
Expand description

A signature.signing-key: private-key signing.

Implementations§

Source§

impl SigningKey

Source

pub fn from_raw(raw: SigningKey) -> Self

Wrap a raw signing-key resource.

Source

pub fn as_raw(&self) -> &SigningKey

Borrow the raw signing-key resource.

Source

pub fn into_raw(self) -> SigningKey

Unwrap into the raw signing-key resource.

Source§

impl SigningKey

Source

pub async fn sign( &self, data: impl Into<DataSource<'_>>, ) -> Result<Vec<u8>, Error>

Sign data, returning the signature in the minting interface’s documented wire format.

Fails only for operational reasons (Error::Other, or Error::Read for a failing DataSource::from_reader source) — never for misuse, which is unrepresentable.

Source

pub fn algorithm_name(&self) -> String

Source

pub fn algorithm_curve(&self) -> Option<String>

Source

pub fn algorithm_hash(&self) -> Option<String>

Source

pub fn algorithm_length(&self) -> Option<u32>

Source

pub fn algorithm_public_exponent(&self) -> Option<Vec<u8>>

Source

pub fn extractable(&self) -> bool

Whether the private key material may be exported by export_key_jwk / export_key_pkcs8 and the wrap inputs — mint-time recorded policy, which platform-backed key storage also honors.

Asking is not the same as exporting: interrogating extractability through an export alone would hand you the material whenever the answer is yes.

Source

pub fn can_sign(&self) -> bool

Whether the key permits sign — the usage recorded at mint (or carried by a platform keystore key). A refused operation fails Error::NotPermitted.

Source

pub async fn export_key_jwk(&self) -> Result<String, Error>

The private key as a JWK (JSON text — an RFC 8037 OKP private key for Ed25519, an EC private key for ECDSA); fails with Error::NotExtractable unless the key was minted extractable. Extractability is an API property, not a physical one: the guarantee is that components holding only the handle cannot obtain the material through this API.

Source

pub async fn export_key_pkcs8(&self) -> Result<Vec<u8>, Error>

The private key as a PKCS#8 PrivateKeyInfo (DER), behind the same extractability gate as export_key_jwk.

Source

pub async fn to_wrap_input_jwk(&self) -> Result<WrapInput, Error>

The private-key JWK serialization as a WrapInput for wrapping under another key — the material transits neither caller. Behind the same extractability gate as export_key_jwk.

Source

pub async fn to_wrap_input_pkcs8(&self) -> Result<WrapInput, Error>

The PKCS#8 serialization as a WrapInput, behind the same gate.

Trait Implementations§

Source§

impl Debug for SigningKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<SigningKey> for SigningKey

Source§

fn from(raw: SigningKey) -> Self

Converts to this type from the input type.

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

§

impl<T> Resource for T
where T: 'static,

§

type Rep = Option<T>

The type which is actually stored in-memory for this resource. Read more
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.