Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package FPauth-core
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Router creates routes, needed for authentication. Contains some basic handlers and joins them with routes from strategies.
type entity = M.ttype entity is a type of authenticatable entity equal to MODEL.t
type strategy = (module Auth_sign.STRATEGY with type entity = entity)strategy is a function that authenticates an entity from a request.
val login_handler :
strategy Base.list ->
(module Auth_sign.RESPONSES) ->
Dream.request ->
Dream.response Lwt.tlogin_handler gets strats and redponses, starts authentication and handles its results
val logout_handler :
(module Auth_sign.RESPONSES) ->
Dream.request ->
Dream.response Lwt.tlogout_handler loguts authenticated user
val call :
?root:Base.string ->
responses:(module Auth_sign.RESPONSES) ->
extractor:Static.Params.extractor ->
strategy Base.list ->
Dream.routecall ?root ~responses ~extractor strat_list creates routes for authentication and added to Dream.router.
Has some basic routes:
- "/auth" is an entrypoint for authentication. Runs all
strategiesin order they were supplied inAuth_sign.AUTHENTICATOR.authenticate. Handles the results and calls corresponding handlers fromAuth_sign.RESPONSES. - "/logout" completes logout with
Authenticator.logoutand responses withAuth_sign.RESPONSES.logout
extractor defines how to extract params from requests for basic routes. See Static.Params.extractor.
responses define how to respond on these basic routes after handling authentication processes.
?root defines the root for all authentication-related routes. Default is "/".