- data Auth
- data AuthPlugin m = AuthPlugin {}
- data AuthRoute
- getAuth :: a -> Auth
- class Yesod m => YesodAuth m where
- type AuthId m
- loginDest :: m -> Route m
- logoutDest :: m -> Route m
- 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
- 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 -> String -> 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
- data Creds m = Creds {
- credsPlugin :: String
- credsIdent :: String
- credsExtra :: [(String, String)]
- setCreds :: YesodAuth m => Bool -> Creds m -> GHandler s m ()
- maybeAuthId :: YesodAuth m => GHandler s m (Maybe (AuthId m))
- 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)
Subsite
data AuthPlugin m Source
class Yesod m => YesodAuth m whereSource
loginDest :: m -> Route mSource
Default destination on successful login, if no other destination exists.
logoutDest :: m -> Route mSource
Default destination on successful logout, if no other destination exists.
getAuthId :: Creds m -> GHandler s m (Maybe (AuthId m))Source
showAuthId :: m -> AuthId m -> StringSource
readAuthId :: m -> String -> Maybe (AuthId m)Source
authPlugins :: [AuthPlugin m]Source
loginHandler :: GHandler Auth m RepHtmlSource
What to show on the login page.
messageNoOpenID :: m -> HtmlSource
messageLoginOpenID :: m -> HtmlSource
messageEmail :: m -> HtmlSource
messagePassword :: m -> HtmlSource
messageRegister :: m -> HtmlSource
messageRegisterLong :: m -> HtmlSource
messageEnterEmail :: m -> HtmlSource
messageConfirmationEmailSentTitle :: m -> HtmlSource
messageConfirmationEmailSent :: m -> String -> HtmlSource
messageAddressVerified :: m -> HtmlSource
messageInvalidKeyTitle :: m -> HtmlSource
messageInvalidKey :: m -> HtmlSource
messageInvalidEmailPass :: m -> HtmlSource
messageBadSetPass :: m -> HtmlSource
messageSetPassTitle :: m -> HtmlSource
messageSetPass :: m -> HtmlSource
messageNewPass :: m -> HtmlSource
messageConfirmPass :: m -> HtmlSource
messagePassMismatch :: m -> HtmlSource
messagePassUpdated :: m -> HtmlSource
messageFacebook :: m -> HtmlSource
Plugin interface
User credentials
Creds | |
|
setCreds :: YesodAuth m => Bool -> Creds m -> GHandler s m ()Source
FIXME: won't show up till redirect
User functions
maybeAuthId :: YesodAuth m => GHandler s m (Maybe (AuthId m))Source
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))Source
requireAuthId :: YesodAuth m => GHandler s m (AuthId m)Source
requireAuth :: (YesodAuth m, Key val ~ AuthId m, PersistBackend (YesodDB m (GGHandler s m IO)), PersistEntity val, YesodPersist m) => GHandler s m (Key val, val)Source