Struct Auth

#[non_exhaustive]
pub struct Auth {
    pub principal: String,
    pub audiences: Vec<String>,
    pub presenter: String,
    pub claims: Option<Struct>,
    pub access_levels: Vec<String>,
}

This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

principal: String

The authenticated principal. Reflects the issuer (iss) and subject (sub) claims within a JWT. The issuer and subject should be / delimited, with / percent-encoded within the subject fragment. For Google accounts, the principal format is: https://accounts.google.com/{id}

audiences: Vec<String>

The intended audience(s) for this authentication information. Reflects the audience (aud) claim within a JWT. The audience value(s) depends on the issuer, but typically include one or more of the following pieces of information:

• The services intended to receive the credential. For example, [https://pubsub.googleapis.com/, https://storage.googleapis.com/].
• A set of service-based scopes. For example, [https://www.googleapis.com/auth/cloud-platform].
• The client id of an app, such as the Firebase project id for JWTs from Firebase Auth.

Consult the documentation for the credential issuer to determine the information provided.

presenter: String

The authorized presenter of the credential. Reflects the optional Authorized Presenter (azp) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: “123456789012.apps.googleusercontent.com”.

claims: Option<Struct>

Structured claims presented with the credential. JWTs include {key: value} pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT:

{‘iss’: ‘accounts.google.com’, ‘sub’: ‘113289723416554971153’, ‘aud’: [‘123456789012’, ‘pubsub.googleapis.com’], ‘azp’: ‘123456789012.apps.googleusercontent.com’, ‘email’: ‘jsmith@example.com’, ‘iat’: 1353601026, ‘exp’: 1353604926}

SAML assertions are similarly specified, but with an identity provider dependent structure.

access_levels: Vec<String>

A list of access level resource names that allow resources to be accessed by authenticated requester. It is part of Secure GCP processing for the incoming request. An access level string has the format: “//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}”

Example: “//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL”

Implementations

impl Auth

pub fn new() -> Self

pub fn set_principal<T: Into<String>>(self, v: T) -> Self

Sets the value of principal.

pub fn set_presenter<T: Into<String>>(self, v: T) -> Self

Sets the value of presenter.

pub fn set_claims<T: Into<Option<Struct>>>(self, v: T) -> Self

Sets the value of claims.

pub fn set_audiences<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of audiences.

pub fn set_access_levels<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of access_levels.

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a copy 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.

impl Default for Auth

fn default() -> Auth

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Auth

where Auth: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Auth

fn typename() -> &'static str

The typename of this message.

fn to_map(&self) -> Result<Map<String, Value>, AnyError>

where Self: Sized + Serialize,

Store the value into a JSON object.

fn from_map(map: &Map<String, Value>) -> Result<Self, AnyError>

where Self: DeserializeOwned,

Extract the value from a JSON object.

impl PartialEq for Auth

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Auth

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Auth