JSON Web Tokens (JWT) Validation

Introduction

JSON Web Token (JWT) is an open standard (RFC 7519) that is used for securely transmitting information between parties (a client and a server). JWT is a set of JSON objects tied together which is used over the web or between a client and a server to validate or authorize the user. They are signed at the client-side using a private key, and the verification is done using a public key provided by an IDP. When the client presents a token, the server represents a signed token. This information can be verified and trusted because it is digitally signed. JWT validation is the authorization method used to provide access to the protected resource based on a JWT issued by an authorization server.


Starting with Avi Vantage release 20.1.3, JWT validation is supported as one of the access policies for secure communication through Avi Vantage and it is based on a JWT issued by an authorization server.

JWT Validation Main Components

The followings are the main components used in a JWT validation process:

  • JSON Web Key Set (JWKS)
  • JSON Web Token (JWT)

Frequently Used Terms in JWT Validation

Terms Description
kid Identifier of the static key used to sign the JWT
algo Algorithm used to sign the key
iss Authorization server that issued the JWT
aud Recipients that the JWT is intended for (Avi virtual service)
sub Identifies the principal that is subject of the JWT
exp The expiration time of the token in seconds
nbf Identifies the time before which the token must not be acccepted for processing
iat The issuing time of the token in seconds
jti Unique identifier of the token

These terms are used while configuring JWT validation through Avi Vantage.

JSON Web Key Set (JWKS)

JSON Web Key Set (JWKS) is set of public keys issued by an authorising server. These keys are used to verify any JSON Web Token (JWT). JWKS is JSON obect that represents a set of JWKs. Each JWK is uniquely identified by a key identifier (kid). Issuer adds the kid to the JWT Header to specify the key used to sign the token.
Authorization server signs JWTs, and publishes the public signing keys in a JWKS (JSON Web Key Set). jwk

JSON Web Token

In its compact form, JSON Web Tokens (JWT) consist of the following components separated by dots (.):

  • Header: The header consists of the followings:
    • Type of the token, which is JWT.
    • Signing algorithm which can be HMAC, SHA256, or RSA. The following is an example of a JWT header.

    header

  • Payload: JWT Payload consists of information about the source or the client. ​JWT Payload contains the claims set. Claims are statements about an entity (of user) and additional data. Claims are of three types: Registered, Public, and Private.
    ​Registered Claims: These are the Claims that are registered in the IANA “JSON Web Token Claims” registry. For more information, refer to IANA Registered claims: https://www.iana.org/assignments/jwt/jwt.xhtml#claims
    • iss: Identifies the principal that issued the JWT
    • aud: Identifies the recipients that the JWT is intended for
    • sub: Identifies the principal that is the subject of the JWT
    • exp: The expiration time of the token in seconds since January 1, 1970 UTC (Unix time)
    • nbf: Identifies the time (a timestamp in seconds since January 1, 1970 UTC) before which the token must not be accepted for processing. (Unix time)
    • iat: The issuing time of the token in seconds since January 1, 1970 UTC (Unix time)
    • jti: Unique identifier of the Token

    The following is a sample payload for a JWT. payload

  • Signature: The signature is used to check that the message, or the request from the user is not tempered along the way.

    signature

A sample JSON token is shown below (when the above components are put together, but separated by a dot (.).

token