Class JwtRequirement.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,JwtRequirementOrBuilder,Cloneable
- Enclosing class:
- JwtRequirement
public static final class JwtRequirement.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
implements 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
# Example 7: A is optional (if token from A is provided, it must be valid, but also allows
missing token.)
requires_any:
requirements:
- provider_name: provider-A
- allow_missing: {}
# Example 8: A is optional and B is required.
requires_all:
requirements:
- requires_any:
requirements:
- provider_name: provider-A
- allow_missing: {}
- provider_name: provider-B
[#next-free-field: 8]
Protobuf type envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid.The requirement is always satisfied even if JWT is missing or the JWT verification fails.Extract JWT claims without performing signature validation.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) Specify a required provider with audiences.Specify a required provider name.Specify list of JwtRequirement.Specify list of JwtRequirement.clone()com.google.protobuf.EmptyThe requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid.com.google.protobuf.Empty.BuilderThe requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid.com.google.protobuf.EmptyOrBuilderThe requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid.com.google.protobuf.EmptyThe requirement is always satisfied even if JWT is missing or the JWT verification fails.com.google.protobuf.Empty.BuilderThe requirement is always satisfied even if JWT is missing or the JWT verification fails.com.google.protobuf.EmptyOrBuilderThe requirement is always satisfied even if JWT is missing or the JWT verification fails.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorExtract JWT claims without performing signature validation.Extract JWT claims without performing signature validation.Extract JWT claims without performing signature validation.Specify a required provider with audiences.Specify a required provider with audiences.Specify a required provider with audiences.Specify a required provider name.com.google.protobuf.ByteStringSpecify a required provider name.Specify list of JwtRequirement.Specify list of JwtRequirement.Specify list of JwtRequirement.Specify list of JwtRequirement.Specify list of JwtRequirement.Specify list of JwtRequirement.booleanThe requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid.booleanThe requirement is always satisfied even if JWT is missing or the JWT verification fails.booleanExtract JWT claims without performing signature validation.booleanSpecify a required provider with audiences.booleanSpecify a required provider name.booleanSpecify list of JwtRequirement.booleanSpecify list of JwtRequirement.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeAllowMissing(com.google.protobuf.Empty value) The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid.mergeAllowMissingOrFailed(com.google.protobuf.Empty value) The requirement is always satisfied even if JWT is missing or the JWT verification fails.Extract JWT claims without performing signature validation.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeFrom(JwtRequirement other) Specify a required provider with audiences.Specify list of JwtRequirement.Specify list of JwtRequirement.final JwtRequirement.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setAllowMissing(com.google.protobuf.Empty value) The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid.setAllowMissing(com.google.protobuf.Empty.Builder builderForValue) The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid.setAllowMissingOrFailed(com.google.protobuf.Empty value) The requirement is always satisfied even if JWT is missing or the JWT verification fails.setAllowMissingOrFailed(com.google.protobuf.Empty.Builder builderForValue) The requirement is always satisfied even if JWT is missing or the JWT verification fails.Extract JWT claims without performing signature validation.setExtractOnlyWithoutValidation(ExtractOnlyWithoutValidation.Builder builderForValue) Extract JWT claims without performing signature validation.Specify a required provider with audiences.setProviderAndAudiences(ProviderWithAudiences.Builder builderForValue) Specify a required provider with audiences.setProviderName(String value) Specify a required provider name.setProviderNameBytes(com.google.protobuf.ByteString value) Specify a required provider name.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) Specify list of JwtRequirement.setRequiresAll(JwtRequirementAndList.Builder builderForValue) Specify list of JwtRequirement.Specify list of JwtRequirement.setRequiresAny(JwtRequirementOrList.Builder builderForValue) Specify list of JwtRequirement.final JwtRequirement.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-
setField
public JwtRequirement.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-
setRepeatedField
public JwtRequirement.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-
addRepeatedField
public JwtRequirement.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<JwtRequirement.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-
mergeFrom
public JwtRequirement.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<JwtRequirement.Builder>- Throws:
IOException
-
getRequiresTypeCase
- Specified by:
getRequiresTypeCasein interfaceJwtRequirementOrBuilder
-
clearRequiresType
-
hasProviderName
public boolean hasProviderName()Specify a required provider name.
string provider_name = 1;- Specified by:
hasProviderNamein interfaceJwtRequirementOrBuilder- Returns:
- Whether the providerName field is set.
-
getProviderName
Specify a required provider name.
string provider_name = 1;- Specified by:
getProviderNamein interfaceJwtRequirementOrBuilder- Returns:
- The providerName.
-
getProviderNameBytes
public com.google.protobuf.ByteString getProviderNameBytes()Specify a required provider name.
string provider_name = 1;- Specified by:
getProviderNameBytesin interfaceJwtRequirementOrBuilder- Returns:
- The bytes for providerName.
-
setProviderName
Specify a required provider name.
string provider_name = 1;- Parameters:
value- The providerName to set.- Returns:
- This builder for chaining.
-
clearProviderName
Specify a required provider name.
string provider_name = 1;- Returns:
- This builder for chaining.
-
setProviderNameBytes
Specify a required provider name.
string provider_name = 1;- Parameters:
value- The bytes for providerName to set.- Returns:
- This builder for chaining.
-
hasProviderAndAudiences
public boolean hasProviderAndAudiences()Specify a required provider with audiences.
.envoy.extensions.filters.http.jwt_authn.v3.ProviderWithAudiences provider_and_audiences = 2;- Specified by:
hasProviderAndAudiencesin interfaceJwtRequirementOrBuilder- Returns:
- Whether the providerAndAudiences field is set.
-
getProviderAndAudiences
Specify a required provider with audiences.
.envoy.extensions.filters.http.jwt_authn.v3.ProviderWithAudiences provider_and_audiences = 2;- Specified by:
getProviderAndAudiencesin interfaceJwtRequirementOrBuilder- Returns:
- The providerAndAudiences.
-
setProviderAndAudiences
Specify a required provider with audiences.
.envoy.extensions.filters.http.jwt_authn.v3.ProviderWithAudiences provider_and_audiences = 2; -
setProviderAndAudiences
public JwtRequirement.Builder setProviderAndAudiences(ProviderWithAudiences.Builder builderForValue) Specify a required provider with audiences.
.envoy.extensions.filters.http.jwt_authn.v3.ProviderWithAudiences provider_and_audiences = 2; -
mergeProviderAndAudiences
Specify a required provider with audiences.
.envoy.extensions.filters.http.jwt_authn.v3.ProviderWithAudiences provider_and_audiences = 2; -
clearProviderAndAudiences
Specify a required provider with audiences.
.envoy.extensions.filters.http.jwt_authn.v3.ProviderWithAudiences provider_and_audiences = 2; -
getProviderAndAudiencesBuilder
Specify a required provider with audiences.
.envoy.extensions.filters.http.jwt_authn.v3.ProviderWithAudiences provider_and_audiences = 2; -
getProviderAndAudiencesOrBuilder
Specify a required provider with audiences.
.envoy.extensions.filters.http.jwt_authn.v3.ProviderWithAudiences provider_and_audiences = 2;- Specified by:
getProviderAndAudiencesOrBuilderin interfaceJwtRequirementOrBuilder
-
hasRequiresAny
public boolean hasRequiresAny()Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementOrList requires_any = 3;- Specified by:
hasRequiresAnyin interfaceJwtRequirementOrBuilder- Returns:
- Whether the requiresAny field is set.
-
getRequiresAny
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementOrList requires_any = 3;- Specified by:
getRequiresAnyin interfaceJwtRequirementOrBuilder- Returns:
- The requiresAny.
-
setRequiresAny
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementOrList requires_any = 3; -
setRequiresAny
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementOrList requires_any = 3; -
mergeRequiresAny
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementOrList requires_any = 3; -
clearRequiresAny
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementOrList requires_any = 3; -
getRequiresAnyBuilder
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementOrList requires_any = 3; -
getRequiresAnyOrBuilder
Specify list of JwtRequirement. Their results are OR-ed. If any one of them passes, the result is passed.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementOrList requires_any = 3;- Specified by:
getRequiresAnyOrBuilderin interfaceJwtRequirementOrBuilder
-
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.extensions.filters.http.jwt_authn.v3.JwtRequirementAndList requires_all = 4;- Specified by:
hasRequiresAllin interfaceJwtRequirementOrBuilder- Returns:
- Whether the requiresAll field is set.
-
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.extensions.filters.http.jwt_authn.v3.JwtRequirementAndList requires_all = 4;- Specified by:
getRequiresAllin interfaceJwtRequirementOrBuilder- Returns:
- The requiresAll.
-
setRequiresAll
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementAndList requires_all = 4; -
setRequiresAll
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementAndList requires_all = 4; -
mergeRequiresAll
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementAndList requires_all = 4; -
clearRequiresAll
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementAndList requires_all = 4; -
getRequiresAllBuilder
Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.
.envoy.extensions.filters.http.jwt_authn.v3.JwtRequirementAndList requires_all = 4; -
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.extensions.filters.http.jwt_authn.v3.JwtRequirementAndList requires_all = 4;- Specified by:
getRequiresAllOrBuilderin interfaceJwtRequirementOrBuilder
-
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 JWTs will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5;- Specified by:
hasAllowMissingOrFailedin interfaceJwtRequirementOrBuilder- Returns:
- Whether the allowMissingOrFailed field is set.
-
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 JWTs will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5;- Specified by:
getAllowMissingOrFailedin interfaceJwtRequirementOrBuilder- Returns:
- The allowMissingOrFailed.
-
setAllowMissingOrFailed
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 JWTs will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5; -
setAllowMissingOrFailed
public JwtRequirement.Builder setAllowMissingOrFailed(com.google.protobuf.Empty.Builder builderForValue) 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 JWTs will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5; -
mergeAllowMissingOrFailed
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 JWTs will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5; -
clearAllowMissingOrFailed
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 JWTs will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5; -
getAllowMissingOrFailedBuilder
public com.google.protobuf.Empty.Builder getAllowMissingOrFailedBuilder()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 JWTs will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5; -
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 JWTs will be verified.
.google.protobuf.Empty allow_missing_or_failed = 5;- Specified by:
getAllowMissingOrFailedOrBuilderin interfaceJwtRequirementOrBuilder
-
hasAllowMissing
public boolean hasAllowMissing()The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid. Similar to allow_missing_or_failed, this is used to only verify JWTs and pass the verified payload to another filter. The different is this mode will reject requests with invalid tokens.
.google.protobuf.Empty allow_missing = 6;- Specified by:
hasAllowMissingin interfaceJwtRequirementOrBuilder- Returns:
- Whether the allowMissing field is set.
-
getAllowMissing
public com.google.protobuf.Empty getAllowMissing()The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid. Similar to allow_missing_or_failed, this is used to only verify JWTs and pass the verified payload to another filter. The different is this mode will reject requests with invalid tokens.
.google.protobuf.Empty allow_missing = 6;- Specified by:
getAllowMissingin interfaceJwtRequirementOrBuilder- Returns:
- The allowMissing.
-
setAllowMissing
The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid. Similar to allow_missing_or_failed, this is used to only verify JWTs and pass the verified payload to another filter. The different is this mode will reject requests with invalid tokens.
.google.protobuf.Empty allow_missing = 6; -
setAllowMissing
The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid. Similar to allow_missing_or_failed, this is used to only verify JWTs and pass the verified payload to another filter. The different is this mode will reject requests with invalid tokens.
.google.protobuf.Empty allow_missing = 6; -
mergeAllowMissing
The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid. Similar to allow_missing_or_failed, this is used to only verify JWTs and pass the verified payload to another filter. The different is this mode will reject requests with invalid tokens.
.google.protobuf.Empty allow_missing = 6; -
clearAllowMissing
The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid. Similar to allow_missing_or_failed, this is used to only verify JWTs and pass the verified payload to another filter. The different is this mode will reject requests with invalid tokens.
.google.protobuf.Empty allow_missing = 6; -
getAllowMissingBuilder
public com.google.protobuf.Empty.Builder getAllowMissingBuilder()The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid. Similar to allow_missing_or_failed, this is used to only verify JWTs and pass the verified payload to another filter. The different is this mode will reject requests with invalid tokens.
.google.protobuf.Empty allow_missing = 6; -
getAllowMissingOrBuilder
public com.google.protobuf.EmptyOrBuilder getAllowMissingOrBuilder()The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid. Similar to allow_missing_or_failed, this is used to only verify JWTs and pass the verified payload to another filter. The different is this mode will reject requests with invalid tokens.
.google.protobuf.Empty allow_missing = 6;- Specified by:
getAllowMissingOrBuilderin interfaceJwtRequirementOrBuilder
-
hasExtractOnlyWithoutValidation
public boolean hasExtractOnlyWithoutValidation()Extract JWT claims without performing signature validation. This mode will decode the JWT, extract claims, and forward them as configured (via claim_to_headers, forward_payload_header, etc.) but will NOT verify the JWT signature against JWKS. .. warning:: This mode does not verify JWT authenticity. Use only in scenarios where: - JWTs come from a trusted source (e.g., internal service mesh) - Signature verification is performed elsewhere in the request path - You are in a testing period and the token issuer doesn't support JWKS yet This mode will: * Decode the JWT header and payload * Extract claims and forward them as headers * Always return success (Status::Ok) regardless of JWT validity * Log when extraction occurs This mode will NOT: * Verify the JWT signature * Validate the (issuer) claim * Validate the (audience) claim * Check not-before time (nbf claim).envoy.extensions.filters.http.jwt_authn.v3.ExtractOnlyWithoutValidation extract_only_without_validation = 7;- Specified by:
hasExtractOnlyWithoutValidationin interfaceJwtRequirementOrBuilder- Returns:
- Whether the extractOnlyWithoutValidation field is set.
-
getExtractOnlyWithoutValidation
Extract JWT claims without performing signature validation. This mode will decode the JWT, extract claims, and forward them as configured (via claim_to_headers, forward_payload_header, etc.) but will NOT verify the JWT signature against JWKS. .. warning:: This mode does not verify JWT authenticity. Use only in scenarios where: - JWTs come from a trusted source (e.g., internal service mesh) - Signature verification is performed elsewhere in the request path - You are in a testing period and the token issuer doesn't support JWKS yet This mode will: * Decode the JWT header and payload * Extract claims and forward them as headers * Always return success (Status::Ok) regardless of JWT validity * Log when extraction occurs This mode will NOT: * Verify the JWT signature * Validate the (issuer) claim * Validate the (audience) claim * Check not-before time (nbf claim).envoy.extensions.filters.http.jwt_authn.v3.ExtractOnlyWithoutValidation extract_only_without_validation = 7;- Specified by:
getExtractOnlyWithoutValidationin interfaceJwtRequirementOrBuilder- Returns:
- The extractOnlyWithoutValidation.
-
setExtractOnlyWithoutValidation
Extract JWT claims without performing signature validation. This mode will decode the JWT, extract claims, and forward them as configured (via claim_to_headers, forward_payload_header, etc.) but will NOT verify the JWT signature against JWKS. .. warning:: This mode does not verify JWT authenticity. Use only in scenarios where: - JWTs come from a trusted source (e.g., internal service mesh) - Signature verification is performed elsewhere in the request path - You are in a testing period and the token issuer doesn't support JWKS yet This mode will: * Decode the JWT header and payload * Extract claims and forward them as headers * Always return success (Status::Ok) regardless of JWT validity * Log when extraction occurs This mode will NOT: * Verify the JWT signature * Validate the (issuer) claim * Validate the (audience) claim * Check not-before time (nbf claim).envoy.extensions.filters.http.jwt_authn.v3.ExtractOnlyWithoutValidation extract_only_without_validation = 7; -
setExtractOnlyWithoutValidation
public JwtRequirement.Builder setExtractOnlyWithoutValidation(ExtractOnlyWithoutValidation.Builder builderForValue) Extract JWT claims without performing signature validation. This mode will decode the JWT, extract claims, and forward them as configured (via claim_to_headers, forward_payload_header, etc.) but will NOT verify the JWT signature against JWKS. .. warning:: This mode does not verify JWT authenticity. Use only in scenarios where: - JWTs come from a trusted source (e.g., internal service mesh) - Signature verification is performed elsewhere in the request path - You are in a testing period and the token issuer doesn't support JWKS yet This mode will: * Decode the JWT header and payload * Extract claims and forward them as headers * Always return success (Status::Ok) regardless of JWT validity * Log when extraction occurs This mode will NOT: * Verify the JWT signature * Validate the (issuer) claim * Validate the (audience) claim * Check not-before time (nbf claim).envoy.extensions.filters.http.jwt_authn.v3.ExtractOnlyWithoutValidation extract_only_without_validation = 7; -
mergeExtractOnlyWithoutValidation
Extract JWT claims without performing signature validation. This mode will decode the JWT, extract claims, and forward them as configured (via claim_to_headers, forward_payload_header, etc.) but will NOT verify the JWT signature against JWKS. .. warning:: This mode does not verify JWT authenticity. Use only in scenarios where: - JWTs come from a trusted source (e.g., internal service mesh) - Signature verification is performed elsewhere in the request path - You are in a testing period and the token issuer doesn't support JWKS yet This mode will: * Decode the JWT header and payload * Extract claims and forward them as headers * Always return success (Status::Ok) regardless of JWT validity * Log when extraction occurs This mode will NOT: * Verify the JWT signature * Validate the (issuer) claim * Validate the (audience) claim * Check not-before time (nbf claim).envoy.extensions.filters.http.jwt_authn.v3.ExtractOnlyWithoutValidation extract_only_without_validation = 7; -
clearExtractOnlyWithoutValidation
Extract JWT claims without performing signature validation. This mode will decode the JWT, extract claims, and forward them as configured (via claim_to_headers, forward_payload_header, etc.) but will NOT verify the JWT signature against JWKS. .. warning:: This mode does not verify JWT authenticity. Use only in scenarios where: - JWTs come from a trusted source (e.g., internal service mesh) - Signature verification is performed elsewhere in the request path - You are in a testing period and the token issuer doesn't support JWKS yet This mode will: * Decode the JWT header and payload * Extract claims and forward them as headers * Always return success (Status::Ok) regardless of JWT validity * Log when extraction occurs This mode will NOT: * Verify the JWT signature * Validate the (issuer) claim * Validate the (audience) claim * Check not-before time (nbf claim).envoy.extensions.filters.http.jwt_authn.v3.ExtractOnlyWithoutValidation extract_only_without_validation = 7; -
getExtractOnlyWithoutValidationBuilder
Extract JWT claims without performing signature validation. This mode will decode the JWT, extract claims, and forward them as configured (via claim_to_headers, forward_payload_header, etc.) but will NOT verify the JWT signature against JWKS. .. warning:: This mode does not verify JWT authenticity. Use only in scenarios where: - JWTs come from a trusted source (e.g., internal service mesh) - Signature verification is performed elsewhere in the request path - You are in a testing period and the token issuer doesn't support JWKS yet This mode will: * Decode the JWT header and payload * Extract claims and forward them as headers * Always return success (Status::Ok) regardless of JWT validity * Log when extraction occurs This mode will NOT: * Verify the JWT signature * Validate the (issuer) claim * Validate the (audience) claim * Check not-before time (nbf claim).envoy.extensions.filters.http.jwt_authn.v3.ExtractOnlyWithoutValidation extract_only_without_validation = 7; -
getExtractOnlyWithoutValidationOrBuilder
Extract JWT claims without performing signature validation. This mode will decode the JWT, extract claims, and forward them as configured (via claim_to_headers, forward_payload_header, etc.) but will NOT verify the JWT signature against JWKS. .. warning:: This mode does not verify JWT authenticity. Use only in scenarios where: - JWTs come from a trusted source (e.g., internal service mesh) - Signature verification is performed elsewhere in the request path - You are in a testing period and the token issuer doesn't support JWKS yet This mode will: * Decode the JWT header and payload * Extract claims and forward them as headers * Always return success (Status::Ok) regardless of JWT validity * Log when extraction occurs This mode will NOT: * Verify the JWT signature * Validate the (issuer) claim * Validate the (audience) claim * Check not-before time (nbf claim).envoy.extensions.filters.http.jwt_authn.v3.ExtractOnlyWithoutValidation extract_only_without_validation = 7;- Specified by:
getExtractOnlyWithoutValidationOrBuilderin interfaceJwtRequirementOrBuilder
-
setUnknownFields
public final JwtRequirement.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-
mergeUnknownFields
public final JwtRequirement.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtRequirement.Builder>
-