package FPauth-core

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package FPauth-core

FPauth-core
- FPauth_core
  - Auth_sign
    
    AUTHENTICATOR
    
    MODEL
    
    RESPONSES
    
    ROUTER
    
    SESSIONMANAGER
    
    STRATEGY
    
    VARIABLES
  - Authenticator
    
    Make
    
    M
    
    V
  - Make_Auth
    
    Authenticator
    
    M
    
    Router
    
    Session_manager
    
    Variables
  - Router
    
    Make
    
    A
    
    M
    
    V
  - Session_manager
    
    Make
    
    M
    
    V
  - Static
    
    AuthResult
    
    Params
    
    StratResult
    
    Infix
  - Variables
    
    Make
    
    M

Legend:
Library
Module
Module type
Parameter
Class
Class type

Make is a functor for creating modules of middlewares for various entities matching Auth.MODEL

Parameters

module M : Auth_sign.MODEL

module V : Auth_sign.VARIABLES with type entity = M.t

Signature

type entity = M.t

type entity is a type of authenticatable entity equal to MODEL.t

val auth_setup : Dream.middleware

auth_setup is a middleware which controlls session, setups field variables and helper functions for downstream handlers

auth_setup tries to extract auth string from session and determine the status of authentication. If there is no auth, then there were no authentication. If auth exisits, than set_helpers checks it and manages authentication status. If something is wrong with a session, Error Error.t is returned, and in this case session is invalidated, error is logged and 401 is sent. If session is ok, Ok request is recived, and that requested is passed on.