envoy.config.filter.http.jwt_authn.v2alpha

Class Config.JwtAuthentication

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

envoy.config.filter.http.jwt_authn.v2alpha.Config.JwtAuthentication

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Config.JwtAuthenticationOrBuilder, Serializable

Enclosing class:

Config

public static final class Config.JwtAuthentication
extends com.google.protobuf.GeneratedMessageV3
implements Config.JwtAuthenticationOrBuilder

 This is the Envoy HTTP filter config for JWT authentication.
 For example:
 .. 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
      provider2:
        issuer: issuer2
        local_jwks:
          inline_string: jwks_string
   rules:
      # Not jwt verification is required for /health path
      - match:
          prefix: "/health"
      # Jwt verification for provider1 is required for path prefixed with "prefix"
      - match:
          prefix: "/prefix"
        requires:
          provider_name: "provider1"
      # Jwt verification for either provider1 or provider2 is required for all other requests.
      - match:
          prefix: "/"
        requires:
          requires_any:
            requirements:
              - provider_name: "provider1"
              - provider_name: "provider2"
 

Protobuf type envoy.config.filter.http.jwt_authn.v2alpha.JwtAuthentication

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.JwtAuthentication.Builder This is the Envoy HTTP filter config for JWT authentication.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROVIDERS_FIELD_NUMBER
static int	RULES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsProviders(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 provider2: issuer: provider2 local_jwks: inline_string: jwks_string map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;
boolean	equals(Object obj)
static Config.JwtAuthentication	getDefaultInstance()
Config.JwtAuthentication	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<Config.JwtAuthentication>	getParserForType()
Map<String,Config.JwtProvider>	getProviders() Deprecated.
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 provider2: issuer: provider2 local_jwks: inline_string: jwks_string map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;
Map<String,Config.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 provider2: issuer: provider2 local_jwks: inline_string: jwks_string map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;
Config.JwtProvider	getProvidersOrDefault(String key, Config.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 provider2: issuer: provider2 local_jwks: inline_string: jwks_string map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;
Config.JwtProvider	getProvidersOrThrow(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 provider2: issuer: provider2 local_jwks: inline_string: jwks_string map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;
Config.RequirementRule	getRules(int index) Specifies requirements based on the route matches.
int	getRulesCount() Specifies requirements based on the route matches.
List<Config.RequirementRule>	getRulesList() Specifies requirements based on the route matches.
Config.RequirementRuleOrBuilder	getRulesOrBuilder(int index) Specifies requirements based on the route matches.
List<? extends Config.RequirementRuleOrBuilder>	getRulesOrBuilderList() Specifies requirements based on the route matches.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static Config.JwtAuthentication.Builder	newBuilder()
static Config.JwtAuthentication.Builder	newBuilder(Config.JwtAuthentication prototype)
Config.JwtAuthentication.Builder	newBuilderForType()
protected Config.JwtAuthentication.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Config.JwtAuthentication	parseDelimitedFrom(InputStream input)
static Config.JwtAuthentication	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.JwtAuthentication	parseFrom(byte[] data)
static Config.JwtAuthentication	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.JwtAuthentication	parseFrom(ByteBuffer data)
static Config.JwtAuthentication	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.JwtAuthentication	parseFrom(com.google.protobuf.ByteString data)
static Config.JwtAuthentication	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.JwtAuthentication	parseFrom(com.google.protobuf.CodedInputStream input)
static Config.JwtAuthentication	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.JwtAuthentication	parseFrom(InputStream input)
static Config.JwtAuthentication	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Config.JwtAuthentication>	parser()
Config.JwtAuthentication.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PROVIDERS_FIELD_NUMBER

public static final int PROVIDERS_FIELD_NUMBER

See Also:

Constant Field Values

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getProvidersCount

public int getProvidersCount()

Description copied from interface: Config.JwtAuthenticationOrBuilder

 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
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
 

map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;

Specified by:

getProvidersCount in interface Config.JwtAuthenticationOrBuilder

containsProviders

public boolean containsProviders(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
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
 

map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;

Specified by:

containsProviders in interface Config.JwtAuthenticationOrBuilder

getProviders

@Deprecated
public Map<String,Config.JwtProvider> getProviders()

Deprecated.

Use getProvidersMap() instead.

Specified by:

getProviders in interface Config.JwtAuthenticationOrBuilder

getProvidersMap

public Map<String,Config.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
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
 

map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;

Specified by:

getProvidersMap in interface Config.JwtAuthenticationOrBuilder

getProvidersOrDefault

public Config.JwtProvider getProvidersOrDefault(String key,
                                                Config.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
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
 

map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;

Specified by:

getProvidersOrDefault in interface Config.JwtAuthenticationOrBuilder

getProvidersOrThrow

public Config.JwtProvider getProvidersOrThrow(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
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
 

map<string, .envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider> providers = 1;

Specified by:

getProvidersOrThrow in interface Config.JwtAuthenticationOrBuilder

getRulesList

public List<Config.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.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;

Specified by:

getRulesList in interface Config.JwtAuthenticationOrBuilder

getRulesOrBuilderList

public List<? extends Config.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.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;

Specified by:

getRulesOrBuilderList in interface Config.JwtAuthenticationOrBuilder

getRulesCount

public 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.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;

Specified by:

getRulesCount in interface Config.JwtAuthenticationOrBuilder

getRules

public Config.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.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;

Specified by:

getRules in interface Config.JwtAuthenticationOrBuilder

getRulesOrBuilder

public Config.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.config.filter.http.jwt_authn.v2alpha.RequirementRule rules = 2;

Specified by:

getRulesOrBuilder in interface Config.JwtAuthenticationOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Config.JwtAuthentication parseFrom(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.JwtAuthentication parseFrom(ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.JwtAuthentication parseFrom(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.JwtAuthentication parseFrom(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.JwtAuthentication parseFrom(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.JwtAuthentication parseFrom(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.JwtAuthentication parseFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

public static Config.JwtAuthentication parseFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static Config.JwtAuthentication parseDelimitedFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static Config.JwtAuthentication parseDelimitedFrom(InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

parseFrom

public static Config.JwtAuthentication parseFrom(com.google.protobuf.CodedInputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

public static Config.JwtAuthentication parseFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

newBuilderForType

public Config.JwtAuthentication.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Config.JwtAuthentication.Builder newBuilder()

newBuilder

public static Config.JwtAuthentication.Builder newBuilder(Config.JwtAuthentication prototype)

toBuilder

public Config.JwtAuthentication.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Config.JwtAuthentication.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Config.JwtAuthentication getDefaultInstance()

parser

public static com.google.protobuf.Parser<Config.JwtAuthentication> parser()

getParserForType

public com.google.protobuf.Parser<Config.JwtAuthentication> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Config.JwtAuthentication getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder