public static final class Config.JwtAuthentication extends com.google.protobuf.GeneratedMessageV3 implements Config.JwtAuthenticationOrBuilder
This is the Envoy HTTP filter config for JWT authentication. [#not-implemented-hide:]Protobuf type
envoy.config.filter.http.jwt_authn.v2alpha.JwtAuthentication| Modifier and Type | Class and Description |
|---|---|
static class |
Config.JwtAuthentication.Builder
This is the Envoy HTTP filter config for JWT authentication.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
ALLOW_MISSING_OR_FAILED_FIELD_NUMBER |
static int |
BYPASS_FIELD_NUMBER |
static int |
RULES_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
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.
|
static Config.JwtAuthentication |
getDefaultInstance() |
Config.JwtAuthentication |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Parser<Config.JwtAuthentication> |
getParserForType() |
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.
|
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
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) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int RULES_FIELD_NUMBER
public static final int ALLOW_MISSING_OR_FAILED_FIELD_NUMBER
public static final int BYPASS_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public List<Config.JwtRule> getRulesList()
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;getRulesList in interface Config.JwtAuthenticationOrBuilderpublic List<? extends Config.JwtRuleOrBuilder> getRulesOrBuilderList()
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;getRulesOrBuilderList in interface Config.JwtAuthenticationOrBuilderpublic int getRulesCount()
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;getRulesCount in interface Config.JwtAuthenticationOrBuilderpublic Config.JwtRule getRules(int index)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;getRules in interface Config.JwtAuthenticationOrBuilderpublic Config.JwtRuleOrBuilder getRulesOrBuilder(int index)
List of JWT rules to valide.
repeated .envoy.config.filter.http.jwt_authn.v2alpha.JwtRule rules = 1;getRulesOrBuilder in interface Config.JwtAuthenticationOrBuilderpublic 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;getAllowMissingOrFailed in interface Config.JwtAuthenticationOrBuilderpublic 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;getBypassList in interface Config.JwtAuthenticationOrBuilderpublic 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;getBypassOrBuilderList in interface Config.JwtAuthenticationOrBuilderpublic 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;getBypassCount in interface Config.JwtAuthenticationOrBuilderpublic 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;getBypass in interface Config.JwtAuthenticationOrBuilderpublic 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;getBypassOrBuilder in interface Config.JwtAuthenticationOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Config.JwtAuthentication parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Config.JwtAuthentication parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Config.JwtAuthentication parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Config.JwtAuthentication parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Config.JwtAuthentication parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Config.JwtAuthentication parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Config.JwtAuthentication parseFrom(InputStream input) throws IOException
IOExceptionpublic static Config.JwtAuthentication parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Config.JwtAuthentication parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Config.JwtAuthentication parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Config.JwtAuthentication parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Config.JwtAuthentication parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Config.JwtAuthentication.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Config.JwtAuthentication.Builder newBuilder()
public static Config.JwtAuthentication.Builder newBuilder(Config.JwtAuthentication prototype)
public Config.JwtAuthentication.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Config.JwtAuthentication.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Config.JwtAuthentication getDefaultInstance()
public static com.google.protobuf.Parser<Config.JwtAuthentication> parser()
public com.google.protobuf.Parser<Config.JwtAuthentication> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Config.JwtAuthentication getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018 The Envoy Project. All rights reserved.