Current section
Files
Jump to
Current section
Files
src/libsnarl_msg.erl
-module(libsnarl_msg).
-export([
allowed/3,
auth/3,
auth/4
]).
-export([
token_delete/2,
token_get/2,
token_add/3,
token_add/4
]).
-export([
user_add/2, user_add/3,
user_cache/2,
user_delete/2,
user_get/2,
user_make_token/2,
user_grant/3,
user_join/3,
user_key_find/2,
user_key_add/4,
user_key_revoke/3,
user_yubikey_add/3,
user_yubikey_check/3,
user_yubikey_remove/3,
user_leave/3,
user_list/1,
user_list/3,
user_lookup/2,
user_passwd/3,
user_revoke/3,
user_revoke_prefix/3,
user_join_org/3,
user_leave_org/3,
user_select_org/3,
user_set_metadata/3,
user_api_token/4,
user_sign_csr/5,
user_revoke_token/3
]).
-export([
client_add/2, client_add/3,
client_delete/2,
client_get/2,
client_grant/3,
client_join/3,
client_uri_add/3,
client_uri_remove/3,
client_leave/3,
client_list/1,
client_list/3,
client_lookup/2,
client_secret/3,
client_revoke/3,
client_revoke_prefix/3,
client_set_metadata/3
]).
-export([
role_add/2,
role_delete/2,
role_get/2,
role_grant/3,
role_list/1,
role_list/3,
role_revoke/3,
role_revoke_prefix/3,
role_set_metadata/3
]).
-export([
org_add/2,
org_delete/2,
org_get/2,
org_add_trigger/3,
org_list/1,
org_list/3,
org_remove_trigger/3,
org_execute_trigger/4,
org_reverse_trigger/4,
org_resource_inc/4,
org_resource_dec/4,
org_set_metadata/3
]).
-export([
acc_create/5,
acc_update/5,
acc_destroy/5,
acc_get/2,
acc_get/3,
acc_get/4
]).
-export([authorize_password/3]).
-export([authorize_password/4]).
-export([authorize_password/5]).
-export([authorize_client_credentials/3]).
-export([authorize_code_grant/4]).
-export([authorize_code_request/5]).
-export([issue_code/2]).
-export([issue_token/2]).
-export([issue_token_and_refresh/2]).
-export([verify_access_token/2]).
-export([verify_access_code/2]).
-export([verify_access_code/3]).
-export([refresh_access_token/4]).
-export([scope/1]).
-export([scope/2]).
-define(USER, <<User:36/binary>>).
-define(CLIENT, <<Client:36/binary>>).
-define(ROLE, <<Role:36/binary>>).
-define(ORG, <<Org:36/binary>>).
-define(TOKEN, {token, <<_/binary>>} = Token).
%%%===================================================================
%%% Generatl Functions
%%%===================================================================
-spec auth(Realm::binary(), Login::binary(), Pass::binary()) ->
{user, auth, Realm::binary(), Login::binary(),
Pass::binary()}.
auth(Realm, Login, Pass) when
is_binary(Realm),
is_binary(Login),
is_binary(Pass)->
{user, auth, Realm, Login, Pass}.
auth(Realm, Login, Pass, OTP) when
is_binary(Realm),
is_binary(Login),
is_binary(Pass),
is_binary(OTP) ->
{user, auth, Realm, Login, Pass, OTP}.
-spec allowed(Realm::binary(),
User::fifo:user_token_id(),
Permission::fifo:permission()) ->
{user, allowed, Realm::binary(),
User::fifo:user_token_id(),
Permission::fifo:permission()}.
allowed(Realm, ?TOKEN, Permission) when
is_binary(Realm),
is_list(Permission) ->
{user, allowed, Realm, Token, Permission};
allowed(Realm, ?USER, Permission)
when is_list(Permission) ->
{user, allowed, Realm, User, Permission}.
%%%===================================================================
%%% Token Functions
%%%===================================================================
-spec token_delete(Realm::binary(), Token::binary()) ->
{token, delete, Realm::binary(), Token::fifo:token()}.
token_delete(Realm, Token) when
is_binary(Realm) ->
{token, delete, Realm, Token}.
-spec token_get(Realm::binary(), Token::binary()) ->
{token, get, Realm::binary(), Token::term()}.
token_get(Realm, Token) when
is_binary(Realm) ->
{token, get, Realm, Token}.
-spec token_add(Realm::binary(), Token::binary(), Timeout::integer(),
Data::term()) ->
{token, add, Realm::binary(), Token::term(),
Timeout::integer(), Data::term()}.
token_add(Realm, Token, Timeout, Data) when
is_binary(Realm), is_integer(Timeout), Timeout > 0 ->
{token, add, Realm, Token, Timeout, Data}.
-spec token_add(Realm::binary(), Timeout::pos_integer(), Data::term()) ->
{token, add, Realm::binary(),
Timeout::pos_integer(), Data::term()}.
token_add(Realm, Timeout, Data) when
is_binary(Realm), is_integer(Timeout), Timeout > 0 ->
{token, add, Realm, Timeout, Data}.
%%%===================================================================
%%% User Functions
%%%===================================================================
%%--------------------------------------------------------------------
%% @doc Sets user metadata.
%% @end
%%--------------------------------------------------------------------
-spec user_set_metadata(Ream::binary(), User::fifo:user_id(),
Attrs::fifo:attr_list()) ->
{user, set_metadata, Realm::binary(),
User::fifo:user_id(), Attrs::fifo:attr_list()}.
user_set_metadata(Realm, User, Attrs) when
is_binary(Realm),
is_binary(User),
is_list(Attrs) ->
{user, set_metadata, Realm, User, Attrs}.
%%--------------------------------------------------------------------
%% @doc Retrievs a list of all user id's.
%% @end
%%--------------------------------------------------------------------
-spec user_list(Realm::binary()) ->
{user, list, Realm::binary()}.
user_list(Realm) when
is_binary(Realm) ->
{user, list, Realm}.
%%--------------------------------------------------------------------
%% @doc Retrievs a list of all user id's.
%% @end
%%--------------------------------------------------------------------
-spec user_list(Realm::binary(), Reqs::[fifo:matcher()], boolean()) ->
{user, list, Realm::binary(),
Reqs::[fifo:matcher()], boolean()}.
user_list(Realm, Reqs, Full) when
is_binary(Realm) ->
{user, list, Realm, Reqs, Full}.
%%--------------------------------------------------------------------
%% @doc Retrieves user data from the server.
%% @end
%%--------------------------------------------------------------------
-spec user_get(Realm::binary(), User::fifo:user_token_id()) ->
{user, get, Realm::binary(), User::fifo:user_token_id()}.
user_get(Realm, ?TOKEN) when
is_binary(Realm) ->
{user, get, Realm, Token};
user_get(Realm, ?USER) when
is_binary(Realm) ->
{user, get, Realm, User}.
%%--------------------------------------------------------------------
%% @doc Creates a token for a user.
%% @end
%%--------------------------------------------------------------------
-spec user_make_token(Realm::binary(), User::fifo:user_id()) ->
{user, token, Realm::binary(),
User::fifo:user_id()}.
user_make_token(Realm, ?USER) when
is_binary(Realm) ->
{user, token, Realm, User}.
%%--------------------------------------------------------------------
%% @doc Retrieves user data from the server.
%% @end
%%--------------------------------------------------------------------
-spec user_lookup(Realm::binary(), Login::binary()) ->
{user, lookup, Realm::binary(), Login::binary()}.
user_lookup(Realm, Login) when
is_binary(Realm),
is_binary(Login) ->
{user, lookup, Realm, Login}.
%%--------------------------------------------------------------------
%% @doc Retrieves all user permissions to later test.
%% @end
%%--------------------------------------------------------------------
-spec user_cache(Realm::binary(), User::fifo:user_token_id()) ->
{user, cache, Realm::binary(),
User::fifo:user_token_id()}.
user_cache(Realm, ?TOKEN) when
is_binary(Realm) ->
{user, cache, Realm, Token};
user_cache(Realm, ?USER) when
is_binary(Realm) ->
{user, cache, Realm, User}.
-spec user_add(Realm::binary(), UserName::binary()) ->
{user, add, Realm::binary(), UserName::binary()}.
user_add(Realm, UserName) when
is_binary(Realm),
is_binary(UserName) ->
{user, add, Realm, UserName}.
-spec user_add(Realm::binary(), Creator::fifo:user_id(),
UserName::binary()) ->
{user, add, Realm::binary(), Creator::fifo:user_id(),
UserName::binary()}.
user_add(Realm, Creator, UserName) when
is_binary(Realm),
is_binary(Creator),
is_binary(UserName) ->
{user, add, Realm, Creator, UserName}.
%%--------------------------------------------------------------------
%% @doc Deletes a user.
%% @end
%%--------------------------------------------------------------------
-spec user_delete(Realm::binary(), User::fifo:user_id()) ->
{user, delete, Realm::binary(), User::fifo:user_id()}.
user_delete(Realm, User) when
is_binary(Realm),
is_binary(User) ->
{user, delete, Realm, User}.
%%--------------------------------------------------------------------
%% @doc Grants a right of a user.
%% @end
%%--------------------------------------------------------------------
-spec user_grant(Realm::binary(), User::fifo:user_id(),
Permission::fifo:permission()) ->
{user, grant, Realm::binary(),
User::fifo:user_id(),
Permission::fifo:permission()}.
user_grant(Realm, User, Permission) when
is_binary(Realm),
is_binary(User) ->
{user, grant, Realm, User, Permission}.
%%--------------------------------------------------------------------
%% @doc Revokes a right of a user.
%% @end
%%--------------------------------------------------------------------
-spec user_revoke(Realm::binary(), User::fifo:user_id(),
Permission::fifo:permission()) ->
{user, revoke, Realm::binary(),
User::fifo:user_id(),
Permission::fifo:permission()}.
user_revoke(Realm, User, Permission) when
is_binary(Realm),
is_binary(User) ->
{user, revoke, Realm, User, Permission}.
%%--------------------------------------------------------------------
%% @doc Revokes all right with a certain prefix from a user.
%% @end
%%--------------------------------------------------------------------
-spec user_revoke_prefix(Realm::binary(), User::fifo:user_id(),
Prefix::fifo:permission()) ->
{user, revoke_prefix, Realm::binary(),
User::fifo:user_id(),
Permission::fifo:permission()}.
user_revoke_prefix(Realm, ?USER, Prefix) when
is_binary(Realm),
is_list(Prefix) ->
{user, revoke_prefix, Realm, User, Prefix}.
%%--------------------------------------------------------------------
%% @doc Changes the Password of a user.
%% @end
%%--------------------------------------------------------------------
-spec user_passwd(Realm::binary(), User::fifo:user_id(), Pass::binary()) ->
{user, passwd, Realm::binary(), User::fifo:user_id(),
Pass::binary()}.
user_passwd(Realm, ?USER, Pass) when
is_binary(Realm),
is_binary(Pass) ->
{user, passwd, Realm, User, Pass}.
%%--------------------------------------------------------------------
%% @doc Adds a user to a role.
%% @end
%%--------------------------------------------------------------------
-spec user_join(Realm::binary(), User::fifo:user_id(), Role::fifo:role_id()) ->
{user, join, Realm::binary(), User::fifo:user_id(),
Role::fifo:role_id()}.
user_join(Realm, ?USER, ?ROLE) when
is_binary(Realm) ->
{user, join, Realm, User, Role}.
-spec user_leave(Realm::binary(), User::fifo:user_id(), Role::fifo:role_id()) ->
{user, leave, Realm::binary(),
User::fifo:user_id(),
Role::fifo:role_id()}.
user_leave(Realm, ?USER, ?ROLE) when
is_binary(Realm) ->
{user, leave, Realm, User, Role}.
-spec user_key_find(Realm::binary(), KeyID::<<_:128>>) ->
{user, keys, find, Realm::binary(),
KeyID::<<_:128>>}.
user_key_find(Realm, <<KeyID:16/binary>>) when
is_binary(Realm) ->
{user, keys, find, Realm, KeyID}.
-spec user_key_add(Realm::binary(), User::fifo:user_id(), KeyID::binary(),
Key::binary()) ->
{user, keys, add, Realm::binary(),
User::fifo:user_id(), KeyID::binary(),
Key::binary()}.
user_key_add(Realm, ?USER, KeyID, Key)when
is_binary(Realm),
is_binary(KeyID),
is_binary(Key) ->
{user, keys, add, Realm, User, KeyID, Key}.
-spec user_key_revoke(Realm::binary(), User::fifo:user_id(), KeyID::binary()) ->
{user, keys, revoke, Realm::binary(),
User::fifo:user_id(), KeyID::binary()}.
user_key_revoke(Realm, ?USER, KeyID)when
is_binary(Realm),
is_binary(KeyID) ->
{user, keys, revoke, Realm, User, KeyID}.
-spec user_yubikey_add(Realm::binary(), User::fifo:user_id(),
KeyID::binary()) ->
{user, yubikeys, add, Realm::binary(),
User::fifo:user_id(), KeyID::binary()}.
user_yubikey_add(Realm, ?USER, KeyID)when
is_binary(Realm),
is_binary(KeyID) ->
{user, yubikeys, add, Realm, User, KeyID}.
-spec user_yubikey_check(Realm::binary(), User::fifo:user_id(),
OTP::binary()) ->
{user, yubikeys, check, Realm::binary(),
User::fifo:user_id(), OTP::binary()}.
user_yubikey_check(Realm, ?USER, OTP) when
is_binary(Realm),
is_binary(OTP) ->
{user, yubikeys, check, Realm, User, OTP}.
-spec user_yubikey_remove(Realm::binary(), User::fifo:user_id(),
KeyID::binary()) ->
{user, yubikeys, remove, Realm::binary(),
User::fifo:user_id(), KeyID::binary()}.
user_yubikey_remove(Realm, ?USER, KeyID) when
is_binary(Realm),
is_binary(KeyID) ->
{user, yubikeys, remove, Realm, User, KeyID}.
-spec user_join_org(Realm::binary(), User::fifo:user_id(),
Org::fifo:org_id()) ->
{user, org, join, Realm::binary(),
User::fifo:user_id(),
Org::fifo:org_id()}.
user_join_org(Realm, ?USER, ?ORG) when
is_binary(Realm) ->
{user, org, join, Realm, User, Org}.
-spec user_leave_org(Realm::binary(), User::fifo:user_id(),
Org::fifo:org_id()) ->
{user, org, leave, Realm::binary(),
User::fifo:user_id(),
Org::fifo:org_id()}.
user_leave_org(Realm, ?USER, ?ORG) when
is_binary(Realm) ->
{user, org, leave, Realm, User, Org}.
-spec user_select_org(Realm::binary(), User::fifo:user_id(),
Org::fifo:org_id()) ->
{user, org, select, Realm::binary(),
User::fifo:user_id(),
Org::fifo:org_id()}.
user_select_org(Realm, ?USER, ?ORG) when
is_binary(Realm) ->
{user, org, select, Realm, User, Org}.
%%--------------------------------------------------------------------
%% @doc Creates a API token
%% @end
%%--------------------------------------------------------------------
-spec user_api_token(Ream::binary(), User::fifo:user_id(),
Scope::[binary()], Comment::binary()) ->
{user, api_token, Realm::binary(),
User::fifo:user_id(), Scope::[binary()],
Comment::binary()}.
user_api_token(Realm, User, Scope, Comment) when
is_binary(Realm),
is_binary(User),
is_list(Scope),
is_binary(Comment) ->
{user, api_token, Realm, User, Scope, Comment}.
%%--------------------------------------------------------------------
%% @doc Signs a CSR requests and returns a certificate
%% @end
%%--------------------------------------------------------------------
-spec user_sign_csr(Ream::binary(), User::fifo:user_id(),
Scope::[binary()], Comment::binary(),
CSR::binary()) ->
{user, sign_csr, Realm::binary(),
User::fifo:user_id(), Scope::[binary()],
Comment::binary(), CSR::binary()}.
user_sign_csr(Realm, User, Scope, Comment, CSR) when
is_binary(Realm),
is_binary(User),
is_list(Scope),
is_binary(Comment),
is_binary(CSR) ->
{user, sign_csr, Realm, User, Scope, Comment, CSR}.
%%--------------------------------------------------------------------
%% @doc Revokes a token with a given tokenID (not by the token itself)
%% @end
%%--------------------------------------------------------------------
-spec user_revoke_token(Reeam::binary(), User::fifo:user_id(),
TokenID::binary()) ->
{user, revoke_token, Realm::binary(),
User::fifo:user_id(),
TokenID::binary()}.
user_revoke_token(Realm, User, TokenID) when
is_binary(Realm),
is_binary(User),
is_binary(TokenID) ->
{user, revoke_token, Realm, User, TokenID}.
%%%===================================================================
%%% Role Functions
%%%===================================================================
-spec role_set_metadata(Ream::binary(), Role::fifo:role_id(),
Attrs::fifo:attr_list()) ->
{role, set_metadata, Realm::binary(),
Role::fifo:role_id(), Attrs::fifo:attr_list()}.
role_set_metadata(Realm, Role, Attrs) when
is_binary(Realm),
is_binary(Role),
is_list(Attrs) ->
{role, set_metadata, Realm, Role, Attrs}.
%%--------------------------------------------------------------------
%% @doc Retrievs a list of all role id's.
%% @end
%%--------------------------------------------------------------------
-spec role_list(Realm::binary()) ->
{role, list, Realm::binary()}.
role_list(Realm) when
is_binary(Realm) ->
{role, list, Realm}.
%%--------------------------------------------------------------------
%% @doc Retrievs a list of all user id's.
%% @end
%%--------------------------------------------------------------------
-spec role_list(Realm::binary(), Reqs::[fifo:matcher()], boolean()) ->
{role, list, Realm::binary(),
Reqs::[fifo:matcher()],
boolean()}.
role_list(Realm, Reqs, Full) when
is_binary(Realm) ->
{role, list, Realm, Reqs, Full}.
%%--------------------------------------------------------------------
%% @doc Retrieves role data from the server.
%% @end
%%--------------------------------------------------------------------
-spec role_get(Realm::binary(), Role::fifo:role_id()) ->
{role, get, Realm::binary(), Role::fifo:role_id()}.
role_get(Realm, ?ROLE) when
is_binary(Realm) ->
{role, get, Realm, Role}.
%%--------------------------------------------------------------------
%% @doc Adds a new role.
%% @end
%%--------------------------------------------------------------------
-spec role_add(Realm::binary(), RoleName::binary()) ->
{role, add, Realm::binary(), RoleName::binary()}.
role_add(Realm, RoleName) when
is_binary(Realm),
is_binary(RoleName) ->
{role, add, Realm, RoleName}.
%%--------------------------------------------------------------------
%% @doc Deletes a role.
%% @end
%%--------------------------------------------------------------------
-spec role_delete(Realm::binary(), Role::fifo:role_id()) ->
{role, delete, Realm::binary(), Role::fifo:role_id()}.
role_delete(Realm, ?ROLE) when
is_binary(Realm) ->
{role, delete, Realm, Role}.
%%--------------------------------------------------------------------
%% @doc Grants a right of a role.
%% @end
%%--------------------------------------------------------------------
-spec role_grant(Realm::binary(), Role::fifo:role_id(),
Permission::fifo:permission()) ->
{role, grant, Realm::binary(),
Role::fifo:role_id(),
Permission::fifo:permission()}.
role_grant(Realm, ?ROLE, Permission) when
is_binary(Realm),
is_list(Permission) ->
{role, grant, Realm, Role, Permission}.
%%--------------------------------------------------------------------
%% @doc Revokes a right of a role.
%% @end
%%--------------------------------------------------------------------
-spec role_revoke(Realm::binary(), Role::fifo:role_id(),
Permission::fifo:permission()) ->
{role, revoke, Realm::binary(),
Role::fifo:role_id(),
Permission::fifo:permission()}.
role_revoke(Realm, ?ROLE, Permission) when
is_binary(Realm),
is_list(Permission) ->
{role, revoke, Realm, Role, Permission}.
%%--------------------------------------------------------------------
%% @doc Revokes all rights matching a prefix from a role.
%% @end
%%--------------------------------------------------------------------
-spec role_revoke_prefix(Realm::binary(), Role::fifo:role_id(),
Prefix::fifo:permission()) ->
{role, revoke_prefix, Realm::binary(),
Role::fifo:role_id(),
Permission::fifo:permission()}.
role_revoke_prefix(Realm, ?ROLE, Prefix) when
is_binary(Realm),
is_list(Prefix) ->
{role, revoke_prefix, Realm, Role, Prefix}.
%%%===================================================================
%%% Org Functions
%%%===================================================================
-spec org_set_metadata(Ream::binary(), Org::fifo:org_id(),
Attrs::fifo:attr_list()) ->
{org, set_metadata, Realm::binary(),
Org::fifo:org_id(), Attrs::fifo:attr_list()}.
org_set_metadata(Realm, Org, Attrs) when
is_binary(Realm),
is_binary(Org),
is_list(Attrs) ->
{org, set_metadata, Realm, Org, Attrs}.
%%--------------------------------------------------------------------
%% @doc Retrievs a list of all org id's.
%% @end
%%--------------------------------------------------------------------
-spec org_list(Realm::binary()) ->
{org, list, Realm::binary()}.
org_list(Realm) when
is_binary(Realm) ->
{org, list, Realm}.
-spec org_list(Realm::binary(), Reqs::[fifo:matcher()], boolean()) ->
{org, list, Realm::binary(), Reqs::[fifo:matcher()],
boolean()}.
org_list(Realm, Reqs, Full) when
is_binary(Realm) ->
{org, list, Realm, Reqs, Full}.
%%--------------------------------------------------------------------
%% @doc Retrieves org data from the server.
%% @end
%%--------------------------------------------------------------------
-spec org_get(Realm::binary(), Org::fifo:org_id()) ->
{org, get, Realm::binary(), Org::fifo:org_id()}.
org_get(Realm, ?ORG) when
is_binary(Realm) ->
{org, get, Realm, Org}.
%%--------------------------------------------------------------------
%% @doc Adds a new org.
%% @end
%%--------------------------------------------------------------------
-spec org_add(Realm::binary(), OrgName::binary()) ->
{org, add, Realm::binary(), OrgName::binary()}.
org_add(Realm, OrgName) when
is_binary(Realm),
is_binary(OrgName) ->
{org, add, Realm, OrgName}.
%%--------------------------------------------------------------------
%% @doc Deletes a org.
%% @end
%%--------------------------------------------------------------------
-spec org_delete(Realm::binary(), Org::fifo:org_id()) ->
{org, delete, Realm::binary(), Org::fifo:org_id()}.
org_delete(Realm, ?ORG) when
is_binary(Realm) ->
{org, delete, Realm, Org}.
%%--------------------------------------------------------------------
%% @doc adds a trigger.
%% @end
%%--------------------------------------------------------------------
-spec org_add_trigger(Realm::binary(), Org::fifo:org_id(),
Trigger::fifo:trigger()) ->
{org, trigger, add, Realm::binary(),
Org::fifo:org_id(),
Trigger::fifo:trigger()}.
org_add_trigger(Realm, ?ORG, Trigger) when
is_binary(Realm) ->
{org, trigger, add, Realm, Org, Trigger}.
%%--------------------------------------------------------------------
%% @doc Removes a trigger.
%% @end
%%--------------------------------------------------------------------
-spec org_remove_trigger(Realm::binary(), Org::fifo:org_id(),
Trigger::fifo:trigger()) ->
{org, trigger, remove, Realm::binary(),
Org::fifo:org_id(),
Trigger::fifo:trigger()}.
org_remove_trigger(Realm, ?ORG, Trigger) when
is_binary(Realm) ->
{org, trigger, remove, Realm, Org, Trigger}.
%%--------------------------------------------------------------------
%% @doc Executes a trigger.
%% @end
%%--------------------------------------------------------------------
-spec org_execute_trigger(Realm::binary(), Org::fifo:org_id(),
Event::fifo:event(),
Payload::term()) ->
{org, trigger, execute, Realm::binary(),
Org::fifo:org_id(),
Trigger::fifo:trigger(),
Payload::term()}.
org_execute_trigger(Realm, ?ORG, Event, Payload) when
is_binary(Realm) ->
{org, trigger, execute, Realm, Org, Event, Payload}.
-spec org_reverse_trigger(Realm::binary(), Org::fifo:org_id(),
Event::fifo:event(),
Payload::term()) ->
{org, trigger, reverse, Realm::binary(),
Org::fifo:org_id(),
Trigger::fifo:trigger(),
Payload::term()}.
org_reverse_trigger(Realm, ?ORG, Event, Payload) when
is_binary(Realm) ->
{org, trigger, reverse, Realm, Org, Event, Payload}.
-spec org_resource_inc(Realm::binary(), Org::fifo:org_id(), Resource::binary(),
Delta::pos_integer()) ->
{org, resource, inc, Realm::binary(),
Org::fifo:org_id(), Resource::binary(),
Delta::pos_integer()}.
org_resource_inc(Realm, ?ORG, Resource, Delta) ->
{org, resource, inc, Realm, Org, Resource, Delta}.
-spec org_resource_dec(Realm::binary(), Org::fifo:org_id(), Resource::binary(),
Delta::pos_integer()) ->
{org, resource, dec, Realm::binary(),
Org::fifo:org_id(), Resource::binary(),
Delta::pos_integer()}.
org_resource_dec(Realm, ?ORG, Resource, Delta) ->
{org, resource, dec, Realm, Org, Resource, Delta}.
%%%===================================================================
%%% Client Functions
%%%===================================================================
-spec client_set_metadata(Ream::binary(), Client::fifo:client_id(),
Attrs::fifo:attr_list()) ->
{client, set_metadata, Realm::binary(),
Client::fifo:client_id(),
Attrs::fifo:attr_list()}.
client_set_metadata(Realm, Client, Attrs) when
is_binary(Realm),
is_binary(Client),
is_list(Attrs) ->
{client, set_metadata, Realm, Client, Attrs}.
%%--------------------------------------------------------------------
%% @doc Retrievs a list of all client id's.
%% @end
%%--------------------------------------------------------------------
-spec client_list(Realm::binary()) ->
{client, list, Realm::binary()}.
client_list(Realm) when
is_binary(Realm) ->
{client, list, Realm}.
%%--------------------------------------------------------------------
%% @doc Retrievs a list of all client id's.
%% @end
%%--------------------------------------------------------------------
-spec client_list(Realm::binary(), Reqs::[fifo:matcher()], boolean()) ->
{client, list, Realm::binary(), Reqs::[fifo:matcher()],
boolean()}.
client_list(Realm, Reqs, Full) when
is_binary(Realm) ->
{client, list, Realm, Reqs, Full}.
%%--------------------------------------------------------------------
%% @doc Retrieves client data from the server.
%% @end
%%--------------------------------------------------------------------
-spec client_get(Realm::binary(), Client::fifo:client_token_id()) ->
{client, get, Realm::binary(),
Client::fifo:client_token_id()}.
client_get(Realm, ?TOKEN) when
is_binary(Realm) ->
{client, get, Realm, Token};
client_get(Realm, ?CLIENT) when
is_binary(Realm) ->
{client, get, Realm, Client}.
%%--------------------------------------------------------------------
%% @doc Retrieves client data from the server.
%% @end
%%--------------------------------------------------------------------
-spec client_lookup(Realm::binary(), Login::binary()) ->
{client, lookup, Realm::binary(), Login::binary()}.
client_lookup(Realm, Login) when
is_binary(Realm),
is_binary(Login) ->
{client, lookup, Realm, Login}.
-spec client_add(Realm::binary(), ClientName::binary()) ->
{client, add, Realm::binary(), ClientName::binary()}.
client_add(Realm, ClientName) when
is_binary(Realm),
is_binary(ClientName) ->
{client, add, Realm, ClientName}.
-spec client_add(Realm::binary(), Creator::fifo:client_id(),
ClientName::binary()) ->
{client, add, Realm::binary(),
Creator::fifo:client_id(), ClientName::binary()}.
client_add(Realm, Creator, ClientName) when
is_binary(Realm),
is_binary(Creator),
is_binary(ClientName) ->
{client, add, Realm, Creator, ClientName}.
%%--------------------------------------------------------------------
%% @doc Deletes a client.
%% @end
%%--------------------------------------------------------------------
-spec client_delete(Realm::binary(), Client::fifo:client_id()) ->
{client, delete, Realm::binary(),
Client::fifo:client_id()}.
client_delete(Realm, Client) when
is_binary(Realm),
is_binary(Client) ->
{client, delete, Realm, Client}.
%%--------------------------------------------------------------------
%% @doc Grants a right of a client.
%% @end
%%--------------------------------------------------------------------
-spec client_grant(Realm::binary(), Client::fifo:client_id(),
Permission::fifo:permission()) ->
{client, grant, Realm::binary(),
Client::fifo:client_id(),
Permission::fifo:permission()}.
client_grant(Realm, Client, Permission) when
is_binary(Realm),
is_binary(Client) ->
{client, grant, Realm, Client, Permission}.
%%--------------------------------------------------------------------
%% @doc Revokes a right of a client.
%% @end
%%--------------------------------------------------------------------
-spec client_revoke(Realm::binary(), Client::fifo:client_id(),
Permission::fifo:permission()) ->
{client, revoke, Realm::binary(),
Client::fifo:client_id(),
Permission::fifo:permission()}.
client_revoke(Realm, Client, Permission) when
is_binary(Realm),
is_binary(Client) ->
{client, revoke, Realm, Client, Permission}.
%%--------------------------------------------------------------------
%% @doc Revokes all right with a certain prefix from a client.
%% @end
%%--------------------------------------------------------------------
-spec client_revoke_prefix(Realm::binary(), Client::fifo:client_id(),
Prefix::fifo:permission()) ->
{client, revoke_prefix, Realm::binary(),
Client::fifo:client_id(),
Permission::fifo:permission()}.
client_revoke_prefix(Realm, ?CLIENT, Prefix) when
is_binary(Realm),
is_list(Prefix) ->
{client, revoke_prefix, Realm, Client, Prefix}.
%%--------------------------------------------------------------------
%% @doc Changes the Password of a client.
%% @end
%%--------------------------------------------------------------------
-spec client_secret(Realm::binary(), Client::fifo:client_id(),
Secret::binary()) ->
{client, secret, Realm::binary(),
Client::fifo:client_id(), Secret::binary()}.
client_secret(Realm, ?CLIENT, Secret) when
is_binary(Realm),
is_binary(Secret) ->
{client, secret, Realm, Client, Secret}.
%%--------------------------------------------------------------------
%% @doc Adds a client to a role.
%% @end
%%--------------------------------------------------------------------
-spec client_join(Realm::binary(), Client::fifo:client_id(),
Role::fifo:role_id()) ->
{client, join, Realm::binary(),
Client::fifo:client_id(), Role::fifo:role_id()}.
client_join(Realm, ?CLIENT, ?ROLE) when
is_binary(Realm) ->
{client, join, Realm, Client, Role}.
-spec client_leave(Realm::binary(), Client::fifo:client_id(),
Role::fifo:role_id()) ->
{client, leave, Realm::binary(),
Client::fifo:client_id(),
Role::fifo:role_id()}.
client_leave(Realm, ?CLIENT, ?ROLE) when
is_binary(Realm) ->
{client, leave, Realm, Client, Role}.
-spec client_uri_add(Realm::binary(), Client::fifo:client_id(),
KeyID::binary()) ->
{client, uris, add, Realm::binary(),
Client::fifo:client_id(), KeyID::binary()}.
client_uri_add(Realm, ?CLIENT, KeyID)when
is_binary(Realm),
is_binary(KeyID) ->
{client, uris, add, Realm, Client, KeyID}.
-spec client_uri_remove(Realm::binary(), Client::fifo:client_id(),
KeyID::binary()) ->
{client, uris, remove, Realm::binary(),
Client::fifo:client_id(), KeyID::binary()}.
client_uri_remove(Realm, ?CLIENT, KeyID) when
is_binary(Realm),
is_binary(KeyID) ->
{client, uris, remove, Realm, Client, KeyID}.
%%%===================================================================
%%% OAuth2 Functions
%%%===================================================================
%%-export([authorize_password/3]).
authorize_password(Realm, User, Scope) ->
{oauth2, authorize_password, Realm, User, Scope}.
%%-export([authorize_password/4]).
authorize_password(Realm, User, Client, Scope) ->
{oauth2, authorize_password, Realm, User, Client, Scope}.
%%-export([authorize_password/5]).
authorize_password(Realm, User, Client, RedirUri, Scope) ->
{oauth2, authorize_password, Realm, User, Client, RedirUri, Scope}.
%% -export([authorize_client_credentials/3]).
authorize_client_credentials(Realm, Client, Scope) ->
{oauth2, authorize_client_credentials, Realm, Client, Scope}.
%% -export([authorize_code_grant/4]).
authorize_code_grant(Realm, Client, Code, RedirUri) ->
{oauth2, authorize_code_grant, Realm, Client, Code, RedirUri}.
%% -export([authorize_code_request/5]).
authorize_code_request(Realm, User, Client, RedirUri, Scope) ->
{oauth2, authorize_code_request, Realm, User, Client, RedirUri, Scope}.
%% -export([issue_code/2]).
issue_code(Realm, Auth) ->
{oauth2, issue_code, Realm, Auth}.
%% -export([issue_token/2]).
issue_token(Realm, Auth) ->
{oauth2, issue_token, Realm, Auth}.
%% -export([issue_token_and_refresh/2]).
issue_token_and_refresh(Realm, Auth) ->
{oauth2, issue_token_and_refresh, Realm, Auth}.
%% -export([verify_access_token/2]).
verify_access_token(Realm, Token) ->
{oauth2, verify_access_token, Realm, Token}.
%% -export([verify_access_code/2]).
verify_access_code(Realm, AccessCode) ->
{oauth2, verify_access_code, Realm, AccessCode}.
%% -export([verify_access_code/3]).
verify_access_code(Realm, AccessCode, Client) ->
{oauth2, verify_access_code, Realm, AccessCode, Client}.
%% -export([refresh_access_token/4]).
refresh_access_token(Realm, Client, RefreshToken, Scope) ->
{oauth2, refresh_access_token, Realm, Client, RefreshToken, Scope}.
scope(Realm) ->
{oauth2, scope, Realm}.
scope(Realm, Subscope) ->
{oauth2, scope, Realm, Subscope}.
%%%===================================================================
%%% Accounting Functions
%%%===================================================================
acc_create(Realm, Org, Resource, Time, Metadata) ->
{accounting, create, Realm, Org, Resource, Time, Metadata}.
acc_update(Realm, Org, Resource, Time, Metadata) ->
{accounting, update, Realm, Org, Resource, Time, Metadata}.
acc_destroy(Realm, Org, Resource, Time, Metadata) ->
{accounting, destroy, Realm, Org, Resource, Time, Metadata}.
acc_get(Realm, Org) ->
{accounting, get, Realm, Org}.
acc_get(Realm, Org, Resource) ->
{accounting, get, Realm, Org, Resource}.
acc_get(Realm, Org, Start, End) ->
{accounting, get, Realm, Org, Start, End}.
%%%===================================================================
%%% Internal Functions
%%%===================================================================