Uses of Class
io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v3.JwtProvider.Builder
Packages that use JwtProvider.Builder
-
Uses of JwtProvider.Builder in io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v3
Methods in io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v3 that return JwtProvider.BuilderModifier and TypeMethodDescriptionJwtProvider.Builder.addAllAudiences(Iterable<String> values) The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.JwtProvider.Builder.addAllClaimToHeaders(Iterable<? extends JwtClaimToHeader> values) Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.JwtProvider.Builder.addAllFromCookies(Iterable<String> values) JWT is sent in a cookie.JwtProvider.Builder.addAllFromHeaders(Iterable<? extends JwtHeader> values) Two fields below define where to extract the JWT from an HTTP request.JwtProvider.Builder.addAllFromParams(Iterable<String> values) JWT is sent in a query parameter.JwtProvider.Builder.addAudiences(String value) The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.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.JwtProvider.Builder.addClaimToHeaders(int index, JwtClaimToHeader value) Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.JwtProvider.Builder.addClaimToHeaders(int index, JwtClaimToHeader.Builder builderForValue) Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.JwtProvider.Builder.addClaimToHeaders(JwtClaimToHeader value) Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.JwtProvider.Builder.addClaimToHeaders(JwtClaimToHeader.Builder builderForValue) Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.JwtProvider.Builder.addFromCookies(String value) JWT is sent in a cookie.JwtProvider.Builder.addFromCookiesBytes(com.google.protobuf.ByteString value) JWT is sent in a cookie.JwtProvider.Builder.addFromHeaders(int index, JwtHeader value) Two fields below define where to extract the JWT from an HTTP request.JwtProvider.Builder.addFromHeaders(int index, JwtHeader.Builder builderForValue) Two fields below define where to extract the JWT from an HTTP request.JwtProvider.Builder.addFromHeaders(JwtHeader value) Two fields below define where to extract the JWT from an HTTP request.JwtProvider.Builder.addFromHeaders(JwtHeader.Builder builderForValue) Two fields below define where to extract the JWT from an HTTP request.JwtProvider.Builder.addFromParams(String value) JWT is sent in a query parameter.JwtProvider.Builder.addFromParamsBytes(com.google.protobuf.ByteString value) JWT is sent in a query parameter.JwtProvider.Builder.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) JwtProvider.Builder.clear()JwtProvider.Builder.clearAudiences()The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are allowed to access.JwtProvider.Builder.clearClaimToHeaders()Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.JwtProvider.Builder.clearClearRouteCache()Clears route cache in order to allow the JWT to correctly affect routing decisions.JwtProvider.Builder.clearClockSkewSeconds()Specify the clock skew in seconds when verifying JWT time constraint, such as ``exp``, and ``nbf``.JwtProvider.Builder.clearFailedStatusInMetadata()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``.JwtProvider.Builder.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) JwtProvider.Builder.clearForward()If false, the JWT is removed in the request after a success verification.JwtProvider.Builder.clearForwardPayloadHeader()This field specifies the header name to forward a successfully verified JWT payload to the backend.JwtProvider.Builder.clearFromCookies()JWT is sent in a cookie.JwtProvider.Builder.clearFromHeaders()Two fields below define where to extract the JWT from an HTTP request.JwtProvider.Builder.clearFromParams()JWT is sent in a query parameter.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.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.JwtProvider.Builder.clearJwksSourceSpecifier()JwtProvider.Builder.clearJwtCacheConfig()Enables JWT cache, its size is specified by ``jwt_cache_size``.JwtProvider.Builder.clearLocalJwks()JWKS is in local data source.JwtProvider.Builder.clearMaxLifetime()Restrict the maximum remaining lifetime of a credential from the JwtProvider.JwtProvider.Builder.clearNormalizePayloadInMetadata()Normalizes the payload representation in the request metadata.JwtProvider.Builder.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) 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.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``.JwtProvider.Builder.clearRemoteJwks()JWKS can be fetched from remote server via HTTP/HTTPS.JwtProvider.Builder.clearRequireExpiration()Requires that the credential contains an `expiration <https://tools.ietf.org/html/rfc7519#section-4.1.4>`_.JwtProvider.Builder.clearSubjects()Restrict the `subjects <https://tools.ietf.org/html/rfc7519#section-4.1.2>`_ that the JwtProvider can assert.JwtProvider.Builder.clone()JwtProvider.Builder.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) JwtProvider.Builder.mergeFrom(com.google.protobuf.Message other) JwtProvider.Builder.mergeFrom(JwtProvider other) JwtProvider.Builder.mergeJwtCacheConfig(JwtCacheConfig value) Enables JWT cache, its size is specified by ``jwt_cache_size``.JwtProvider.Builder.mergeLocalJwks(DataSource value) JWKS is in local data source.JwtProvider.Builder.mergeMaxLifetime(com.google.protobuf.Duration value) Restrict the maximum remaining lifetime of a credential from the JwtProvider.JwtProvider.Builder.mergeNormalizePayloadInMetadata(JwtProvider.NormalizePayload value) Normalizes the payload representation in the request metadata.JwtProvider.Builder.mergeRemoteJwks(RemoteJwks value) JWKS can be fetched from remote server via HTTP/HTTPS.JwtProvider.Builder.mergeSubjects(StringMatcher value) Restrict the `subjects <https://tools.ietf.org/html/rfc7519#section-4.1.2>`_ that the JwtProvider can assert.final JwtProvider.BuilderJwtProvider.Builder.mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) static JwtProvider.BuilderJwtProvider.newBuilder()static JwtProvider.BuilderJwtProvider.newBuilder(JwtProvider prototype) JwtProvider.newBuilderForType()protected JwtProvider.BuilderJwtProvider.newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) JwtAuthentication.Builder.putProvidersBuilderIfAbsent(String key) Map of provider names to JwtProviders. .. code-block:: yaml providers: provider1: issuer: issuer1 audiences: - audience1 - audience2 remote_jwks: http_uri: uri: https://example.com/.well-known/jwks.json cluster: example_jwks_cluster timeout: 1s provider2: issuer: provider2 local_jwks: inline_string: jwks_stringJwtProvider.Builder.removeClaimToHeaders(int index) Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.JwtProvider.Builder.removeFromHeaders(int index) Two fields below define where to extract the JWT from an HTTP request.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.JwtProvider.Builder.setClaimToHeaders(int index, JwtClaimToHeader value) Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.JwtProvider.Builder.setClaimToHeaders(int index, JwtClaimToHeader.Builder builderForValue) Add JWT claim to HTTP Header Specify the claim name you want to copy in which HTTP header.JwtProvider.Builder.setClearRouteCache(boolean value) Clears route cache in order to allow the JWT to correctly affect routing decisions.JwtProvider.Builder.setClockSkewSeconds(int value) Specify the clock skew in seconds when verifying JWT time constraint, such as ``exp``, and ``nbf``.JwtProvider.Builder.setFailedStatusInMetadata(String value) 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``.JwtProvider.Builder.setFailedStatusInMetadataBytes(com.google.protobuf.ByteString value) 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``.JwtProvider.Builder.setForward(boolean value) If false, the JWT is removed in the request after a success verification.JwtProvider.Builder.setForwardPayloadHeader(String value) This field specifies the header name to forward a successfully verified JWT payload to the backend.JwtProvider.Builder.setForwardPayloadHeaderBytes(com.google.protobuf.ByteString value) This field specifies the header name to forward a successfully verified JWT payload to the backend.JwtProvider.Builder.setFromCookies(int index, String value) JWT is sent in a cookie.JwtProvider.Builder.setFromHeaders(int index, JwtHeader value) Two fields below define where to extract the JWT from an HTTP request.JwtProvider.Builder.setFromHeaders(int index, JwtHeader.Builder builderForValue) Two fields below define where to extract the JWT from an HTTP request.JwtProvider.Builder.setFromParams(int index, String value) JWT is sent in a query parameter.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.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.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.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.JwtProvider.Builder.setJwtCacheConfig(JwtCacheConfig value) Enables JWT cache, its size is specified by ``jwt_cache_size``.JwtProvider.Builder.setJwtCacheConfig(JwtCacheConfig.Builder builderForValue) Enables JWT cache, its size is specified by ``jwt_cache_size``.JwtProvider.Builder.setLocalJwks(DataSource value) JWKS is in local data source.JwtProvider.Builder.setLocalJwks(DataSource.Builder builderForValue) JWKS is in local data source.JwtProvider.Builder.setMaxLifetime(com.google.protobuf.Duration value) Restrict the maximum remaining lifetime of a credential from the JwtProvider.JwtProvider.Builder.setMaxLifetime(com.google.protobuf.Duration.Builder builderForValue) Restrict the maximum remaining lifetime of a credential from the JwtProvider.JwtProvider.Builder.setNormalizePayloadInMetadata(JwtProvider.NormalizePayload value) Normalizes the payload representation in the request metadata.JwtProvider.Builder.setNormalizePayloadInMetadata(JwtProvider.NormalizePayload.Builder builderForValue) Normalizes the payload representation in the request metadata.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.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``.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``.JwtProvider.Builder.setRemoteJwks(RemoteJwks value) JWKS can be fetched from remote server via HTTP/HTTPS.JwtProvider.Builder.setRemoteJwks(RemoteJwks.Builder builderForValue) JWKS can be fetched from remote server via HTTP/HTTPS.JwtProvider.Builder.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) JwtProvider.Builder.setRequireExpiration(boolean value) Requires that the credential contains an `expiration <https://tools.ietf.org/html/rfc7519#section-4.1.4>`_.JwtProvider.Builder.setSubjects(StringMatcher value) Restrict the `subjects <https://tools.ietf.org/html/rfc7519#section-4.1.2>`_ that the JwtProvider can assert.JwtProvider.Builder.setSubjects(StringMatcher.Builder builderForValue) Restrict the `subjects <https://tools.ietf.org/html/rfc7519#section-4.1.2>`_ that the JwtProvider can assert.final JwtProvider.BuilderJwtProvider.Builder.setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) JwtProvider.toBuilder()