Servant.API.Auth.Token

API specs

type AuthAPI = AuthSigninMethod :<|> (AuthTouchMethod :<|> (AuthTokenInfoMethod :<|> (AuthSignoutMethod :<|> (AuthSignupMethod :<|> (AuthUsersMethod :<|> (AuthGetUserMethod :<|> (AuthPatchUserMethod :<|> (AuthPutUserMethod :<|> (AuthDeleteUserMethod :<|> (AuthRestoreMethod :<|> (AuthGetGroupMethod :<|> (AuthPostGroupMethod :<|> (AuthPutGroupMethod :<|> (AuthPatchGroupMethod :<|> (AuthDeleteGroupMethod :<|> AuthGroupsMethod)))))))))))))))

Generic authorization API

type AuthSigninMethod = "auth" :> ("signin" :> (QueryParam "login" Login :> (QueryParam "password" Password :> (QueryParam "expire" Seconds :> Get '[JSON] (OnlyField "token" SimpleToken)))))

How to get a token, expire of Nothing means some default value (server config)

type AuthTouchMethod = "auth" :> ("touch" :> (QueryParam "expire" Seconds :> (TokenHeader '[] :> Post '[JSON] ())))

Client cat expand the token lifetime, no permissions are required

type AuthTokenInfoMethod = "auth" :> ("token" :> (TokenHeader '[] :> Get '[JSON] RespUserInfo))

Get client info that is binded to the token

type AuthSignoutMethod = "auth" :> ("signout" :> (TokenHeader '[] :> Post '[JSON] ()))

Close session, after call of the method the token in header is not valid.

type AuthSignupMethod = "auth" :> ("signup" :> (ReqBody '[JSON] ReqRegister :> (TokenHeader '["auth-register"] :> Post '[JSON] (OnlyField "user" UserId))))

Creation of new user, requires registerPerm for token

type AuthUsersMethod = "auth" :> ("users" :> (PageParam :> (PageSizeParam :> (TokenHeader '["auth-info"] :> Get '[JSON] RespUsersInfo))))

Getting list of all users, requires authInfoPerm for token

type AuthGetUserMethod = "auth" :> ("user" :> (Capture "user-id" UserId :> (TokenHeader '["auth-info"] :> Get '[JSON] RespUserInfo)))

Getting info about user, requires authInfoPerm for token

type AuthPatchUserMethod = "auth" :> ("user" :> (Capture "user-id" UserId :> (ReqBody '[JSON] PatchUser :> (TokenHeader '["auth-update"] :> Patch '[JSON] ()))))

Updating loginemailpassword, requires authUpdatePerm for token

type AuthPutUserMethod = "auth" :> ("user" :> (Capture "user-id" UserId :> (ReqBody '[JSON] ReqRegister :> (TokenHeader '["auth-update"] :> Put '[JSON] ()))))

Replace user with the user in the body, requires authUpdatePerm for token

type AuthDeleteUserMethod = "auth" :> ("user" :> (Capture "user-id" UserId :> (TokenHeader '["auth-delete"] :> Delete '[JSON] ())))

Delete user from DB, requires authDeletePerm and will cause cascade deletion, that is your usually want

type AuthRestoreMethod = "auth" :> ("restore" :> (Capture "user-id" UserId :> (QueryParam "code" RestoreCode :> (QueryParam "password" Password :> Post '[JSON] ()))))

Generate new password for user. There is two phases, first, the method is called without code parameter. The system sends email with a restore code to user email or sms (its depends on server). After that a call of the method with the code is needed to change password.

type AuthGetGroupMethod = "auth" :> ("group" :> (Capture "group-id" UserGroupId :> (TokenHeader '["auth-info"] :> Get '[JSON] UserGroup)))

Getting info about user group, requires authInfoPerm for token

type AuthPostGroupMethod = "auth" :> ("group" :> (ReqBody '[JSON] UserGroup :> (TokenHeader '["auth-update"] :> Post '[JSON] (OnlyId UserGroupId))))

Inserting new user group, requires authUpdatePerm for token

type AuthPutGroupMethod = "auth" :> ("group" :> (Capture "group-id" UserGroupId :> (ReqBody '[JSON] UserGroup :> (TokenHeader '["auth-update"] :> Put '[JSON] ()))))

Replace info about given user group, requires authUpdatePerm for token

type AuthPatchGroupMethod = "auth" :> ("group" :> (Capture "group-id" UserGroupId :> (ReqBody '[JSON] PatchUserGroup :> (TokenHeader '["auth-update"] :> Patch '[JSON] ()))))

Patch info about given user group, requires authUpdatePerm for token

type AuthDeleteGroupMethod = "auth" :> ("group" :> (Capture "group-id" UserGroupId :> (TokenHeader '["auth-delete"] :> Delete '[JSON] ())))

Delete all info about given user group, requires authDeletePerm for token

type AuthGroupsMethod = "auth" :> ("group" :> (PageParam :> (PageSizeParam :> (TokenHeader '["auth-info"] :> Get '[JSON] (PagedList UserGroupId UserGroup)))))

Get list of user groups, requires authInfoPerm for token

authAPI :: Proxy AuthAPI

Proxy type for auth API, used to pass the type-level info into client/docs generation functions

authDocs :: API

Servant.Docs documentation of the Auth API

Token

newtype Token perms

Token is simple string marked by permissions that are expected from the token to pass guarding functions.

Constructors

Token

Fields

• unToken :: Text

Instances

Eq (Token perms)

Methods

(==) :: Token perms -> Token perms -> Bool

(/=) :: Token perms -> Token perms -> Bool

Show (Token perms)

Methods

showsPrec :: Int -> Token perms -> ShowS

show :: Token perms -> String

showList :: [Token perms] -> ShowS

ToHttpApiData (Token perms)

Methods

toUrlPiece :: Token perms -> Text

toHeader :: Token perms -> ByteString

toQueryParam :: Token perms -> Text

FromHttpApiData (Token perms)

Methods

parseUrlPiece :: Text -> Either Text (Token perms)

parseHeader :: ByteString -> Either Text (Token perms)

parseQueryParam :: Text -> Either Text (Token perms)

ToSample (Token perms)

Methods

toSamples :: Proxy * (Token perms) -> [(Text, Token perms)]

ToParamSchema (Token perms)

Methods

toParamSchema :: proxy (Token perms) -> ParamSchema t

type MToken perms = Maybe (Token perms)

Shortcut for Maybe Token with attached permissions

type TokenHeader perms = Header "Authorization" (Token perms)

Token header that we require for authorization marked by permissions that are expected from the token to pass guarding functions.

type SimpleToken = Text

Token that doesn't have attached compile-time permissions

class PermsList a where

Minimal complete definition

unliftPerms

Methods

unliftPerms :: forall proxy. proxy a -> [Permission]

Instances

PermsList ([] Symbol)

Methods

unliftPerms :: proxy [Symbol] -> [Permission]

(KnownSymbol x, PermsList xs) => PermsList ((:) Symbol x xs)

Methods

unliftPerms :: proxy ((Symbol ': x) xs) -> [Permission]

downgradeToken' :: True ~ PermsSubset ts' ts => Token ts -> Token ts'

Cast token to permissions that are lower than original one

The cast is safe, the permissions are cheked on compile time.

downgradeToken :: True ~ PermsSubset ts' ts => MToken ts -> MToken ts'

Cast token to permissions that are lower than original one.

The cast is safe, the permissions are cheked on compile time.

User

type UserId = Word

Id of user that is used in the API

type Login = Text

User name for login

type Password = Text

Password for login

type Email = Text

User email

type Permission = Text

Special tag for a permission that a user has

type Seconds = Word

Amount of seconds

type RestoreCode = Text

Special tag for password restore

data ReqRegister

Request body for user registration

Constructors

ReqRegister

Fields

• reqRegLogin :: !Login
• reqRegPassword :: !Password
• reqRegEmail :: !Email
• reqRegPermissions :: ![Permission]
• reqRegGroups :: !(Maybe [UserGroupId])

Instances

Show ReqRegister

Methods

showsPrec :: Int -> ReqRegister -> ShowS

show :: ReqRegister -> String

showList :: [ReqRegister] -> ShowS

Generic ReqRegister

Associated Types

type Rep ReqRegister :: * -> *

Methods

from :: ReqRegister -> Rep ReqRegister x

to :: Rep ReqRegister x -> ReqRegister

ToJSON ReqRegister

Methods

toJSON :: ReqRegister -> Value

toEncoding :: ReqRegister -> Encoding

FromJSON ReqRegister

Methods

parseJSON :: Value -> Parser ReqRegister

ToSchema ReqRegister

Methods

declareNamedSchema :: proxy ReqRegister -> Declare (Definitions Schema) NamedSchema

ToSample ReqRegister

Methods

toSamples :: Proxy * ReqRegister -> [(Text, ReqRegister)]

type Rep ReqRegister

type Rep ReqRegister = D1 (MetaData "ReqRegister" "Servant.API.Auth.Token" "servant-auth-token-api-0.1.0.0-ytdrdPO8IZ81Ej6YqyzUX" False) (C1 (MetaCons "ReqRegister" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "reqRegLogin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Login)) (S1 (MetaSel (Just Symbol "reqRegPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Password))) ((:*:) (S1 (MetaSel (Just Symbol "reqRegEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Email)) ((:*:) (S1 (MetaSel (Just Symbol "reqRegPermissions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Permission])) (S1 (MetaSel (Just Symbol "reqRegGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UserGroupId])))))))

data RespUserInfo

Response with user info

Constructors

RespUserInfo

Fields

• respUserId :: !UserId
• respUserLogin :: !Login
• respUserEmail :: !Email
• respUserPermissions :: ![Permission]
• respUserGroups :: ![UserGroupId]

Instances

Show RespUserInfo

Methods

showsPrec :: Int -> RespUserInfo -> ShowS

show :: RespUserInfo -> String

showList :: [RespUserInfo] -> ShowS

Generic RespUserInfo

Associated Types

type Rep RespUserInfo :: * -> *

Methods

from :: RespUserInfo -> Rep RespUserInfo x

to :: Rep RespUserInfo x -> RespUserInfo

ToJSON RespUserInfo

Methods

toJSON :: RespUserInfo -> Value

toEncoding :: RespUserInfo -> Encoding

FromJSON RespUserInfo

Methods

parseJSON :: Value -> Parser RespUserInfo

ToSchema RespUserInfo

Methods

declareNamedSchema :: proxy RespUserInfo -> Declare (Definitions Schema) NamedSchema

ToSample RespUserInfo

Methods

toSamples :: Proxy * RespUserInfo -> [(Text, RespUserInfo)]

type Rep RespUserInfo

type Rep RespUserInfo = D1 (MetaData "RespUserInfo" "Servant.API.Auth.Token" "servant-auth-token-api-0.1.0.0-ytdrdPO8IZ81Ej6YqyzUX" False) (C1 (MetaCons "RespUserInfo" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "respUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UserId)) (S1 (MetaSel (Just Symbol "respUserLogin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Login))) ((:*:) (S1 (MetaSel (Just Symbol "respUserEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Email)) ((:*:) (S1 (MetaSel (Just Symbol "respUserPermissions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Permission])) (S1 (MetaSel (Just Symbol "respUserGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [UserGroupId]))))))

data PatchUser

Request body for patching user

Constructors

PatchUser

Fields

• patchUserLogin :: !(Maybe Login)
• patchUserPassword :: !(Maybe Password)
• patchUserEmail :: !(Maybe Email)
• patchUserPermissions :: !(Maybe [Permission])
• patchUserGroups :: !(Maybe [UserGroupId])

Instances

Show PatchUser

Methods

showsPrec :: Int -> PatchUser -> ShowS

show :: PatchUser -> String

showList :: [PatchUser] -> ShowS

Generic PatchUser

Associated Types

type Rep PatchUser :: * -> *

Methods

from :: PatchUser -> Rep PatchUser x

to :: Rep PatchUser x -> PatchUser

ToJSON PatchUser

Methods

toJSON :: PatchUser -> Value

toEncoding :: PatchUser -> Encoding

FromJSON PatchUser

Methods

parseJSON :: Value -> Parser PatchUser

ToSchema PatchUser

Methods

declareNamedSchema :: proxy PatchUser -> Declare (Definitions Schema) NamedSchema

ToSample PatchUser

Methods

toSamples :: Proxy * PatchUser -> [(Text, PatchUser)]

type Rep PatchUser

type Rep PatchUser = D1 (MetaData "PatchUser" "Servant.API.Auth.Token" "servant-auth-token-api-0.1.0.0-ytdrdPO8IZ81Ej6YqyzUX" False) (C1 (MetaCons "PatchUser" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "patchUserLogin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Login))) (S1 (MetaSel (Just Symbol "patchUserPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Password)))) ((:*:) (S1 (MetaSel (Just Symbol "patchUserEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Email))) ((:*:) (S1 (MetaSel (Just Symbol "patchUserPermissions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Permission]))) (S1 (MetaSel (Just Symbol "patchUserGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UserGroupId])))))))

data RespUsersInfo

Response with users info and pagination

Constructors

RespUsersInfo

Fields

• respUsersItems :: ![RespUserInfo]
• respUsersPages :: !Word

Instances

Show RespUsersInfo

Methods

showsPrec :: Int -> RespUsersInfo -> ShowS

show :: RespUsersInfo -> String

showList :: [RespUsersInfo] -> ShowS

Generic RespUsersInfo

Associated Types

type Rep RespUsersInfo :: * -> *

Methods

from :: RespUsersInfo -> Rep RespUsersInfo x

to :: Rep RespUsersInfo x -> RespUsersInfo

ToJSON RespUsersInfo

Methods

toJSON :: RespUsersInfo -> Value

toEncoding :: RespUsersInfo -> Encoding

FromJSON RespUsersInfo

Methods

parseJSON :: Value -> Parser RespUsersInfo

ToSchema RespUsersInfo

Methods

declareNamedSchema :: proxy RespUsersInfo -> Declare (Definitions Schema) NamedSchema

ToSample RespUsersInfo

Methods

toSamples :: Proxy * RespUsersInfo -> [(Text, RespUsersInfo)]

type Rep RespUsersInfo

type Rep RespUsersInfo = D1 (MetaData "RespUsersInfo" "Servant.API.Auth.Token" "servant-auth-token-api-0.1.0.0-ytdrdPO8IZ81Ej6YqyzUX" False) (C1 (MetaCons "RespUsersInfo" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "respUsersItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [RespUserInfo])) (S1 (MetaSel (Just Symbol "respUsersPages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word))))

User groups

type UserGroupId = Word

Id of user group

data UserGroup

Data of user group, groups allows to group permissions and assign them to particular users in batch manner.

Also a group hierarchy can be formed.

Constructors

UserGroup

Fields

• userGroupName :: !Text
• userGroupUsers :: ![UserId]
• userGroupPermissions :: ![Permission]
• userGroupParent :: !(Maybe UserGroupId)

Instances

Show UserGroup

Methods

showsPrec :: Int -> UserGroup -> ShowS

show :: UserGroup -> String

showList :: [UserGroup] -> ShowS

Generic UserGroup

Associated Types

type Rep UserGroup :: * -> *

Methods

from :: UserGroup -> Rep UserGroup x

to :: Rep UserGroup x -> UserGroup

ToJSON UserGroup

Methods

toJSON :: UserGroup -> Value

toEncoding :: UserGroup -> Encoding

FromJSON UserGroup

Methods

parseJSON :: Value -> Parser UserGroup

ToSchema UserGroup

Methods

declareNamedSchema :: proxy UserGroup -> Declare (Definitions Schema) NamedSchema

ToSample UserGroup

Methods

toSamples :: Proxy * UserGroup -> [(Text, UserGroup)]

type Rep UserGroup

type Rep UserGroup = D1 (MetaData "UserGroup" "Servant.API.Auth.Token" "servant-auth-token-api-0.1.0.0-ytdrdPO8IZ81Ej6YqyzUX" False) (C1 (MetaCons "UserGroup" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "userGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "userGroupUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [UserId]))) ((:*:) (S1 (MetaSel (Just Symbol "userGroupPermissions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Permission])) (S1 (MetaSel (Just Symbol "userGroupParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UserGroupId))))))

data PatchUserGroup

Data type that is used to patch UserGroup

Constructors

PatchUserGroup

Fields

• patchUserGroupName :: !(Maybe Text)
• patchUserGroupUsers :: !(Maybe [UserId])
• patchUserGroupPermissions :: !(Maybe [Permission])
• patchUserGroupParent :: !(Maybe UserGroupId)
• patchUserGroupNoParent :: !(Maybe Bool)

  Special case when you want to set parent to Nothing

Instances

Show PatchUserGroup

Methods

showsPrec :: Int -> PatchUserGroup -> ShowS

show :: PatchUserGroup -> String

showList :: [PatchUserGroup] -> ShowS

Generic PatchUserGroup

Associated Types

type Rep PatchUserGroup :: * -> *

Methods

from :: PatchUserGroup -> Rep PatchUserGroup x

to :: Rep PatchUserGroup x -> PatchUserGroup

ToJSON PatchUserGroup

Methods

toJSON :: PatchUserGroup -> Value

toEncoding :: PatchUserGroup -> Encoding

FromJSON PatchUserGroup

Methods

parseJSON :: Value -> Parser PatchUserGroup

ToSchema PatchUserGroup

Methods

declareNamedSchema :: proxy PatchUserGroup -> Declare (Definitions Schema) NamedSchema

ToSample PatchUserGroup

Methods

toSamples :: Proxy * PatchUserGroup -> [(Text, PatchUserGroup)]

type Rep PatchUserGroup

type Rep PatchUserGroup = D1 (MetaData "PatchUserGroup" "Servant.API.Auth.Token" "servant-auth-token-api-0.1.0.0-ytdrdPO8IZ81Ej6YqyzUX" False) (C1 (MetaCons "PatchUserGroup" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "patchUserGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "patchUserGroupUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UserId])))) ((:*:) (S1 (MetaSel (Just Symbol "patchUserGroupPermissions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Permission]))) ((:*:) (S1 (MetaSel (Just Symbol "patchUserGroupParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UserGroupId))) (S1 (MetaSel (Just Symbol "patchUserGroupNoParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))))

Default permissions

adminPerm :: Permission

Permission that allows everything by default

registerPerm :: Permission

Permission that allows registration of new users

authInfoPerm :: Permission

Permission that allows to query info about other users

authUpdatePerm :: Permission

Permission that allows to update fields of an user

authDeletePerm :: Permission

Permission that allows to delete users and cause cascade deletion

Swagger helpers

authOperations :: Traversal' Swagger Operation

Select only operations of the Auth API

Reexports

Orphan instances

ToSample Word

Methods

toSamples :: Proxy * Word -> [(Text, Word)]

ToSample ()

Methods

toSamples :: Proxy * () -> [(Text, ())]

ToSample Text

Methods

toSamples :: Proxy * Text -> [(Text, Text)]

ToParam * (QueryParam * "code" RestoreCode)

Methods

toParam :: Proxy (QueryParam * "code" RestoreCode) t -> DocQueryParam

ToParam * (QueryParam * "expire" Seconds)

Methods

toParam :: Proxy (QueryParam * "expire" Seconds) t -> DocQueryParam

ToParam * (QueryParam * "login" Login)

Methods

toParam :: Proxy (QueryParam * "login" Login) t -> DocQueryParam

ToParam * (QueryParam * "password" Password)

Methods

toParam :: Proxy (QueryParam * "password" Password) t -> DocQueryParam

ToCapture * (Capture * "group-id" UserGroupId)

Methods

toCapture :: Proxy (Capture * "group-id" UserGroupId) c -> DocCapture

ToCapture * (Capture * "user-id" UserId)

Methods

toCapture :: Proxy (Capture * "user-id" UserId) c -> DocCapture