Skip to main content

PresenceMode

Enum PresenceMode 

Source
pub enum PresenceMode {
    Cached,
    Strict,
    None,
}
Expand description

User-presence prompt cadence for sign operations.

Orthogonal to AccessPolicy: AccessPolicy says what counts as authentication (e.g. fingerprint vs. passcode); PresenceMode says how often the user must reproduce it.

On macOS the choice is implemented by passing (or omitting) a long-lived LAContext to CryptoKit’s SecureEnclave.P256.Signing.PrivateKey.

Other platforms do not have an analogous cached-context concept and treat all variants identically:

  • Windows TPM (CNG): The hardware enforces NCRYPT_UI_POLICY per sign, so every signature triggers a fresh Windows Hello prompt.
  • Linux TPM and software / keyring backends: No gate at all. AccessPolicy is stored in metadata but is not consulted at sign or decrypt time, so all PresenceMode variants behave the same as PresenceMode::None. See the “Linux TPM backend” section of THREAT_MODEL.md.

Variants§

§

Cached

User-presence prompt batched within a TTL window. The first sign after the cache is cold prompts; subsequent signs within the cache TTL reuse the same LAContext and are silent. This is the default for any new key created with user-presence enabled.

§

Strict

User-presence prompt on every sign. The agent does not pass a long-lived LAContext, so the SEP enforces a fresh authentication per signature.

§

None

No user-presence prompt. The key has AccessPolicy::None (or its platform equivalent) and signs silently regardless of cache state.

Implementations§

Source§

impl PresenceMode

Source

pub fn migration_default(policy: AccessPolicy) -> Self

Migration default for keys whose .meta predates presence_mode: historically, a key with any access policy other than None effectively had Strict semantics (one prompt per sign), and a key with None was silent. Use this when reading a legacy .meta file with no presence_mode field.

Trait Implementations§

Source§

impl Clone for PresenceMode

Source§

fn clone(&self) -> PresenceMode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PresenceMode

Source§

impl Debug for PresenceMode

Source§

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

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

impl Default for PresenceMode

Source§

fn default() -> PresenceMode

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for PresenceMode

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for PresenceMode

Source§

impl PartialEq for PresenceMode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for PresenceMode

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PresenceMode

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> ToOwned for T
where T: Clone,

Source§

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)

Uses borrowed data to replace owned data, usually by cloning. 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.
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