| Copyright | (c) Anton Gushcha 2016 |
|---|---|
| License | MIT |
| Maintainer | [email protected] |
| Stability | experimental |
| Portability | Portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Servant.API.Auth.Token
Description
- type AuthAPI = AuthSigninMethod :<|> (AuthTouchMethod :<|> (AuthTokenInfoMethod :<|> (AuthSignoutMethod :<|> (AuthSignupMethod :<|> (AuthUsersMethod :<|> (AuthGetUserMethod :<|> (AuthPatchUserMethod :<|> (AuthPutUserMethod :<|> (AuthDeleteUserMethod :<|> (AuthRestoreMethod :<|> (AuthGetGroupMethod :<|> (AuthPostGroupMethod :<|> (AuthPutGroupMethod :<|> (AuthPatchGroupMethod :<|> (AuthDeleteGroupMethod :<|> AuthGroupsMethod)))))))))))))))
- type AuthSigninMethod = "auth" :> ("signin" :> (QueryParam "login" Login :> (QueryParam "password" Password :> (QueryParam "expire" Seconds :> Get '[JSON] (OnlyField "token" SimpleToken)))))
- type AuthTouchMethod = "auth" :> ("touch" :> (QueryParam "expire" Seconds :> (TokenHeader '[] :> Post '[JSON] ())))
- type AuthTokenInfoMethod = "auth" :> ("token" :> (TokenHeader '[] :> Get '[JSON] RespUserInfo))
- type AuthSignoutMethod = "auth" :> ("signout" :> (TokenHeader '[] :> Post '[JSON] ()))
- type AuthSignupMethod = "auth" :> ("signup" :> (ReqBody '[JSON] ReqRegister :> (TokenHeader '["auth-register"] :> Post '[JSON] (OnlyField "user" UserId))))
- type AuthUsersMethod = "auth" :> ("users" :> (PageParam :> (PageSizeParam :> (TokenHeader '["auth-info"] :> Get '[JSON] RespUsersInfo))))
- type AuthGetUserMethod = "auth" :> ("user" :> (Capture "user-id" UserId :> (TokenHeader '["auth-info"] :> Get '[JSON] RespUserInfo)))
- type AuthPatchUserMethod = "auth" :> ("user" :> (Capture "user-id" UserId :> (ReqBody '[JSON] PatchUser :> (TokenHeader '["auth-update"] :> Patch '[JSON] ()))))
- type AuthPutUserMethod = "auth" :> ("user" :> (Capture "user-id" UserId :> (ReqBody '[JSON] ReqRegister :> (TokenHeader '["auth-update"] :> Put '[JSON] ()))))
- type AuthDeleteUserMethod = "auth" :> ("user" :> (Capture "user-id" UserId :> (TokenHeader '["auth-delete"] :> Delete '[JSON] ())))
- type AuthRestoreMethod = "auth" :> ("restore" :> (Capture "user-id" UserId :> (QueryParam "code" RestoreCode :> (QueryParam "password" Password :> Post '[JSON] ()))))
- type AuthGetGroupMethod = "auth" :> ("group" :> (Capture "group-id" UserGroupId :> (TokenHeader '["auth-info"] :> Get '[JSON] UserGroup)))
- type AuthPostGroupMethod = "auth" :> ("group" :> (ReqBody '[JSON] UserGroup :> (TokenHeader '["auth-update"] :> Post '[JSON] (OnlyId UserGroupId))))
- type AuthPutGroupMethod = "auth" :> ("group" :> (Capture "group-id" UserGroupId :> (ReqBody '[JSON] UserGroup :> (TokenHeader '["auth-update"] :> Put '[JSON] ()))))
- type AuthPatchGroupMethod = "auth" :> ("group" :> (Capture "group-id" UserGroupId :> (ReqBody '[JSON] PatchUserGroup :> (TokenHeader '["auth-update"] :> Patch '[JSON] ()))))
- type AuthDeleteGroupMethod = "auth" :> ("group" :> (Capture "group-id" UserGroupId :> (TokenHeader '["auth-delete"] :> Delete '[JSON] ())))
- type AuthGroupsMethod = "auth" :> ("group" :> (PageParam :> (PageSizeParam :> (TokenHeader '["auth-info"] :> Get '[JSON] (PagedList UserGroupId UserGroup)))))
- authAPI :: Proxy AuthAPI
- authDocs :: API
- newtype Token perms = Token {}
- type MToken perms = Maybe (Token perms)
- type TokenHeader perms = Header "Authorization" (Token perms)
- type SimpleToken = Text
- class PermsList a where
- downgradeToken' :: True ~ PermsSubset ts' ts => Token ts -> Token ts'
- downgradeToken :: True ~ PermsSubset ts' ts => MToken ts -> MToken ts'
- type UserId = Word
- type Login = Text
- type Password = Text
- type Email = Text
- type Permission = Text
- type Seconds = Word
- type RestoreCode = Text
- data ReqRegister = ReqRegister {
- reqRegLogin :: !Login
- reqRegPassword :: !Password
- reqRegEmail :: !Email
- reqRegPermissions :: ![Permission]
- reqRegGroups :: !(Maybe [UserGroupId])
- data RespUserInfo = RespUserInfo {
- respUserId :: !UserId
- respUserLogin :: !Login
- respUserEmail :: !Email
- respUserPermissions :: ![Permission]
- respUserGroups :: ![UserGroupId]
- data PatchUser = PatchUser {
- patchUserLogin :: !(Maybe Login)
- patchUserPassword :: !(Maybe Password)
- patchUserEmail :: !(Maybe Email)
- patchUserPermissions :: !(Maybe [Permission])
- patchUserGroups :: !(Maybe [UserGroupId])
- data RespUsersInfo = RespUsersInfo {
- respUsersItems :: ![RespUserInfo]
- respUsersPages :: !Word
- type UserGroupId = Word
- data UserGroup = UserGroup {
- userGroupName :: !Text
- userGroupUsers :: ![UserId]
- userGroupPermissions :: ![Permission]
- userGroupParent :: !(Maybe UserGroupId)
- data PatchUserGroup = PatchUserGroup {
- patchUserGroupName :: !(Maybe Text)
- patchUserGroupUsers :: !(Maybe [UserId])
- patchUserGroupPermissions :: !(Maybe [Permission])
- patchUserGroupParent :: !(Maybe UserGroupId)
- patchUserGroupNoParent :: !(Maybe Bool)
- adminPerm :: Permission
- registerPerm :: Permission
- authInfoPerm :: Permission
- authUpdatePerm :: Permission
- authDeletePerm :: Permission
- authOperations :: Traversal' Swagger Operation
API specs
type AuthAPI = AuthSigninMethod :<|> (AuthTouchMethod :<|> (AuthTokenInfoMethod :<|> (AuthSignoutMethod :<|> (AuthSignupMethod :<|> (AuthUsersMethod :<|> (AuthGetUserMethod :<|> (AuthPatchUserMethod :<|> (AuthPutUserMethod :<|> (AuthDeleteUserMethod :<|> (AuthRestoreMethod :<|> (AuthGetGroupMethod :<|> (AuthPostGroupMethod :<|> (AuthPutGroupMethod :<|> (AuthPatchGroupMethod :<|> (AuthDeleteGroupMethod :<|> AuthGroupsMethod))))))))))))))) Source #
Generic authorization API
type AuthSigninMethod = "auth" :> ("signin" :> (QueryParam "login" Login :> (QueryParam "password" Password :> (QueryParam "expire" Seconds :> Get '[JSON] (OnlyField "token" SimpleToken))))) Source #
How to get a token, expire of Nothing means
some default value (server config)
type AuthTouchMethod = "auth" :> ("touch" :> (QueryParam "expire" Seconds :> (TokenHeader '[] :> Post '[JSON] ()))) Source #
Client cat expand the token lifetime, no permissions are required
type AuthTokenInfoMethod = "auth" :> ("token" :> (TokenHeader '[] :> Get '[JSON] RespUserInfo)) Source #
Get client info that is binded to the token
type AuthSignoutMethod = "auth" :> ("signout" :> (TokenHeader '[] :> Post '[JSON] ())) Source #
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)))) Source #
Creation of new user, requires registerPerm for token
type AuthUsersMethod = "auth" :> ("users" :> (PageParam :> (PageSizeParam :> (TokenHeader '["auth-info"] :> Get '[JSON] RespUsersInfo)))) Source #
Getting list of all users, requires authInfoPerm for token
type AuthGetUserMethod = "auth" :> ("user" :> (Capture "user-id" UserId :> (TokenHeader '["auth-info"] :> Get '[JSON] RespUserInfo))) Source #
Getting info about user, requires authInfoPerm for token
type AuthPatchUserMethod = "auth" :> ("user" :> (Capture "user-id" UserId :> (ReqBody '[JSON] PatchUser :> (TokenHeader '["auth-update"] :> Patch '[JSON] ())))) Source #
Updating loginemailpassword, requires authUpdatePerm for token
type AuthPutUserMethod = "auth" :> ("user" :> (Capture "user-id" UserId :> (ReqBody '[JSON] ReqRegister :> (TokenHeader '["auth-update"] :> Put '[JSON] ())))) Source #
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] ()))) Source #
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] ())))) Source #
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))) Source #
Getting info about user group, requires authInfoPerm for token
type AuthPostGroupMethod = "auth" :> ("group" :> (ReqBody '[JSON] UserGroup :> (TokenHeader '["auth-update"] :> Post '[JSON] (OnlyId UserGroupId)))) Source #
Inserting new user group, requires authUpdatePerm for token
type AuthPutGroupMethod = "auth" :> ("group" :> (Capture "group-id" UserGroupId :> (ReqBody '[JSON] UserGroup :> (TokenHeader '["auth-update"] :> Put '[JSON] ())))) Source #
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] ())))) Source #
Patch info about given user group, requires authUpdatePerm for token
type AuthDeleteGroupMethod = "auth" :> ("group" :> (Capture "group-id" UserGroupId :> (TokenHeader '["auth-delete"] :> Delete '[JSON] ()))) Source #
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))))) Source #
Get list of user groups, requires authInfoPerm for token
authAPI :: Proxy AuthAPI Source #
Proxy type for auth API, used to pass the type-level info into client/docs generation functions
Servant.Docs documentation of the Auth API
Token
Token is simple string marked by permissions that are expected from the token to pass guarding functions.
type TokenHeader perms = Header "Authorization" (Token perms) Source #
Token header that we require for authorization marked by permissions that are expected from the token to pass guarding functions.
type SimpleToken = Text Source #
Token that doesn't have attached compile-time permissions
class PermsList a where Source #
Minimal complete definition
Methods
unliftPerms :: forall proxy. proxy a -> [Permission] Source #
downgradeToken' :: True ~ PermsSubset ts' ts => Token ts -> Token ts' Source #
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' Source #
Cast token to permissions that are lower than original one.
The cast is safe, the permissions are cheked on compile time.
User
type Permission = Text Source #
Special tag for a permission that a user has
type RestoreCode = Text Source #
Special tag for password restore
data ReqRegister Source #
Request body for user registration
Constructors
| ReqRegister | |
Fields
| |
data RespUserInfo Source #
Response with user info
Constructors
| RespUserInfo | |
Fields
| |
Request body for patching user
Constructors
| PatchUser | |
Fields
| |
data RespUsersInfo Source #
Response with users info and pagination
Constructors
| RespUsersInfo | |
Fields
| |
User groups
type UserGroupId = Word Source #
Id of user group
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
| |
data PatchUserGroup Source #
Data type that is used to patch UserGroup
Constructors
| PatchUserGroup | |
Fields
| |
Default permissions
adminPerm :: Permission Source #
Permission that allows everything by default
registerPerm :: Permission Source #
Permission that allows registration of new users
authInfoPerm :: Permission Source #
Permission that allows to query info about other users
authUpdatePerm :: Permission Source #
Permission that allows to update fields of an user
authDeletePerm :: Permission Source #
Permission that allows to delete users and cause cascade deletion
Swagger helpers
authOperations :: Traversal' Swagger Operation Source #
Select only operations of the Auth API
Reexports
Orphan instances
| ToSample Word Source # | |
| ToSample () Source # | |
| ToSample Text Source # | |
| ToParam * (QueryParam * "code" RestoreCode) Source # | |
| ToParam * (QueryParam * "expire" Seconds) Source # | |
| ToParam * (QueryParam * "login" Login) Source # | |
| ToParam * (QueryParam * "password" Password) Source # | |
| ToCapture * (Capture * "group-id" UserGroupId) Source # | |
| ToCapture * (Capture * "user-id" UserId) Source # | |