Enum Auth 

#[non_exhaustive]
pub enum Auth {
    Anonymous,
    Token(String),
    Login {
        method: String,
        bearer: Bearer,
        meta: Vec<(String, String)>,
    },
}

How to obtain a Consul ACL token.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Anonymous

No token at all.

Correct for a Consul with ACLs disabled, and for a default policy that allows reads — both of which are ordinary in development.

Token(String)

A token somebody already obtained, usually CONSUL_HTTP_TOKEN.

The only variant that cannot recover on its own: there are no credentials here to log in again with.

Login

A bearer token presented to an auth method.

Consul calls the endpoint /v1/acl/login; the method decides what a valid bearer token looks like — a Kubernetes service-account JWT, an OIDC id token, a JWT signed by something Consul trusts.

Fields

method: String

The auth method’s name, as configured in Consul.

bearer: Bearer

Where the bearer token comes from.

meta: Vec<(String, String)>

Consul’s Meta, attached to the issued token for auditing.

Implementations

impl Auth

pub fn token(token: impl Into<String>) -> Self

A token somebody already obtained.

pub fn from_environment() -> Self

CONSUL_HTTP_TOKEN, if it is set and not empty.

Returns Auth::Anonymous when it is not, because a Consul with ACLs disabled is a perfectly ordinary thing to point this at, and failing would make the convenience useless in exactly that case.

pub fn kubernetes(method: impl Into<String>) -> Self

Kubernetes: the pod’s service-account token, presented to method.

pub fn jwt(method: impl Into<String>, token: impl Into<String>) -> Self

A JWT or OIDC token presented to method.

pub fn with_bearer_file(self, path: impl Into<String>) -> Self

Reads the bearer token from somewhere other than the conventional path.

pub fn with_meta( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Adds a Meta entry, which Consul attaches to the issued token.

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Auth

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

Formats the value using the given formatter.