JWT Authentication

    As of Envoy v1.18 the v2 API has been removed and is no longer supported.

    If you are upgrading from v2 API config you may wish to view the v2 API documentation:

    This extension may be referenced by the qualified name

    Note

    This extension is functional but has not had substantial production burn time, use only with this caveat.

    This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted.

    Tip

    This extension extends and can be used with the following extension category:

    JWT Authentication .

    [extensions.filters.http.jwt_authn.v3.JwtProvider proto]

    Please see following for JWT authentication flow:

    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:

    1. {
    2.   "issuer": "...",
    3.   "audiences": [],
    4.   "remote_jwks": "{...}",
    5.   "local_jwks": "{...}",
    6.   "forward": "...",
    7.   "from_headers": [],
    8.   "from_params": [],
    9.   "from_cookies": [],
    10.   "forward_payload_header": "...",
    11.   "pad_forward_payload_header": "...",
    12.   "payload_in_metadata": "...",
    13.   "header_in_metadata": "...",
    14.   "clock_skew_seconds": "...",
    15.   "jwt_cache_config": "{...}"
    16. }

    issuer

    (string) Specify the 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.

    If a JWT has iss field and this field is specified, they have to match, otherwise the JWT iss field is not checked.

    Note: JwtRequirement allow_missing and 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:

    audiences

    (repeated string) The list of JWT 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:

    1. audiences:
    2. - bookstore_android.apps.googleusercontent.com
    3. - bookstore_web.apps.googleusercontent.com

    remote_jwks

    (extensions.filters.http.jwt_authn.v3.RemoteJwks) 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:

    1. remote_jwks:
    2.   http_uri:
    3.     uri: https://www.googleapis.com/oauth2/v1/certs
    4.     cluster: jwt.www.googleapis.com|443
    5.     timeout: 1s
    6.   cache_duration:
    7.     seconds: 300

    is needed to validate signature of a JWT. This field specifies where to fetch JWKS.

    Precisely one of remote_jwks, must be set.

    local_jwks

    (config.core.v3.DataSource) JWKS is in local data source. It could be either in a local file or embedded in the inline_string.

    Example: local file

    1. local_jwks:
    2.   filename: /etc/envoy/jwks/jwks1.txt

    Example: inline_string

    1. local_jwks:
    2.   inline_string: ACADADADADA

    is needed to validate signature of a JWT. This field specifies where to fetch JWKS.

    Precisely one of remote_jwks, must be set.

    forward

    (bool) 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.

    from_headers

    (repeated ) 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. Example:

    1. Authorization: Bearer <token>.
    1. 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:

    1. from_headers:
    2. - name: x-goog-iap-jwt-assertion

    can be used to extract token from header:

    1. ``x-goog-iap-jwt-assertion: <JWT>``.

    from_params

    (repeated string) JWT is sent in a query parameter. jwt_params represents the query parameter names.

    For example, if config is:

    1. from_params:
    2. - jwt_token

    The JWT format in query parameter is:

    1. /path?jwt_token=<JWT>

    from_cookies

    (repeated ) JWT is sent in a cookie. from_cookies represents the cookie names to extract from.

    For example, if config is:

    1. from_cookies:
    2. - auth-token

    Then JWT will be extracted from auth-token cookie in the request.

    forward_payload_header

    (string) This field specifies the header name to forward a successfully verified JWT payload to the backend. The forwarded data is:

    1. base64url_encoded(jwt_payload_in_JSON)

    pad_forward_payload_header

    () When 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 is specified.

    payload_in_metadata

    (string) 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:

    header_in_metadata

    () If not empty, similar to payload_in_metadata, a successfully verified JWT header will be written to 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:

    1. envoy.filters.http.jwt_authn:
    2.   my_header:
    3.     alg: JWT
    4.     kid: EF71iSaosbC5C4tC6Syq1Gm647M
    5.     alg: PS256

    When the metadata has envoy.filters.http.jwt_authn entry already (for example if payload_in_metadata is not empty), it will be inserted as a new entry in the same namespace as shown below:

    1. envoy.filters.http.jwt_authn:
    2.   my_payload:
    3.     iss: https://example.com
    4.     sub: test@example.com
    5.     aud: https://example.com
    6.     exp: 1501281058
    7.   my_header:
    8.     alg: JWT
    9.     kid: EF71iSaosbC5C4tC6Syq1Gm647M
    10.     alg: PS256

    Warning

    Using the same key name for and payload_in_metadata is not suggested due to potential override of existing entry, while it is not enforced during config validation.

    clock_skew_seconds

    () Specify the clock skew in seconds when verifying JWT time constraint, such as exp, and nbf. If not specified, default is 60 seconds.

    jwt_cache_config

    (extensions.filters.http.jwt_authn.v3.JwtCacheConfig) Enables JWT cache, its size is specified by jwt_cache_size. Only valid JWT tokens are cached.

    extensions.filters.http.jwt_authn.v3.JwtCacheConfig

    [extensions.filters.http.jwt_authn.v3.JwtCacheConfig proto]

    This message specifies JWT Cache configuration.

    1. {
    2.   "jwt_cache_size": "..."
    3. }

    jwt_cache_size

    () The unit is number of JWT tokens, default to 100.

    extensions.filters.http.jwt_authn.v3.RemoteJwks

    This message specifies how to fetch JWKS from remote and how to cache it.

    1. {
    2.   "http_uri": "{...}",
    3.   "cache_duration": "{...}",
    4.   "async_fetch": "{...}",
    5.   "retry_policy": "{...}"
    6. }

    http_uri

    (config.core.v3.HttpUri) The HTTP URI to fetch the JWKS. For example:

    1. http_uri:
    2.   uri: https://www.googleapis.com/oauth2/v1/certs
    3.   cluster: jwt.www.googleapis.com|443

    cache_duration

    () Duration after which the cached JWKS should be expired. If not specified, default cache duration is 5 minutes.

    async_fetch

    (extensions.filters.http.jwt_authn.v3.JwksAsyncFetch) Fetch Jwks asynchronously in the main thread before the listener is activated. Fetched Jwks can be used by all worker threads.

    If this feature is not enabled:

    • The Jwks is fetched on-demand when the requests come. During the fetching, first few requests are paused until the Jwks is fetched.

    • Each worker thread fetches its own Jwks since Jwks cache is per worker thread.

    If this feature is enabled:

    • Fetched Jwks is done in the main thread before the listener is activated. Its fetched Jwks can be used by all worker threads. Each worker thread doesn’t need to fetch its own.

    • Jwks is ready when the requests come, not need to wait for the Jwks fetching.

    retry_policy

    () Retry policy for fetching Jwks. optional. turned off by default.

    For example:

    1. retry_policy:
    2.   retry_back_off:
    3.     base_interval: 0.01s
    4.     max_interval: 20s
    5.   num_retries: 10

    will yield a randomized truncated exponential backoff policy with an initial delay of 10ms 10 maximum attempts spaced at most 20s seconds.

    1. retry_policy:
    2.   num_retries:1

    uses the default retry backoff strategy. with the default base interval is 1000 milliseconds. and the default maximum interval of 10 times the base interval.

    if num_retries is omitted, the default is to allow only one retry.

    If enabled, the retry policy will apply to all Jwks fetching approaches, e.g. on demand or asynchronously in background.

    extensions.filters.http.jwt_authn.v3.JwksAsyncFetch

    [extensions.filters.http.jwt_authn.v3.JwksAsyncFetch proto]

    Fetch Jwks asynchronously in the main thread when the filter config is parsed. The listener is activated only after the Jwks is fetched. When the Jwks is expired in the cache, it is fetched again in the main thread. The fetched Jwks from the main thread can be used by all worker threads.

    1. {
    2.   "fast_listener": "..."
    3. }

    fast_listener

    () If false, the listener is activated after the initial fetch is completed. The initial fetch result can be either successful or failed. If true, it is activated without waiting for the initial fetch to complete. Default is false.

    [extensions.filters.http.jwt_authn.v3.JwtHeader proto]

    This message specifies a header location to extract JWT token.

    1. {
    2.   "name": "...",
    3.   "value_prefix": "..."

    name

    (, REQUIRED) The HTTP header name.

    value_prefix

    (string) The value prefix. The value format is “value_prefix<token>” For example, for “Authorization: Bearer <token>”, value_prefix=”Bearer ” with a space at the end.

    extensions.filters.http.jwt_authn.v3.ProviderWithAudiences

    [extensions.filters.http.jwt_authn.v3.ProviderWithAudiences proto]

    Specify a required provider with audiences.

    1. {
    2.   "provider_name": "...",
    3.   "audiences": []
    4. }

    provider_name

    () Specify a required provider name.

    audiences

    (repeated string) This field overrides the one specified in the JwtProvider.

    extensions.filters.http.jwt_authn.v3.JwtRequirement

    [extensions.filters.http.jwt_authn.v3.JwtRequirement proto]

    This message specifies a Jwt requirement. An empty message means JWT verification is not required. Here are some config examples:

    1. # Example 1: not required with an empty message
    3. # Example 2: require A
    4. provider_name: provider-A
    6. # Example 3: require A or B
    7. requires_any:
    8.   requirements:
    9.     - provider_name: provider-A
    10.     - provider_name: provider-B
    12. # Example 4: require A and B
    13. requires_all:
    14.   requirements:
    15.     - provider_name: provider-A
    16.     - provider_name: provider-B
    18. # Example 5: require A and (B or C)
    19. requires_all:
    20.   requirements:
    21.     - provider_name: provider-A
    22.     - requires_any:
    23.       requirements:
    24.         - provider_name: provider-B
    25.         - provider_name: provider-C
    27. # Example 6: require A or (B and C)
    28. requires_any:
    29.   requirements:
    30.     - provider_name: provider-A
    31.     - requires_all:
    32.       requirements:
    33.         - provider_name: provider-B
    34.         - provider_name: provider-C
    36. # Example 7: A is optional (if token from A is provided, it must be valid, but also allows
    37. missing token.)
    38. requires_any:
    39.   requirements:
    40.   - provider_name: provider-A
    41.   - allow_missing: {}
    43. # Example 8: A is optional and B is required.
    44. requires_all:
    45.   requirements:
    46.   - requires_any:
    47.       requirements:
    48.       - provider_name: provider-A
    49.       - allow_missing: {}
    50.   - provider_name: provider-B
    1. {
    2.   "provider_name": "...",
    3.   "provider_and_audiences": "{...}",
    4.   "requires_any": "{...}",
    5.   "requires_all": "{...}",
    6.   "allow_missing_or_failed": "{...}",
    7.   "allow_missing": "{...}"
    8. }

    provider_name

    () Specify a required provider name.

    Only one of provider_name, , requires_any, , allow_missing_or_failed, may be set.

    provider_and_audiences

    (extensions.filters.http.jwt_authn.v3.ProviderWithAudiences) Specify a required provider with audiences.

    requires_any

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

    Only one of provider_name, , requires_any, , allow_missing_or_failed, may be set.

    requires_all

    (extensions.filters.http.jwt_authn.v3.JwtRequirementAndList) Specify list of JwtRequirement. Their results are AND-ed. All of them must pass, if one of them fails or missing, it fails.

    Only one of , provider_and_audiences, , requires_all, , allow_missing may be set.

    allow_missing_or_failed

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

    Only one of provider_name, , requires_any, , allow_missing_or_failed, may be set.

    allow_missing

    (Empty) The requirement is satisfied if JWT is missing, but failed if JWT is presented but invalid. Similar to allow_missing_or_failed, this is used to only verify JWTs and pass the verified payload to another filter. The different is this mode will reject requests with invalid tokens.

    Only one of , provider_and_audiences, , requires_all, , allow_missing may be set.

    extensions.filters.http.jwt_authn.v3.JwtRequirementOrList

    [extensions.filters.http.jwt_authn.v3.JwtRequirementOrList proto]

    This message specifies a list of RequiredProvider. Their results are OR-ed; if any one of them passes, the result is passed

    requirements

    (repeated , REQUIRED) Specify a list of JwtRequirement.

    [extensions.filters.http.jwt_authn.v3.JwtRequirementAndList proto]

    This message specifies a list of RequiredProvider. Their results are AND-ed; all of them must pass, if one of them fails or missing, it fails.

    1. {
    2.   "requirements": []
    3. }

    requirements

    (repeated , REQUIRED) Specify a list of JwtRequirement.

    extensions.filters.http.jwt_authn.v3.RequirementRule

    This message specifies a Jwt requirement for a specific Route condition. Example 1:

    1. - match:
    2.     prefix: /healthz

    In above example, “requires” field is empty for /healthz prefix match, it means that requests matching the path prefix don’t require JWT authentication.

    Example 2:

    1. - match:
    2.     prefix: /
    3.   requires: { provider_name: provider-A }

    In above example, all requests matched the path prefix require jwt authentication from “provider-A”.

    1. {
    2.   "match": "{...}",
    3.   "requires": "{...}",
    4.   "requirement_name": "..."
    5. }

    match

    (config.route.v3.RouteMatch, REQUIRED) The route matching parameter. Only when the match is satisfied, the “requires” field will apply.

    For example: following match will match all requests.

    1.   prefix: /

    requires

    () Specify a Jwt requirement. Please see detail comment in message JwtRequirement.

    Specify a Jwt requirement. If not specified, Jwt verification is disabled.

    Only one of requires, may be set.

    requirement_name

    (string) Use requirement_name to specify a Jwt requirement. This requirement_name MUST be specified at the in JwtAuthentication.

    Specify a Jwt requirement. If not specified, Jwt verification is disabled.

    Only one of requires, may be set.

    extensions.filters.http.jwt_authn.v3.FilterStateRule

    This message specifies Jwt requirements based on stream_info.filterState. This FilterState should use Router::StringAccessor object to set a string value. Other HTTP filters can use it to specify Jwt requirements dynamically.

    Example:

    1. name: jwt_selector
    2. requires:
    3.   issuer_1:
    4.     provider_name: issuer1
    5.   issuer_2:
    6.     provider_name: issuer2

    If a filter set “jwt_selector” with “issuer_1” to FilterState for a request, jwt_authn filter will use JwtRequirement{“provider_name”: “issuer1”} to verify.

    2.   "name": "...",
    3.   "requires": "{...}"
    4. }

    name

    (string, REQUIRED) The filter state name to retrieve the Router::StringAccessor object.

    requires

    (repeated map<, extensions.filters.http.jwt_authn.v3.JwtRequirement>) A map of string keys to requirements. The string key is the string value in the FilterState with the name specified in the name field above.

    extensions.filters.http.jwt_authn.v3.JwtAuthentication

    [extensions.filters.http.jwt_authn.v3.JwtAuthentication proto]

    This is the Envoy HTTP filter config for JWT authentication.

    For example:

    1. providers:
    2.    provider1:
    3.      issuer: issuer1
    4.      audiences:
    5.      - audience1
    6.      - audience2
    7.      remote_jwks:
    8.        http_uri:
    9.          uri: https://example.com/.well-known/jwks.json
    10.          cluster: example_jwks_cluster
    11.          timeout: 1s
    12.    provider2:
    13.      issuer: issuer2
    14.      local_jwks:
    15.        inline_string: jwks_string
    17. rules:
    18.    # Not jwt verification is required for /health path
    19.    - match:
    20.        prefix: /health
    22.    # Jwt verification for provider1 is required for path prefixed with "prefix"
    23.    - match:
    24.        prefix: /prefix
    25.      requires:
    26.        provider_name: provider1
    28.    # Jwt verification for either provider1 or provider2 is required for all other requests.
    29.    - match:
    30.        prefix: /
    31.      requires:
    32.        requires_any:
    33.          requirements:
    34.            - provider_name: provider1
    35.            - provider_name: provider2
    1. {
    2.   "providers": "{...}",
    3.   "rules": [],
    4.   "filter_state_rules": "{...}",
    5.   "bypass_cors_preflight": "...",
    6.   "requirement_map": "{...}"
    7. }

    providers

    (repeated map<, extensions.filters.http.jwt_authn.v3.JwtProvider>) Map of provider names to JwtProviders.

    1. providers:
    2.   provider1:
    3.      issuer: issuer1
    4.      audiences:
    5.      - audience1
    6.      - audience2
    7.      remote_jwks:
    8.        http_uri:
    9.          uri: https://example.com/.well-known/jwks.json
    10.          cluster: example_jwks_cluster
    11.          timeout: 1s
    12.    provider2:
    13.      issuer: provider2
    14.      local_jwks:
    15.        inline_string: jwks_string

    rules

    (repeated ) Specifies requirements based on the route matches. The first matched requirement will be applied. If there are overlapped match conditions, please put the most specific match first.

    Examples

    1. rules:
    2.   - match:
    3.       prefix: /healthz
    4.   - match:
    5.       prefix: /baz
    6.     requires:
    7.       provider_name: provider1
    8.   - match:
    9.       prefix: /foo
    10.     requires:
    11.       requires_any:
    12.         requirements:
    13.           - provider_name: provider1
    14.           - provider_name: provider2
    15.   - match:
    16.       prefix: /bar
    17.     requires:
    18.       requires_all:
    19.         requirements:
    20.           - provider_name: provider1
    21.           - provider_name: provider2

    filter_state_rules

    (extensions.filters.http.jwt_authn.v3.FilterStateRule) This message specifies Jwt requirements based on stream_info.filterState. Other HTTP filters can use it to specify Jwt requirements dynamically. The rules field above is checked first, if it could not find any matches, check this one.

    bypass_cors_preflight

    () When set to true, bypass the CORS preflight request regardless of JWT requirements specified in the rules.

    requirement_map

    (repeated map<, extensions.filters.http.jwt_authn.v3.JwtRequirement>) A map of unique requirement_names to JwtRequirements. in PerRouteConfig uses this map to specify a JwtRequirement.

    [extensions.filters.http.jwt_authn.v3.PerRouteConfig proto]

    Specify per-route config.

    1. {
    2.   "disabled": "...",
    4. }

    disabled

    () Disable Jwt Authentication for this route.

    Precisely one of disabled, must be set.

    requirement_name

    Precisely one of disabled, must be set.