envoy.config.filter.http.jwt_authn.v2alpha

Interface Config.JwtAuthenticationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Config.JwtAuthentication, Config.JwtAuthentication.Builder

Enclosing class:

Config

public static interface Config.JwtAuthenticationOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAllowMissingOrFailed() If true, the request is allowed if JWT is missing or JWT verification fails.
RouteOuterClass.RouteMatch	getBypass(int index) This field lists the patterns allowed to bypass JWT verification.
int	getBypassCount() This field lists the patterns allowed to bypass JWT verification.
List<RouteOuterClass.RouteMatch>	getBypassList() This field lists the patterns allowed to bypass JWT verification.
RouteOuterClass.RouteMatchOrBuilder	getBypassOrBuilder(int index) This field lists the patterns allowed to bypass JWT verification.
List<? extends RouteOuterClass.RouteMatchOrBuilder>	getBypassOrBuilderList() This field lists the patterns allowed to bypass JWT verification.
Config.JwtRule	getRules(int index) List of JWT rules to valide.
int	getRulesCount() List of JWT rules to valide.
List<Config.JwtRule>	getRulesList() List of JWT rules to valide.
Config.JwtRuleOrBuilder	getRulesOrBuilder(int index) List of JWT rules to valide.
List<? extends Config.JwtRuleOrBuilder>	getRulesOrBuilderList() List of JWT rules to valide.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getRulesList

List<Config.JwtRule> getRulesList()

 List of JWT rules to valide.
 

repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;

getRules

Config.JwtRule getRules(int index)

 List of JWT rules to valide.
 

repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;

getRulesCount

int getRulesCount()

 List of JWT rules to valide.
 

repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;

getRulesOrBuilderList

List<? extends Config.JwtRuleOrBuilder> getRulesOrBuilderList()

 List of JWT rules to valide.
 

repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;

getRulesOrBuilder

Config.JwtRuleOrBuilder getRulesOrBuilder(int index)

 List of JWT rules to valide.
 

repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;

getAllowMissingOrFailed

boolean getAllowMissingOrFailed()

 If true, the request is allowed if JWT is missing or JWT verification fails.
 Default is false, a request without JWT or failed JWT verification is not allowed.
 

bool allow_missing_or_failed = 2;

getBypassList

List<RouteOuterClass.RouteMatch> getBypassList()

 This field lists the patterns allowed to bypass JWT verification. This only applies when
 `allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
 will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
 for CORS and some health checking paths.
 Examples: bypass all CORS options requests
 .. code-block:: yaml
   bypass:
   - headers:
     - name: :method
       value: OPTIONS
   - headers:
     - name: :path
       regex_match: /.*
 Examples: bypass /healthz check
 .. code-block:: yaml
   bypass:
   - headers:
     - name: :method
       value: GET
   - headers:
     - name: :path
       exact_match: /healthz
 

repeated .envoy.api.v2.route.RouteMatch bypass = 3;

getBypass

RouteOuterClass.RouteMatch getBypass(int index)

 This field lists the patterns allowed to bypass JWT verification. This only applies when
 `allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
 will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
 for CORS and some health checking paths.
 Examples: bypass all CORS options requests
 .. code-block:: yaml
   bypass:
   - headers:
     - name: :method
       value: OPTIONS
   - headers:
     - name: :path
       regex_match: /.*
 Examples: bypass /healthz check
 .. code-block:: yaml
   bypass:
   - headers:
     - name: :method
       value: GET
   - headers:
     - name: :path
       exact_match: /healthz
 

repeated .envoy.api.v2.route.RouteMatch bypass = 3;

getBypassCount

int getBypassCount()

 This field lists the patterns allowed to bypass JWT verification. This only applies when
 `allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
 will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
 for CORS and some health checking paths.
 Examples: bypass all CORS options requests
 .. code-block:: yaml
   bypass:
   - headers:
     - name: :method
       value: OPTIONS
   - headers:
     - name: :path
       regex_match: /.*
 Examples: bypass /healthz check
 .. code-block:: yaml
   bypass:
   - headers:
     - name: :method
       value: GET
   - headers:
     - name: :path
       exact_match: /healthz
 

repeated .envoy.api.v2.route.RouteMatch bypass = 3;

getBypassOrBuilderList

List<? extends RouteOuterClass.RouteMatchOrBuilder> getBypassOrBuilderList()

 This field lists the patterns allowed to bypass JWT verification. This only applies when
 `allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
 will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
 for CORS and some health checking paths.
 Examples: bypass all CORS options requests
 .. code-block:: yaml
   bypass:
   - headers:
     - name: :method
       value: OPTIONS
   - headers:
     - name: :path
       regex_match: /.*
 Examples: bypass /healthz check
 .. code-block:: yaml
   bypass:
   - headers:
     - name: :method
       value: GET
   - headers:
     - name: :path
       exact_match: /healthz
 

repeated .envoy.api.v2.route.RouteMatch bypass = 3;

getBypassOrBuilder

RouteOuterClass.RouteMatchOrBuilder getBypassOrBuilder(int index)

 This field lists the patterns allowed to bypass JWT verification. This only applies when
 `allow_missing_or_failed_jwt` is false. Under this config, if a request doesn't have JWT, it
 will be rejected. But some requests still needed to be forwarded without JWT, such as OPTIONS
 for CORS and some health checking paths.
 Examples: bypass all CORS options requests
 .. code-block:: yaml
   bypass:
   - headers:
     - name: :method
       value: OPTIONS
   - headers:
     - name: :path
       regex_match: /.*
 Examples: bypass /healthz check
 .. code-block:: yaml
   bypass:
   - headers:
     - name: :method
       value: GET
   - headers:
     - name: :path
       exact_match: /healthz
 

repeated .envoy.api.v2.route.RouteMatch bypass = 3;