package jose

  1. Overview
  2. Docs

Module Jose.HeaderSource

Sourcetype t = {
  1. alg : Jwa.alg;
  2. jku : string option;
  3. jwk : Jwk.public Jwk.t option;
  4. kid : string option;
  5. x5t : string option;
  6. x5t256 : string option;
  7. typ : string option;
  8. cty : string option;
  9. enc : Jwa.enc option;
}

The header has the following properties: - alg Jwa - RS256 and none is currently the only supported algs - jku JWK Set URL - jwk JSON Web Key

  • kid Key ID - We currently always expect this to be there, this can change in the future - x5t X.509 Certificate SHA-1 Thumbprint - x5t#S256 X.509 Certificate SHA-256 Thumbprint - typ Type - cty Content Type Not implemented: - x5u X.509 URL - x5c X.509 Certficate Chain - crit Critical

Link to RFC

Sourceval make_header : ?typ:string -> ?alg:Jwa.alg -> ?enc:Jwa.enc -> Jwk.priv Jwk.t -> t

make_header typ alg enc jwk if alg is not provided it will be derived from jwk.

Sourceval of_string : string -> (t, [> `Msg of string ]) result
Sourceval to_string : t -> string
Sourceval to_json : t -> Yojson.Safe.t
Sourceval of_json : Yojson.Safe.t -> (t, [> `Msg of string ]) result