Class JwtProvider
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v3.JwtProvider
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,JwtProviderOrBuilder,Serializable
public final class JwtProvider
extends com.google.protobuf.GeneratedMessageV3
implements JwtProviderOrBuilder
Please see following for JWT authentication flow:
* `JSON Web Token (JWT) <https://tools.ietf.org/html/rfc7519>`_
* `The OAuth 2.0 Authorization Framework <https://tools.ietf.org/html/rfc6749>`_
* `OpenID Connect <http://openid.net/connect>`_
A JwtProvider message specifies how a JSON Web Token (JWT) can be verified. It specifies:
* issuer: the principal that issues the JWT. If specified, it has to match the ``iss`` field in JWT.
* allowed audiences: the ones in the token have to be listed here.
* how to fetch public key JWKS to verify the token signature.
* how to extract the JWT in the request.
* how to pass successfully verified token payload.
Example:
.. code-block:: yaml
issuer: https://example.com
audiences:
- bookstore_android.apps.googleusercontent.com
- bookstore_web.apps.googleusercontent.com
remote_jwks:
http_uri:
uri: https://example.com/.well-known/jwks.json
cluster: example_jwks_cluster
timeout: 1s
cache_duration:
seconds: 300
[#next-free-field: 22]
Protobuf type envoy.extensions.filters.http.jwt_authn.v3.JwtProvider- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classPlease see following for JWT authentication flow: * `JSON Web Token (JWT) <https://tools.ietf.org/html/rfc7519>`_ * `The OAuth 2.0 Authorization Framework <https://tools.ietf.org/html/rfc6749>`_ * `OpenID Connect <http://openid.net/connect>`_ A JwtProvider message specifies how a JSON Web Token (JWT) can be verified.static enumstatic final classAlters the payload representation in the request dynamic metadata to facilitate its use in matching.static interfaceNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetAudiences(int index) The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.com.google.protobuf.ByteStringgetAudiencesBytes(int index) The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.intThe list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.com.google.protobuf.ProtocolStringListThe list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.getClaimToHeaders(int index) Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.intAdd JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.getClaimToHeadersOrBuilder(int index) Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.List<? extends JwtClaimToHeaderOrBuilder>Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.booleanClears route cache in order to allow the JWT to correctly affect routing decisions.intSpecify the clock skew in seconds when verifying JWT time constraint, such as ``exp``, and ``nbf``.static JwtProviderstatic final com.google.protobuf.Descriptors.DescriptorIf non empty, the failure status ``::google::jwt_verify::Status`` for a non verified JWT will be written to StreamInfo DynamicMetadata in the format as: ``namespace`` is the jwt_authn filter name as ``envoy.filters.http.jwt_authn`` The value is the ``protobuf::Struct``.com.google.protobuf.ByteStringIf non empty, the failure status ``::google::jwt_verify::Status`` for a non verified JWT will be written to StreamInfo DynamicMetadata in the format as: ``namespace`` is the jwt_authn filter name as ``envoy.filters.http.jwt_authn`` The value is the ``protobuf::Struct``.booleanIf false, the JWT is removed in the request after a success verification.This field specifies the header name to forward a successfully verified JWT payload to the backend.com.google.protobuf.ByteStringThis field specifies the header name to forward a successfully verified JWT payload to the backend.getFromCookies(int index) JWT is sent in a cookie.com.google.protobuf.ByteStringgetFromCookiesBytes(int index) JWT is sent in a cookie.intJWT is sent in a cookie.com.google.protobuf.ProtocolStringListJWT is sent in a cookie.getFromHeaders(int index) Two fields below define where to extract the JWT from an HTTP request.intTwo fields below define where to extract the JWT from an HTTP request.Two fields below define where to extract the JWT from an HTTP request.getFromHeadersOrBuilder(int index) Two fields below define where to extract the JWT from an HTTP request.List<? extends JwtHeaderOrBuilder>Two fields below define where to extract the JWT from an HTTP request.getFromParams(int index) JWT is sent in a query parameter.com.google.protobuf.ByteStringgetFromParamsBytes(int index) JWT is sent in a query parameter.intJWT is sent in a query parameter.com.google.protobuf.ProtocolStringListJWT is sent in a query parameter.If not empty, similar to :ref:`payload_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>`, a successfully verified JWT header will be written to :ref:`Dynamic State <arch_overview_data_sharing_between_filters>` as an entry (``protobuf::Struct``) in ``envoy.filters.http.jwt_authn`` ``namespace`` with the value of this field as the key.com.google.protobuf.ByteStringIf not empty, similar to :ref:`payload_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>`, a successfully verified JWT header will be written to :ref:`Dynamic State <arch_overview_data_sharing_between_filters>` as an entry (``protobuf::Struct``) in ``envoy.filters.http.jwt_authn`` ``namespace`` with the value of this field as the key.Specify the `principal <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_ that issued the JWT, usually a URL or an email address.com.google.protobuf.ByteStringSpecify the `principal <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_ that issued the JWT, usually a URL or an email address.Enables JWT cache, its size is specified by ``jwt_cache_size``.Enables JWT cache, its size is specified by ``jwt_cache_size``.JWKS is in local data source.JWKS is in local data source.com.google.protobuf.DurationRestrict the maximum remaining lifetime of a credential from the JwtProvider.com.google.protobuf.DurationOrBuilderRestrict the maximum remaining lifetime of a credential from the JwtProvider.Normalizes the payload representation in the request metadata.Normalizes the payload representation in the request metadata.booleanWhen :ref:`forward_payload_header <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.forward_payload_header>` is specified, the base64 encoded payload will be added to the headers.com.google.protobuf.Parser<JwtProvider>If non empty, successfully verified JWT payloads will be written to StreamInfo DynamicMetadata in the format as: ``namespace`` is the jwt_authn filter name as ````envoy.filters.http.jwt_authn```` The value is the ``protobuf::Struct``.com.google.protobuf.ByteStringIf non empty, successfully verified JWT payloads will be written to StreamInfo DynamicMetadata in the format as: ``namespace`` is the jwt_authn filter name as ````envoy.filters.http.jwt_authn```` The value is the ``protobuf::Struct``.JWKS can be fetched from remote server via HTTP/HTTPS.JWKS can be fetched from remote server via HTTP/HTTPS.booleanRequires that the credential contains an `expiration <https://tools.ietf.org/html/rfc7519#section-4.1.4>`_.intRestrict the `subjects <https://tools.ietf.org/html/rfc7519#section-4.1.2>`_ that the JwtProvider can assert.Restrict the `subjects <https://tools.ietf.org/html/rfc7519#section-4.1.2>`_ that the JwtProvider can assert.inthashCode()booleanEnables JWT cache, its size is specified by ``jwt_cache_size``.booleanJWKS is in local data source.booleanRestrict the maximum remaining lifetime of a credential from the JwtProvider.booleanNormalizes the payload representation in the request metadata.booleanJWKS can be fetched from remote server via HTTP/HTTPS.booleanRestrict the `subjects <https://tools.ietf.org/html/rfc7519#section-4.1.2>`_ that the JwtProvider can assert.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic JwtProvider.Builderstatic JwtProvider.BuildernewBuilder(JwtProvider prototype) protected JwtProvider.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static JwtProviderparseDelimitedFrom(InputStream input) static JwtProviderparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static JwtProviderparseFrom(byte[] data) static JwtProviderparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static JwtProviderparseFrom(com.google.protobuf.ByteString data) static JwtProviderparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static JwtProviderparseFrom(com.google.protobuf.CodedInputStream input) static JwtProviderparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static JwtProviderparseFrom(InputStream input) static JwtProviderparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static JwtProviderparseFrom(ByteBuffer data) static JwtProviderparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<JwtProvider>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
ISSUER_FIELD_NUMBER
public static final int ISSUER_FIELD_NUMBER- See Also:
-
AUDIENCES_FIELD_NUMBER
public static final int AUDIENCES_FIELD_NUMBER- See Also:
-
SUBJECTS_FIELD_NUMBER
public static final int SUBJECTS_FIELD_NUMBER- See Also:
-
REQUIRE_EXPIRATION_FIELD_NUMBER
public static final int REQUIRE_EXPIRATION_FIELD_NUMBER- See Also:
-
MAX_LIFETIME_FIELD_NUMBER
public static final int MAX_LIFETIME_FIELD_NUMBER- See Also:
-
REMOTE_JWKS_FIELD_NUMBER
public static final int REMOTE_JWKS_FIELD_NUMBER- See Also:
-
LOCAL_JWKS_FIELD_NUMBER
public static final int LOCAL_JWKS_FIELD_NUMBER- See Also:
-
FORWARD_FIELD_NUMBER
public static final int FORWARD_FIELD_NUMBER- See Also:
-
FROM_HEADERS_FIELD_NUMBER
public static final int FROM_HEADERS_FIELD_NUMBER- See Also:
-
FROM_PARAMS_FIELD_NUMBER
public static final int FROM_PARAMS_FIELD_NUMBER- See Also:
-
FROM_COOKIES_FIELD_NUMBER
public static final int FROM_COOKIES_FIELD_NUMBER- See Also:
-
FORWARD_PAYLOAD_HEADER_FIELD_NUMBER
public static final int FORWARD_PAYLOAD_HEADER_FIELD_NUMBER- See Also:
-
PAD_FORWARD_PAYLOAD_HEADER_FIELD_NUMBER
public static final int PAD_FORWARD_PAYLOAD_HEADER_FIELD_NUMBER- See Also:
-
PAYLOAD_IN_METADATA_FIELD_NUMBER
public static final int PAYLOAD_IN_METADATA_FIELD_NUMBER- See Also:
-
NORMALIZE_PAYLOAD_IN_METADATA_FIELD_NUMBER
public static final int NORMALIZE_PAYLOAD_IN_METADATA_FIELD_NUMBER- See Also:
-
HEADER_IN_METADATA_FIELD_NUMBER
public static final int HEADER_IN_METADATA_FIELD_NUMBER- See Also:
-
FAILED_STATUS_IN_METADATA_FIELD_NUMBER
public static final int FAILED_STATUS_IN_METADATA_FIELD_NUMBER- See Also:
-
CLOCK_SKEW_SECONDS_FIELD_NUMBER
public static final int CLOCK_SKEW_SECONDS_FIELD_NUMBER- See Also:
-
JWT_CACHE_CONFIG_FIELD_NUMBER
public static final int JWT_CACHE_CONFIG_FIELD_NUMBER- See Also:
-
CLAIM_TO_HEADERS_FIELD_NUMBER
public static final int CLAIM_TO_HEADERS_FIELD_NUMBER- See Also:
-
CLEAR_ROUTE_CACHE_FIELD_NUMBER
public static final int CLEAR_ROUTE_CACHE_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
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
-
getJwksSourceSpecifierCase
- Specified by:
getJwksSourceSpecifierCasein interfaceJwtProviderOrBuilder
-
getIssuer
Specify the `principal <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_ that issued the JWT, usually a URL or an email address. It is optional. If specified, it has to match the ``iss`` field in JWT, otherwise the JWT ``iss`` field is not checked. .. note:: ``JwtRequirement`` :ref:`allow_missing <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtRequirement.allow_missing>` and :ref:`allow_missing_or_failed <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtRequirement.allow_missing_or_failed>` are implemented differently than other ``JwtRequirements``. Hence the usage of this field is different as follows if ``allow_missing`` or ``allow_missing_or_failed`` is used: * If a JWT has ``iss`` field, it needs to be specified by this field in one of ``JwtProviders``. * If a JWT doesn't have ``iss`` field, one of ``JwtProviders`` should fill this field empty. * Multiple ``JwtProviders`` should not have same value in this field. Examples: * https://securetoken.google.com * Example: 1234567-compute@developer.gserviceaccount.comstring issuer = 1;- Specified by:
getIssuerin interfaceJwtProviderOrBuilder- Returns:
- The issuer.
-
getIssuerBytes
public com.google.protobuf.ByteString getIssuerBytes()Specify the `principal <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_ that issued the JWT, usually a URL or an email address. It is optional. If specified, it has to match the ``iss`` field in JWT, otherwise the JWT ``iss`` field is not checked. .. note:: ``JwtRequirement`` :ref:`allow_missing <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtRequirement.allow_missing>` and :ref:`allow_missing_or_failed <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtRequirement.allow_missing_or_failed>` are implemented differently than other ``JwtRequirements``. Hence the usage of this field is different as follows if ``allow_missing`` or ``allow_missing_or_failed`` is used: * If a JWT has ``iss`` field, it needs to be specified by this field in one of ``JwtProviders``. * If a JWT doesn't have ``iss`` field, one of ``JwtProviders`` should fill this field empty. * Multiple ``JwtProviders`` should not have same value in this field. Examples: * https://securetoken.google.com * Example: 1234567-compute@developer.gserviceaccount.comstring issuer = 1;- Specified by:
getIssuerBytesin interfaceJwtProviderOrBuilder- Returns:
- The bytes for issuer.
-
getAudiencesList
public com.google.protobuf.ProtocolStringList getAudiencesList()The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access. A JWT containing any of these audiences will be accepted. If not specified, will not check audiences in the token. Example: .. code-block:: yaml audiences: - bookstore_android.apps.googleusercontent.com - bookstore_web.apps.googleusercontent.comrepeated string audiences = 2;- Specified by:
getAudiencesListin interfaceJwtProviderOrBuilder- Returns:
- A list containing the audiences.
-
getAudiencesCount
public int getAudiencesCount()The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access. A JWT containing any of these audiences will be accepted. If not specified, will not check audiences in the token. Example: .. code-block:: yaml audiences: - bookstore_android.apps.googleusercontent.com - bookstore_web.apps.googleusercontent.comrepeated string audiences = 2;- Specified by:
getAudiencesCountin interfaceJwtProviderOrBuilder- Returns:
- The count of audiences.
-
getAudiences
The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access. A JWT containing any of these audiences will be accepted. If not specified, will not check audiences in the token. Example: .. code-block:: yaml audiences: - bookstore_android.apps.googleusercontent.com - bookstore_web.apps.googleusercontent.comrepeated string audiences = 2;- Specified by:
getAudiencesin interfaceJwtProviderOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The audiences at the given index.
-
getAudiencesBytes
public com.google.protobuf.ByteString getAudiencesBytes(int index) The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access. A JWT containing any of these audiences will be accepted. If not specified, will not check audiences in the token. Example: .. code-block:: yaml audiences: - bookstore_android.apps.googleusercontent.com - bookstore_web.apps.googleusercontent.comrepeated string audiences = 2;- Specified by:
getAudiencesBytesin interfaceJwtProviderOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the audiences at the given index.
-
hasSubjects
public boolean hasSubjects()Restrict the `subjects <https://tools.ietf.org/html/rfc7519#section-4.1.2>`_ that the JwtProvider can assert. For instance, this could implement JWT-SVID `subject restrictions <https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md#31-subject>`_. If not specified, will not check subjects in the token. Example: .. code-block:: yaml subjects: prefix: spiffe://spiffe.example.com/.envoy.type.matcher.v3.StringMatcher subjects = 19;- Specified by:
hasSubjectsin interfaceJwtProviderOrBuilder- Returns:
- Whether the subjects field is set.
-
getSubjects
Restrict the `subjects <https://tools.ietf.org/html/rfc7519#section-4.1.2>`_ that the JwtProvider can assert. For instance, this could implement JWT-SVID `subject restrictions <https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md#31-subject>`_. If not specified, will not check subjects in the token. Example: .. code-block:: yaml subjects: prefix: spiffe://spiffe.example.com/.envoy.type.matcher.v3.StringMatcher subjects = 19;- Specified by:
getSubjectsin interfaceJwtProviderOrBuilder- Returns:
- The subjects.
-
getSubjectsOrBuilder
Restrict the `subjects <https://tools.ietf.org/html/rfc7519#section-4.1.2>`_ that the JwtProvider can assert. For instance, this could implement JWT-SVID `subject restrictions <https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md#31-subject>`_. If not specified, will not check subjects in the token. Example: .. code-block:: yaml subjects: prefix: spiffe://spiffe.example.com/.envoy.type.matcher.v3.StringMatcher subjects = 19;- Specified by:
getSubjectsOrBuilderin interfaceJwtProviderOrBuilder
-
getRequireExpiration
public boolean getRequireExpiration()Requires that the credential contains an `expiration <https://tools.ietf.org/html/rfc7519#section-4.1.4>`_. For instance, this could implement JWT-SVID `expiration restrictions <https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md#33-expiration-time>`_. Unlike ``max_lifetime``, this only requires that expiration is present, where ``max_lifetime`` also checks the value. Example: .. code-block:: yaml require_expiration: truebool require_expiration = 20;- Specified by:
getRequireExpirationin interfaceJwtProviderOrBuilder- Returns:
- The requireExpiration.
-
hasMaxLifetime
public boolean hasMaxLifetime()Restrict the maximum remaining lifetime of a credential from the JwtProvider. Credential lifetime is the difference between the current time and the expiration of the credential. For instance, the following example will reject credentials that have a lifetime longer than 24 hours. If not set, expiration checking still occurs, but there is no limit on credential lifetime. If set, takes precedence over ``require_expiration``. Example: .. code-block:: yaml max_lifetime: seconds: 86400.google.protobuf.Duration max_lifetime = 21;- Specified by:
hasMaxLifetimein interfaceJwtProviderOrBuilder- Returns:
- Whether the maxLifetime field is set.
-
getMaxLifetime
public com.google.protobuf.Duration getMaxLifetime()Restrict the maximum remaining lifetime of a credential from the JwtProvider. Credential lifetime is the difference between the current time and the expiration of the credential. For instance, the following example will reject credentials that have a lifetime longer than 24 hours. If not set, expiration checking still occurs, but there is no limit on credential lifetime. If set, takes precedence over ``require_expiration``. Example: .. code-block:: yaml max_lifetime: seconds: 86400.google.protobuf.Duration max_lifetime = 21;- Specified by:
getMaxLifetimein interfaceJwtProviderOrBuilder- Returns:
- The maxLifetime.
-
getMaxLifetimeOrBuilder
public com.google.protobuf.DurationOrBuilder getMaxLifetimeOrBuilder()Restrict the maximum remaining lifetime of a credential from the JwtProvider. Credential lifetime is the difference between the current time and the expiration of the credential. For instance, the following example will reject credentials that have a lifetime longer than 24 hours. If not set, expiration checking still occurs, but there is no limit on credential lifetime. If set, takes precedence over ``require_expiration``. Example: .. code-block:: yaml max_lifetime: seconds: 86400.google.protobuf.Duration max_lifetime = 21;- Specified by:
getMaxLifetimeOrBuilderin interfaceJwtProviderOrBuilder
-
hasRemoteJwks
public boolean hasRemoteJwks()JWKS can be fetched from remote server via HTTP/HTTPS. This field specifies the remote HTTP URI and how the fetched JWKS should be cached. Example: .. code-block:: yaml remote_jwks: http_uri: uri: https://www.googleapis.com/oauth2/v1/certs cluster: jwt.www.googleapis.com|443 timeout: 1s cache_duration: seconds: 300.envoy.extensions.filters.http.jwt_authn.v3.RemoteJwks remote_jwks = 3;- Specified by:
hasRemoteJwksin interfaceJwtProviderOrBuilder- Returns:
- Whether the remoteJwks field is set.
-
getRemoteJwks
JWKS can be fetched from remote server via HTTP/HTTPS. This field specifies the remote HTTP URI and how the fetched JWKS should be cached. Example: .. code-block:: yaml remote_jwks: http_uri: uri: https://www.googleapis.com/oauth2/v1/certs cluster: jwt.www.googleapis.com|443 timeout: 1s cache_duration: seconds: 300.envoy.extensions.filters.http.jwt_authn.v3.RemoteJwks remote_jwks = 3;- Specified by:
getRemoteJwksin interfaceJwtProviderOrBuilder- Returns:
- The remoteJwks.
-
getRemoteJwksOrBuilder
JWKS can be fetched from remote server via HTTP/HTTPS. This field specifies the remote HTTP URI and how the fetched JWKS should be cached. Example: .. code-block:: yaml remote_jwks: http_uri: uri: https://www.googleapis.com/oauth2/v1/certs cluster: jwt.www.googleapis.com|443 timeout: 1s cache_duration: seconds: 300.envoy.extensions.filters.http.jwt_authn.v3.RemoteJwks remote_jwks = 3;- Specified by:
getRemoteJwksOrBuilderin interfaceJwtProviderOrBuilder
-
hasLocalJwks
public boolean hasLocalJwks()JWKS is in local data source. It could be either in a local file or embedded in the inline_string. Example: local file .. code-block:: yaml local_jwks: filename: /etc/envoy/jwks/jwks1.txt Example: inline_string .. code-block:: yaml local_jwks: inline_string: ACADADADADA.envoy.config.core.v3.DataSource local_jwks = 4;- Specified by:
hasLocalJwksin interfaceJwtProviderOrBuilder- Returns:
- Whether the localJwks field is set.
-
getLocalJwks
JWKS is in local data source. It could be either in a local file or embedded in the inline_string. Example: local file .. code-block:: yaml local_jwks: filename: /etc/envoy/jwks/jwks1.txt Example: inline_string .. code-block:: yaml local_jwks: inline_string: ACADADADADA.envoy.config.core.v3.DataSource local_jwks = 4;- Specified by:
getLocalJwksin interfaceJwtProviderOrBuilder- Returns:
- The localJwks.
-
getLocalJwksOrBuilder
JWKS is in local data source. It could be either in a local file or embedded in the inline_string. Example: local file .. code-block:: yaml local_jwks: filename: /etc/envoy/jwks/jwks1.txt Example: inline_string .. code-block:: yaml local_jwks: inline_string: ACADADADADA.envoy.config.core.v3.DataSource local_jwks = 4;- Specified by:
getLocalJwksOrBuilderin interfaceJwtProviderOrBuilder
-
getForward
public boolean getForward()If false, the JWT is removed in the request after a success verification. If true, the JWT is not removed in the request. Default value is false. caveat: only works for from_header/from_params & has no effect for JWTs extracted through from_cookies.
bool forward = 5;- Specified by:
getForwardin interfaceJwtProviderOrBuilder- Returns:
- The forward.
-
getFromHeadersList
Two fields below define where to extract the JWT from an HTTP request. If no explicit location is specified, the following default locations are tried in order: 1. The Authorization header using the `Bearer schema <https://tools.ietf.org/html/rfc6750#section-2.1>`_. Example:: Authorization: Bearer <token>. 2. `access_token <https://tools.ietf.org/html/rfc6750#section-2.3>`_ query parameter. Multiple JWTs can be verified for a request. Each JWT has to be extracted from the locations its provider specified or from the default locations. Specify the HTTP headers to extract the JWT. For examples, following config: .. code-block:: yaml from_headers: - name: x-goog-iap-jwt-assertion can be used to extract token from header:: ``x-goog-iap-jwt-assertion: <JWT>``.repeated .envoy.extensions.filters.http.jwt_authn.v3.JwtHeader from_headers = 6;- Specified by:
getFromHeadersListin interfaceJwtProviderOrBuilder
-
getFromHeadersOrBuilderList
Two fields below define where to extract the JWT from an HTTP request. If no explicit location is specified, the following default locations are tried in order: 1. The Authorization header using the `Bearer schema <https://tools.ietf.org/html/rfc6750#section-2.1>`_. Example:: Authorization: Bearer <token>. 2. `access_token <https://tools.ietf.org/html/rfc6750#section-2.3>`_ query parameter. Multiple JWTs can be verified for a request. Each JWT has to be extracted from the locations its provider specified or from the default locations. Specify the HTTP headers to extract the JWT. For examples, following config: .. code-block:: yaml from_headers: - name: x-goog-iap-jwt-assertion can be used to extract token from header:: ``x-goog-iap-jwt-assertion: <JWT>``.repeated .envoy.extensions.filters.http.jwt_authn.v3.JwtHeader from_headers = 6;- Specified by:
getFromHeadersOrBuilderListin interfaceJwtProviderOrBuilder
-
getFromHeadersCount
public int getFromHeadersCount()Two fields below define where to extract the JWT from an HTTP request. If no explicit location is specified, the following default locations are tried in order: 1. The Authorization header using the `Bearer schema <https://tools.ietf.org/html/rfc6750#section-2.1>`_. Example:: Authorization: Bearer <token>. 2. `access_token <https://tools.ietf.org/html/rfc6750#section-2.3>`_ query parameter. Multiple JWTs can be verified for a request. Each JWT has to be extracted from the locations its provider specified or from the default locations. Specify the HTTP headers to extract the JWT. For examples, following config: .. code-block:: yaml from_headers: - name: x-goog-iap-jwt-assertion can be used to extract token from header:: ``x-goog-iap-jwt-assertion: <JWT>``.repeated .envoy.extensions.filters.http.jwt_authn.v3.JwtHeader from_headers = 6;- Specified by:
getFromHeadersCountin interfaceJwtProviderOrBuilder
-
getFromHeaders
Two fields below define where to extract the JWT from an HTTP request. If no explicit location is specified, the following default locations are tried in order: 1. The Authorization header using the `Bearer schema <https://tools.ietf.org/html/rfc6750#section-2.1>`_. Example:: Authorization: Bearer <token>. 2. `access_token <https://tools.ietf.org/html/rfc6750#section-2.3>`_ query parameter. Multiple JWTs can be verified for a request. Each JWT has to be extracted from the locations its provider specified or from the default locations. Specify the HTTP headers to extract the JWT. For examples, following config: .. code-block:: yaml from_headers: - name: x-goog-iap-jwt-assertion can be used to extract token from header:: ``x-goog-iap-jwt-assertion: <JWT>``.repeated .envoy.extensions.filters.http.jwt_authn.v3.JwtHeader from_headers = 6;- Specified by:
getFromHeadersin interfaceJwtProviderOrBuilder
-
getFromHeadersOrBuilder
Two fields below define where to extract the JWT from an HTTP request. If no explicit location is specified, the following default locations are tried in order: 1. The Authorization header using the `Bearer schema <https://tools.ietf.org/html/rfc6750#section-2.1>`_. Example:: Authorization: Bearer <token>. 2. `access_token <https://tools.ietf.org/html/rfc6750#section-2.3>`_ query parameter. Multiple JWTs can be verified for a request. Each JWT has to be extracted from the locations its provider specified or from the default locations. Specify the HTTP headers to extract the JWT. For examples, following config: .. code-block:: yaml from_headers: - name: x-goog-iap-jwt-assertion can be used to extract token from header:: ``x-goog-iap-jwt-assertion: <JWT>``.repeated .envoy.extensions.filters.http.jwt_authn.v3.JwtHeader from_headers = 6;- Specified by:
getFromHeadersOrBuilderin interfaceJwtProviderOrBuilder
-
getFromParamsList
public com.google.protobuf.ProtocolStringList getFromParamsList()JWT is sent in a query parameter. ``jwt_params`` represents the query parameter names. For example, if config is: .. code-block:: yaml from_params: - jwt_token The JWT format in query parameter is:: /path?jwt_token=<JWT>repeated string from_params = 7;- Specified by:
getFromParamsListin interfaceJwtProviderOrBuilder- Returns:
- A list containing the fromParams.
-
getFromParamsCount
public int getFromParamsCount()JWT is sent in a query parameter. ``jwt_params`` represents the query parameter names. For example, if config is: .. code-block:: yaml from_params: - jwt_token The JWT format in query parameter is:: /path?jwt_token=<JWT>repeated string from_params = 7;- Specified by:
getFromParamsCountin interfaceJwtProviderOrBuilder- Returns:
- The count of fromParams.
-
getFromParams
JWT is sent in a query parameter. ``jwt_params`` represents the query parameter names. For example, if config is: .. code-block:: yaml from_params: - jwt_token The JWT format in query parameter is:: /path?jwt_token=<JWT>repeated string from_params = 7;- Specified by:
getFromParamsin interfaceJwtProviderOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The fromParams at the given index.
-
getFromParamsBytes
public com.google.protobuf.ByteString getFromParamsBytes(int index) JWT is sent in a query parameter. ``jwt_params`` represents the query parameter names. For example, if config is: .. code-block:: yaml from_params: - jwt_token The JWT format in query parameter is:: /path?jwt_token=<JWT>repeated string from_params = 7;- Specified by:
getFromParamsBytesin interfaceJwtProviderOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the fromParams at the given index.
-
getFromCookiesList
public com.google.protobuf.ProtocolStringList getFromCookiesList()JWT is sent in a cookie. ``from_cookies`` represents the cookie names to extract from. For example, if config is: .. code-block:: yaml from_cookies: - auth-token Then JWT will be extracted from ``auth-token`` cookie in the request.
repeated string from_cookies = 13;- Specified by:
getFromCookiesListin interfaceJwtProviderOrBuilder- Returns:
- A list containing the fromCookies.
-
getFromCookiesCount
public int getFromCookiesCount()JWT is sent in a cookie. ``from_cookies`` represents the cookie names to extract from. For example, if config is: .. code-block:: yaml from_cookies: - auth-token Then JWT will be extracted from ``auth-token`` cookie in the request.
repeated string from_cookies = 13;- Specified by:
getFromCookiesCountin interfaceJwtProviderOrBuilder- Returns:
- The count of fromCookies.
-
getFromCookies
JWT is sent in a cookie. ``from_cookies`` represents the cookie names to extract from. For example, if config is: .. code-block:: yaml from_cookies: - auth-token Then JWT will be extracted from ``auth-token`` cookie in the request.
repeated string from_cookies = 13;- Specified by:
getFromCookiesin interfaceJwtProviderOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The fromCookies at the given index.
-
getFromCookiesBytes
public com.google.protobuf.ByteString getFromCookiesBytes(int index) JWT is sent in a cookie. ``from_cookies`` represents the cookie names to extract from. For example, if config is: .. code-block:: yaml from_cookies: - auth-token Then JWT will be extracted from ``auth-token`` cookie in the request.
repeated string from_cookies = 13;- Specified by:
getFromCookiesBytesin interfaceJwtProviderOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the fromCookies at the given index.
-
getForwardPayloadHeader
This field specifies the header name to forward a successfully verified JWT payload to the backend. The forwarded data is:: base64url_encoded(jwt_payload_in_JSON) If it is not specified, the payload will not be forwarded.string forward_payload_header = 8 [(.validate.rules) = { ... }- Specified by:
getForwardPayloadHeaderin interfaceJwtProviderOrBuilder- Returns:
- The forwardPayloadHeader.
-
getForwardPayloadHeaderBytes
public com.google.protobuf.ByteString getForwardPayloadHeaderBytes()This field specifies the header name to forward a successfully verified JWT payload to the backend. The forwarded data is:: base64url_encoded(jwt_payload_in_JSON) If it is not specified, the payload will not be forwarded.string forward_payload_header = 8 [(.validate.rules) = { ... }- Specified by:
getForwardPayloadHeaderBytesin interfaceJwtProviderOrBuilder- Returns:
- The bytes for forwardPayloadHeader.
-
getPadForwardPayloadHeader
public boolean getPadForwardPayloadHeader()When :ref:`forward_payload_header <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.forward_payload_header>` is specified, the base64 encoded payload will be added to the headers. Normally JWT based64 encode doesn't add padding. If this field is true, the header will be padded. This field is only relevant if :ref:`forward_payload_header <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.forward_payload_header>` is specified.
bool pad_forward_payload_header = 11;- Specified by:
getPadForwardPayloadHeaderin interfaceJwtProviderOrBuilder- Returns:
- The padForwardPayloadHeader.
-
getPayloadInMetadata
If non empty, successfully verified JWT payloads will be written to StreamInfo DynamicMetadata in the format as: ``namespace`` is the jwt_authn filter name as ````envoy.filters.http.jwt_authn```` The value is the ``protobuf::Struct``. The value of this field will be the key for its ``fields`` and the value is the ``protobuf::Struct`` converted from JWT JSON payload. For example, if payload_in_metadata is ``my_payload``: .. code-block:: yaml envoy.filters.http.jwt_authn: my_payload: iss: https://example.com sub: test@example.com aud: https://example.com exp: 1501281058string payload_in_metadata = 9;- Specified by:
getPayloadInMetadatain interfaceJwtProviderOrBuilder- Returns:
- The payloadInMetadata.
-
getPayloadInMetadataBytes
public com.google.protobuf.ByteString getPayloadInMetadataBytes()If non empty, successfully verified JWT payloads will be written to StreamInfo DynamicMetadata in the format as: ``namespace`` is the jwt_authn filter name as ````envoy.filters.http.jwt_authn```` The value is the ``protobuf::Struct``. The value of this field will be the key for its ``fields`` and the value is the ``protobuf::Struct`` converted from JWT JSON payload. For example, if payload_in_metadata is ``my_payload``: .. code-block:: yaml envoy.filters.http.jwt_authn: my_payload: iss: https://example.com sub: test@example.com aud: https://example.com exp: 1501281058string payload_in_metadata = 9;- Specified by:
getPayloadInMetadataBytesin interfaceJwtProviderOrBuilder- Returns:
- The bytes for payloadInMetadata.
-
hasNormalizePayloadInMetadata
public boolean hasNormalizePayloadInMetadata()Normalizes the payload representation in the request metadata.
.envoy.extensions.filters.http.jwt_authn.v3.JwtProvider.NormalizePayload normalize_payload_in_metadata = 18;- Specified by:
hasNormalizePayloadInMetadatain interfaceJwtProviderOrBuilder- Returns:
- Whether the normalizePayloadInMetadata field is set.
-
getNormalizePayloadInMetadata
Normalizes the payload representation in the request metadata.
.envoy.extensions.filters.http.jwt_authn.v3.JwtProvider.NormalizePayload normalize_payload_in_metadata = 18;- Specified by:
getNormalizePayloadInMetadatain interfaceJwtProviderOrBuilder- Returns:
- The normalizePayloadInMetadata.
-
getNormalizePayloadInMetadataOrBuilder
Normalizes the payload representation in the request metadata.
.envoy.extensions.filters.http.jwt_authn.v3.JwtProvider.NormalizePayload normalize_payload_in_metadata = 18;- Specified by:
getNormalizePayloadInMetadataOrBuilderin interfaceJwtProviderOrBuilder
-
getHeaderInMetadata
If not empty, similar to :ref:`payload_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>`, a successfully verified JWT header will be written to :ref:`Dynamic State <arch_overview_data_sharing_between_filters>` as an entry (``protobuf::Struct``) in ``envoy.filters.http.jwt_authn`` ``namespace`` with the value of this field as the key. For example, if ``header_in_metadata`` is ``my_header``: .. code-block:: yaml envoy.filters.http.jwt_authn: my_header: alg: JWT kid: EF71iSaosbC5C4tC6Syq1Gm647M alg: PS256 When the metadata has ``envoy.filters.http.jwt_authn`` entry already (for example if :ref:`payload_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is not empty), it will be inserted as a new entry in the same ``namespace`` as shown below: .. code-block:: yaml envoy.filters.http.jwt_authn: my_payload: iss: https://example.com sub: test@example.com aud: https://example.com exp: 1501281058 my_header: alg: JWT kid: EF71iSaosbC5C4tC6Syq1Gm647M alg: PS256 .. warning:: Using the same key name for :ref:`header_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` and :ref:`payload_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is not suggested due to potential override of existing entry, while it is not enforced during config validation.string header_in_metadata = 14;- Specified by:
getHeaderInMetadatain interfaceJwtProviderOrBuilder- Returns:
- The headerInMetadata.
-
getHeaderInMetadataBytes
public com.google.protobuf.ByteString getHeaderInMetadataBytes()If not empty, similar to :ref:`payload_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>`, a successfully verified JWT header will be written to :ref:`Dynamic State <arch_overview_data_sharing_between_filters>` as an entry (``protobuf::Struct``) in ``envoy.filters.http.jwt_authn`` ``namespace`` with the value of this field as the key. For example, if ``header_in_metadata`` is ``my_header``: .. code-block:: yaml envoy.filters.http.jwt_authn: my_header: alg: JWT kid: EF71iSaosbC5C4tC6Syq1Gm647M alg: PS256 When the metadata has ``envoy.filters.http.jwt_authn`` entry already (for example if :ref:`payload_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is not empty), it will be inserted as a new entry in the same ``namespace`` as shown below: .. code-block:: yaml envoy.filters.http.jwt_authn: my_payload: iss: https://example.com sub: test@example.com aud: https://example.com exp: 1501281058 my_header: alg: JWT kid: EF71iSaosbC5C4tC6Syq1Gm647M alg: PS256 .. warning:: Using the same key name for :ref:`header_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` and :ref:`payload_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is not suggested due to potential override of existing entry, while it is not enforced during config validation.string header_in_metadata = 14;- Specified by:
getHeaderInMetadataBytesin interfaceJwtProviderOrBuilder- Returns:
- The bytes for headerInMetadata.
-
getFailedStatusInMetadata
If non empty, the failure status ``::google::jwt_verify::Status`` for a non verified JWT will be written to StreamInfo DynamicMetadata in the format as: ``namespace`` is the jwt_authn filter name as ``envoy.filters.http.jwt_authn`` The value is the ``protobuf::Struct``. The values of this field will be ``code`` and ``message`` and they will contain the JWT authentication failure status code and a message describing the failure. For example, if failed_status_in_metadata is ``my_auth_failure_status``: .. code-block:: yaml envoy.filters.http.jwt_authn: my_auth_failure_status: code: 3 message: Jwt expiredstring failed_status_in_metadata = 16;- Specified by:
getFailedStatusInMetadatain interfaceJwtProviderOrBuilder- Returns:
- The failedStatusInMetadata.
-
getFailedStatusInMetadataBytes
public com.google.protobuf.ByteString getFailedStatusInMetadataBytes()If non empty, the failure status ``::google::jwt_verify::Status`` for a non verified JWT will be written to StreamInfo DynamicMetadata in the format as: ``namespace`` is the jwt_authn filter name as ``envoy.filters.http.jwt_authn`` The value is the ``protobuf::Struct``. The values of this field will be ``code`` and ``message`` and they will contain the JWT authentication failure status code and a message describing the failure. For example, if failed_status_in_metadata is ``my_auth_failure_status``: .. code-block:: yaml envoy.filters.http.jwt_authn: my_auth_failure_status: code: 3 message: Jwt expiredstring failed_status_in_metadata = 16;- Specified by:
getFailedStatusInMetadataBytesin interfaceJwtProviderOrBuilder- Returns:
- The bytes for failedStatusInMetadata.
-
getClockSkewSeconds
public int getClockSkewSeconds()Specify the clock skew in seconds when verifying JWT time constraint, such as ``exp``, and ``nbf``. If not specified, default is 60 seconds.
uint32 clock_skew_seconds = 10;- Specified by:
getClockSkewSecondsin interfaceJwtProviderOrBuilder- Returns:
- The clockSkewSeconds.
-
hasJwtCacheConfig
public boolean hasJwtCacheConfig()Enables JWT cache, its size is specified by ``jwt_cache_size``. Only valid JWTs are cached.
.envoy.extensions.filters.http.jwt_authn.v3.JwtCacheConfig jwt_cache_config = 12;- Specified by:
hasJwtCacheConfigin interfaceJwtProviderOrBuilder- Returns:
- Whether the jwtCacheConfig field is set.
-
getJwtCacheConfig
Enables JWT cache, its size is specified by ``jwt_cache_size``. Only valid JWTs are cached.
.envoy.extensions.filters.http.jwt_authn.v3.JwtCacheConfig jwt_cache_config = 12;- Specified by:
getJwtCacheConfigin interfaceJwtProviderOrBuilder- Returns:
- The jwtCacheConfig.
-
getJwtCacheConfigOrBuilder
Enables JWT cache, its size is specified by ``jwt_cache_size``. Only valid JWTs are cached.
.envoy.extensions.filters.http.jwt_authn.v3.JwtCacheConfig jwt_cache_config = 12;- Specified by:
getJwtCacheConfigOrBuilderin interfaceJwtProviderOrBuilder
-
getClaimToHeadersList
Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header. For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported .. literalinclude:: /_configs/repo/jwt_authn.yaml :language: yaml :lines: 44-48 :linenos: :lineno-start: 44 :caption: :download:`jwt_authn.yaml </_configs/repo/jwt_authn.yaml>` This header is only reserved for jwt claim; any other value will be overwritten.repeated .envoy.extensions.filters.http.jwt_authn.v3.JwtClaimToHeader claim_to_headers = 15;- Specified by:
getClaimToHeadersListin interfaceJwtProviderOrBuilder
-
getClaimToHeadersOrBuilderList
Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header. For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported .. literalinclude:: /_configs/repo/jwt_authn.yaml :language: yaml :lines: 44-48 :linenos: :lineno-start: 44 :caption: :download:`jwt_authn.yaml </_configs/repo/jwt_authn.yaml>` This header is only reserved for jwt claim; any other value will be overwritten.repeated .envoy.extensions.filters.http.jwt_authn.v3.JwtClaimToHeader claim_to_headers = 15;- Specified by:
getClaimToHeadersOrBuilderListin interfaceJwtProviderOrBuilder
-
getClaimToHeadersCount
public int getClaimToHeadersCount()Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header. For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported .. literalinclude:: /_configs/repo/jwt_authn.yaml :language: yaml :lines: 44-48 :linenos: :lineno-start: 44 :caption: :download:`jwt_authn.yaml </_configs/repo/jwt_authn.yaml>` This header is only reserved for jwt claim; any other value will be overwritten.repeated .envoy.extensions.filters.http.jwt_authn.v3.JwtClaimToHeader claim_to_headers = 15;- Specified by:
getClaimToHeadersCountin interfaceJwtProviderOrBuilder
-
getClaimToHeaders
Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header. For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported .. literalinclude:: /_configs/repo/jwt_authn.yaml :language: yaml :lines: 44-48 :linenos: :lineno-start: 44 :caption: :download:`jwt_authn.yaml </_configs/repo/jwt_authn.yaml>` This header is only reserved for jwt claim; any other value will be overwritten.repeated .envoy.extensions.filters.http.jwt_authn.v3.JwtClaimToHeader claim_to_headers = 15;- Specified by:
getClaimToHeadersin interfaceJwtProviderOrBuilder
-
getClaimToHeadersOrBuilder
Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header. For examples, following config: The claim must be of type; string, int, double, bool. Array type claims are not supported .. literalinclude:: /_configs/repo/jwt_authn.yaml :language: yaml :lines: 44-48 :linenos: :lineno-start: 44 :caption: :download:`jwt_authn.yaml </_configs/repo/jwt_authn.yaml>` This header is only reserved for jwt claim; any other value will be overwritten.repeated .envoy.extensions.filters.http.jwt_authn.v3.JwtClaimToHeader claim_to_headers = 15;- Specified by:
getClaimToHeadersOrBuilderin interfaceJwtProviderOrBuilder
-
getClearRouteCache
public boolean getClearRouteCache()Clears route cache in order to allow the JWT to correctly affect routing decisions. Filter clears all cached routes when: 1. The field is set to ``true``. 2. At least one ``claim_to_headers`` header is added to the request OR if ``payload_in_metadata`` is set.bool clear_route_cache = 17;- Specified by:
getClearRouteCachein interfaceJwtProviderOrBuilder- Returns:
- The clearRouteCache.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static JwtProvider parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static JwtProvider parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static JwtProvider parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static JwtProvider parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static JwtProvider parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static JwtProvider parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static JwtProvider parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static JwtProvider parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static JwtProvider parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected JwtProvider.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-