Class JwtProvider.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- com.google.protobuf.GeneratedMessageV3.Builder<JwtProvider.Builder>
-
- io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v3.JwtProvider.Builder
-
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,JwtProviderOrBuilder,Cloneable
- Enclosing class:
- JwtProvider
public static final class JwtProvider.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<JwtProvider.Builder> 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 JWT token 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: 15]Protobuf typeenvoy.extensions.filters.http.jwt_authn.v3.JwtProvider
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description JwtProvider.BuilderaddAllAudiences(Iterable<String> values)The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.JwtProvider.BuilderaddAllFromCookies(Iterable<String> values)JWT is sent in a cookie.JwtProvider.BuilderaddAllFromHeaders(Iterable<? extends JwtHeader> values)Two fields below define where to extract the JWT from an HTTP request.JwtProvider.BuilderaddAllFromParams(Iterable<String> values)JWT is sent in a query parameter.JwtProvider.BuilderaddAudiences(String value)The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.JwtProvider.BuilderaddAudiencesBytes(com.google.protobuf.ByteString value)The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.JwtProvider.BuilderaddFromCookies(String value)JWT is sent in a cookie.JwtProvider.BuilderaddFromCookiesBytes(com.google.protobuf.ByteString value)JWT is sent in a cookie.JwtProvider.BuilderaddFromHeaders(int index, JwtHeader value)Two fields below define where to extract the JWT from an HTTP request.JwtProvider.BuilderaddFromHeaders(int index, JwtHeader.Builder builderForValue)Two fields below define where to extract the JWT from an HTTP request.JwtProvider.BuilderaddFromHeaders(JwtHeader value)Two fields below define where to extract the JWT from an HTTP request.JwtProvider.BuilderaddFromHeaders(JwtHeader.Builder builderForValue)Two fields below define where to extract the JWT from an HTTP request.JwtHeader.BuilderaddFromHeadersBuilder()Two fields below define where to extract the JWT from an HTTP request.JwtHeader.BuilderaddFromHeadersBuilder(int index)Two fields below define where to extract the JWT from an HTTP request.JwtProvider.BuilderaddFromParams(String value)JWT is sent in a query parameter.JwtProvider.BuilderaddFromParamsBytes(com.google.protobuf.ByteString value)JWT is sent in a query parameter.JwtProvider.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)JwtProviderbuild()JwtProviderbuildPartial()JwtProvider.Builderclear()JwtProvider.BuilderclearAudiences()The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.JwtProvider.BuilderclearClockSkewSeconds()Specify the clock skew in seconds when verifying JWT time constraint, such as ``exp``, and ``nbf``.JwtProvider.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)JwtProvider.BuilderclearForward()If false, the JWT is removed in the request after a success verification.JwtProvider.BuilderclearForwardPayloadHeader()This field specifies the header name to forward a successfully verified JWT payload to the backend.JwtProvider.BuilderclearFromCookies()JWT is sent in a cookie.JwtProvider.BuilderclearFromHeaders()Two fields below define where to extract the JWT from an HTTP request.JwtProvider.BuilderclearFromParams()JWT is sent in a query parameter.JwtProvider.BuilderclearHeaderInMetadata()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.JwtProvider.BuilderclearIssuer()Specify the `principal <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_ that issued the JWT, usually a URL or an email address.JwtProvider.BuilderclearJwksSourceSpecifier()JwtProvider.BuilderclearJwtCacheConfig()Enables JWT cache, its size is specified by ``jwt_cache_size``.JwtProvider.BuilderclearLocalJwks()JWKS is in local data source.JwtProvider.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)JwtProvider.BuilderclearPadForwardPayloadHeader()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.JwtProvider.BuilderclearPayloadInMetadata()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``.JwtProvider.BuilderclearRemoteJwks()JWKS can be fetched from remote server via HTTP/HTTPS.JwtProvider.Builderclone()StringgetAudiences(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.intgetAudiencesCount()The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.com.google.protobuf.ProtocolStringListgetAudiencesList()The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.intgetClockSkewSeconds()Specify the clock skew in seconds when verifying JWT time constraint, such as ``exp``, and ``nbf``.JwtProvidergetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()booleangetForward()If false, the JWT is removed in the request after a success verification.StringgetForwardPayloadHeader()This field specifies the header name to forward a successfully verified JWT payload to the backend.com.google.protobuf.ByteStringgetForwardPayloadHeaderBytes()This field specifies the header name to forward a successfully verified JWT payload to the backend.StringgetFromCookies(int index)JWT is sent in a cookie.com.google.protobuf.ByteStringgetFromCookiesBytes(int index)JWT is sent in a cookie.intgetFromCookiesCount()JWT is sent in a cookie.com.google.protobuf.ProtocolStringListgetFromCookiesList()JWT is sent in a cookie.JwtHeadergetFromHeaders(int index)Two fields below define where to extract the JWT from an HTTP request.JwtHeader.BuildergetFromHeadersBuilder(int index)Two fields below define where to extract the JWT from an HTTP request.List<JwtHeader.Builder>getFromHeadersBuilderList()Two fields below define where to extract the JWT from an HTTP request.intgetFromHeadersCount()Two fields below define where to extract the JWT from an HTTP request.List<JwtHeader>getFromHeadersList()Two fields below define where to extract the JWT from an HTTP request.JwtHeaderOrBuildergetFromHeadersOrBuilder(int index)Two fields below define where to extract the JWT from an HTTP request.List<? extends JwtHeaderOrBuilder>getFromHeadersOrBuilderList()Two fields below define where to extract the JWT from an HTTP request.StringgetFromParams(int index)JWT is sent in a query parameter.com.google.protobuf.ByteStringgetFromParamsBytes(int index)JWT is sent in a query parameter.intgetFromParamsCount()JWT is sent in a query parameter.com.google.protobuf.ProtocolStringListgetFromParamsList()JWT is sent in a query parameter.StringgetHeaderInMetadata()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.ByteStringgetHeaderInMetadataBytes()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.StringgetIssuer()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.ByteStringgetIssuerBytes()Specify the `principal <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_ that issued the JWT, usually a URL or an email address.JwtProvider.JwksSourceSpecifierCasegetJwksSourceSpecifierCase()JwtCacheConfiggetJwtCacheConfig()Enables JWT cache, its size is specified by ``jwt_cache_size``.JwtCacheConfig.BuildergetJwtCacheConfigBuilder()Enables JWT cache, its size is specified by ``jwt_cache_size``.JwtCacheConfigOrBuildergetJwtCacheConfigOrBuilder()Enables JWT cache, its size is specified by ``jwt_cache_size``.DataSourcegetLocalJwks()JWKS is in local data source.DataSource.BuildergetLocalJwksBuilder()JWKS is in local data source.DataSourceOrBuildergetLocalJwksOrBuilder()JWKS is in local data source.booleangetPadForwardPayloadHeader()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.StringgetPayloadInMetadata()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.ByteStringgetPayloadInMetadataBytes()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``.RemoteJwksgetRemoteJwks()JWKS can be fetched from remote server via HTTP/HTTPS.RemoteJwks.BuildergetRemoteJwksBuilder()JWKS can be fetched from remote server via HTTP/HTTPS.RemoteJwksOrBuildergetRemoteJwksOrBuilder()JWKS can be fetched from remote server via HTTP/HTTPS.booleanhasJwtCacheConfig()Enables JWT cache, its size is specified by ``jwt_cache_size``.booleanhasLocalJwks()JWKS is in local data source.booleanhasRemoteJwks()JWKS can be fetched from remote server via HTTP/HTTPS.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()JwtProvider.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)JwtProvider.BuildermergeFrom(com.google.protobuf.Message other)JwtProvider.BuildermergeFrom(JwtProvider other)JwtProvider.BuildermergeJwtCacheConfig(JwtCacheConfig value)Enables JWT cache, its size is specified by ``jwt_cache_size``.JwtProvider.BuildermergeLocalJwks(DataSource value)JWKS is in local data source.JwtProvider.BuildermergeRemoteJwks(RemoteJwks value)JWKS can be fetched from remote server via HTTP/HTTPS.JwtProvider.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)JwtProvider.BuilderremoveFromHeaders(int index)Two fields below define where to extract the JWT from an HTTP request.JwtProvider.BuildersetAudiences(int index, String value)The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.JwtProvider.BuildersetClockSkewSeconds(int value)Specify the clock skew in seconds when verifying JWT time constraint, such as ``exp``, and ``nbf``.JwtProvider.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)JwtProvider.BuildersetForward(boolean value)If false, the JWT is removed in the request after a success verification.JwtProvider.BuildersetForwardPayloadHeader(String value)This field specifies the header name to forward a successfully verified JWT payload to the backend.JwtProvider.BuildersetForwardPayloadHeaderBytes(com.google.protobuf.ByteString value)This field specifies the header name to forward a successfully verified JWT payload to the backend.JwtProvider.BuildersetFromCookies(int index, String value)JWT is sent in a cookie.JwtProvider.BuildersetFromHeaders(int index, JwtHeader value)Two fields below define where to extract the JWT from an HTTP request.JwtProvider.BuildersetFromHeaders(int index, JwtHeader.Builder builderForValue)Two fields below define where to extract the JWT from an HTTP request.JwtProvider.BuildersetFromParams(int index, String value)JWT is sent in a query parameter.JwtProvider.BuildersetHeaderInMetadata(String value)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.JwtProvider.BuildersetHeaderInMetadataBytes(com.google.protobuf.ByteString value)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.JwtProvider.BuildersetIssuer(String value)Specify the `principal <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_ that issued the JWT, usually a URL or an email address.JwtProvider.BuildersetIssuerBytes(com.google.protobuf.ByteString value)Specify the `principal <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_ that issued the JWT, usually a URL or an email address.JwtProvider.BuildersetJwtCacheConfig(JwtCacheConfig value)Enables JWT cache, its size is specified by ``jwt_cache_size``.JwtProvider.BuildersetJwtCacheConfig(JwtCacheConfig.Builder builderForValue)Enables JWT cache, its size is specified by ``jwt_cache_size``.JwtProvider.BuildersetLocalJwks(DataSource value)JWKS is in local data source.JwtProvider.BuildersetLocalJwks(DataSource.Builder builderForValue)JWKS is in local data source.JwtProvider.BuildersetPadForwardPayloadHeader(boolean value)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.JwtProvider.BuildersetPayloadInMetadata(String value)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``.JwtProvider.BuildersetPayloadInMetadataBytes(com.google.protobuf.ByteString value)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``.JwtProvider.BuildersetRemoteJwks(RemoteJwks value)JWKS can be fetched from remote server via HTTP/HTTPS.JwtProvider.BuildersetRemoteJwks(RemoteJwks.Builder builderForValue)JWKS can be fetched from remote server via HTTP/HTTPS.JwtProvider.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)JwtProvider.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
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<JwtProvider.Builder>
-
clear
public JwtProvider.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<JwtProvider.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<JwtProvider.Builder>
-
getDefaultInstanceForType
public JwtProvider getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public JwtProvider build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public JwtProvider buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public JwtProvider.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<JwtProvider.Builder>
-
setField
public JwtProvider.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<JwtProvider.Builder>
-
clearField
public JwtProvider.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtProvider.Builder>
-
clearOneof
public JwtProvider.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtProvider.Builder>
-
setRepeatedField
public JwtProvider.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<JwtProvider.Builder>
-
addRepeatedField
public JwtProvider.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<JwtProvider.Builder>
-
mergeFrom
public JwtProvider.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<JwtProvider.Builder>
-
mergeFrom
public JwtProvider.Builder mergeFrom(JwtProvider other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtProvider.Builder>
-
mergeFrom
public JwtProvider.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<JwtProvider.Builder>- Throws:
IOException
-
getJwksSourceSpecifierCase
public JwtProvider.JwksSourceSpecifierCase getJwksSourceSpecifierCase()
- Specified by:
getJwksSourceSpecifierCasein interfaceJwtProviderOrBuilder
-
clearJwksSourceSpecifier
public JwtProvider.Builder clearJwksSourceSpecifier()
-
getIssuer
public String 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. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
string 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. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
string issuer = 1;- Specified by:
getIssuerBytesin interfaceJwtProviderOrBuilder- Returns:
- The bytes for issuer.
-
setIssuer
public JwtProvider.Builder setIssuer(String value)
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. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
string issuer = 1;- Parameters:
value- The issuer to set.- Returns:
- This builder for chaining.
-
clearIssuer
public JwtProvider.Builder clearIssuer()
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. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
string issuer = 1;- Returns:
- This builder for chaining.
-
setIssuerBytes
public JwtProvider.Builder setIssuerBytes(com.google.protobuf.ByteString value)
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. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
string issuer = 1;- Parameters:
value- The bytes for issuer to set.- Returns:
- This builder for chaining.
-
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
public String getAudiences(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:
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.
-
setAudiences
public JwtProvider.Builder setAudiences(int index, String value)
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;- Parameters:
index- The index to set the value at.value- The audiences to set.- Returns:
- This builder for chaining.
-
addAudiences
public JwtProvider.Builder addAudiences(String value)
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;- Parameters:
value- The audiences to add.- Returns:
- This builder for chaining.
-
addAllAudiences
public JwtProvider.Builder addAllAudiences(Iterable<String> values)
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;- Parameters:
values- The audiences to add.- Returns:
- This builder for chaining.
-
clearAudiences
public JwtProvider.Builder clearAudiences()
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;- Returns:
- This builder for chaining.
-
addAudiencesBytes
public JwtProvider.Builder addAudiencesBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes of the audiences to add.- Returns:
- This builder for chaining.
-
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
public RemoteJwks 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.
-
setRemoteJwks
public JwtProvider.Builder setRemoteJwks(RemoteJwks value)
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;
-
setRemoteJwks
public JwtProvider.Builder setRemoteJwks(RemoteJwks.Builder builderForValue)
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;
-
mergeRemoteJwks
public JwtProvider.Builder mergeRemoteJwks(RemoteJwks value)
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;
-
clearRemoteJwks
public JwtProvider.Builder clearRemoteJwks()
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;
-
getRemoteJwksBuilder
public RemoteJwks.Builder getRemoteJwksBuilder()
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;
-
getRemoteJwksOrBuilder
public RemoteJwksOrBuilder 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
public DataSource 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.
-
setLocalJwks
public JwtProvider.Builder setLocalJwks(DataSource value)
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;
-
setLocalJwks
public JwtProvider.Builder setLocalJwks(DataSource.Builder builderForValue)
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;
-
mergeLocalJwks
public JwtProvider.Builder mergeLocalJwks(DataSource value)
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;
-
clearLocalJwks
public JwtProvider.Builder clearLocalJwks()
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;
-
getLocalJwksBuilder
public DataSource.Builder getLocalJwksBuilder()
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;
-
getLocalJwksOrBuilder
public DataSourceOrBuilder 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 & has no effect for JWTs extracted through from_params & from_cookies.
bool forward = 5;- Specified by:
getForwardin interfaceJwtProviderOrBuilder- Returns:
- The forward.
-
setForward
public JwtProvider.Builder setForward(boolean value)
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 & has no effect for JWTs extracted through from_params & from_cookies.
bool forward = 5;- Parameters:
value- The forward to set.- Returns:
- This builder for chaining.
-
clearForward
public JwtProvider.Builder clearForward()
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 & has no effect for JWTs extracted through from_params & from_cookies.
bool forward = 5;- Returns:
- This builder for chaining.
-
getFromHeadersList
public List<JwtHeader> 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 JWT token. 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
-
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 JWT token. 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
public JwtHeader getFromHeaders(int index)
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 JWT token. 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
-
setFromHeaders
public JwtProvider.Builder setFromHeaders(int index, JwtHeader value)
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 JWT token. 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;
-
setFromHeaders
public JwtProvider.Builder setFromHeaders(int index, JwtHeader.Builder builderForValue)
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 JWT token. 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;
-
addFromHeaders
public JwtProvider.Builder addFromHeaders(JwtHeader value)
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 JWT token. 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;
-
addFromHeaders
public JwtProvider.Builder addFromHeaders(int index, JwtHeader value)
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 JWT token. 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;
-
addFromHeaders
public JwtProvider.Builder addFromHeaders(JwtHeader.Builder builderForValue)
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 JWT token. 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;
-
addFromHeaders
public JwtProvider.Builder addFromHeaders(int index, JwtHeader.Builder builderForValue)
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 JWT token. 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;
-
addAllFromHeaders
public JwtProvider.Builder addAllFromHeaders(Iterable<? extends JwtHeader> values)
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 JWT token. 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;
-
clearFromHeaders
public JwtProvider.Builder clearFromHeaders()
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 JWT token. 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;
-
removeFromHeaders
public JwtProvider.Builder removeFromHeaders(int index)
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 JWT token. 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;
-
getFromHeadersBuilder
public JwtHeader.Builder getFromHeadersBuilder(int index)
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 JWT token. 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;
-
getFromHeadersOrBuilder
public JwtHeaderOrBuilder getFromHeadersOrBuilder(int index)
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 JWT token. 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
-
getFromHeadersOrBuilderList
public List<? extends JwtHeaderOrBuilder> 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 JWT token. 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
-
addFromHeadersBuilder
public JwtHeader.Builder addFromHeadersBuilder()
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 JWT token. 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;
-
addFromHeadersBuilder
public JwtHeader.Builder addFromHeadersBuilder(int index)
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 JWT token. 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;
-
getFromHeadersBuilderList
public List<JwtHeader.Builder> getFromHeadersBuilderList()
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 JWT token. 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;
-
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
public String getFromParams(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:
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.
-
setFromParams
public JwtProvider.Builder setFromParams(int index, String value)
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;- Parameters:
index- The index to set the value at.value- The fromParams to set.- Returns:
- This builder for chaining.
-
addFromParams
public JwtProvider.Builder addFromParams(String value)
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;- Parameters:
value- The fromParams to add.- Returns:
- This builder for chaining.
-
addAllFromParams
public JwtProvider.Builder addAllFromParams(Iterable<String> values)
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;- Parameters:
values- The fromParams to add.- Returns:
- This builder for chaining.
-
clearFromParams
public JwtProvider.Builder clearFromParams()
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;- Returns:
- This builder for chaining.
-
addFromParamsBytes
public JwtProvider.Builder addFromParamsBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes of the fromParams to add.- Returns:
- This builder for chaining.
-
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
public String getFromCookies(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:
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.
-
setFromCookies
public JwtProvider.Builder setFromCookies(int index, String value)
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;- Parameters:
index- The index to set the value at.value- The fromCookies to set.- Returns:
- This builder for chaining.
-
addFromCookies
public JwtProvider.Builder addFromCookies(String value)
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;- Parameters:
value- The fromCookies to add.- Returns:
- This builder for chaining.
-
addAllFromCookies
public JwtProvider.Builder addAllFromCookies(Iterable<String> values)
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;- Parameters:
values- The fromCookies to add.- Returns:
- This builder for chaining.
-
clearFromCookies
public JwtProvider.Builder clearFromCookies()
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;- Returns:
- This builder for chaining.
-
addFromCookiesBytes
public JwtProvider.Builder addFromCookiesBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes of the fromCookies to add.- Returns:
- This builder for chaining.
-
getForwardPayloadHeader
public String 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.
-
setForwardPayloadHeader
public JwtProvider.Builder setForwardPayloadHeader(String value)
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) = { ... }- Parameters:
value- The forwardPayloadHeader to set.- Returns:
- This builder for chaining.
-
clearForwardPayloadHeader
public JwtProvider.Builder clearForwardPayloadHeader()
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) = { ... }- Returns:
- This builder for chaining.
-
setForwardPayloadHeaderBytes
public JwtProvider.Builder setForwardPayloadHeaderBytes(com.google.protobuf.ByteString value)
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) = { ... }- Parameters:
value- The bytes for forwardPayloadHeader to set.- Returns:
- This builder for chaining.
-
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.
-
setPadForwardPayloadHeader
public JwtProvider.Builder setPadForwardPayloadHeader(boolean value)
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;- Parameters:
value- The padForwardPayloadHeader to set.- Returns:
- This builder for chaining.
-
clearPadForwardPayloadHeader
public JwtProvider.Builder clearPadForwardPayloadHeader()
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;- Returns:
- This builder for chaining.
-
getPayloadInMetadata
public String 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.
-
setPayloadInMetadata
public JwtProvider.Builder setPayloadInMetadata(String value)
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;- Parameters:
value- The payloadInMetadata to set.- Returns:
- This builder for chaining.
-
clearPayloadInMetadata
public JwtProvider.Builder clearPayloadInMetadata()
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;- Returns:
- This builder for chaining.
-
setPayloadInMetadataBytes
public JwtProvider.Builder setPayloadInMetadataBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for payloadInMetadata to set.- Returns:
- This builder for chaining.
-
getHeaderInMetadata
public String 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.
-
setHeaderInMetadata
public JwtProvider.Builder setHeaderInMetadata(String value)
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;- Parameters:
value- The headerInMetadata to set.- Returns:
- This builder for chaining.
-
clearHeaderInMetadata
public JwtProvider.Builder clearHeaderInMetadata()
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;- Returns:
- This builder for chaining.
-
setHeaderInMetadataBytes
public JwtProvider.Builder setHeaderInMetadataBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for headerInMetadata to set.- Returns:
- This builder for chaining.
-
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.
-
setClockSkewSeconds
public JwtProvider.Builder setClockSkewSeconds(int value)
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;- Parameters:
value- The clockSkewSeconds to set.- Returns:
- This builder for chaining.
-
clearClockSkewSeconds
public JwtProvider.Builder clearClockSkewSeconds()
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;- Returns:
- This builder for chaining.
-
hasJwtCacheConfig
public boolean hasJwtCacheConfig()
Enables JWT cache, its size is specified by ``jwt_cache_size``. Only valid JWT tokens 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
public JwtCacheConfig getJwtCacheConfig()
Enables JWT cache, its size is specified by ``jwt_cache_size``. Only valid JWT tokens are cached.
.envoy.extensions.filters.http.jwt_authn.v3.JwtCacheConfig jwt_cache_config = 12;- Specified by:
getJwtCacheConfigin interfaceJwtProviderOrBuilder- Returns:
- The jwtCacheConfig.
-
setJwtCacheConfig
public JwtProvider.Builder setJwtCacheConfig(JwtCacheConfig value)
Enables JWT cache, its size is specified by ``jwt_cache_size``. Only valid JWT tokens are cached.
.envoy.extensions.filters.http.jwt_authn.v3.JwtCacheConfig jwt_cache_config = 12;
-
setJwtCacheConfig
public JwtProvider.Builder setJwtCacheConfig(JwtCacheConfig.Builder builderForValue)
Enables JWT cache, its size is specified by ``jwt_cache_size``. Only valid JWT tokens are cached.
.envoy.extensions.filters.http.jwt_authn.v3.JwtCacheConfig jwt_cache_config = 12;
-
mergeJwtCacheConfig
public JwtProvider.Builder mergeJwtCacheConfig(JwtCacheConfig value)
Enables JWT cache, its size is specified by ``jwt_cache_size``. Only valid JWT tokens are cached.
.envoy.extensions.filters.http.jwt_authn.v3.JwtCacheConfig jwt_cache_config = 12;
-
clearJwtCacheConfig
public JwtProvider.Builder clearJwtCacheConfig()
Enables JWT cache, its size is specified by ``jwt_cache_size``. Only valid JWT tokens are cached.
.envoy.extensions.filters.http.jwt_authn.v3.JwtCacheConfig jwt_cache_config = 12;
-
getJwtCacheConfigBuilder
public JwtCacheConfig.Builder getJwtCacheConfigBuilder()
Enables JWT cache, its size is specified by ``jwt_cache_size``. Only valid JWT tokens are cached.
.envoy.extensions.filters.http.jwt_authn.v3.JwtCacheConfig jwt_cache_config = 12;
-
getJwtCacheConfigOrBuilder
public JwtCacheConfigOrBuilder getJwtCacheConfigOrBuilder()
Enables JWT cache, its size is specified by ``jwt_cache_size``. Only valid JWT tokens are cached.
.envoy.extensions.filters.http.jwt_authn.v3.JwtCacheConfig jwt_cache_config = 12;- Specified by:
getJwtCacheConfigOrBuilderin interfaceJwtProviderOrBuilder
-
setUnknownFields
public final JwtProvider.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtProvider.Builder>
-
mergeUnknownFields
public final JwtProvider.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<JwtProvider.Builder>
-
-