package ez_api

You can search for identifiers within the package.

in-package search v0.2.0

Easy API library and tools

Install

md5=ed68e0a33325ecf6a3319cafa636d62e

sha512=425c6289d568cf697e8d9977ac43e2ebcdeec8f04f5a17225824d5a37ac700961e5d1283b92aeaebaf58ccfb5b4261bcba1180ab11c267ade0de86b68fd6ca2d

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.

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

Not implemented search for foreign user.

val 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.

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

User storage located in the memory of the server.

Sourcemodule SessionStoreInMemory : SessionStore

Implementation of session store in the server's memory.