package sihl

You can search for identifiers within the package.

in-package search v0.2.0

The modular functional web framework

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (35)

Authors

J

Josef Erben

Maintainers

J

josef@oxidizing.io

Sources

sihl-0.1.3.tbz

sha256=3d1acdd1eae24a7131033656f90b5d20c1621e6ef92957edf88a09b8b5f2d9e9

sha512=d224f54e20a9465c7a03d534dadcb2b9a181ae87c13731840db945aab37534f6f3982c5cb25a197e90c17d8772da062b19fa92bb93ed53a8b736c3776a7776db

doc/sihl.utils/Utils/Jwt/index.html

Module `Utils.Jwt`Source

This module implements JSON Web tokens. They are typically used decouple authentication from the other parts of a system.

Sourcetype algorithm = Jwto.algorithm =

| HS256
| HS512
| Unknown

Sourcetype t = Jwto.t

Sourcetype payload

Sourceval empty : payload

Sourceval add_claim : key:string -> value:string -> payload -> payload

Source

val set_expires_in : 
  now:Ptime.t ->
  Utils__.Utils_time.duration ->
  payload ->
  payload

Adds the "exp" claim.

Sourceval encode : algorithm -> secret:string -> payload -> (string, string) result

Sourceval decode : secret:string -> string -> (t, string) result

Checks whether the signature is correct and decodes the base64 string representation to t.

Sourceval get_claim : key:string -> t -> string option

Sourceval is_expired : now:Ptime.t -> ?claim:string -> t -> bool

Checks whether the claim of the token t is in the past by looking at now. If no exp claim was not found the token can not expire and is_expired returns true. A custom claim can be provided, by default it looks for "exp".

Sourceval pp : Format.formatter -> t -> unit

Sourceval eq : t -> t -> bool

Sourcemodule Jwto = Jwto