Yesod.Helpers.Auth

Subsite

data Auth

Instances

(Yesod master, YesodAuth master) => YesodDispatch Auth master

data AuthPlugin m

Constructors

AuthPlugin

Fields

apName :: Text

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

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

data AuthRoute

Constructors

CheckR

LoginR

LogoutR

PluginR Text Texts

Instances

Eq AuthRoute

Read AuthRoute

Show AuthRoute

RenderRoute AuthRoute

getAuth :: a -> Auth

class (Yesod m, SinglePiece (AuthId 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))

authPlugins :: [AuthPlugin m]

loginHandler :: GHandler Auth m RepHtml

What to show on the login page.

messageNoOpenID :: m -> Html

messageLoginOpenID :: m -> Html

messageEmail :: m -> Html

messagePassword :: m -> Html

messageRegister :: m -> Html

messageRegisterLong :: m -> Html

messageEnterEmail :: m -> Html

messageConfirmationEmailSentTitle :: m -> Html

messageConfirmationEmailSent :: m -> Text -> Html

messageAddressVerified :: m -> Html

messageInvalidKeyTitle :: m -> Html

messageInvalidKey :: m -> Html

messageInvalidEmailPass :: m -> Html

messageBadSetPass :: m -> Html

messageSetPassTitle :: m -> Html

messageSetPass :: m -> Html

messageNewPass :: m -> Html

messageConfirmPass :: m -> Html

messagePassMismatch :: m -> Html

messagePassUpdated :: m -> Html

messageFacebook :: m -> Html

Plugin interface

data Creds m

User credentials

Constructors

Creds

Fields

credsPlugin :: Text

How the user was authenticated

credsIdent :: Text

Identifier. Exact meaning depends on plugin.

credsExtra :: [(Text, Text)]

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 (GGHandler s m IO)), 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 (GGHandler s m IO)), PersistEntity val, YesodPersist m) => GHandler s m (Key val, val)