package ez_api

  1. Overview
  2. Docs
package ez_api
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module EzSessionServerSource

Sourceval random_challenge : unit -> string

Returns random challenge 30 characters long

Sourcemodule type SessionStore = sig ... end

Module that defines a way to store user's sessions.

Sourcemodule type Arg = sig ... end

Main argument for Make functor. Specifies session's and user's storage and session main configurations.

Sourceval default_check_foreign : origin:string -> token:string -> (_, int * string option) result Lwt.t

Not implemented search for foreign user.

Sourceval default_register_foreign : origin:string -> token:string -> (_, int * string option) result Lwt.t

Not implemented registration for foreign user.

Sourcemodule Make (S : Arg) : sig ... end

Main functor that defines handlers for authentication services.

Sourceexception UserAlreadyDefined

Exception when trying to create user that already exists.

Sourceexception NoPasswordProvided

Exception when trying to create non-foreign user without password.

Sourcemodule UserStoreInMemory (S : EzSession.TYPES.SessionArg with type user_id = string) : sig ... end

User storage located in the memory of the server.

Implementation of session store in the server's memory.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct