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.4.tbz

sha256=49fe887d05083b37523cd6e7ca35239822c561fe7109dd383c30aeb4259a7b98

sha512=4135ad42a75fb9adc3e853a466b696d9ee6d7a9d8acf0cee9fd5f5485679a517f524ce704e2d153df4a7c4f1d14df9f94ab2a8fbe5b36e744b505daab1d40f3d

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