snaplet-customauth-0.2.1: Alternate authentication snaplet
Safe HaskellNone
LanguageHaskell2010

Snap.Snaplet.CustomAuth

Documentation

data AuthManager u e b Source #

Constructors

forall i.IAuthBackend u i e b => AuthManager 

Fields

data AuthUser Source #

Constructors

AuthUser 

Fields

Instances

Instances details
Show AuthUser Source # 
Instance details

Defined in Snap.Snaplet.CustomAuth.Types

Methods

showsPrec :: Int -> AuthUser -> ShowS #

show :: AuthUser -> String #

showList :: [AuthUser] -> ShowS #

data AuthFailure e Source #

Constructors

UserError e 
Login LoginFailure 
Create CreateFailure 

Instances

Instances details
Show e => Show (AuthFailure e) Source # 
Instance details

Defined in Snap.Snaplet.CustomAuth.Types

Methods

showsPrec :: Int -> AuthFailure e -> ShowS #

show :: AuthFailure e -> String #

showList :: [AuthFailure e] -> ShowS #

data LoginFailure Source #

Constructors

NoSession 
SessionRecoverFail 
UsernameMissing 
PasswordMissing 
WrongPasswordOrUsername 

Instances

Instances details
Eq LoginFailure Source # 
Instance details

Defined in Snap.Snaplet.CustomAuth.Types

Methods

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

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

Read LoginFailure Source # 
Instance details

Defined in Snap.Snaplet.CustomAuth.Types

Methods

readsPrec :: Int -> ReadS LoginFailure #

readList :: ReadS [LoginFailure] #

readPrec :: ReadPrec LoginFailure #

readListPrec :: ReadPrec [LoginFailure] #

Show LoginFailure Source # 
Instance details

Defined in Snap.Snaplet.CustomAuth.Types

Methods

showsPrec :: Int -> LoginFailure -> ShowS #

show :: LoginFailure -> String #

showList :: [LoginFailure] -> ShowS #

data CreateFailure Source #

Constructors

MissingName 
InvalidName 
DuplicateName 
PasswordFailure PasswordFailure 
OAuth2Failure OAuth2Failure 

Instances

Instances details
Eq CreateFailure Source # 
Instance details

Defined in Snap.Snaplet.CustomAuth.Types

Methods

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

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

Read CreateFailure Source # 
Instance details

Defined in Snap.Snaplet.CustomAuth.Types

Methods

readsPrec :: Int -> ReadS CreateFailure #

readList :: ReadS [CreateFailure] #

readPrec :: ReadPrec CreateFailure #

readListPrec :: ReadPrec [CreateFailure] #

Show CreateFailure Source # 
Instance details

Defined in Snap.Snaplet.CustomAuth.Types

Methods

showsPrec :: Int -> CreateFailure -> ShowS #

show :: CreateFailure -> String #

showList :: [CreateFailure] -> ShowS #

data PasswordFailure Source #

Constructors

Missing 
Mismatch 

Instances

Instances details
Eq PasswordFailure Source # 
Instance details

Defined in Snap.Snaplet.CustomAuth.Types

Methods

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

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

Read PasswordFailure Source # 
Instance details

Defined in Snap.Snaplet.CustomAuth.Types

Methods

readsPrec :: Int -> ReadS PasswordFailure #

readList :: ReadS [PasswordFailure] #

readPrec :: ReadPrec PasswordFailure #

readListPrec :: ReadPrec [PasswordFailure] #

Show PasswordFailure Source # 
Instance details

Defined in Snap.Snaplet.CustomAuth.Types

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 Source #

Methods

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

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

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

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

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

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

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

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

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

class UserData a where Source #

Methods

extractUser :: a -> AuthUser Source #

defAuthSettings :: AuthSettings Source #

authName :: Lens' AuthSettings Text Source #

authCookieLifetime :: Lens' AuthSettings (Maybe NominalDiffTime) Source #

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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