Struct AuthProvider 

#[non_exhaustive]
pub struct AuthProvider {
    pub id: String,
    pub issuer: String,
    pub jwks_uri: String,
    pub audiences: String,
    pub authorization_url: String,
    pub jwt_locations: Vec<JwtLocation>,
    /* private fields */
}

Configuration for an authentication provider, including support for JSON Web Token (JWT).

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.

id: String

The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id.

Example: “bookstore_auth”.

issuer: String

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address.

Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

jwks_uri: String

URL of the provider’s public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document:

• can be retrieved from OpenID Discovery of the issuer.
• can be inferred from the email domain of the issuer (e.g. a Google service account).

Example: https://www.googleapis.com/oauth2/v1/certs

audiences: String

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences:

• “https://[service.name]/[google.protobuf.Api.name]”
• “https://[service.name]/” will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences:

https://library-example.googleapis.com/google.example.library.v1.LibraryService

• https://library-example.googleapis.com/

Example:

audiences: bookstore_android.apps.googleusercontent.com,
           bookstore_web.apps.googleusercontent.com

authorization_url: String

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

jwt_locations: Vec<JwtLocation>

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations)

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

If not specified, default to use following 3 locations:

1. Authorization: Bearer
2. x-goog-iap-jwt-assertion
3. access_token query parameter

Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: “Bearer “
• header: x-goog-iap-jwt-assertion
• query: access_token

Implementations

impl AuthProvider

pub fn new() -> Self

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

Sets the value of id.

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

Sets the value of issuer.

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

Sets the value of jwks_uri.

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

Sets the value of audiences.

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

Sets the value of authorization_url.

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

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

Sets the value of jwt_locations.

Trait Implementations

impl Clone for AuthProvider

fn clone(&self) -> AuthProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthProvider

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

Formats the value using the given formatter.

impl Default for AuthProvider

fn default() -> AuthProvider

Returns the “default value” for a type.

impl Message for AuthProvider

fn typename() -> &'static str

The typename of this message.

impl PartialEq for AuthProvider

fn eq(&self, other: &AuthProvider) -> 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 StructuralPartialEq for AuthProvider