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

Maintainers

J

josef@oxidizing.io

Sources

sihl-queue-0.1.10.tbz

sha256=b264f357c2a65dbed00c3459be76cdd9b21275aeb9d0289634a2050161665211

sha512=b22fa96a3c7fa607df04848b40a0f54890f4f63c519d10ff7fcef8ccf09341731b42ff4decccb4a7e858e138a803c849ee0c5226c514938cdcded2fd80cae4cb

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

Module `Sihl_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

Sourceval set_expires_in : now:Ptime.t -> 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