Yesod.Helpers.Auth

Subsite

data Auth

Constructors

Auth

Instances

YesodAuth master => YesodSubSite Auth master

getAuth :: a -> Auth

data AuthRoute

Constructors

CheckR

LogoutR

OpenIdForwardR

OpenIdCompleteR

RpxnowR

FacebookR

EmailRegisterR

EmailVerifyR Int64 String

EmailLoginR

EmailPasswordR

LoginR

Instances

Eq AuthRoute

Read AuthRoute

Show AuthRoute

Settings

class (Yesod master, PersistEntity (AuthEntity master), PersistEntity (AuthEmailEntity master)) => YesodAuth master where

Associated Types

type AuthEntity master

type AuthEmailEntity master

Methods

defaultDest :: master -> Route master

Default destination on successful login or logout, if no other destination exists.

getAuthId :: Creds master -> [(String, String)] -> GHandler s master (Maybe (AuthId master))

randomKey :: master -> IO String

Generate a random alphanumeric string.

This is used for verify string in email authentication.

openIdEnabled :: master -> Bool

rpxnowSettings :: master -> Maybe RpxnowSettings

emailSettings :: master -> Maybe (EmailSettings master)

facebookSettings :: master -> Maybe FacebookSettings

client id, secret and requested permissions

data Creds m

User credentials

Constructors

Creds

Fields

credsIdent :: String

Identifier. Exact meaning depends on credsAuthType.

credsAuthType :: AuthType

How the user was authenticated

credsEmail :: Maybe String

Verified e-mail address.

credsDisplayName :: Maybe String

Display name.

credsId :: Maybe (AuthId m)

Numeric ID, if used.

credsFacebookToken :: Maybe AccessToken

data EmailCreds m

Data stored in a database for each e-mail address.

Constructors

EmailCreds

Fields

emailCredsId :: AuthEmailId m

emailCredsAuthId :: Maybe (AuthId m)

emailCredsStatus :: VerStatus

emailCredsVerkey :: Maybe VerKey

data AuthType

Which subsystem authenticated the user.

Constructors

AuthOpenId

AuthRpxnow

AuthEmail

AuthFacebook

Instances

Eq AuthType

Read AuthType

Show AuthType

data RpxnowSettings

Constructors

RpxnowSettings

Fields

rpxnowApp :: String

rpxnowKey :: String

data EmailSettings m

Constructors

EmailSettings

Fields

addUnverified :: Email -> VerKey -> GHandler Auth m (AuthEmailId m)

sendVerifyEmail :: Email -> VerKey -> VerUrl -> GHandler Auth m ()

getVerifyKey :: AuthEmailId m -> GHandler Auth m (Maybe VerKey)

setVerifyKey :: AuthEmailId m -> VerKey -> GHandler Auth m ()

verifyAccount :: AuthEmailId m -> GHandler Auth m (Maybe (AuthId m))

getPassword :: AuthId m -> GHandler Auth m (Maybe SaltedPass)

setPassword :: AuthId m -> SaltedPass -> GHandler Auth m ()

getEmailCreds :: Email -> GHandler Auth m (Maybe (EmailCreds m))

getEmail :: AuthEmailId m -> GHandler Auth m (Maybe Email)

data FacebookSettings

Constructors

FacebookSettings

Fields

fbAppId :: String

fbSecret :: String

fbPerms :: [String]

getFacebookUrl :: YesodAuth m => (AuthRoute -> Route m) -> GHandler s m (Maybe String)

Functions

maybeAuth :: (PersistBackend (YesodDB m (GHandler s m)), YesodPersist m, YesodAuth m) => GHandler s m (Maybe (AuthId m, AuthEntity m))

maybeAuthId :: YesodAuth m => GHandler s m (Maybe (AuthId m))

Retrieves user credentials, if user is authenticated.

requireAuth :: (PersistBackend (YesodDB m (GHandler s m)), YesodPersist m, YesodAuth m) => GHandler s m (AuthId m, AuthEntity m)

requireAuthId :: YesodAuth m => GHandler sub m (AuthId m)

Retrieve user credentials. If user is not logged in, redirects to the authRoute. Sets ultimate destination to current route, so user should be sent back here after authenticating.