Snap.Snaplet.CustomAuth

Documentation

data AuthManager u e b

Constructors

IAuthBackend u i e b => AuthManager

Fields

• activeUser :: UserData u => Maybe u
• setCookie :: ByteString -> Cookie
• sessionCookieName :: ByteString
• userField :: ByteString
• passwordField :: ByteString
• stateStore' :: SnapletLens (Snaplet b) SessionManager
• oauth2Provider :: Maybe Text
• authFailData :: Maybe (AuthFailure e)
• providers :: HashMap Text Provider

data AuthUser

Constructors

AuthUser

Fields

• name :: Text
• session :: ByteString
• csrfToken :: ByteString

Instances

Show AuthUser

Methods

showsPrec :: Int -> AuthUser -> ShowS

show :: AuthUser -> String

showList :: [AuthUser] -> ShowS

data AuthFailure e

Constructors

UserError e

Login LoginFailure

Create CreateFailure

Instances

Show e => Show (AuthFailure e)

Methods

showsPrec :: Int -> AuthFailure e -> ShowS

show :: AuthFailure e -> String

showList :: [AuthFailure e] -> ShowS

data LoginFailure

Constructors

NoSession

SessionRecoverFail

UsernameMissing

PasswordMissing

WrongPasswordOrUsername

Instances

Eq LoginFailure

Methods

(==) :: LoginFailure -> LoginFailure -> Bool

(/=) :: LoginFailure -> LoginFailure -> Bool

Read LoginFailure

Methods

readsPrec :: Int -> ReadS LoginFailure

readList :: ReadS [LoginFailure]

readPrec :: ReadPrec LoginFailure

readListPrec :: ReadPrec [LoginFailure]

Show LoginFailure

Methods

showsPrec :: Int -> LoginFailure -> ShowS

show :: LoginFailure -> String

showList :: [LoginFailure] -> ShowS

data CreateFailure

Constructors

MissingName

InvalidName

DuplicateName

PasswordFailure PasswordFailure

OAuth2Failure OAuth2Failure

Instances

Eq CreateFailure

Methods

(==) :: CreateFailure -> CreateFailure -> Bool

(/=) :: CreateFailure -> CreateFailure -> Bool

Read CreateFailure

Methods

readsPrec :: Int -> ReadS CreateFailure

readList :: ReadS [CreateFailure]

readPrec :: ReadPrec CreateFailure

readListPrec :: ReadPrec [CreateFailure]

Show CreateFailure

Methods

showsPrec :: Int -> CreateFailure -> ShowS

show :: CreateFailure -> String

showList :: [CreateFailure] -> ShowS

data PasswordFailure

Constructors

Missing

Mismatch

Instances

Eq PasswordFailure

Methods

(==) :: PasswordFailure -> PasswordFailure -> Bool

(/=) :: PasswordFailure -> PasswordFailure -> Bool

Read PasswordFailure

Methods

readsPrec :: Int -> ReadS PasswordFailure

readList :: ReadS [PasswordFailure]

readPrec :: ReadPrec PasswordFailure

readListPrec :: ReadPrec [PasswordFailure]

Show PasswordFailure

Methods

showsPrec :: Int -> PasswordFailure -> ShowS

show :: PasswordFailure -> String

showList :: [PasswordFailure] -> ShowS

class (UserData u, Binary i, Show e, Eq e) => IAuthBackend u i e b | u -> b, b -> e, e -> i where

Minimal complete definition

preparePasswordCreate, cancelPrepare, create, attachLoginMethod, login, logout, recover, getUserId, isDuplicateError

Methods

preparePasswordCreate :: Maybe u -> Text -> Handler b (AuthManager u e b) (Either e i)

cancelPrepare :: i -> Handler b (AuthManager u e b) ()

create :: Text -> i -> Handler b (AuthManager u e b) (Either (Either e CreateFailure) u)

attachLoginMethod :: u -> i -> Handler b (AuthManager u e b) (Either e ())

login :: Text -> Text -> Handler b (AuthManager u e b) (Either e (Maybe u))

logout :: Text -> Handler b (AuthManager u e b) ()

recover :: Text -> Handler b (AuthManager u e b) (Either (AuthFailure e) u)

getUserId :: u -> Handler b (AuthManager u e b) ByteString

isDuplicateError :: e -> Handler b (AuthManager u e b) Bool

class UserData a where

Minimal complete definition

extractUser

Methods

extractUser :: a -> AuthUser

defAuthSettings :: AuthSettings

authName :: Lens' AuthSettings Text

authSetCookie :: Lens' AuthSettings (ByteString -> Cookie)

createAccount :: IAuthBackend u i e b => Handler b (AuthManager u e b) (Either (Either e CreateFailure) u)

loginUser :: IAuthBackend u i e b => Handler b (AuthManager u e b) () -> Handler b (AuthManager u e b) () -> Handler b (AuthManager u e b) ()

logoutUser :: IAuthBackend u i e b => Handler b (AuthManager u e b) ()

recoverSession :: IAuthBackend u i e b => Handler b (AuthManager u e b) ()

combinedLoginRecover :: IAuthBackend u i e b => Handler b (AuthManager u e b) () -> Handler b (AuthManager u e b) (Maybe u)

setUser :: UserData u => u -> Handler b (AuthManager u e b) ()

currentUser :: UserData u => Handler b (AuthManager u e b) (Maybe u)

getAuthFailData :: Handler b (AuthManager u e b) (Maybe (AuthFailure e))

resetAuthFailData :: Handler b (AuthManager u e b) ()

authInit :: IAuthBackend u i e b => Maybe (OAuth2Settings u i e b) -> AuthSettings -> SnapletInit b (AuthManager u e b)

isSessionDefined :: Handler b (AuthManager u e b) Bool

isLoggedIn :: UserData u => Handler b (AuthManager u e b) Bool

compiledAuthSplices :: UserData u => SnapletLens b (AuthManager u e b) -> Splices (SnapletCSplice b)

ifLoggedIn :: UserData u => SnapletLens b (AuthManager u e b) -> SnapletISplice b

ifLoggedOut :: UserData u => SnapletLens b (AuthManager u e b) -> SnapletISplice b

loggedInUser :: UserData u => SnapletLens b (AuthManager u e b) -> SnapletISplice b