package jose

You can search for identifiers within the package.

in-package search v0.2.0

package jose

jose
- Jose
  - Header
  - Jwa
  - Jwe
  - Jwk
  - Jwks
  - Jws
  - Jwt

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t = {

alg : Jwa.alg;
jwk : Jwk.public Jwk.t option;
kid : string option;
x5t : string option;
x5t256 : string option;
typ : string option;
cty : string option;
enc : Jwa.enc option;
extra : (string * Yojson.Safe.t) list;

}

The header has the following properties:

alg Jwa.alg
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

Link to RFC

Complete list of registered header parameters

val make_header : 
  ?typ:string ->
  ?alg:Jwa.alg ->
  ?enc:Jwa.enc ->
  ?extra:(string * Yojson.Safe.t) list ->
  ?jwk_header:bool ->
  Jwk.priv Jwk.t ->
  t

make_header typ alg enc jwk if alg is not provided it will be derived from jwk. jwk_header decides if the jwk should be put in the header.

val of_string : string -> (t, [> `Msg of string ]) Stdlib.result

val to_string : t -> string

val to_json : t -> Yojson.Safe.t

val of_json : Yojson.Safe.t -> (t, [> `Msg of string ]) Stdlib.result