Skip to main content

SigningKeyMaterial

Enum SigningKeyMaterial 

Source
pub enum SigningKeyMaterial {
    Off,
    Hmac {
        kid: String,
        key: Zeroizing<Vec<u8>>,
    },
    Ed25519 {
        kid: String,
        signing_key: SigningKey,
    },
}
Expand description

Runtime signing key material.

Note: Debug is implemented manually so that key bytes never leak into log output. We surface the variant + kid only.

Variants§

§

Off

Signing disabled — passthrough, no envelope wrapping.

§

Hmac

HMAC-SHA256 with a shared symmetric key.

Fields

§kid: String

Signer kid embedded in the SignedEventEnvelopeV1.

§key: Zeroizing<Vec<u8>>

Shared HMAC key bytes. Red-team wave-2 T1b: Zeroizing<Vec<u8>> so the secret key is wiped on drop instead of lingering in freed allocations.

§

Ed25519

Ed25519 asymmetric signing.

Fields

§kid: String

Signer kid embedded in the SignedEventEnvelopeV1.

§signing_key: SigningKey

Ed25519 signing key (private). Verifier holds the matching VerifyingKey.

Implementations§

Source§

impl SigningKeyMaterial

Source

pub fn is_off(&self) -> bool

True iff this is the SigningKeyMaterial::Off variant.

Source

pub fn kid(&self) -> Option<&str>

Signer kid for the active variant; None for SigningKeyMaterial::Off.

Source

pub fn from_env() -> Result<Self, SignOutboundError>

Load signing material from env vars (see module docs).

  • Unset / "off"SigningKeyMaterial::Off.
  • "hmac-sha256" → requires kid + HMAC key, rejects ed25519 key.
  • "ed25519" → requires kid + ed25519 seed, rejects HMAC key.

Trait Implementations§

Source§

impl Debug for SigningKeyMaterial

Source§

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

Custom Debug that NEVER prints key bytes — only variant + kid. This matters because operators sometimes pipe tracing output into log stores that retain forever; an accidental {:?} of a SigningKeyMaterial must not become a key-leak channel.

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