Safe Haskell	None
Language	Haskell2010

Web.Users.Types

Contents

The core type class
User representation
Token types
Error types
Helper typed

Synopsis

class IsUserBackend b => UserStorageBackend b where
- type UserId b :: *
- initUserBackend :: b -> IO ()
- destroyUserBackend :: b -> IO ()
- housekeepBackend :: b -> IO ()
- getUserIdByName :: b -> Text -> IO (Maybe (UserId b))
- getUserById :: b -> UserId b -> IO (Maybe User)
- listUsers :: b -> Maybe (Int64, Int64) -> SortBy UserField -> IO [(UserId b, User)]
- countUsers :: b -> IO Int64
- createUser :: b -> User -> IO (Either CreateUserError (UserId b))
- updateUser :: b -> UserId b -> (User -> User) -> IO (Either UpdateUserError ())
- deleteUser :: b -> UserId b -> IO ()
- authUser :: b -> Text -> PasswordPlain -> NominalDiffTime -> IO (Maybe SessionId)
- withAuthUser :: b -> Text -> (User -> Bool) -> (UserId b -> IO r) -> IO (Maybe r)
- verifySession :: b -> SessionId -> NominalDiffTime -> IO (Maybe (UserId b))
- createSession :: b -> UserId b -> NominalDiffTime -> IO (Maybe SessionId)
- destroySession :: b -> SessionId -> IO ()
- requestPasswordReset :: b -> UserId b -> NominalDiffTime -> IO PasswordResetToken
- verifyPasswordResetToken :: b -> PasswordResetToken -> IO (Maybe User)
- applyNewPassword :: b -> PasswordResetToken -> Password -> IO (Either TokenError ())
- requestActivationToken :: b -> UserId b -> NominalDiffTime -> IO ActivationToken
- activateUser :: b -> ActivationToken -> IO (Either TokenError ())
data User = User {
- u_name :: !Text
- u_email :: !Text
- u_password :: !Password
- u_active :: !Bool
}
data Password
- = PasswordHash !Text
- | PasswordHidden
makePassword :: PasswordPlain -> Password
hidePassword :: User -> User
newtype PasswordPlain = PasswordPlain {
- unPasswordPlain :: Text
}
verifyPassword :: PasswordPlain -> Password -> Bool
data UserField
- = UserFieldId
- | UserFieldName
- | UserFieldEmail
- | UserFieldPassword
- | UserFieldActive
newtype PasswordResetToken = PasswordResetToken {
- unPasswordResetToken :: Text
}
newtype ActivationToken = ActivationToken {
- unActivationToken :: Text
}
newtype SessionId = SessionId {
- unSessionId :: Text
}
data CreateUserError
data UpdateUserError
data TokenError = TokenInvalid
data SortBy t
- = SortAsc t
- | SortDesc t

The core type class

class IsUserBackend b => UserStorageBackend b where #

An abstract backend for managing users. A backend library should implement the interface and an end user should build applications on top of this interface.

Associated Types

type UserId b :: * #

The storage backends userid

Methods

initUserBackend :: b -> IO () #

Initialise the backend. Call once on application launch to for example create missing database tables

destroyUserBackend :: b -> IO () #

Destory the backend. WARNING: This is only for testing! It deletes all tables and data.

housekeepBackend :: b -> IO () #

This cleans up invalid sessions and other tokens. Call periodically as needed.

getUserIdByName :: b -> Text -> IO (Maybe (UserId b)) #

Retrieve a user id from the database

getUserById :: b -> UserId b -> IO (Maybe User) #

Retrieve a user from the database

listUsers :: b -> Maybe (Int64, Int64) -> SortBy UserField -> IO [(UserId b, User)] #

List all users unlimited, or limited, sorted by a UserField

countUsers :: b -> IO Int64 #

Count all users

createUser :: b -> User -> IO (Either CreateUserError (UserId b)) #

Create a user

updateUser :: b -> UserId b -> (User -> User) -> IO (Either UpdateUserError ()) #

Modify a user

deleteUser :: b -> UserId b -> IO () #

Delete a user

authUser :: b -> Text -> PasswordPlain -> NominalDiffTime -> IO (Maybe SessionId) #

Authentificate a user using username/email and password. The NominalDiffTime describes the session duration

withAuthUser :: b -> Text -> (User -> Bool) -> (UserId b -> IO r) -> IO (Maybe r) #

Authentificate a user and execute a single action.

verifySession :: b -> SessionId -> NominalDiffTime -> IO (Maybe (UserId b)) #

Verify a SessionId. The session duration can be extended by NominalDiffTime

createSession :: b -> UserId b -> NominalDiffTime -> IO (Maybe SessionId) #

Force create a session for a user. This is useful for support/admin login. If the user does not exist, this will fail.

destroySession :: b -> SessionId -> IO () #

Destroy a session

requestPasswordReset :: b -> UserId b -> NominalDiffTime -> IO PasswordResetToken #

Request a PasswordResetToken for a given user, valid for NominalDiffTime

verifyPasswordResetToken :: b -> PasswordResetToken -> IO (Maybe User) #

Check if a PasswordResetToken is still valid and retrieve the owner of it

applyNewPassword :: b -> PasswordResetToken -> Password -> IO (Either TokenError ()) #

Apply a new password to the owner of PasswordResetToken iff the token is still valid

requestActivationToken :: b -> UserId b -> NominalDiffTime -> IO ActivationToken #

Request an ActivationToken for a given user, valid for NominalDiffTime

activateUser :: b -> ActivationToken -> IO (Either TokenError ()) #

Activate the owner of ActivationToken iff the token is still valid

User representation

data User #

Core user datatype

Constructors

User
Fields u_name :: !Text u_email :: !Text u_password :: !Password u_active :: !Bool

Instances

Eq User #
Instance details Defined in Web.Users.Types Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Show User #
Instance details Defined in Web.Users.Types Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
ToJSON User #
Instance details Defined in Web.Users.Types Methods toJSON :: User -> Value # toEncoding :: User -> Encoding # toJSONList :: [User] -> Value # toEncodingList :: [User] -> Encoding #
FromJSON User #
Instance details Defined in Web.Users.Types Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #

data Password #

Password representation. When updating or creating a user, use makePassword to create one. The implementation details of this type are ONLY for use in backend implementations.

Constructors

PasswordHash !Text
PasswordHidden

Instances

Eq Password #
Instance details Defined in Web.Users.Types Methods (==) :: Password -> Password -> Bool # (/=) :: Password -> Password -> Bool #
Show Password #
Instance details Defined in Web.Users.Types Methods showsPrec :: Int -> Password -> ShowS # show :: Password -> String # showList :: [Password] -> ShowS #

makePassword :: PasswordPlain -> Password #

Construct a password from plaintext by hashing it

hidePassword :: User -> User #

Strip the password from the user type.

newtype PasswordPlain #

Plaintext passsword. Used for authentification.

Constructors

PasswordPlain
Fields unPasswordPlain :: Text

Instances

Eq PasswordPlain #
Instance details Defined in Web.Users.Types Methods (==) :: PasswordPlain -> PasswordPlain -> Bool # (/=) :: PasswordPlain -> PasswordPlain -> Bool #
Show PasswordPlain #
Instance details Defined in Web.Users.Types Methods showsPrec :: Int -> PasswordPlain -> ShowS # show :: PasswordPlain -> String # showList :: [PasswordPlain] -> ShowS #
IsString PasswordPlain #
Instance details Defined in Web.Users.Types Methods fromString :: String -> PasswordPlain #

verifyPassword :: PasswordPlain -> Password -> Bool #

Check a plaintext password against a password

data UserField #

Fields of user datatype

Constructors

UserFieldId
UserFieldName
UserFieldEmail
UserFieldPassword
UserFieldActive

Instances

Eq UserField #
Instance details Defined in Web.Users.Types Methods (==) :: UserField -> UserField -> Bool # (/=) :: UserField -> UserField -> Bool #
Show UserField #
Instance details Defined in Web.Users.Types Methods showsPrec :: Int -> UserField -> ShowS # show :: UserField -> String # showList :: [UserField] -> ShowS #

Token types

newtype PasswordResetToken #

A password reset token to send out to users via email or sms

Constructors

PasswordResetToken
Fields unPasswordResetToken :: Text

Instances

Eq PasswordResetToken #
Instance details Defined in Web.Users.Types Methods (==) :: PasswordResetToken -> PasswordResetToken -> Bool # (/=) :: PasswordResetToken -> PasswordResetToken -> Bool #
Show PasswordResetToken #
Instance details Defined in Web.Users.Types Methods showsPrec :: Int -> PasswordResetToken -> ShowS # show :: PasswordResetToken -> String # showList :: [PasswordResetToken] -> ShowS #
ToJSON PasswordResetToken #
Instance details Defined in Web.Users.Types Methods toJSON :: PasswordResetToken -> Value # toEncoding :: PasswordResetToken -> Encoding # toJSONList :: [PasswordResetToken] -> Value # toEncodingList :: [PasswordResetToken] -> Encoding #
FromJSON PasswordResetToken #
Instance details Defined in Web.Users.Types Methods parseJSON :: Value -> Parser PasswordResetToken # parseJSONList :: Value -> Parser [PasswordResetToken] #
PathPiece PasswordResetToken #
Instance details Defined in Web.Users.Types Methods fromPathPiece :: Text -> Maybe PasswordResetToken # toPathPiece :: PasswordResetToken -> Text #

newtype ActivationToken #

An activation token to send out to users via email or sms

Constructors

ActivationToken
Fields unActivationToken :: Text

Instances

Eq ActivationToken #
Instance details Defined in Web.Users.Types Methods (==) :: ActivationToken -> ActivationToken -> Bool # (/=) :: ActivationToken -> ActivationToken -> Bool #
Show ActivationToken #
Instance details Defined in Web.Users.Types Methods showsPrec :: Int -> ActivationToken -> ShowS # show :: ActivationToken -> String # showList :: [ActivationToken] -> ShowS #
ToJSON ActivationToken #
Instance details Defined in Web.Users.Types Methods toJSON :: ActivationToken -> Value # toEncoding :: ActivationToken -> Encoding # toJSONList :: [ActivationToken] -> Value # toEncodingList :: [ActivationToken] -> Encoding #
FromJSON ActivationToken #
Instance details Defined in Web.Users.Types Methods parseJSON :: Value -> Parser ActivationToken # parseJSONList :: Value -> Parser [ActivationToken] #
PathPiece ActivationToken #
Instance details Defined in Web.Users.Types Methods fromPathPiece :: Text -> Maybe ActivationToken # toPathPiece :: ActivationToken -> Text #

newtype SessionId #

A session id for identifying user sessions

Constructors

SessionId
Fields unSessionId :: Text

Instances

Eq SessionId #
Instance details Defined in Web.Users.Types Methods (==) :: SessionId -> SessionId -> Bool # (/=) :: SessionId -> SessionId -> Bool #
Show SessionId #
Instance details Defined in Web.Users.Types Methods showsPrec :: Int -> SessionId -> ShowS # show :: SessionId -> String # showList :: [SessionId] -> ShowS #
ToJSON SessionId #
Instance details Defined in Web.Users.Types Methods toJSON :: SessionId -> Value # toEncoding :: SessionId -> Encoding # toJSONList :: [SessionId] -> Value # toEncodingList :: [SessionId] -> Encoding #
FromJSON SessionId #
Instance details Defined in Web.Users.Types Methods parseJSON :: Value -> Parser SessionId # parseJSONList :: Value -> Parser [SessionId] #
PathPiece SessionId #
Instance details Defined in Web.Users.Types Methods fromPathPiece :: Text -> Maybe SessionId # toPathPiece :: SessionId -> Text #

Error types

data CreateUserError #

Errors that happen on storage level during user creation

Constructors

InvalidPassword
UsernameAlreadyTaken
EmailAlreadyTaken
UsernameAndEmailAlreadyTaken

Instances

Eq CreateUserError #
Instance details Defined in Web.Users.Types Methods (==) :: CreateUserError -> CreateUserError -> Bool # (/=) :: CreateUserError -> CreateUserError -> Bool #
Show CreateUserError #
Instance details Defined in Web.Users.Types Methods showsPrec :: Int -> CreateUserError -> ShowS # show :: CreateUserError -> String # showList :: [CreateUserError] -> ShowS #

data UpdateUserError #

Errors that happen on storage level during user updating

Constructors

UsernameAlreadyExists
EmailAlreadyExists
UserDoesntExist

Instances

Eq UpdateUserError #
Instance details Defined in Web.Users.Types Methods (==) :: UpdateUserError -> UpdateUserError -> Bool # (/=) :: UpdateUserError -> UpdateUserError -> Bool #
Show UpdateUserError #
Instance details Defined in Web.Users.Types Methods showsPrec :: Int -> UpdateUserError -> ShowS # show :: UpdateUserError -> String # showList :: [UpdateUserError] -> ShowS #

data TokenError #

Errors that happen on storage level during token actions

Constructors

TokenInvalid

Instances

Eq TokenError #
Instance details Defined in Web.Users.Types Methods (==) :: TokenError -> TokenError -> Bool # (/=) :: TokenError -> TokenError -> Bool #
Show TokenError #
Instance details Defined in Web.Users.Types Methods showsPrec :: Int -> TokenError -> ShowS # show :: TokenError -> String # showList :: [TokenError] -> ShowS #

Helper typed

data SortBy t #

Sorting direction

Constructors

SortAsc t
SortDesc t