package FPauth-strategies

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

FPauth-strategies
- FPauth_strategies
  - Password
    
    MODEL
    
    Make
    
    M
  - TOTP
    
    HTML_settings
    
    JSON_Responses
    
    MODEL
    
    Make
    
    M
    
    R
    
    V
    
    Make_HTML_Responses
    
    S
    
    RESPONSES

Legend:
Library
Module
Module type
Parameter
Class
Class type

Make creates a strategy for a provided model with provided responses.

Parameters

module R : RESPONSES

module M : MODEL

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

Signature

type entity = M.t

val call : 
  Dream.request ->
  entity ->
  entity FPauth_core.Static.StratResult.t Lwt.t

call is the main function of the strategy. It needs "totp_code" param, otherwise it is skipped. Verifies, that the code is correct for user's secret.

val routes : Dream.route

routes provide these routes in "/totp" scope:

GET "/generate_secret" is the first step to enable TOTP. Generates a secret for a user. The user must be authenticated first. The user must have TOTP disabled.
POST "/finish_setup" is the second step to enable TOTP. Should recieve "totp_code" as param, verifies it and enables TOTP if it was correct.

val name : string

See TOTP.name