Struct Principal 

pub struct Principal {
    pub subject: String,
    pub provider: String,
    pub roles: BTreeSet<String>,
    pub claims: BTreeMap<String, String>,
}

An authenticated (or anonymous) caller, carried in request extensions.

A principal is what an IdentityProvider produces from credentials and what an Authorizer consumes. It is intentionally a flat bag of strings so that identities from different providers (static tokens, OIDC claims, mTLS subjects) share one shape; richer typing can come later without changing the seam.

Fields

subject: String

Stable subject identifier, unique within provider (e.g. an OIDC sub, a certificate SAN, or a static-token label).

provider: String

Name of the IdentityProvider that vouched for this principal.

roles: BTreeSet<String>

Roles used by role-based authorizers.

claims: BTreeMap<String, String>

Arbitrary provider claims (e.g. tenant, email, scope).

Implementations

impl Principal

pub fn anonymous() -> Self

The unauthenticated caller. Present whenever a surface does not require authentication, so handlers never deal with an absent identity.

pub fn new(provider: impl Into<String>, subject: impl Into<String>) -> Self

Builds a principal with subject vouched for by provider.

pub fn with_role(self, role: impl Into<String>) -> Self

Adds a role (builder style).

pub fn with_claim( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Adds a claim (builder style).

pub fn is_anonymous(&self) -> bool

Whether this is the anonymous principal.

pub fn has_role(&self, role: &str) -> bool

Whether the principal holds role.

pub fn claim(&self, key: &str) -> Option<&str>

Reads a claim by key.

Trait Implementations

impl Clone for Principal

fn clone(&self) -> Principal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Principal

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

Formats the value using the given formatter.

impl Eq for Principal

impl PartialEq for Principal

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Principal