JwtAuthentication (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v3.JwtAuthentication

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, JwtAuthenticationOrBuilder, Serializable

public final class JwtAuthentication
extends com.google.protobuf.GeneratedMessageV3
implements 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
            timeout: 1s
      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
 [#next-free-field: 6]

Protobuf type envoy.extensions.filters.http.jwt_authn.v3.JwtAuthentication

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class 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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BYPASS_CORS_PREFLIGHT_FIELD_NUMBER`
`static int`	`FILTER_STATE_RULES_FIELD_NUMBER`
`static int`	`PROVIDERS_FIELD_NUMBER`
`static int`	`REQUIREMENT_MAP_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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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 timeout: 1s provider2: issuer: provider2 local_jwks: inline_string: jwks_string `map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;`
`boolean`	`containsRequirementMap(String key)` A map of unique requirement_names to JwtRequirements.
`boolean`	`equals(Object obj)`
`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.
`static JwtAuthentication`	`getDefaultInstance()`
`JwtAuthentication`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`FilterStateRule`	`getFilterStateRules()` This message specifies Jwt requirements based on stream_info.filterState.
`FilterStateRuleOrBuilder`	`getFilterStateRulesOrBuilder()` This message specifies Jwt requirements based on stream_info.filterState.
`com.google.protobuf.Parser<JwtAuthentication>`	`getParserForType()`
`Map<String,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 timeout: 1s provider2: issuer: provider2 local_jwks: inline_string: jwks_string `map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;`
`Map<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;`
`JwtProvider`	`getProvidersOrDefault(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;`
`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 timeout: 1s provider2: issuer: provider2 local_jwks: inline_string: jwks_string `map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;`
`Map<String,JwtRequirement>`	`getRequirementMap()` Deprecated.
`int`	`getRequirementMapCount()` A map of unique requirement_names to JwtRequirements.
`Map<String,JwtRequirement>`	`getRequirementMapMap()` A map of unique requirement_names to JwtRequirements.
`JwtRequirement`	`getRequirementMapOrDefault(String key, JwtRequirement defaultValue)` A map of unique requirement_names to JwtRequirements.
`JwtRequirement`	`getRequirementMapOrThrow(String key)` A map of unique requirement_names to JwtRequirements.
`RequirementRule`	`getRules(int index)` Specifies requirements based on the route matches.
`int`	`getRulesCount()` Specifies requirements based on the route matches.
`List<RequirementRule>`	`getRulesList()` Specifies requirements based on the route matches.
`RequirementRuleOrBuilder`	`getRulesOrBuilder(int index)` Specifies requirements based on the route matches.
`List<? extends RequirementRuleOrBuilder>`	`getRulesOrBuilderList()` Specifies requirements based on the route matches.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasFilterStateRules()` This message specifies Jwt requirements based on stream_info.filterState.
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static JwtAuthentication.Builder`	`newBuilder()`
`static JwtAuthentication.Builder`	`newBuilder(JwtAuthentication prototype)`
`JwtAuthentication.Builder`	`newBuilderForType()`
`protected JwtAuthentication.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static JwtAuthentication`	`parseDelimitedFrom(InputStream input)`
`static JwtAuthentication`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static JwtAuthentication`	`parseFrom(byte[] data)`
`static JwtAuthentication`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static JwtAuthentication`	`parseFrom(ByteBuffer data)`
`static JwtAuthentication`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static JwtAuthentication`	`parseFrom(com.google.protobuf.ByteString data)`
`static JwtAuthentication`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static JwtAuthentication`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static JwtAuthentication`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static JwtAuthentication`	`parseFrom(InputStream input)`
`static JwtAuthentication`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<JwtAuthentication>`	`parser()`
`JwtAuthentication.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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
- FILTER_STATE_RULES_FIELD_NUMBER
```
public static final int FILTER_STATE_RULES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BYPASS_CORS_PREFLIGHT_FIELD_NUMBER
```
public static final int BYPASS_CORS_PREFLIGHT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REQUIREMENT_MAP_FIELD_NUMBER
```
public static final int REQUIREMENT_MAP_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

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