Snap.Snaplet.Auth.Backends.Hdbc

Authentication backend using HDBC

Documentation

initHdbcAuthManager

Arguments

:: (ConnSrc s, IConnection c)

=> AuthSettings

Auth settings

-> Lens b (Snaplet SessionManager)

Lens to the session manager

-> s c

Raw HDBC connection

-> AuthTable

Authentication table configuration

-> Queries

Queries to be used for authentication

-> SnapletInit b (AuthManager b)

Initialises this HDBC snaplet. It automatically configures a resource pool with commonly acceptable default settings. Use initHdbcAuthManager' to initialise with a custom resource pool.

data HdbcAuthManager

Authmanager state containing the resource pool and the table/query configuration.

Constructors

forall c s . (IConnection c, ConnSrc s) => HdbcAuthManager

Fields

connSt :: HdbcSnaplet c s

table :: AuthTable

qries :: Queries

Instances

IAuthBackend HdbcAuthManager

data AuthTable

Datatype containing the names of the columns for the authentication table.

Constructors

AuthTable

Fields

tblName :: String

colId :: String

colLogin :: String

colPassword :: String

colActivatedAt :: String

colSuspendedAt :: String

colRememberToken :: String

colLoginCount :: String

colFailedLoginCount :: String

colLockedOutUntil :: String

colCurrentLoginAt :: String

colLastLoginAt :: String

colCurrentLoginIp :: String

colLastLoginIp :: String

colCreatedAt :: String

colUpdatedAt :: String

colRoles :: String

colMeta :: String

defAuthTable :: AuthTable

Default authentication table layout

colLst :: [AuthTable -> String]

List of deconstructors so it's easier to extract column names form an AuthTable.

data LookupQuery

Constructors

ByUserId

ByLogin

ByRememberToken

data Queries

Constructors

Queries

Fields

selectQuery :: AuthTable -> LookupQuery -> [SqlValue] -> (String, [SqlValue])

saveQuery :: AuthTable -> AuthUser -> (String, String, [SqlValue])

deleteQuery :: AuthTable -> AuthUser -> (String, [SqlValue])

defQueries :: Queries

defSelectQuery :: AuthTable -> LookupQuery -> [SqlValue] -> (String, [SqlValue])

defSaveQuery :: AuthTable -> AuthUser -> (String, String, [SqlValue])

defDeleteQuery :: AuthTable -> AuthUser -> (String, [SqlValue])

prepExec :: IConnection conn => String -> [SqlValue] -> conn -> IO ()

authQuery :: HdbcAuthManager -> (String, [SqlValue]) -> IO (Maybe AuthUser)

mkUser :: AuthTable -> Map String SqlValue -> AuthUser