Package io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v3

Interface JwtAuthenticationOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    JwtAuthentication, JwtAuthentication.Builder
    public interface JwtAuthenticationOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getProvidersCount

        int getProvidersCount()
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;

      • containsProviders

        boolean containsProviders​(java.lang.String key)
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;

      • getProvidersMap

        java.util.Map<java.lang.String,​JwtProvider> getProvidersMap()
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;

      • getProvidersOrDefault

        JwtProvider getProvidersOrDefault​(java.lang.String key,
                                  JwtProvider defaultValue)
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;

      • getProvidersOrThrow

        JwtProvider getProvidersOrThrow​(java.lang.String key)
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;

      • getRulesList

        java.util.List<RequirementRule> getRulesList()
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • getRules

        RequirementRule getRules​(int index)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • getRulesCount

        int getRulesCount()
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • getRulesOrBuilderList

        java.util.List<? extends RequirementRuleOrBuilder> getRulesOrBuilderList()
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • getRulesOrBuilder

        RequirementRuleOrBuilder getRulesOrBuilder​(int index)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • hasFilterStateRules

        boolean hasFilterStateRules()
         This message specifies Jwt requirements based on stream_info.filterState.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 The ``rules`` field above is checked first, if it could not find any matches,
 check this one.
        .envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule filter_state_rules = 3;
        Returns:
        Whether the filterStateRules field is set.

      • getFilterStateRules

        FilterStateRule getFilterStateRules()
         This message specifies Jwt requirements based on stream_info.filterState.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 The ``rules`` field above is checked first, if it could not find any matches,
 check this one.
        .envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule filter_state_rules = 3;
        Returns:
        The filterStateRules.

      • getFilterStateRulesOrBuilder

        FilterStateRuleOrBuilder getFilterStateRulesOrBuilder()
         This message specifies Jwt requirements based on stream_info.filterState.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 The ``rules`` field above is checked first, if it could not find any matches,
 check this one.
        .envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule filter_state_rules = 3;

      • getBypassCorsPreflight

        boolean getBypassCorsPreflight()
         When set to true, bypass the `CORS preflight request
 <http://www.w3.org/TR/cors/#cross-origin-request-with-preflight>`_ regardless of JWT
 requirements specified in the rules.
        bool bypass_cors_preflight = 4;
        Returns:
        The bypassCorsPreflight.

      • getRequirementMapCount

        int getRequirementMapCount()
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;

      • containsRequirementMap

        boolean containsRequirementMap​(java.lang.String key)
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;

      • getRequirementMapMap

        java.util.Map<java.lang.String,​JwtRequirement> getRequirementMapMap()
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;

      • getRequirementMapOrDefault

        JwtRequirement getRequirementMapOrDefault​(java.lang.String key,
                                          JwtRequirement defaultValue)
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;

      • getRequirementMapOrThrow

        JwtRequirement getRequirementMapOrThrow​(java.lang.String key)
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;