Skip to main content

Principal

Struct Principal 

Source
pub struct Principal { /* private fields */ }
Expand description

An issuer-namespaced subject: idp:<uuid>, nostr:<64-hex>, apikey:<id>.

§Invariants

The fields are private and both constructors (Principal::new and FromStr) validate, so every Principal value in existence satisfies its issuer’s rules. Deserialize goes through FromStr, so a JSON document cannot smuggle in an invalid one either.

Display and FromStr round-trip exactly — no normalization is performed anywhere, because normalizing would let one subject have two renderings and therefore two unequal Principals.

§Wire form

A plain JSON string ("idp:6ba7b810-9dad-11d1-80b4-00c04fd430c8"), not an object — implemented by hand rather than with #[serde(transparent)] so that deserialization can enforce validation.

§This is a name, not a proof

Holding a Principal proves nothing about authentication: it is data, parsed from a string. The proof is Authenticated, which only an Authenticator produces, and whose principal field was populated from verified material.

Implementations§

Source§

impl Principal

Source

pub fn new( issuer: Issuer, subject: impl Into<String>, ) -> Result<Self, PrincipalParseError>

Build a principal, validating the subject against the issuer’s rules.

§Errors

See PrincipalParseError.

Source

pub fn oidc(provider: &str, sub: &str) -> Result<Self, PrincipalParseError>

The principal an OIDC provider adapter mints: oidc:<provider>/<sub>.

provider is the adapter’s configured name (auth0). sub is the provider’s subject exactly as its token carries it; any :, %, quote, backslash or non-printable byte is percent-encoded, so auth0|64f1 stays auth0|64f1 and a colon-bearing subject still has one rendering that round-trips through Display and FromStr.

Source

pub fn idp(uuid: &Uuid) -> Self

An idp-minted principal from a UUID.

Source

pub fn from_legacy_user_id(user_id: &str) -> Option<Self>

Interpret a legacy bare user_id as an idp principal.

This is the bridge that makes AuthContext::principal and AuthContext::user_id agree by construction: today’s user_id is a plexus-idp-minted UUID v4 reused verbatim as the JWT sub, so idp:<user_id> is the same identity under a namespaced name.

Returns None for anything that is not a canonical hyphenated UUID — notably "anonymous", and any user_id minted by a system that is not plexus-idp. A None here means “this context has no principal we can name”, never “this context is authenticated as something else”.

Source

pub fn issuer(&self) -> Issuer

Who vouches for this subject.

Source

pub fn subject(&self) -> &str

The issuer-scoped subject, without the prefix.

Source

pub fn as_legacy_user_id(&self) -> String

The value this principal contributes to the legacy AuthContext::user_id field.

For idp: principals this is the bare subject — byte-identical to what plexus-idp writes today, so nothing that reads user_id observes any change. For every other issuer it is the full namespaced string (nostr:abc…), because a nostr pubkey and an idp UUID share no namespace and must never collide in a column that callers treat as a unique user key.

Trait Implementations§

Source§

impl Clone for Principal

Source§

fn clone(&self) -> Self

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 Principal

Source§

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

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

impl<'de> Deserialize<'de> for Principal

Source§

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

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

impl Display for Principal

Source§

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

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

impl Eq for Principal

Source§

impl FromStr for Principal

Source§

type Err = PrincipalParseError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Principal

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Principal

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for Principal

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Principal

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for Principal

Source§

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

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

impl StructuralPartialEq for Principal

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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