Skip to main content

SignerConfig

Enum SignerConfig 

Source
pub enum SignerConfig {
    Local {
        private_key: String,
    },
    Vault {
        address: String,
        key: String,
        token_env: String,
        alg: TokenAlg,
    },
    AwsKms {
        key_id: String,
        region: Option<String>,
    },
    GcpKms {
        key_version: String,
        access_token_env: String,
    },
    AzureKv {
        vault_url: String,
        key: String,
        key_version: String,
        access_token_env: String,
    },
    Pkcs11 {
        module: String,
        token_label: String,
        key_label: String,
        pin_env: String,
        alg: TokenAlg,
    },
}
Expand description

Which signer backend issues control-plane tokens, and its parameters. Selected by the operator (config [auth.signer]); the default is SignerConfig::Local.

Variants§

§

Local

An in-process key ("<alg>:<hex>") — the default / dev backend.

Fields

§private_key: String

The private key spec, "<alg>:<hex>" (from boatramp auth init).

§

Vault

A HashiCorp Vault Transit key. Token from token_env.

Fields

§address: String

Vault base address, e.g. https://vault.example:8200.

§key: String

The Transit key name.

§token_env: String

Env var holding the Vault token.

§alg: TokenAlg

The key’s algorithm (ES256 or Ed25519).

§

AwsKms

An AWS KMS asymmetric signing key (ES256 only). Credentials from the standard AWS provider chain (env / profile / IMDS).

Fields

§key_id: String

The KMS key id or ARN.

§region: Option<String>

Optional region override (else the provider chain’s region).

§

GcpKms

A GCP Cloud KMS asymmetric signing key version (ES256 only). Access token from access_token_env (a sidecar / workload-identity refreshes it).

Fields

§key_version: String

The full key-version resource name (projects/…/cryptoKeyVersions/N).

§access_token_env: String

Env var holding a GCP OAuth2 access token.

§

AzureKv

An Azure Key Vault signing key (ES256 only). Access token from access_token_env (managed identity / a sidecar refreshes it).

Fields

§vault_url: String

The vault base URL, e.g. https://kv.vault.azure.net.

§key: String

The key name.

§key_version: String

The key version (a specific version id).

§access_token_env: String

Env var holding an Azure AD access token for the Key Vault resource.

§

Pkcs11

A PKCS#11 HSM key. PIN from pin_env.

Fields

§module: String

Path to the PKCS#11 module (.so).

§token_label: String

The token label to open a session on.

§key_label: String

The signing key’s CKA_LABEL.

§pin_env: String

Env var holding the user PIN.

§alg: TokenAlg

The key’s algorithm (ES256 or Ed25519).

Trait Implementations§

Source§

impl Clone for SignerConfig

Source§

fn clone(&self) -> SignerConfig

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 Debug for SignerConfig

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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