envoy.config.filter.http.jwt_authn.v2alpha

Class Config.JwtRequirement

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

Config

public static final class Config.JwtRequirement
extends com.google.protobuf.GeneratedMessageV3
implements Config.JwtRequirementOrBuilder

 This message specifies a Jwt requirement. An empty message means JWT verification is not
 required. Here are some config examples:
 .. code-block:: yaml
  # Example 1: not required with an empty message
  # Example 2: require A
  provider_name: "provider-A"
  # Example 3: require A or B
  requires_any:
    requirements:
      - provider_name: "provider-A"
      - provider_name: "provider-B"
  # Example 4: require A and B
  requires_all:
    requirements:
      - provider_name: "provider-A"
      - provider_name: "provider-B"
  # Example 5: require A and (B or C)
  requires_all:
    requirements:
      - provider_name: "provider-A"
      - requires_any:
        requirements:
          - provider_name: "provider-B"
          - provider_name: "provider-C"
  # Example 6: require A or (B and C)
  requires_any:
    requirements:
      - provider_name: "provider-A"
      - requires_all:
        requirements:
          - provider_name: "provider-B"
          - provider_name: "provider-C"
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.JwtRequirement.Builder This message specifies a Jwt requirement.
static class	Config.JwtRequirement.RequiresTypeCase

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	ALLOW_MISSING_OR_FAILED_FIELD_NUMBER
static int	PROVIDER_AND_AUDIENCES_FIELD_NUMBER
static int	PROVIDER_NAME_FIELD_NUMBER
static int	REQUIRES_ALL_FIELD_NUMBER
static int	REQUIRES_ANY_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	equals(Object obj)
com.google.protobuf.Empty	getAllowMissingOrFailed() The requirement is always satisfied even if JWT is missing or the JWT verification fails.
com.google.protobuf.EmptyOrBuilder	getAllowMissingOrFailedOrBuilder() The requirement is always satisfied even if JWT is missing or the JWT verification fails.
static Config.JwtRequirement	getDefaultInstance()
Config.JwtRequirement	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<Config.JwtRequirement>	getParserForType()
Config.ProviderWithAudiences	getProviderAndAudiences() Specify a required provider with audiences.
Config.ProviderWithAudiencesOrBuilder	getProviderAndAudiencesOrBuilder() Specify a required provider with audiences.
String	getProviderName() Specify a required provider name.
com.google.protobuf.ByteString	getProviderNameBytes() Specify a required provider name.
Config.JwtRequirementAndList	getRequiresAll() Specify list of JwtRequirement.
Config.JwtRequirementAndListOrBuilder	getRequiresAllOrBuilder() Specify list of JwtRequirement.
Config.JwtRequirementOrList	getRequiresAny() Specify list of JwtRequirement.
Config.JwtRequirementOrListOrBuilder	getRequiresAnyOrBuilder() Specify list of JwtRequirement.
Config.JwtRequirement.RequiresTypeCase	getRequiresTypeCase()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasAllowMissingOrFailed() The requirement is always satisfied even if JWT is missing or the JWT verification fails.
int	hashCode()
boolean	hasProviderAndAudiences() Specify a required provider with audiences.
boolean	hasRequiresAll() Specify list of JwtRequirement.
boolean	hasRequiresAny() Specify list of JwtRequirement.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Config.JwtRequirement.Builder	newBuilder()
static Config.JwtRequirement.Builder	newBuilder(Config.JwtRequirement prototype)
Config.JwtRequirement.Builder	newBuilderForType()
protected Config.JwtRequirement.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Config.JwtRequirement	parseDelimitedFrom(InputStream input)
static Config.JwtRequirement	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.JwtRequirement	parseFrom(byte[] data)
static Config.JwtRequirement	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.JwtRequirement	parseFrom(ByteBuffer data)
static Config.JwtRequirement	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.JwtRequirement	parseFrom(com.google.protobuf.ByteString data)
static Config.JwtRequirement	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.JwtRequirement	parseFrom(com.google.protobuf.CodedInputStream input)
static Config.JwtRequirement	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Config.JwtRequirement	parseFrom(InputStream input)
static Config.JwtRequirement	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Config.JwtRequirement>	parser()
Config.JwtRequirement.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, internalGetMapField, 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

PROVIDER_NAME_FIELD_NUMBER

public static final int PROVIDER_NAME_FIELD_NUMBER

See Also:

Constant Field Values

PROVIDER_AND_AUDIENCES_FIELD_NUMBER

public static final int PROVIDER_AND_AUDIENCES_FIELD_NUMBER

See Also:

Constant Field Values

REQUIRES_ANY_FIELD_NUMBER

public static final int REQUIRES_ANY_FIELD_NUMBER

See Also:

Constant Field Values

REQUIRES_ALL_FIELD_NUMBER

public static final int REQUIRES_ALL_FIELD_NUMBER

See Also:

Constant Field Values

ALLOW_MISSING_OR_FAILED_FIELD_NUMBER

public static final int ALLOW_MISSING_OR_FAILED_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()

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getRequiresTypeCase

public Config.JwtRequirement.RequiresTypeCase getRequiresTypeCase()

Specified by:

getRequiresTypeCase in interface Config.JwtRequirementOrBuilder

getProviderName

public String getProviderName()

 Specify a required provider name.
 

string provider_name = 1;

Specified by:

getProviderName in interface Config.JwtRequirementOrBuilder

getProviderNameBytes

public com.google.protobuf.ByteString getProviderNameBytes()

 Specify a required provider name.
 

string provider_name = 1;

Specified by:

getProviderNameBytes in interface Config.JwtRequirementOrBuilder

hasProviderAndAudiences

public boolean hasProviderAndAudiences()

 Specify a required provider with audiences.
 

.envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences provider_and_audiences = 2;

Specified by:

hasProviderAndAudiences in interface Config.JwtRequirementOrBuilder

getProviderAndAudiences

public Config.ProviderWithAudiences getProviderAndAudiences()

 Specify a required provider with audiences.
 

.envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences provider_and_audiences = 2;

Specified by:

getProviderAndAudiences in interface Config.JwtRequirementOrBuilder

getProviderAndAudiencesOrBuilder

public Config.ProviderWithAudiencesOrBuilder getProviderAndAudiencesOrBuilder()

 Specify a required provider with audiences.
 

.envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences provider_and_audiences = 2;

Specified by:

getProviderAndAudiencesOrBuilder in interface Config.JwtRequirementOrBuilder

hasRequiresAny

public boolean hasRequiresAny()

 Specify list of JwtRequirement. Their results are OR-ed.
 If any one of them passes, the result is passed.
 

.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList requires_any = 3;

Specified by:

hasRequiresAny in interface Config.JwtRequirementOrBuilder

getRequiresAny

public Config.JwtRequirementOrList getRequiresAny()

 Specify list of JwtRequirement. Their results are OR-ed.
 If any one of them passes, the result is passed.
 

.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList requires_any = 3;

Specified by:

getRequiresAny in interface Config.JwtRequirementOrBuilder

getRequiresAnyOrBuilder

public Config.JwtRequirementOrListOrBuilder getRequiresAnyOrBuilder()

 Specify list of JwtRequirement. Their results are OR-ed.
 If any one of them passes, the result is passed.
 

.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList requires_any = 3;

Specified by:

getRequiresAnyOrBuilder in interface Config.JwtRequirementOrBuilder

hasRequiresAll

public boolean hasRequiresAll()

 Specify list of JwtRequirement. Their results are AND-ed.
 All of them must pass, if one of them fails or missing, it fails.
 

.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList requires_all = 4;

Specified by:

hasRequiresAll in interface Config.JwtRequirementOrBuilder

getRequiresAll

public Config.JwtRequirementAndList getRequiresAll()

 Specify list of JwtRequirement. Their results are AND-ed.
 All of them must pass, if one of them fails or missing, it fails.
 

.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList requires_all = 4;

Specified by:

getRequiresAll in interface Config.JwtRequirementOrBuilder

getRequiresAllOrBuilder

public Config.JwtRequirementAndListOrBuilder getRequiresAllOrBuilder()

 Specify list of JwtRequirement. Their results are AND-ed.
 All of them must pass, if one of them fails or missing, it fails.
 

.envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList requires_all = 4;

Specified by:

getRequiresAllOrBuilder in interface Config.JwtRequirementOrBuilder

hasAllowMissingOrFailed

public boolean hasAllowMissingOrFailed()

 The requirement is always satisfied even if JWT is missing or the JWT
 verification fails. A typical usage is: this filter is used to only verify
 JWTs and pass the verified JWT payloads to another filter, the other filter
 will make decision. In this mode, all JWT tokens will be verified.
 

.google.protobuf.Empty allow_missing_or_failed = 5;

Specified by:

hasAllowMissingOrFailed in interface Config.JwtRequirementOrBuilder

getAllowMissingOrFailed

public com.google.protobuf.Empty getAllowMissingOrFailed()

 The requirement is always satisfied even if JWT is missing or the JWT
 verification fails. A typical usage is: this filter is used to only verify
 JWTs and pass the verified JWT payloads to another filter, the other filter
 will make decision. In this mode, all JWT tokens will be verified.
 

.google.protobuf.Empty allow_missing_or_failed = 5;

Specified by:

getAllowMissingOrFailed in interface Config.JwtRequirementOrBuilder

getAllowMissingOrFailedOrBuilder

public com.google.protobuf.EmptyOrBuilder getAllowMissingOrFailedOrBuilder()

 The requirement is always satisfied even if JWT is missing or the JWT
 verification fails. A typical usage is: this filter is used to only verify
 JWTs and pass the verified JWT payloads to another filter, the other filter
 will make decision. In this mode, all JWT tokens will be verified.
 

.google.protobuf.Empty allow_missing_or_failed = 5;

Specified by:

getAllowMissingOrFailedOrBuilder in interface Config.JwtRequirementOrBuilder

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.JwtRequirement parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Config.JwtRequirement 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.JwtRequirement parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Config.JwtRequirement.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Config.JwtRequirement.Builder newBuilder()

newBuilder

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

toBuilder

public Config.JwtRequirement.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Config.JwtRequirement getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Config.JwtRequirement> 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.JwtRequirement getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder