Servant.Server.Auth.Token.Model

DB entities

data UserImpl

Internal user implementation

Constructors

UserImpl

Fields

• userImplLogin :: !Login

  Unique user login

• userImplPassword :: !Password

  Password encrypted with salt

• userImplEmail :: !Email

  User email

Instances

Show UserImpl

Methods

showsPrec :: Int -> UserImpl -> ShowS

show :: UserImpl -> String

showList :: [UserImpl] -> ShowS

Generic UserImpl

Associated Types

type Rep UserImpl :: * -> *

Methods

from :: UserImpl -> Rep UserImpl x

to :: Rep UserImpl x -> UserImpl

type Rep UserImpl

type Rep UserImpl = D1 (MetaData "UserImpl" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" False) (C1 (MetaCons "UserImpl" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "userImplLogin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Login)) ((:*:) (S1 (MetaSel (Just Symbol "userImplPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Password)) (S1 (MetaSel (Just Symbol "userImplEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Email)))))

data UserPerm

Internal implementation of permission (1-M)

Constructors

UserPerm

Fields

• userPermUser :: !UserImplId

  Reference to user

• userPermPermission :: !Permission

  Permission tag

Instances

Show UserPerm

Methods

showsPrec :: Int -> UserPerm -> ShowS

show :: UserPerm -> String

showList :: [UserPerm] -> ShowS

Generic UserPerm

Associated Types

type Rep UserPerm :: * -> *

Methods

from :: UserPerm -> Rep UserPerm x

to :: Rep UserPerm x -> UserPerm

type Rep UserPerm

type Rep UserPerm = D1 (MetaData "UserPerm" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" False) (C1 (MetaCons "UserPerm" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "userPermUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UserImplId)) (S1 (MetaSel (Just Symbol "userPermPermission") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Permission))))

data AuthToken

Internal implementation of authorisation token

Constructors

AuthToken

Fields

• authTokenValue :: !SimpleToken

  Value of token

• authTokenUser :: !UserImplId

  Reference to user of the token

• authTokenExpire :: !UTCTime

  When the token expires

Instances

Show AuthToken

Methods

showsPrec :: Int -> AuthToken -> ShowS

show :: AuthToken -> String

showList :: [AuthToken] -> ShowS

Generic AuthToken

Associated Types

type Rep AuthToken :: * -> *

Methods

from :: AuthToken -> Rep AuthToken x

to :: Rep AuthToken x -> AuthToken

type Rep AuthToken

type Rep AuthToken = D1 (MetaData "AuthToken" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" False) (C1 (MetaCons "AuthToken" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "authTokenValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SimpleToken)) ((:*:) (S1 (MetaSel (Just Symbol "authTokenUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UserImplId)) (S1 (MetaSel (Just Symbol "authTokenExpire") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UTCTime)))))

data UserRestore

Internal implementation of restoration code

Constructors

UserRestore

Fields

• userRestoreValue :: !RestoreCode

  Code value

• userRestoreUser :: !UserImplId

  Reference to user that the code restores

• userRestoreExpire :: !UTCTime

  When the code expires

Instances

Show UserRestore

Methods

showsPrec :: Int -> UserRestore -> ShowS

show :: UserRestore -> String

showList :: [UserRestore] -> ShowS

Generic UserRestore

Associated Types

type Rep UserRestore :: * -> *

Methods

from :: UserRestore -> Rep UserRestore x

to :: Rep UserRestore x -> UserRestore

type Rep UserRestore

type Rep UserRestore = D1 (MetaData "UserRestore" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" False) (C1 (MetaCons "UserRestore" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "userRestoreValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RestoreCode)) ((:*:) (S1 (MetaSel (Just Symbol "userRestoreUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UserImplId)) (S1 (MetaSel (Just Symbol "userRestoreExpire") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UTCTime)))))

data AuthUserGroup

Internal implementation of user group

Constructors

AuthUserGroup

Fields

• authUserGroupName :: !Text

  Name of group

• authUserGroupParent :: !(Maybe AuthUserGroupId)

  Can be a child of another group

Instances

Show AuthUserGroup

Methods

showsPrec :: Int -> AuthUserGroup -> ShowS

show :: AuthUserGroup -> String

showList :: [AuthUserGroup] -> ShowS

Generic AuthUserGroup

Associated Types

type Rep AuthUserGroup :: * -> *

Methods

from :: AuthUserGroup -> Rep AuthUserGroup x

to :: Rep AuthUserGroup x -> AuthUserGroup

type Rep AuthUserGroup

type Rep AuthUserGroup = D1 (MetaData "AuthUserGroup" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" False) (C1 (MetaCons "AuthUserGroup" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "authUserGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "authUserGroupParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AuthUserGroupId)))))

data AuthUserGroupUsers

Implementation of M-M between user and group

Constructors

AuthUserGroupUsers

Fields

• authUserGroupUsersGroup :: !AuthUserGroupId
• authUserGroupUsersUser :: !UserImplId

Instances

Show AuthUserGroupUsers

Methods

showsPrec :: Int -> AuthUserGroupUsers -> ShowS

show :: AuthUserGroupUsers -> String

showList :: [AuthUserGroupUsers] -> ShowS

Generic AuthUserGroupUsers

Associated Types

type Rep AuthUserGroupUsers :: * -> *

Methods

from :: AuthUserGroupUsers -> Rep AuthUserGroupUsers x

to :: Rep AuthUserGroupUsers x -> AuthUserGroupUsers

type Rep AuthUserGroupUsers

type Rep AuthUserGroupUsers = D1 (MetaData "AuthUserGroupUsers" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" False) (C1 (MetaCons "AuthUserGroupUsers" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "authUserGroupUsersGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AuthUserGroupId)) (S1 (MetaSel (Just Symbol "authUserGroupUsersUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UserImplId))))

data AuthUserGroupPerms

Implementation of M-M between permission and group

Constructors

AuthUserGroupPerms

Fields

• authUserGroupPermsGroup :: AuthUserGroupId
• authUserGroupPermsPermission :: Permission

Instances

Show AuthUserGroupPerms

Methods

showsPrec :: Int -> AuthUserGroupPerms -> ShowS

show :: AuthUserGroupPerms -> String

showList :: [AuthUserGroupPerms] -> ShowS

Generic AuthUserGroupPerms

Associated Types

type Rep AuthUserGroupPerms :: * -> *

Methods

from :: AuthUserGroupPerms -> Rep AuthUserGroupPerms x

to :: Rep AuthUserGroupPerms x -> AuthUserGroupPerms

type Rep AuthUserGroupPerms

type Rep AuthUserGroupPerms = D1 (MetaData "AuthUserGroupPerms" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" False) (C1 (MetaCons "AuthUserGroupPerms" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "authUserGroupPermsGroup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AuthUserGroupId)) (S1 (MetaSel (Just Symbol "authUserGroupPermsPermission") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Permission))))

data UserSingleUseCode

Internal implementation of single use code

Constructors

UserSingleUseCode

Fields

• userSingleUseCodeValue :: !SingleUseCode

  Value of single use code

• userSingleUseCodeUser :: !UserImplId

  Reference to user the code is owned by

• userSingleUseCodeExpire :: !(Maybe UTCTime)

  When the code expires, Nothing is code that never expires

• userSingleUseCodeUsed :: !(Maybe UTCTime)

  When the code was used

Instances

Show UserSingleUseCode

Methods

showsPrec :: Int -> UserSingleUseCode -> ShowS

show :: UserSingleUseCode -> String

showList :: [UserSingleUseCode] -> ShowS

Generic UserSingleUseCode

Associated Types

type Rep UserSingleUseCode :: * -> *

Methods

from :: UserSingleUseCode -> Rep UserSingleUseCode x

to :: Rep UserSingleUseCode x -> UserSingleUseCode

type Rep UserSingleUseCode

type Rep UserSingleUseCode = D1 (MetaData "UserSingleUseCode" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" False) (C1 (MetaCons "UserSingleUseCode" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "userSingleUseCodeValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SingleUseCode)) (S1 (MetaSel (Just Symbol "userSingleUseCodeUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UserImplId))) ((:*:) (S1 (MetaSel (Just Symbol "userSingleUseCodeExpire") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UTCTime))) (S1 (MetaSel (Just Symbol "userSingleUseCodeUsed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UTCTime))))))

IDs of entities

data UserImplId

ID of user

Instances

Eq UserImplId

Methods

(==) :: UserImplId -> UserImplId -> Bool

(/=) :: UserImplId -> UserImplId -> Bool

Ord UserImplId

Methods

compare :: UserImplId -> UserImplId -> Ordering

(<) :: UserImplId -> UserImplId -> Bool

(<=) :: UserImplId -> UserImplId -> Bool

(>) :: UserImplId -> UserImplId -> Bool

(>=) :: UserImplId -> UserImplId -> Bool

max :: UserImplId -> UserImplId -> UserImplId

min :: UserImplId -> UserImplId -> UserImplId

Show UserImplId

Methods

showsPrec :: Int -> UserImplId -> ShowS

show :: UserImplId -> String

showList :: [UserImplId] -> ShowS

Generic UserImplId

Associated Types

type Rep UserImplId :: * -> *

Methods

from :: UserImplId -> Rep UserImplId x

to :: Rep UserImplId x -> UserImplId

ConvertableKey UserImplId

Methods

fromKey :: Integral b => UserImplId -> b

toKey :: Integral b => b -> UserImplId

type Rep UserImplId

type Rep UserImplId = D1 (MetaData "UserImplId" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" True) (C1 (MetaCons "UserImplId" PrefixI True) (S1 (MetaSel (Just Symbol "unUserImplId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int64)))

data UserPermId

ID of user permission

Instances

Eq UserPermId

Methods

(==) :: UserPermId -> UserPermId -> Bool

(/=) :: UserPermId -> UserPermId -> Bool

Ord UserPermId

Methods

compare :: UserPermId -> UserPermId -> Ordering

(<) :: UserPermId -> UserPermId -> Bool

(<=) :: UserPermId -> UserPermId -> Bool

(>) :: UserPermId -> UserPermId -> Bool

(>=) :: UserPermId -> UserPermId -> Bool

max :: UserPermId -> UserPermId -> UserPermId

min :: UserPermId -> UserPermId -> UserPermId

Show UserPermId

Methods

showsPrec :: Int -> UserPermId -> ShowS

show :: UserPermId -> String

showList :: [UserPermId] -> ShowS

Generic UserPermId

Associated Types

type Rep UserPermId :: * -> *

Methods

from :: UserPermId -> Rep UserPermId x

to :: Rep UserPermId x -> UserPermId

ConvertableKey UserPermId

Methods

fromKey :: Integral b => UserPermId -> b

toKey :: Integral b => b -> UserPermId

type Rep UserPermId

type Rep UserPermId = D1 (MetaData "UserPermId" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" True) (C1 (MetaCons "UserPermId" PrefixI True) (S1 (MetaSel (Just Symbol "unUserPermId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int64)))

data AuthTokenId

ID of authorisation token

Instances

Eq AuthTokenId

Methods

(==) :: AuthTokenId -> AuthTokenId -> Bool

(/=) :: AuthTokenId -> AuthTokenId -> Bool

Ord AuthTokenId

Methods

compare :: AuthTokenId -> AuthTokenId -> Ordering

(<) :: AuthTokenId -> AuthTokenId -> Bool

(<=) :: AuthTokenId -> AuthTokenId -> Bool

(>) :: AuthTokenId -> AuthTokenId -> Bool

(>=) :: AuthTokenId -> AuthTokenId -> Bool

max :: AuthTokenId -> AuthTokenId -> AuthTokenId

min :: AuthTokenId -> AuthTokenId -> AuthTokenId

Show AuthTokenId

Methods

showsPrec :: Int -> AuthTokenId -> ShowS

show :: AuthTokenId -> String

showList :: [AuthTokenId] -> ShowS

Generic AuthTokenId

Associated Types

type Rep AuthTokenId :: * -> *

Methods

from :: AuthTokenId -> Rep AuthTokenId x

to :: Rep AuthTokenId x -> AuthTokenId

ConvertableKey AuthTokenId

Methods

fromKey :: Integral b => AuthTokenId -> b

toKey :: Integral b => b -> AuthTokenId

type Rep AuthTokenId

type Rep AuthTokenId = D1 (MetaData "AuthTokenId" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" True) (C1 (MetaCons "AuthTokenId" PrefixI True) (S1 (MetaSel (Just Symbol "unAuthTokenId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int64)))

data UserRestoreId

ID of restoration code

Instances

Eq UserRestoreId

Methods

(==) :: UserRestoreId -> UserRestoreId -> Bool

(/=) :: UserRestoreId -> UserRestoreId -> Bool

Ord UserRestoreId

Methods

compare :: UserRestoreId -> UserRestoreId -> Ordering

(<) :: UserRestoreId -> UserRestoreId -> Bool

(<=) :: UserRestoreId -> UserRestoreId -> Bool

(>) :: UserRestoreId -> UserRestoreId -> Bool

(>=) :: UserRestoreId -> UserRestoreId -> Bool

max :: UserRestoreId -> UserRestoreId -> UserRestoreId

min :: UserRestoreId -> UserRestoreId -> UserRestoreId

Show UserRestoreId

Methods

showsPrec :: Int -> UserRestoreId -> ShowS

show :: UserRestoreId -> String

showList :: [UserRestoreId] -> ShowS

Generic UserRestoreId

Associated Types

type Rep UserRestoreId :: * -> *

Methods

from :: UserRestoreId -> Rep UserRestoreId x

to :: Rep UserRestoreId x -> UserRestoreId

ConvertableKey UserRestoreId

Methods

fromKey :: Integral b => UserRestoreId -> b

toKey :: Integral b => b -> UserRestoreId

type Rep UserRestoreId

type Rep UserRestoreId = D1 (MetaData "UserRestoreId" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" True) (C1 (MetaCons "UserRestoreId" PrefixI True) (S1 (MetaSel (Just Symbol "unUserRestoreId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int64)))

data AuthUserGroupId

ID of user group

Instances

Eq AuthUserGroupId

Methods

(==) :: AuthUserGroupId -> AuthUserGroupId -> Bool

(/=) :: AuthUserGroupId -> AuthUserGroupId -> Bool

Ord AuthUserGroupId

Methods

compare :: AuthUserGroupId -> AuthUserGroupId -> Ordering

(<) :: AuthUserGroupId -> AuthUserGroupId -> Bool

(<=) :: AuthUserGroupId -> AuthUserGroupId -> Bool

(>) :: AuthUserGroupId -> AuthUserGroupId -> Bool

(>=) :: AuthUserGroupId -> AuthUserGroupId -> Bool

max :: AuthUserGroupId -> AuthUserGroupId -> AuthUserGroupId

min :: AuthUserGroupId -> AuthUserGroupId -> AuthUserGroupId

Show AuthUserGroupId

Methods

showsPrec :: Int -> AuthUserGroupId -> ShowS

show :: AuthUserGroupId -> String

showList :: [AuthUserGroupId] -> ShowS

Generic AuthUserGroupId

Associated Types

type Rep AuthUserGroupId :: * -> *

Methods

from :: AuthUserGroupId -> Rep AuthUserGroupId x

to :: Rep AuthUserGroupId x -> AuthUserGroupId

ConvertableKey AuthUserGroupId

Methods

fromKey :: Integral b => AuthUserGroupId -> b

toKey :: Integral b => b -> AuthUserGroupId

type Rep AuthUserGroupId

type Rep AuthUserGroupId = D1 (MetaData "AuthUserGroupId" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" True) (C1 (MetaCons "AuthUserGroupId" PrefixI True) (S1 (MetaSel (Just Symbol "unAuthUserGroupId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int64)))

data AuthUserGroupUsersId

ID of user-group binding

Instances

Eq AuthUserGroupUsersId

Methods

(==) :: AuthUserGroupUsersId -> AuthUserGroupUsersId -> Bool

(/=) :: AuthUserGroupUsersId -> AuthUserGroupUsersId -> Bool

Ord AuthUserGroupUsersId

Methods

compare :: AuthUserGroupUsersId -> AuthUserGroupUsersId -> Ordering

(<) :: AuthUserGroupUsersId -> AuthUserGroupUsersId -> Bool

(<=) :: AuthUserGroupUsersId -> AuthUserGroupUsersId -> Bool

(>) :: AuthUserGroupUsersId -> AuthUserGroupUsersId -> Bool

(>=) :: AuthUserGroupUsersId -> AuthUserGroupUsersId -> Bool

max :: AuthUserGroupUsersId -> AuthUserGroupUsersId -> AuthUserGroupUsersId

min :: AuthUserGroupUsersId -> AuthUserGroupUsersId -> AuthUserGroupUsersId

Show AuthUserGroupUsersId

Methods

showsPrec :: Int -> AuthUserGroupUsersId -> ShowS

show :: AuthUserGroupUsersId -> String

showList :: [AuthUserGroupUsersId] -> ShowS

Generic AuthUserGroupUsersId

Associated Types

type Rep AuthUserGroupUsersId :: * -> *

Methods

from :: AuthUserGroupUsersId -> Rep AuthUserGroupUsersId x

to :: Rep AuthUserGroupUsersId x -> AuthUserGroupUsersId

ConvertableKey AuthUserGroupUsersId

Methods

fromKey :: Integral b => AuthUserGroupUsersId -> b

toKey :: Integral b => b -> AuthUserGroupUsersId

type Rep AuthUserGroupUsersId

type Rep AuthUserGroupUsersId = D1 (MetaData "AuthUserGroupUsersId" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" True) (C1 (MetaCons "AuthUserGroupUsersId" PrefixI True) (S1 (MetaSel (Just Symbol "unAuthUserGroupUsersId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int64)))

data AuthUserGroupPermsId

ID of permission-group binding

Instances

Eq AuthUserGroupPermsId

Methods

(==) :: AuthUserGroupPermsId -> AuthUserGroupPermsId -> Bool

(/=) :: AuthUserGroupPermsId -> AuthUserGroupPermsId -> Bool

Ord AuthUserGroupPermsId

Methods

compare :: AuthUserGroupPermsId -> AuthUserGroupPermsId -> Ordering

(<) :: AuthUserGroupPermsId -> AuthUserGroupPermsId -> Bool

(<=) :: AuthUserGroupPermsId -> AuthUserGroupPermsId -> Bool

(>) :: AuthUserGroupPermsId -> AuthUserGroupPermsId -> Bool

(>=) :: AuthUserGroupPermsId -> AuthUserGroupPermsId -> Bool

max :: AuthUserGroupPermsId -> AuthUserGroupPermsId -> AuthUserGroupPermsId

min :: AuthUserGroupPermsId -> AuthUserGroupPermsId -> AuthUserGroupPermsId

Show AuthUserGroupPermsId

Methods

showsPrec :: Int -> AuthUserGroupPermsId -> ShowS

show :: AuthUserGroupPermsId -> String

showList :: [AuthUserGroupPermsId] -> ShowS

Generic AuthUserGroupPermsId

Associated Types

type Rep AuthUserGroupPermsId :: * -> *

Methods

from :: AuthUserGroupPermsId -> Rep AuthUserGroupPermsId x

to :: Rep AuthUserGroupPermsId x -> AuthUserGroupPermsId

ConvertableKey AuthUserGroupPermsId

Methods

fromKey :: Integral b => AuthUserGroupPermsId -> b

toKey :: Integral b => b -> AuthUserGroupPermsId

type Rep AuthUserGroupPermsId

type Rep AuthUserGroupPermsId = D1 (MetaData "AuthUserGroupPermsId" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" True) (C1 (MetaCons "AuthUserGroupPermsId" PrefixI True) (S1 (MetaSel (Just Symbol "unAuthUserGroupPermsId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int64)))

data UserSingleUseCodeId

ID of single use code

Instances

Eq UserSingleUseCodeId

Methods

(==) :: UserSingleUseCodeId -> UserSingleUseCodeId -> Bool

(/=) :: UserSingleUseCodeId -> UserSingleUseCodeId -> Bool

Ord UserSingleUseCodeId

Methods

compare :: UserSingleUseCodeId -> UserSingleUseCodeId -> Ordering

(<) :: UserSingleUseCodeId -> UserSingleUseCodeId -> Bool

(<=) :: UserSingleUseCodeId -> UserSingleUseCodeId -> Bool

(>) :: UserSingleUseCodeId -> UserSingleUseCodeId -> Bool

(>=) :: UserSingleUseCodeId -> UserSingleUseCodeId -> Bool

max :: UserSingleUseCodeId -> UserSingleUseCodeId -> UserSingleUseCodeId

min :: UserSingleUseCodeId -> UserSingleUseCodeId -> UserSingleUseCodeId

Show UserSingleUseCodeId

Methods

showsPrec :: Int -> UserSingleUseCodeId -> ShowS

show :: UserSingleUseCodeId -> String

showList :: [UserSingleUseCodeId] -> ShowS

Generic UserSingleUseCodeId

Associated Types

type Rep UserSingleUseCodeId :: * -> *

Methods

from :: UserSingleUseCodeId -> Rep UserSingleUseCodeId x

to :: Rep UserSingleUseCodeId x -> UserSingleUseCodeId

ConvertableKey UserSingleUseCodeId

Methods

fromKey :: Integral b => UserSingleUseCodeId -> b

toKey :: Integral b => b -> UserSingleUseCodeId

type Rep UserSingleUseCodeId

type Rep UserSingleUseCodeId = D1 (MetaData "UserSingleUseCodeId" "Servant.Server.Auth.Token.Model" "servant-auth-token-0.4.3.0-6hAgxnY3qHkKQKFChJCE1p" True) (C1 (MetaCons "UserSingleUseCodeId" PrefixI True) (S1 (MetaSel (Just Symbol "unUserSingleUseCodeId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int64)))

DB interface

class MonadIO m => HasStorage m where

Abstract storage interface. External libraries can implement this in terms of PostgreSQL or acid-state.

Minimal complete definition

getUserImpl, getUserImplByLogin, listUsersPaged, getUserImplPermissions, deleteUserPermissions, insertUserPerm, insertUserImpl, replaceUserImpl, deleteUserImpl, hasPerm, getFirstUserByPerm, selectUserImplGroups, clearUserImplGroups, insertAuthUserGroup, insertAuthUserGroupUsers, insertAuthUserGroupPerms, getAuthUserGroup, listAuthUserGroupPermissions, listAuthUserGroupUsers, replaceAuthUserGroup, clearAuthUserGroupUsers, clearAuthUserGroupPerms, deleteAuthUserGroup, listGroupsPaged, setAuthUserGroupName, setAuthUserGroupParent, insertSingleUseCode, setSingleUseCodeUsed, getUnusedCode, invalidatePermamentCodes, selectLastRestoreCode, insertUserRestore, findRestoreCode, replaceRestoreCode, findAuthToken, findAuthTokenByValue, insertAuthToken, replaceAuthToken

Methods

getUserImpl :: UserImplId -> m (Maybe UserImpl)

Getting user from storage

getUserImplByLogin :: Login -> m (Maybe (WithId UserImplId UserImpl))

Getting user from storage by login

listUsersPaged :: Page -> PageSize -> m ([WithId UserImplId UserImpl], Word)

Get paged list of users and total count of users

getUserImplPermissions :: UserImplId -> m [WithId UserPermId UserPerm]

Get user permissions, ascending by tag

deleteUserPermissions :: UserImplId -> m ()

Delete user permissions

insertUserPerm :: UserPerm -> m UserPermId

Insertion of new user permission

insertUserImpl :: UserImpl -> m UserImplId

Insertion of new user

replaceUserImpl :: UserImplId -> UserImpl -> m ()

Replace user with new value

deleteUserImpl :: UserImplId -> m ()

Delete user by id

hasPerm :: UserImplId -> Permission -> m Bool

Check whether the user has particular permission

getFirstUserByPerm :: Permission -> m (Maybe (WithId UserImplId UserImpl))

Get any user with given permission

selectUserImplGroups :: UserImplId -> m [WithId AuthUserGroupUsersId AuthUserGroupUsers]

Select user groups and sort them by ascending name

clearUserImplGroups :: UserImplId -> m ()

Remove user from all groups

insertAuthUserGroup :: AuthUserGroup -> m AuthUserGroupId

Add new user group

insertAuthUserGroupUsers :: AuthUserGroupUsers -> m AuthUserGroupUsersId

Add user to given group

insertAuthUserGroupPerms :: AuthUserGroupPerms -> m AuthUserGroupPermsId

Add permission to given group

getAuthUserGroup :: AuthUserGroupId -> m (Maybe AuthUserGroup)

Find user group by id

listAuthUserGroupPermissions :: AuthUserGroupId -> m [WithId AuthUserGroupPermsId AuthUserGroupPerms]

Get list of permissions of given group

listAuthUserGroupUsers :: AuthUserGroupId -> m [WithId AuthUserGroupUsersId AuthUserGroupUsers]

Get list of all users of the group

replaceAuthUserGroup :: AuthUserGroupId -> AuthUserGroup -> m ()

Replace record of user group

clearAuthUserGroupUsers :: AuthUserGroupId -> m ()

Remove all users from group

clearAuthUserGroupPerms :: AuthUserGroupId -> m ()

Remove all permissions from group

deleteAuthUserGroup :: AuthUserGroupId -> m ()

Delete user group from storage

listGroupsPaged :: Page -> PageSize -> m ([WithId AuthUserGroupId AuthUserGroup], Word)

Get paged list of user groups with total count

setAuthUserGroupName :: AuthUserGroupId -> Text -> m ()

Set group name

setAuthUserGroupParent :: AuthUserGroupId -> Maybe AuthUserGroupId -> m ()

Set group parent

insertSingleUseCode :: UserSingleUseCode -> m UserSingleUseCodeId

Add new single use code

setSingleUseCodeUsed :: UserSingleUseCodeId -> Maybe UTCTime -> m ()

Set usage time of the single use code

getUnusedCode :: SingleUseCode -> UserImplId -> UTCTime -> m (Maybe (WithId UserSingleUseCodeId UserSingleUseCode))

Find unused code for the user and expiration time greater than the given time

invalidatePermamentCodes :: UserImplId -> UTCTime -> m ()

Invalidate all permament codes for user and set use time for them

selectLastRestoreCode :: UserImplId -> UTCTime -> m (Maybe (WithId UserRestoreId UserRestore))

Select last valid restoration code by the given current time

insertUserRestore :: UserRestore -> m UserRestoreId

Insert new restore code

findRestoreCode :: UserImplId -> RestoreCode -> UTCTime -> m (Maybe (WithId UserRestoreId UserRestore))

Find unexpired by the time restore code

replaceRestoreCode :: UserRestoreId -> UserRestore -> m ()

Replace restore code with new value

findAuthToken :: UserImplId -> UTCTime -> m (Maybe (WithId AuthTokenId AuthToken))

Find first non-expired by the time token for user

findAuthTokenByValue :: SimpleToken -> m (Maybe (WithId AuthTokenId AuthToken))

Find token by value

insertAuthToken :: AuthToken -> m AuthTokenId

Insert new token

replaceAuthToken :: AuthTokenId -> AuthToken -> m ()

Replace auth token with new value

Operations

passToByteString :: Password -> ByteString

Convert password to bytestring

byteStringToPass :: ByteString -> Password

Convert bytestring into password

User

userToUserInfo :: WithId UserImplId UserImpl -> [Permission] -> [UserGroupId] -> RespUserInfo

Helper to convert user to response

readUserInfo :: HasStorage m => UserId -> m (Maybe RespUserInfo)

Get user by id

readUserInfoByLogin :: HasStorage m => Login -> m (Maybe RespUserInfo)

Get user by login

getUserPermissions :: HasStorage m => UserImplId -> m [Permission]

Return list of permissions for the given user (only permissions that are assigned to him directly)

setUserPermissions :: HasStorage m => UserImplId -> [Permission] -> m ()

Return list of permissions for the given user

createUser :: HasStorage m => Int -> Login -> Password -> Email -> [Permission] -> m UserImplId

Creation of new user

hasPerms :: HasStorage m => UserImplId -> [Permission] -> m Bool

Check whether the user has particular permissions

createAdmin :: HasStorage m => Int -> Login -> Password -> Email -> m UserImplId

Creates user with admin privileges

ensureAdmin :: HasStorage m => Int -> Login -> Password -> Email -> m ()

Ensures that DB has at leas one admin, if not, creates a new one with specified info.

patchUser

Arguments

:: HasStorage m

=> Int

Password strength

-> PatchUser

-> WithId UserImplId UserImpl

-> m (WithId UserImplId UserImpl)

Apply patches for user

setUserPassword'

Arguments

:: MonadIO m

=> Int

Password strength

-> Password

-> UserImpl

-> m UserImpl

Update password of user

User groups

getUserGroups :: HasStorage m => UserImplId -> m [UserGroupId]

Get all groups the user belongs to

setUserGroups :: HasStorage m => UserImplId -> [UserGroupId] -> m ()

Rewrite all user groups

validateGroups :: HasStorage m => [UserGroupId] -> m [AuthUserGroupId]

Leave only existing groups

getGroupPermissions :: HasStorage m => UserGroupId -> m [Permission]

Getting permission of a group and all it parent groups

getUserGroupPermissions :: HasStorage m => UserImplId -> m [Permission]

Get user permissions that are assigned to him/her via groups only

getUserAllPermissions :: HasStorage m => UserImplId -> m [Permission]

Get user permissions that are assigned to him/her either by direct way or by his/her groups.

readUserGroup :: HasStorage m => UserGroupId -> m (Maybe UserGroup)

Collect full info about user group from RDBMS

toAuthUserGroup :: UserGroup -> (AuthUserGroup, AuthUserGroupId -> [AuthUserGroupUsers], AuthUserGroupId -> [AuthUserGroupPerms])

Helper to convert user group into values of several tables

insertUserGroup :: HasStorage m => UserGroup -> m UserGroupId

Insert user group into RDBMS

updateUserGroup :: HasStorage m => UserGroupId -> UserGroup -> m ()

Replace user group with new value

deleteUserGroup :: HasStorage m => UserGroupId -> m ()

Erase user group from RDBMS, cascade

patchUserGroup :: HasStorage m => UserGroupId -> PatchUserGroup -> m ()

Partial update of user group

Low-level

makeUserInfo :: HasStorage m => WithId UserImplId UserImpl -> m RespUserInfo

Low level operation for collecting info about user