Struct MiddlewareForwardAuth 

pub struct MiddlewareForwardAuth {
    pub add_auth_cookies_to_response: Option<Vec<String>>,
    pub address: Option<String>,
    pub auth_request_headers: Option<Vec<String>>,
    pub auth_response_headers: Option<Vec<String>>,
    pub auth_response_headers_regex: Option<String>,
    pub forward_body: Option<bool>,
    pub max_body_size: Option<i64>,
    pub preserve_location_header: Option<bool>,
    pub tls: Option<MiddlewareForwardAuthTls>,
    pub trust_forward_header: Option<bool>,
}

ForwardAuth holds the forward auth middleware configuration. This middleware delegates the request authentication to a Service. More info: https://doc.traefik.io/traefik/v3.3/middlewares/http/forwardauth/

Fields

add_auth_cookies_to_response: Option<Vec<String>>

AddAuthCookiesToResponse defines the list of cookies to copy from the authentication server response to the response.

address: Option<String>

Address defines the authentication server address.

auth_request_headers: Option<Vec<String>>

AuthRequestHeaders defines the list of the headers to copy from the request to the authentication server. If not set or empty then all request headers are passed.

auth_response_headers: Option<Vec<String>>

AuthResponseHeaders defines the list of headers to copy from the authentication server response and set on forwarded request, replacing any existing conflicting headers.

auth_response_headers_regex: Option<String>

AuthResponseHeadersRegex defines the regex to match headers to copy from the authentication server response and set on forwarded request, after stripping all headers that match the regex. More info: https://doc.traefik.io/traefik/v3.3/middlewares/http/forwardauth/#authresponseheadersregex

forward_body: Option<bool>

ForwardBody defines whether to send the request body to the authentication server.

max_body_size: Option<i64>

MaxBodySize defines the maximum body size in bytes allowed to be forwarded to the authentication server.

preserve_location_header: Option<bool>

PreserveLocationHeader defines whether to forward the Location header to the client as is or prefix it with the domain name of the authentication server.

tls: Option<MiddlewareForwardAuthTls>

TLS defines the configuration used to secure the connection to the authentication server.

trust_forward_header: Option<bool>

TrustForwardHeader defines whether to trust (ie: forward) all X-Forwarded-* headers.

Implementations

impl MiddlewareForwardAuth

pub fn builder() -> MiddlewareForwardAuthBuilder<((), (), (), (), (), (), (), (), (), ())>

Create a builder for building MiddlewareForwardAuth. On the builder, call .add_auth_cookies_to_response(...)(optional), .address(...)(optional), .auth_request_headers(...)(optional), .auth_response_headers(...)(optional), .auth_response_headers_regex(...)(optional), .forward_body(...)(optional), .max_body_size(...)(optional), .preserve_location_header(...)(optional), .tls(...)(optional), .trust_forward_header(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of MiddlewareForwardAuth.

Trait Implementations

impl Clone for MiddlewareForwardAuth

fn clone(&self) -> MiddlewareForwardAuth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MiddlewareForwardAuth

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

Formats the value using the given formatter.

impl Default for MiddlewareForwardAuth

fn default() -> MiddlewareForwardAuth

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MiddlewareForwardAuth

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MiddlewareForwardAuth

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for MiddlewareForwardAuth

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

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 MiddlewareForwardAuth