Skip to main content

SignerHandle

Struct SignerHandle 

Source
pub struct SignerHandle { /* private fields */ }
Expand description

Handle to a signing backend. Obtained from create_signer().

Multi-key: each method takes a label parameter. The factory initializes the backend and ensures the default_key_label exists.

Implementations§

Source§

impl SignerHandle

Source

pub fn generate_key(&self, label: &str, policy: AccessPolicy) -> Result<Vec<u8>>

Generate a new P-256 signing key. Returns uncompressed SEC1 public key.

§Errors
Source

pub fn public_key(&self, label: &str) -> Result<Vec<u8>>

Return the uncompressed SEC1 public key for an existing key.

Source

pub fn sign(&self, label: &str, data: &[u8]) -> Result<Vec<u8>>

Sign data (SHA-256 applied internally). Returns a DER-encoded ECDSA P-256 signature.

§Errors
Source

pub fn sign_with_presence( &self, label: &str, data: &[u8], opts: &PresenceOptions, ) -> Result<Vec<u8>>

Sign data with an optional user-presence prompt.

  • PresenceMode::Strict on a platform where presence_available() is false returns Error::PresenceNotAvailable.
  • PresenceMode::Cached or PresenceMode::None always falls through to a plain sign on non-macOS platforms (no error).
§Errors
Source

pub fn presence_available(&self) -> bool

True when the current platform supports presence prompting.

Source

pub fn list_keys(&self) -> Result<Vec<KeyInfo>>

List all signing keys in this app’s key store.

Source

pub fn delete_key(&self, label: &str) -> Result<()>

Permanently delete a signing key and its metadata.

Source

pub fn key_exists(&self, label: &str) -> Result<bool>

Return true if a key with this label exists.

Source

pub fn rename_key(&self, old_label: &str, new_label: &str) -> Result<()>

Atomically rename a signing key.

Source

pub fn evict_presence_cache(&self, label: &str)

Evict the cached wrapping-key / LAContext for label, forcing the next sign to re-authenticate. Has no effect on platforms without presence caching.

Source

pub fn backend_kind(&self) -> BackendKind

Which hardware security backend backs this handle.

Trait Implementations§

Source§

impl Debug for SignerHandle

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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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