package jose

  1. Overview
  2. Docs
On This Page
  1. JSON Web Token

Module Jose.JwtSource

JSON Web Token

Sourcetype payload = Yojson.Safe.t
Sourcetype claim = string * Yojson.Safe.t
Sourceval empty_payload : payload
Sourcetype t = {
  1. header : Header.t;
  2. raw_header : string;
  3. payload : payload;
  4. raw_payload : string;
  5. signature : Jws.signature;
}
Sourceval add_claim : string -> Yojson.Safe.t -> payload -> payload
Sourceval get_yojson_claim : t -> string -> Yojson.Safe.t option
Sourceval get_string_claim : t -> string -> string option
Sourceval get_int_claim : t -> string -> int option
Sourceval to_string : t -> string
Sourceval of_string : jwk:'a Jwk.t -> string -> (t, [> `Expired | `Invalid_signature | `Msg of string ]) result

of_string ~jwk jwt_string parses and validates the encoded JWT string.

Sourceval unsafe_of_string : string -> (t, [> `Msg of string ]) result
Sourceval to_jws : t -> Jws.t
Sourceval of_jws : Jws.t -> t
Sourceval validate_signature : jwk:'a Jwk.t -> t -> (t, [> `Invalid_signature | `Msg of string ]) result

validate_signature ~jwk t checks if the JWT is valid and then calls Jws.validate to validate the signature

Sourceval check_expiration : t -> (t, [> `Expired ]) result

check_expiration t checks whether the JWT is valid at the current time.

Sourceval validate : jwk:'a Jwk.t -> t -> (t, [> `Expired | `Invalid_signature | `Msg of string ]) result

validate ~jwk t does the same validation as `validate_signature` and additionally checks expiration.

Sourceval sign : ?header:Header.t -> payload:payload -> Jwk.priv Jwk.t -> (t, [> `Msg of string ]) result

sign header payload priv creates a signed JWT from header and payload

We will start using a private JWK instead of a Mirage_crypto_pk.Rsa.priv soon