Kong JWT Signer Configuration

You are browsing documentation for an outdated plugin version.

Configuration

This plugin is compatible with DB-less mode.

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name or plugin

  string required

  The name of the plugin, in this case jwt-signer.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/{serviceName|Id}/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/{routeName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • realm

    string

    When authentication or authorization fails, or there is an unexpected error, the plugin sends an WWW-Authenticate header with the realm attribute value.

  • enable_hs_signatures

    boolean default: false

    Tokens signed with HMAC algorithms such as HS256, HS384, or HS512 are not accepted by default. If you need to accept such tokens for verification, enable this setting.

  • enable_instrumentation

    boolean default: false

    When you are experiencing problems in production and don’t want to change the logging level on Kong nodes, which requires a reload, use this parameter to enable instrumentation for the request. The parameter writes log entries with some added information using ngx.CRIT (CRITICAL) level.

  • access_token_issuer

    string default: kong

    The iss claim of a signed or re-signed access token is set to this value. Original iss claim of the incoming token (possibly introspected) is stored in original_iss claim of the newly signed access token.

  • access_token_keyset

    string default: kong

    The name of the keyset containing signing keys.

  • access_token_jwks_uri

    string

    If you want to use config.verify_access_token_signature, you must specify the URI where the plugin can fetch the public keys (JWKS) to verify the signature of the access token. If you don’t specify a URI and you pass a JWT token to the plugin, then the plugin responds with 401 Unauthorized.

  • access_token_request_header

    string default: Authorization

    This parameter tells the name of the header where to look for the access token. By default, the plugin searches it from Authorization: Bearer <token> header (the value being magic key authorization:bearer). If you don’t want to do anything with access token, then you can set this to null or "" (empty string). Any header can be used to pass the access token to the plugin. Two predefined values are authorization:bearer and authorization:basic.

  • access_token_leeway

    number default: 0

    Adjusts clock skew between the token issuer and Kong. The value is added to the token’s exp claim before checking token expiry against Kong servers’ current time in seconds. You can disable access token expiry verification altogether with config.verify_access_token_expiry.

  • access_token_scopes_required

    array of type string

    Specify the required values (or scopes) that are checked by a claim specified by config.access_token_scopes_claim. For example, [ "employee demo-service", "superadmin" ] can be given as "employee demo-service,superadmin" (form post) would mean that the claim needs to have values "employee" and "demo-service" OR that the claim needs to have the value of "superadmin" to be successfully authorized for the upstream access. If required scopes are not found in access token, the plugin responds with 403 Forbidden.

  • access_token_scopes_claim

    array of type string default: scope

    Specify the claim in an access token to verify against values of config.access_token_scopes_required. This supports nested claims. For example, with Keycloak you could use [ "realm_access", "roles" ], which can be given as realm_access,roles (form post). If the claim is not found in the access token, and you have specified config.access_token_scopes_required, the plugin responds with 403 Forbidden.

  • access_token_consumer_claim

    array of type string

    When you set a value for this parameter, the plugin tries to map an arbitrary claim specified with this configuration parameter (for example, sub or username) in an access token to Kong consumer entity. Kong consumers have an id, a username, and a custom_id. The config.access_token_consumer_by parameter tells the plugin which of these Kong consumer properties can be used for mapping. If this parameter is enabled but the mapping fails, such as when there’s a non-existent Kong consumer, the plugin responds with 403 Forbidden. Kong consumer mapping is useful when you want to communicate this information to other plugins such as ACL or rate limiting. The JWT Signer plugin also sets a couple of standard Kong upstream consumer headers.

  • access_token_consumer_by

    array of type string default: username, custom_id Must be one of: id, username, custom_id

    When the plugin tries to apply an access token to a Kong consumer mapping, it tries to find a matching Kong consumer from properties defined using this configuration parameter. The parameter can take an array of alues. Valid values are id, username, and custom_id.

  • access_token_upstream_header

    string default: Authorization:Bearer

    Removes the config.access_token_request_header from the request after reading its value. With config.access_token_upstream_header, you can specify the upstream header where the plugin adds the Kong signed token. If you don’t specify a value, such as use null or "" (empty string), the plugin does not even try to sign or re-sign the token.

  • access_token_upstream_leeway

    number default: 0

    If you want to add or perhaps subtract (using a negative value) expiry time (in seconds) of the original access token, you can specify a value that is added to the original access token’s exp claim.

  • access_token_introspection_endpoint

    string

    When you use opaque access tokens and you want to turn on access token introspection, you need to specify the OAuth 2.0 introspection endpoint URI with this configuration parameter. Otherwise, the plugin does not try introspection and returns 401 Unauthorized instead.

  • access_token_introspection_endpoint

    string

    When you use opaque access tokens and you want to turn on access token introspection, you need to specify the OAuth 2.0 introspection endpoint URI with this configuration parameter. Otherwise, the plugin does not try introspection and returns 401 Unauthorized instead.

  • access_token_introspection_authorization

    string

    If the introspection endpoint requires client authentication (client being the JWT Signer plugin), you can specify the Authorization header’s value with this configuration parameter. For example, if you use client credentials, enter the value of "Basic base64encode('client_id:client_secret')" to this configuration parameter. You are responsible for providing the full string of the header and doing all of the necessary encodings (such as base64) required on a given endpoint.

  • access_token_introspection_body_args

    string

    If you need to pass additional body arguments to an introspection endpoint when the plugin introspects the opaque access token, use this config parameter to specify them. You should URL encode the value. For example: resource= or a=1&b=&c.

  • access_token_introspection_hint

    string default: access_token

    If you need to give hint parameter when introspecting an access token, use this parameter to specify the value. By default, the plugin sends hint=access_token.

  • access_token_introspection_jwt_claim

    array of type string

    If your introspection endpoint returns an access token in one of the keys (or claims) within the introspection results (JSON), the plugin can use that value instead of the introspection results when doing expiry verification and signing of the new token issued by Kong. For example, if you specify [ "token_string" ], which can be given as "token_string" (form post) to this configuration parameter, the plugin looks for key token_string in JSON of the introspection results and uses that as an access token instead of using introspection JSON directly. If the key cannot be found, the plugin responds with 401 Unauthorized. Also if the key is found but cannot be decoded as JWT, it also responds with 401 Unauthorized.

  • access_token_introspection_scopes_required

    array of type string

    Specify the required values (or scopes) that are checked by an introspection claim/property specified by config.access_token_introspection_scopes_claim. For example, [ "employee demo-service", "superadmin" ] can be given as "employee demo-service,superadmin" (form post) would mean that the claim needs to have values "employee" and "demo-service" OR that the claim needs to have value of "superadmin" to be successfully authorized for the upstream access. If required scopes are not found in access token introspection results (JSON), the plugin responds with 403 Forbidden.

  • access_token_introspection_scopes_claim

    array of type string required default: scope

    Specify the claim/property in access token introspection results (JSON) to be verified against values of config.access_token_introspection_scopes_required. This supports nested claims. For example, with Keycloak you could use [ "realm_access", "roles" ], hich can be given as realm_access,roles (form post). If the claim is not found in access token introspection results, and you have specified config.access_token_introspection_scopes_required, the plugin responds with 403 Forbidden.

  • access_token_introspection_consumer_claim

    array of type string

    When you set a value for this parameter, the plugin tries to map an arbitrary claim specified with this configuration parameter (such as sub or username) in access token introspection results to the Kong consumer entity. Kong consumers have an id, a username, and a custom_id. The config.access_token_introspection_consumer_by parameter tells the plugin which of these Kong consumer properties can be used for mapping. If this parameter is enabled but the mapping fails, such as when there’s a non-existent Kong consumer, the plugin responds with 403 Forbidden. Kong consumer mapping is useful when you want to communicate this information to other plugins such as ACL or rate limiting. The JWT Signer plugin also sets a couple of standard Kong upstream consumer headers.

  • access_token_introspection_consumer_by

    array of type string default: username, custom_id Must be one of: id, username, custom_id

    When the plugin tries to do access token introspection results to Kong consumer mapping, it tries to find a matching Kong consumer from properties defined using this configuration parameter. The parameter can take an array of values. Valid values are id, username, and custom_id.

  • access_token_introspection_leeway

    number default: 0

    Adjusts clock skew between the token issuer introspection results and Kong. The value is added to introspection results (JSON) exp claim/property before checking token expiry against Kong servers current time in seconds. You can disable access token introspection expiry verification altogether with config.verify_access_token_introspection_expiry.

  • access_token_introspection_timeout

    number

    Timeout in milliseconds for an introspection request. The plugin tries to introspect twice if the first request fails for some reason. If both requests timeout, then the plugin runs two times the config.access_token_introspection_timeout on access token introspection.

  • access_token_signing_algorithm

    string required default: RS256 Must be one of: HS256, HS384, HS512, RS256, RS512, ES256, ES384, ES512, PS256, PS384, PS512, EdDSA

    When this plugin sets the upstream header as specified with config.access_token_upstream_header, it also re-signs the original access token using the private keys of the JWT Signer plugin. Specify the algorithm that is used to sign the token. Currently supported values:

    • "HS256"
    • "HS384"
    • "HS512"
    • "RS256"
    • "RS512"
    • "ES256"
    • "ES384"
    • "ES512"
    • "PS256"
    • "PS384"
    • "PS512"
    • "EdDSA" The config.access_token_issuer specifies which keyset is used to sign the new token issued by Kong using the specified signing algorithm.

  • access_token_optional

    boolean default: false

    If an access token is not provided or no config.access_token_request_header is specified, the plugin cannot verify the access token. In that case, the plugin normally responds with 401 Unauthorized (client didn’t send a token) or 500 Unexpected (a configuration error). Use this parameter to allow the request to proceed even when there is no token to check. If the token is provided, then this parameter has no effect (look other parameters to enable and disable checks in that case).

  • verify_access_token_signature

    boolean default: true

    Quickly turn access token signature verification off and on as needed.

  • verify_access_token_expiry

    boolean default: true

    Quickly turn access token expiry verification off and on as needed.

  • verify_access_token_scopes

    boolean default: true

    Quickly turn off and on the access token required scopes verification, specified with config.access_token_scopes_required.

  • verify_access_token_introspection_expiry

    boolean default: true

    Quickly turn access token introspection expiry verification off and on as needed.

  • verify_access_token_introspection_scopes

    boolean default: true

    Quickly turn off and on the access token introspection scopes verification, specified with config.access_token_introspection_scopes_required.

  • cache_access_token_introspection

    boolean default: true

    Whether to cache access token introspection results.

  • trust_access_token_introspection

    boolean default: true

    When you provide a opaque access token that the plugin introspects, and you do expiry and scopes verification on introspection results, you probably don’t want to do another round of checks on the payload before the plugin signs a new token. Or that you don’t want to do checks to a JWT token provided with introspection JSON specified with config.access_token_introspection_jwt_claim. Use this parameter to enable and disable further checks on a payload before the new token is signed. If you set this to true, the expiry or scopes are not checked on a payload.

  • enable_access_token_introspection

    boolean default: true

    If you don’t want to support opaque access tokens, change this configuration parameter to false to disable introspection.

  • channel_token_issuer

    string default: kong

    The iss claim of the re-signed channel token is set to this value, which is kong by default. The original iss claim of the incoming token (possibly introspected) is stored in the original_iss claim of the newly signed channel token.

  • channel_token_keyset

    string default: kong

    The name of the keyset containing signing keys.

  • channel_token_jwks_uri

    string

    If you want to use config.verify_channel_token_signature, you must specify the URI where the plugin can fetch the public keys (JWKS) to verify the signature of the channel token. If you don’t specify a URI and you pass a JWT token to the plugin, then the plugin responds with 401 Unauthorized.

  • channel_token_request_header

    string

    This parameter tells the name of the header where to look for the channel token. By default, the plugin doesn’t look for the channel token. If you don’t want to do anything with the channel token, then you can set this to null or "" (empty string). Any header can be used to pass the channel token to this plugin. Two predefined values are authorization:bearer and authorization:basic.

  • channel_token_leeway

    number default: 0

    Adjusts clock skew between the token issuer and Kong. The value will be added to token’s exp claim before checking token expiry against Kong servers current time in seconds. You can disable channel token expiry verification altogether with config.verify_channel_token_expiry.

  • channel_token_scopes_required

    array of type string

    Specify the required values (or scopes) that are checked by a claim specified by config.channel_token_scopes_claim. For example, if [ "employee demo-service", "superadmin" ] was given as "employee demo-service,superadmin" (form post), the claim needs to have values "employee" and "demo-service", OR that the claim needs to have the value of "superadmin" to be successfully authorized for the upstream access. If required scopes are not found in the channel token, the plugin responds with 403 Forbidden.

  • channel_token_scopes_claim

    array of type string default: scope

    Specify the claim in a channel token to verify against values of config.channel_token_scopes_required. This supports nested claims. With Keycloak, you could use [ "realm_access", "roles" ], which can be given as realm_access,roles (form post). If the claim is not found in the channel token, and you have specified config.channel_token_scopes_required, the plugin responds with 403 Forbidden.

  • channel_token_consumer_claim

    array of type string

    When you set a value for this parameter, the plugin tries to map an arbitrary claim specified with this configuration parameter (such as sub or username) in a channel token to a Kong consumer entity. Kong consumers have an id, a username, and a custom_id. The config.channel_token_consumer_by parameter tells the plugin which Kong consumer properties can be used for mapping. If this parameter is enabled but the mapping fails, such as when there’s a non-existent Kong consumer, the plugin responds with 403 Forbidden. Kong consumer mapping is useful when you want to communicate this information to other plugins such as ACL or rate limiting. The JWT Signer plugin also sets a couple of standard Kong upstream consumer headers.

  • channel_token_consumer_by

    array of type string default: username, custom_id Must be one of: id, username, custom_id

    When the plugin tries to do channel token to Kong consumer mapping, it tries to find a matching Kong consumer from properties defined using this configuration parameter. The parameter can take an array of valid values: id, username, and custom_id.

  • channel_token_upstream_header

    string

    This plugin removes the config.channel_token_request_header from the request after reading its value. With config.channel_token_upstream_header, you can specify the upstream header where the plugin adds the Kong-signed token. If you don’t specify a value (so null or "" empty string), the plugin does not attempt to re-sign the token.

  • channel_token_upstream_leeway

    number default: 0

    If you want to add or perhaps subtract (using negative value) expiry time of the original channel token, you can specify a value that is added to the original channel token’s exp claim.

  • channel_token_introspection_endpoint

    string

    When using opaque channel tokens, and you want to turn on channel token introspection, you need to specify the OAuth 2.0 introspection endpoint URI with this configuration parameter. Otherwise the plugin will not try introspection, and instead returns 401 Unauthorized when using opaque channel tokens.

  • channel_token_introspection_authorization

    string

    If the introspection endpoint requires client authentication (client being this plugin), you can specify the Authorization header’s value with this configuration parameter. If you use client credentials, you should enter the value of "Basic base64encode('client_id:client_secret')" to this configuration parameter. You are responsible for providing the full string of the header and doing all the necessary encodings (such as base64) required on a given endpoint.

  • channel_token_introspection_body_args

    string

    If you need to pass additional body arguments to introspection endpoint when the plugin introspects the opaque channel token, you can use this config parameter to specify them. You should URL encode the value. For example: resource= or a=1&b=&c.

  • channel_token_introspection_hint

    string

    If you need to give hint parameter when introspecting a channel token, you can use this parameter to specify the value of such parameter. By default, a hint isn’t sent with channel token introspection.

  • channel_token_introspection_jwt_claim

    array of type string

    If your introspection endpoint returns a channel token in one of the keys (or claims) in the introspection results (JSON), the plugin can use that value instead of the introspection results when doing expiry verification and signing of the new token issued by Kong. For example, if you specify [ "token_string" ], which can be given as "token_string" (form post) to this configuration parameter, the plugin looks for key token_string in JSON of the introspection results and uses that as a channel token instead of using introspection JSON directly. If the key cannot be found, the plugin responds with 401 Unauthorized. Also if the key is found but cannot be decoded as JWT, the plugin responds with 401 Unauthorized.

  • channel_token_introspection_scopes_required

    array of type string

    Use this parameter to specify the required values (or scopes) that are checked by an introspection claim/property specified by config.channel_token_introspection_scopes_claim. For example, [ "employee demo-service", "superadmin" ], which can be given as "employee demo-service,superadmin" (form post) would mean that the claim needs to have the values "employee" and "demo-service" OR that the claim needs to have the value of "superadmin" to be successfully authorized for the upstream access. If required scopes are not found in channel token introspection results (JSON), the plugin responds with 403 Forbidden.

  • channel_token_introspection_scopes_claim

    array of type string default: scope

    Use this parameter to specify the claim/property in channel token introspection results (JSON) to be verified against values of config.channel_token_introspection_scopes_required. This supports nested claims. For example, with Keycloak you could use [ "realm_access", "roles" ], which can be given as realm_access,roles (form post). If the claim is not found in channel token introspection results, and you have specified config.channel_token_introspection_scopes_required, the plugin responds with 403 Forbidden.

  • channel_token_introspection_consumer_claim

    array of type string

    When you set a value for this parameter, the plugin tries to map an arbitrary claim specified with this configuration parameter (such as sub or username) in channel token introspection results to Kong consumer entity. Kong consumers have an id, a username and a custom_id. The config.channel_token_introspection_consumer_by parameter tells the plugin which of these Kong consumer properties can be used for mapping. If this parameter is enabled but the mapping fails, such as when there’s a non-existent Kong consumer, the plugin responds with 403 Forbidden. Kong consumer mapping is useful when you want to communicate this information to other plugins such as ACL or rate limiting. The JWT Signer plugin also sets a couple of standard Kong upstream consumer headers.

  • channel_token_introspection_consumer_by

    array of type string default: username, custom_id Must be one of: id, username, custom_id

    When the plugin tries to do channel token introspection results to Kong consumer mapping, it tries to find a matching Kong consumer from properties defined using this configuration parameter. The parameter can take an array of values. Valid values are id, username and custom_id.

  • channel_token_introspection_leeway

    number default: 0

    You can use this parameter to adjust clock skew between the token issuer introspection results and Kong. The value will be added to introspection results (JSON) exp claim/property before checking token expiry against Kong servers current time (in seconds). You can disable channel token introspection expiry verification altogether with config.verify_channel_token_introspection_expiry.

  • channel_token_introspection_timeout

    number

    Timeout in milliseconds for an introspection request. The plugin tries to introspect twice if the first request fails for some reason. If both requests timeout, then the plugin runs two times the config.access_token_introspection_timeout on channel token introspection.

  • channel_token_signing_algorithm

    string required default: RS256 Must be one of: HS256, HS384, HS512, RS256, RS512, ES256, ES384, ES512, PS256, PS384, PS512, EdDSA

    When this plugin sets the upstream header as specified with config.channel_token_upstream_header, it also re-signs the original channel token using private keys of this plugin. Specify the algorithm that is used to sign the token. Currently supported values:

    • "HS256"
    • "HS384"
    • "HS512"
    • "RS256"
    • "RS512"
    • "ES256"
    • "ES384"
    • "ES512"
    • "PS256"
    • "PS384"
    • "PS512"
    • "EdDSA"

    The config.channel_token_issuer specifies which keyset is used to sign the new token issued by Kong using the specified signing algorithm.

  • channel_token_optional

    boolean default: false

    If a channel token is not provided or no config.channel_token_request_header is specified, the plugin cannot verify the channel token. In that case, the plugin normally responds with 401 Unauthorized (client didn’t send a token) or 500 Unexpected (a configuration error). Enable this parameter to allow the request to proceed even when there is no channel token to check. If the channel token is provided, then this parameter has no effect (look other parameters to enable and disable checks in that case).

  • verify_channel_token_signature

    boolean default: true

    Quickly turn on/off the channel token signature verification.

  • verify_channel_token_expiry

    boolean default: true

  • verify_channel_token_scopes

    boolean default: true

    Quickly turn on/off the channel token required scopes verification specified with config.channel_token_scopes_required.

  • verify_channel_token_introspection_expiry

    boolean default: true

    Quickly turn on/off the channel token introspection expiry verification.

  • verify_channel_token_introspection_scopes

    boolean default: true

    Quickly turn on/off the channel token introspection scopes verification specified with config.channel_token_introspection_scopes_required.

  • cache_channel_token_introspection

    boolean default: true

    Whether to cache channel token introspection results.

  • trust_channel_token_introspection

    boolean default: true

    When you provide an opaque channel token that the plugin introspects, and you do expiry and scopes verification on introspection results, you probably don’t want to do another round of checks on the payload before the plugin signs a new token. Or you don’t want to do checks to a JWT token provided with introspection JSON specified with config.channel_token_introspection_jwt_claim. Use this parameter to enable or disable further checks on a payload before the new token is signed. If you set this to true (default), the expiry or scopes are not checked on a payload.

  • enable_channel_token_introspection

    boolean default: true

    If you don’t want to support opaque channel tokens, disable introspection by changing this configuration parameter to false.