Struct HTTPRouteRulesFiltersExternalAuth 

pub struct HTTPRouteRulesFiltersExternalAuth {
    pub backend_ref: HTTPRouteRulesFiltersExternalAuthBackendRef,
    pub forward_body: Option<HTTPRouteRulesFiltersExternalAuthForwardBody>,
    pub grpc: Option<HTTPRouteRulesFiltersExternalAuthGrpc>,
    pub http: Option<HTTPRouteRulesFiltersExternalAuthHttp>,
    pub protocol: HTTPRouteRulesFiltersExternalAuthProtocol,
}

ExternalAuth configures settings related to sending request details to an external auth service. The external service MUST authenticate the request, and MAY authorize the request as well.

If there is any problem communicating with the external service, this filter MUST fail closed.

Support: Extended

Fields

backend_ref: HTTPRouteRulesFiltersExternalAuthBackendRef

BackendRef is a reference to a backend to send authorization requests to.

The backend must speak the selected protocol (GRPC or HTTP) on the referenced port.

If the backend service requires TLS, use BackendTLSPolicy to tell the implementation to supply the TLS details to be used to connect to that backend.

forward_body: Option<HTTPRouteRulesFiltersExternalAuthForwardBody>

ForwardBody controls if requests to the authorization server should include the body of the client request; and if so, how big that body is allowed to be.

It is expected that implementations will buffer the request body up to forwardBody.maxSize bytes. Bodies over that size must be rejected with a 4xx series error (413 or 403 are common examples), and fail processing of the filter.

If unset, or forwardBody.maxSize is set to 0, then the body will not be forwarded.

Feature Name: HTTPRouteExternalAuthForwardBody

grpc: Option<HTTPRouteRulesFiltersExternalAuthGrpc>

GRPCAuthConfig contains configuration for communication with ext_authz protocol-speaking backends.

If unset, implementations must assume the default behavior for each included field is intended.

http: Option<HTTPRouteRulesFiltersExternalAuthHttp>

HTTPAuthConfig contains configuration for communication with HTTP-speaking backends.

If unset, implementations must assume the default behavior for each included field is intended.

protocol: HTTPRouteRulesFiltersExternalAuthProtocol

ExternalAuthProtocol describes which protocol to use when communicating with an ext_authz authorization server.

When this is set to GRPC, each backend must use the Envoy ext_authz protocol on the port specified in backendRefs. Requests and responses are defined in the protobufs explained at: https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto

When this is set to HTTP, each backend must respond with a 200 status code in on a successful authorization. Any other code is considered an authorization failure.

Feature Names: GRPC Support - HTTPRouteExternalAuthGRPC HTTP Support - HTTPRouteExternalAuthHTTP

Trait Implementations

impl Clone for HTTPRouteRulesFiltersExternalAuth

fn clone(&self) -> HTTPRouteRulesFiltersExternalAuth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HTTPRouteRulesFiltersExternalAuth

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

Formats the value using the given formatter.

impl Default for HTTPRouteRulesFiltersExternalAuth

fn default() -> HTTPRouteRulesFiltersExternalAuth

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HTTPRouteRulesFiltersExternalAuth

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for HTTPRouteRulesFiltersExternalAuth

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for HTTPRouteRulesFiltersExternalAuth

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

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 HTTPRouteRulesFiltersExternalAuth