Safe Haskell	None

Happstack.Auth.Core.Auth

Synopsis

Documentation

data UserPass Source

Constructors

UserPass
Fields upName :: UserName upPassword :: HashedPass upId :: UserPassId

Instances

Eq UserPass
Data UserPass
Ord UserPass
Read UserPass
Show UserPass
Typeable UserPass
Indexable UserPass
SafeCopy UserPass

newtype UserPassId Source

Constructors

UserPassId
Fields unUserPassId :: Integer

Instances

Eq UserPassId
Data UserPassId
Ord UserPassId
Read UserPassId
Show UserPassId
Typeable UserPassId
SafeCopy UserPassId

newtype UserName Source

NOTE: The Eq and Ord instances are 'case-insensitive'. They apply toCaseFold before comparing.

Constructors

UserName
Fields unUserName :: Text

Instances

Eq UserName
Data UserName
Ord UserName
Read UserName
Show UserName
Typeable UserName
SafeCopy UserName

data UserPassError Source

errors that can occur when working with UserPass

Constructors

UsernameInUse UserName
InvalidUserPassId UserPassId
InvalidUserName UserName
InvalidPassword

Instances

Eq UserPassError
Data UserPassError
Ord UserPassError
Read UserPassError
Show UserPassError
Typeable UserPassError
SafeCopy UserPassError

userPassErrorString :: UserPassError -> StringSource

return a user-friendly error message string for an AddAuthError

data SetUserName Source

Constructors

SetUserName UserPassId Text

Instances

Typeable SetUserName
UpdateEvent SetUserName
Method SetUserName
SafeCopy SetUserName

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

initialAuthState :: AuthState Source

a reasonable initial AuthState

data AuthToken Source

Constructors

AuthToken
Fields tokenString :: String tokenExpires :: UTCTime tokenLifetime :: Int tokenAuthId :: Maybe AuthId tokenAuthMethod :: AuthMethod

Instances

Eq AuthToken
Data AuthToken
Ord AuthToken
Show AuthToken
Typeable AuthToken
Indexable AuthToken
Migrate AuthToken
SafeCopy AuthToken

newtype AuthId Source

Constructors

AuthId
Fields unAuthId :: Integer

Instances

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

newtype FacebookId Source

Constructors

FacebookId
Fields unFacebookId :: UserId

Instances

Eq FacebookId
Data FacebookId
Ord FacebookId
Read FacebookId
Show FacebookId
Typeable FacebookId
Migrate FacebookId
SafeCopy FacebookId

data AuthMethod Source

Constructors

AuthIdentifier
Fields amIdentifier :: Identifier
AuthUserPassId
Fields amUserPassId :: UserPassId
AuthFacebook
Fields amFacebookId :: FacebookId

Instances

Eq AuthMethod
Data AuthMethod
Ord AuthMethod
Read AuthMethod
Show AuthMethod
Typeable AuthMethod
Migrate AuthMethod
SafeCopy AuthMethod

data AuthMethod_v1 Source

Constructors

AuthIdentifier_v1
Fields amIdentifier_v1 :: Identifier
AuthUserPassId_v1
Fields amUserPassId_v1 :: UserPassId

Instances

Eq AuthMethod_v1
Data AuthMethod_v1
Ord AuthMethod_v1
Read AuthMethod_v1
Show AuthMethod_v1
Typeable AuthMethod_v1
SafeCopy AuthMethod_v1

data AuthMap Source

This links an authentication method (such as on OpenId Identifier, a FacebookId, or UserPassId) to an AuthId.

Constructors

AuthMap
Fields amMethod :: AuthMethod amAuthId :: AuthId

Instances

Eq AuthMap
Data AuthMap
Ord AuthMap
Read AuthMap
Show AuthMap
Typeable AuthMap
Indexable AuthMap
SafeCopy AuthMap

newtype HashedPass Source

Constructors

HashedPass ByteString

Instances

Eq HashedPass
Data HashedPass
Ord HashedPass
Read HashedPass
Show HashedPass
Typeable HashedPass
SafeCopy HashedPass

mkHashedPass Source

Arguments

:: Text	password in plain text
-> IO HashedPass	salted and hashed

hash a password string

genAuthToken :: MonadIO m => Maybe AuthId -> AuthMethod -> Int -> m AuthToken Source

generate an new authentication token

newtype AskUserPass Source

Constructors

AskUserPass UserPassId

Instances

Typeable AskUserPass
QueryEvent AskUserPass
Method AskUserPass
SafeCopy AskUserPass

data CheckUserPass Source

Constructors

CheckUserPass Text Text

Instances

Typeable CheckUserPass
QueryEvent CheckUserPass
Method CheckUserPass
SafeCopy CheckUserPass

data CreateUserPass Source

Constructors

CreateUserPass UserName HashedPass

Instances

Typeable CreateUserPass
UpdateEvent CreateUserPass
Method CreateUserPass
SafeCopy CreateUserPass

data SetPassword Source

Constructors

SetPassword UserPassId HashedPass

Instances

Typeable SetPassword
UpdateEvent SetPassword
Method SetPassword
SafeCopy SetPassword

newtype AddAuthToken Source

Constructors

AddAuthToken AuthToken

Instances

Typeable AddAuthToken
UpdateEvent AddAuthToken
Method AddAuthToken
SafeCopy AddAuthToken

newtype AskAuthToken Source

Constructors

AskAuthToken String

Instances

Typeable AskAuthToken
QueryEvent AskAuthToken
Method AskAuthToken
SafeCopy AskAuthToken

newtype UpdateAuthToken Source

Constructors

UpdateAuthToken AuthToken

Instances

Typeable UpdateAuthToken
UpdateEvent UpdateAuthToken
Method UpdateAuthToken
SafeCopy UpdateAuthToken

newtype DeleteAuthToken Source

Constructors

DeleteAuthToken String

Instances

Typeable DeleteAuthToken
UpdateEvent DeleteAuthToken
Method DeleteAuthToken
SafeCopy DeleteAuthToken

data GenAuthId Source

Constructors

GenAuthId

Instances

Typeable GenAuthId
UpdateEvent GenAuthId
Method GenAuthId
SafeCopy GenAuthId

data AddAuthMethod Source

Constructors

AddAuthMethod AuthMethod AuthId

Instances

Typeable AddAuthMethod
UpdateEvent AddAuthMethod
Method AddAuthMethod
SafeCopy AddAuthMethod

newtype NewAuthMethod Source

Constructors

NewAuthMethod AuthMethod

Instances

Typeable NewAuthMethod
UpdateEvent NewAuthMethod
Method NewAuthMethod
SafeCopy NewAuthMethod

data RemoveAuthIdentifier Source

Constructors

RemoveAuthIdentifier Identifier AuthId

Instances

Typeable RemoveAuthIdentifier
UpdateEvent RemoveAuthIdentifier
Method RemoveAuthIdentifier
SafeCopy RemoveAuthIdentifier

newtype IdentifierAuthIds Source

Constructors

IdentifierAuthIds Identifier

Instances

Typeable IdentifierAuthIds
QueryEvent IdentifierAuthIds
Method IdentifierAuthIds
SafeCopy IdentifierAuthIds

newtype FacebookAuthIds Source

Constructors

FacebookAuthIds FacebookId

Instances

Typeable FacebookAuthIds
QueryEvent FacebookAuthIds
Method FacebookAuthIds
SafeCopy FacebookAuthIds

data AddAuthUserPassId Source

Constructors

AddAuthUserPassId UserPassId AuthId

Instances

Typeable AddAuthUserPassId
UpdateEvent AddAuthUserPassId
Method AddAuthUserPassId
SafeCopy AddAuthUserPassId

data RemoveAuthUserPassId Source

Constructors

RemoveAuthUserPassId UserPassId AuthId

Instances

Typeable RemoveAuthUserPassId
UpdateEvent RemoveAuthUserPassId
Method RemoveAuthUserPassId
SafeCopy RemoveAuthUserPassId

newtype UserPassIdAuthIds Source

Constructors

UserPassIdAuthIds UserPassId

Instances

Typeable UserPassIdAuthIds
QueryEvent UserPassIdAuthIds
Method UserPassIdAuthIds
SafeCopy UserPassIdAuthIds

data AskAuthState Source

Constructors

AskAuthState

Instances

Typeable AskAuthState
QueryEvent AskAuthState
Method AskAuthState
SafeCopy AskAuthState

newtype SetDefaultSessionTimeout Source

Constructors

SetDefaultSessionTimeout Int

Instances

Typeable SetDefaultSessionTimeout
UpdateEvent SetDefaultSessionTimeout
Method SetDefaultSessionTimeout
SafeCopy SetDefaultSessionTimeout

data GetDefaultSessionTimeout Source

Constructors

GetDefaultSessionTimeout

Instances

Typeable GetDefaultSessionTimeout
QueryEvent GetDefaultSessionTimeout
Method GetDefaultSessionTimeout
SafeCopy GetDefaultSessionTimeout

addAuthCookie :: Happstack m => AcidState AuthState -> Maybe AuthId -> AuthMethod -> m ()Source

deleteAuthCookie :: (Happstack m, Alternative m) => AcidState AuthState -> m ()Source

getAuthId :: (Alternative m, Happstack m) => AcidState AuthState -> m (Maybe AuthId)Source

getAuthToken :: (Alternative m, Happstack m) => AcidState AuthState -> m (Maybe AuthToken)Source