Safe Haskell	None

Happstack.Auth

Synopsis

Documentation

newtype UserId Source

Constructors

UserId
Fields unUserId :: Integer

Instances

Eq UserId
Data UserId
Ord UserId
Read UserId
Show UserId
Typeable UserId
SafeCopy UserId
PathInfo UserId

data AuthState Source

Constructors

AuthState
Fields userPasses :: UserPasses nextUserPassId :: UserPassId authMaps :: AuthMaps nextAuthId :: AuthId authTokens :: AuthTokens defaultSessionTimeout :: Int

Instances

Eq AuthState
Data AuthState
Show AuthState
Typeable AuthState
IsAcidic AuthState
Migrate AuthState
SafeCopy AuthState

data ProfileState Source

Constructors

ProfileState
Fields profiles :: Profiles authUserMap :: Map AuthId UserId map of what `UserId` an `AuthId` is currently defaulting to nextUserId :: UserId

Instances

Eq ProfileState
Data ProfileState
Ord ProfileState
Read ProfileState
Show ProfileState
Typeable ProfileState
IsAcidic ProfileState
SafeCopy ProfileState

data AuthProfileURL Source

Constructors

AuthURL AuthURL
ProfileURL ProfileURL

Instances

Eq AuthProfileURL
Data AuthProfileURL
Ord AuthProfileURL
Read AuthProfileURL
Show AuthProfileURL
Typeable AuthProfileURL
Arbitrary AuthProfileURL
PathInfo AuthProfileURL

data AuthURL Source

Constructors

A_Login
A_AddAuth
A_Logout
A_Signup
A_Local
A_CreateAccount
A_ChangePassword
A_OpenId OpenIdURL
A_OpenIdProvider AuthMode OpenIdProvider
A_Facebook AuthMode
A_FacebookRedirect AuthMode

Instances

Eq AuthURL
Data AuthURL
Ord AuthURL
Read AuthURL
Show AuthURL
Typeable AuthURL
Arbitrary AuthURL
PathInfo AuthURL

data ProfileURL Source

Constructors

P_SetPersonality UserId
P_SetAuthId AuthId
P_PickProfile

Instances

Eq ProfileURL
Data ProfileURL
Ord ProfileURL
Read ProfileURL
Show ProfileURL
Typeable ProfileURL
Arbitrary ProfileURL
PathInfo ProfileURL

getUserId :: (Alternative m, Happstack m) => AcidState AuthState -> AcidState ProfileState -> m (Maybe UserId)Source

authProfileHandler Source

Arguments

:: Happstack m
=> Text	baseURI for this server part
-> Text	unique path prefix
-> AcidState AuthState	handle for 'AcidState AuthState'
-> AcidState ProfileState	handle for 'AcidState ProfileState'
-> (String -> Html -> Html -> m Response)	template function used to render pages
-> Maybe Credentials	optional Facebook `Credentials`
-> Maybe Text	optional realm to use for `OpenId` authentication
-> Text	url to redirect to if authentication and profile selection is successful
-> m Response

this is a simple entry point into happstack-authenticate that provides reasonable default behavior. A majority of the time you will just call this function.

handleAuth Source

Arguments

:: (Happstack m, MonadRoute m, URL m ~ AuthURL)
=> AcidState AuthState	database handle for `AuthState`
-> (String -> Html -> Html -> m Response)	page template function
-> Maybe Credentials	config information for facebook connect
-> Maybe Text	authentication realm
-> Text	URL to redirect to after succesful authentication
-> AuthURL	url to route
-> m Response

Function which takes care of all AuthURL routes.

The caller provides a page template function which will be used to render pages. The provided page template function takes three arguments:

    String -- ^ string to use in the <title> tag
 -> Html   -- ^ extra headers to add to the <head> tag
 -> Html   -- ^ contents to stick in the <body> tag

handleProfile Source

Arguments

:: (Happstack m, Alternative m, MonadRoute m, URL m ~ ProfileURL)
=> AcidState AuthState	database handle for `AuthState`
-> AcidState ProfileState	database handle for `ProfileState`
-> (String -> Html -> Html -> m Response)	page template function
-> Text	URL to redirect to after successfully picking an identity
-> ProfileURL	URL to route
-> m Response

Function which takes care of all ProfileURL routes.

The caller provides a page template function which will be used to render pages. The provided page template function takes three arguments:

    String -- ^ string to use in the <title> tag
 -> Html   -- ^ extra headers to add to the <head> tag
 -> Html   -- ^ contents to stick in the <body> tag

handleAuthProfile :: forall m. (Happstack m, MonadRoute m, URL m ~ AuthProfileURL) => AcidState AuthState -> AcidState ProfileState -> (String -> Html -> Html -> m Response) -> Maybe Credentials -> Maybe Text -> Text -> AuthProfileURL -> m Response Source

handleAuthProfileRouteT :: forall m. Happstack m => AcidState AuthState -> AcidState ProfileState -> (String -> Html -> Html -> m Response) -> Maybe Credentials -> Maybe Text -> Text -> AuthProfileURL -> RouteT AuthProfileURL m Response Source