Yesod.Helpers.Auth

Subsite

data Auth

Instances

YesodAuth master => YesodSubSite Auth master

data AuthPlugin m

Constructors

AuthPlugin

Fields

apName :: String

apDispatch :: Method -> [Piece] -> GHandler Auth m ()

apLogin :: forall s. (Route Auth -> Route m) -> GWidget s m ()

data AuthRoute

Constructors

CheckR

LoginR

LogoutR

PluginR String Strings

Instances

Eq AuthRoute

Read AuthRoute

Show AuthRoute

getAuth :: a -> Auth

class Yesod m => YesodAuth m where

Associated Types

type AuthId m

Methods

loginDest :: m -> Route m

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

logoutDest :: m -> Route m

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

getAuthId :: Creds m -> GHandler s m (Maybe (AuthId m))

showAuthId :: m -> AuthId m -> String

readAuthId :: m -> String -> Maybe (AuthId m)

authPlugins :: [AuthPlugin m]

loginHandler :: GHandler Auth m RepHtml

What to show on the login page.

Plugin interface

data Creds m

User credentials

Constructors

Creds

Fields

credsPlugin :: String

How the user was authenticated

credsIdent :: String

Identifier. Exact meaning depends on plugin.

credsExtra :: [(String, String)]

setCreds :: YesodAuth m => Bool -> Creds m -> GHandler s m ()

FIXME: won't show up till redirect

User functions

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

Retrieves user credentials, if user is authenticated.

maybeAuth :: (YesodAuth m, Key val ~ AuthId m, PersistBackend (YesodDB m (GHandler s m)), PersistEntity val, YesodPersist m) => GHandler s m (Maybe (Key val, val))

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

requireAuth :: (YesodAuth m, Key val ~ AuthId m, PersistBackend (YesodDB m (GHandler s m)), PersistEntity val, YesodPersist m) => GHandler s m (Key val, val)