Skip to content

Commit

Permalink
Merge pull request #1 from Leapsight/feature/alejandro-miguez.authent…
Browse files Browse the repository at this point in the history 
…ication_support

authentication support
  • Loading branch information
@alejandro-miguez
alejandro-miguez authored Oct 15, 2024
2 parents 062bc1f + 9347e2d commit 27ad9ce
Show file tree
Hide file tree
Showing 5 changed files with 896 additions and 605 deletions.
2 changes: 1 addition & 1 deletion rebar.config
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
{shell, [
%% {config, "config/dev/sys.config"},
{apps, [
sasl, pbkdf2, wamper, awre
sasl, wamper, awre
]}
]}.

Expand Down
2 changes: 1 addition & 1 deletion src/awre.app.src
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
{application, awre, [
{id, "git"},
{description, "a simple wamp client library"},
{vsn, "0.1.0"},
{vsn, "0.2.0"},
{modules, []},
{registered, [
awre_sup
Expand Down
287 changes: 171 additions & 116 deletions src/awre.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,202 +20,257 @@
%% SOFTWARE.
%%


-module(awre).

-define(TIMEOUT, 15000).

%% API for connecting to a router (either local or remote)
-export([start_client/0]).
-export([stop_client/1,stop_client/3]).
-export([stop_client/1, stop_client/3]).

-export([connect/2]).
-export([connect/5]).
-export([connect/6]).

-export([subscribe/3,subscribe/4]).
-export([subscribe/3, subscribe/4]).
-export([unsubscribe/2]).
-export([publish/3,publish/4,publish/5]).
-export([publish/3, publish/4, publish/5]).

-export([register/3,register/4]).
-export([register/3, register/4]).
-export([unregister/2]).
-export([call/3,call/4,call/5,call/6]).
-export([yield/3,yield/4,yield/5]).
-export([call/3, call/4, call/5, call/6]).
-export([yield/3, yield/4, yield/5]).
-export([error/6]).


-export([get_version/0]).

%% @doc returns the version string for the application, used as agent description
-spec get_version() -> Version::binary().
-spec get_version() -> Version :: binary().
get_version() ->
case application:get_env(awre, agent, undefined) of
undefined ->
Ver = case application:get_key(vsn) of
{ok, V} -> list_to_binary(V);
_ -> <<"UNKNOWN">>
end,
<<"Awre-", Ver/binary >>;
App ->
Ver = case lists:keyfind(App, 1, application:loaded_applications()) of
{_, _, V} ->
V;
false ->
"UNKNOWN"
end,
<<(list_to_binary(atom_to_list(App)))/binary, "-", (list_to_binary(Ver))/binary>>
end.

case application:get_env(awre, agent, undefined) of
undefined ->
Ver =
case application:get_key(vsn) of
{ok, V} -> list_to_binary(V);
_ -> <<"UNKNOWN">>
end,
<<"Awre-", Ver/binary>>;
App ->
Ver =
case lists:keyfind(App, 1, application:loaded_applications()) of
{_, _, V} ->
V;
false ->
"UNKNOWN"
end,
<<(list_to_binary(atom_to_list(App)))/binary, "-", (list_to_binary(Ver))/binary>>
end.

%% connecting to a (remote) router (for peer)

%% @doc start a connection server to handle a connection to a router.
%% The connection can be either remote or local within the VM.
-spec start_client() -> {ok,Con :: pid()}.
-spec start_client() -> {ok, Con :: pid()}.
start_client() ->
supervisor:start_child(awre_sup,[[]]).
supervisor:start_child(awre_sup, [[]]).

%% @doc stop the given connection
%% TODO: implement
-spec stop_client(ConPid :: pid(),Details :: list(),Reason :: binary()) -> ok.
stop_client(ConPid,Details,Reason) ->
gen_server:cast(ConPid,{shutdown,Details,Reason}).
-spec stop_client(ConPid :: pid(), Details :: list(), Reason :: binary()) -> ok.
stop_client(ConPid, Details, Reason) ->
gen_server:cast(ConPid, {shutdown, Details, Reason}).

-spec stop_client(ConPid :: pid()) -> ok.
stop_client(ConPid) ->
gen_server:cast(ConPid,{shutdown,#{},goodbye_and_out}).
gen_server:cast(ConPid, {shutdown, #{}, goodbye_and_out}).

%% @doc Connect to a router in the VM.
%% The connection will be established to the local router in the VM.
-spec connect(ConPid :: pid(), Realm :: binary()) -> {ok,SessionId :: non_neg_integer() ,RouterDetails :: list()}.
connect(ConPid,Realm) ->
gen_server:call(ConPid,{awre_call,{connect,undefined,undefined,Realm,undefined}}).
-spec connect(ConPid :: pid(), Realm :: binary()) ->
{ok, SessionId :: non_neg_integer(), RouterDetails :: list()}.
connect(ConPid, Realm) ->
gen_server:call(ConPid, {awre_call, {connect, undefined, undefined, Realm, undefined}}).

%% @doc connect to a remote router.
%% Connect to the router at the given host Host on port Port to the realm Realm.
%% The connection will be established by using the encoding Encoding for serialization.
%% The connection wil be a direct TCP connection, there is no support for websocket connections.
-spec connect(ConPid :: pid(), Host :: string(), Port :: non_neg_integer(), Realm :: binary(), Encoding :: raw_json | raw_msgpack) -> {ok,SessionId :: non_neg_integer() ,RouterDetails :: list()}.
connect(ConPid,Host,Port,Realm,Encoding) ->
gen_server:call(ConPid,{awre_call,{connect,Host,Port,Realm,Encoding}}).


-spec connect(
ConPid :: pid(),
Host :: string(),
Port :: non_neg_integer(),
Realm :: binary(),
Encoding :: raw_json | raw_msgpack
) -> {ok, SessionId :: non_neg_integer(), RouterDetails :: list()}.
connect(ConPid, Host, Port, Realm, Encoding) ->
gen_server:call(ConPid, {awre_call, {connect, Host, Port, Realm, Encoding}}).

-spec connect(
ConPid :: pid(),
Host :: string(),
Port :: non_neg_integer(),
Realm :: binary(),
Encoding :: raw_json | raw_msgpack,
AuthDetails :: undefined | map()
) -> {ok, SessionId :: non_neg_integer(), RouterDetails :: list()}.
connect(ConPid, Host, Port, Realm, Encoding, undefined) ->
connect(ConPid, Host, Port, Realm, Encoding);
connect(ConPid, Host, Port, Realm, Encoding, AuthDetails) ->
gen_server:call(ConPid, {awre_call, {connect, Host, Port, Realm, Encoding, AuthDetails}}).

%% @doc Subscribe to an event.
%% subscribe to the event Topic.
%% On an event the Mfa wil be called as:
%% Module:Function(Details, Arguments, ArgumentsKw, Argument),
%% the last Argument will be the one from the Mfa, given at subscription time.
-spec subscribe(ConPid :: pid(), Options :: list(), Topic :: binary(), Mfa :: {atom,atom,any()} | undefined) -> {ok,SubscriptionId :: non_neg_integer()}.
subscribe(ConPid,Options,Topic,Mfa) ->
gen_server:call(ConPid,{awre_call,{subscribe,Options,Topic,Mfa}}).

-spec subscribe(
ConPid :: pid(), Options :: list(), Topic :: binary(), Mfa :: {atom, atom, any()} | undefined
) -> {ok, SubscriptionId :: non_neg_integer()}.
subscribe(ConPid, Options, Topic, Mfa) ->
gen_server:call(ConPid, {awre_call, {subscribe, Options, Topic, Mfa}}).

%% @doc Subscribe to an event.
-spec subscribe(ConPid :: pid(), Options :: list(), Topic :: binary()) -> {ok,SubscriptionId :: non_neg_integer()}.
subscribe(ConPid,Options,Topic) ->
subscribe(ConPid,Options,Topic,undefined).

-spec subscribe(ConPid :: pid(), Options :: list(), Topic :: binary()) ->
{ok, SubscriptionId :: non_neg_integer()}.
subscribe(ConPid, Options, Topic) ->
subscribe(ConPid, Options, Topic, undefined).

%% @doc Unsubscribe from an event.
-spec unsubscribe(ConPid :: pid(), SubscriptionId :: non_neg_integer()) -> ok.
unsubscribe(ConPid,SubscriptionId) ->
gen_server:call(ConPid,{awre_call,{unsubscribe,SubscriptionId}}).
unsubscribe(ConPid, SubscriptionId) ->
gen_server:call(ConPid, {awre_call, {unsubscribe, SubscriptionId}}).

%% @doc Publish an event.
-spec publish(ConPid :: pid(), Options :: list(), Topic :: binary()) -> ok.
publish(ConPid,Options,Topic) ->
publish(ConPid,Options,Topic,undefined,undefined).
publish(ConPid, Options, Topic) ->
publish(ConPid, Options, Topic, undefined, undefined).

%% @doc Publish an event.
-spec publish(ConPid :: pid(), Options :: list(), Topic :: binary(), Arguments :: list() | undefined) -> ok.
publish(ConPid,Options,Topic,Arguments)->
publish(ConPid,Options,Topic,Arguments,undefined).
-spec publish(
ConPid :: pid(), Options :: list(), Topic :: binary(), Arguments :: list() | undefined
) -> ok.
publish(ConPid, Options, Topic, Arguments) ->
publish(ConPid, Options, Topic, Arguments, undefined).

%% @doc Publish an event.
-spec publish(ConPid :: pid(), Options :: list(), Topic :: binary(), Arguments :: list() | undefined, ArgumentsKw :: list() | undefined) -> ok.
publish(ConPid,Options,Topic,Arguments,ArgumentsKw) ->
gen_server:call(ConPid,{awre_call,{publish,Options,Topic,Arguments,ArgumentsKw}}).
-spec publish(
ConPid :: pid(),
Options :: list(),
Topic :: binary(),
Arguments :: list() | undefined,
ArgumentsKw :: list() | undefined
) -> ok.
publish(ConPid, Options, Topic, Arguments, ArgumentsKw) ->
gen_server:call(ConPid, {awre_call, {publish, Options, Topic, Arguments, ArgumentsKw}}).

%% @doc Register a remote procedure.
-spec register(ConPid :: pid(), Options :: list(), Procedure :: binary()) -> {ok, RegistrationId :: non_neg_integer() }.
register(ConPid,Options,Procedure) ->
register(ConPid,Options,Procedure,undefined).
-spec register(ConPid :: pid(), Options :: list(), Procedure :: binary()) ->
{ok, RegistrationId :: non_neg_integer()}.
register(ConPid, Options, Procedure) ->
register(ConPid, Options, Procedure, undefined).

%% @doc Register a remote procedure.
-spec register(ConPid :: pid(), Options :: list(), Procedure :: binary(), Mfa :: {atom,atom,any()}|undefined) -> {ok, RegistrationId :: non_neg_integer() }.
register(ConPid,Options,Procedure,Mfa) ->
gen_server:call(ConPid,{awre_call,{register,Options,Procedure,Mfa}}).
-spec register(
ConPid :: pid(),
Options :: list(),
Procedure :: binary(),
Mfa :: {atom, atom, any()} | undefined
) -> {ok, RegistrationId :: non_neg_integer()}.
register(ConPid, Options, Procedure, Mfa) ->
gen_server:call(ConPid, {awre_call, {register, Options, Procedure, Mfa}}).

%% @doc Unregister a remote procedure.
-spec unregister(ConPid :: pid(), RegistrationId :: non_neg_integer()) -> ok.
unregister(ConPid,RegistrationId) ->
gen_server:call(ConPid,{awre_call,{unregister, RegistrationId}}).

unregister(ConPid, RegistrationId) ->
gen_server:call(ConPid, {awre_call, {unregister, RegistrationId}}).

%% @doc Call a remote procedure.
-spec call(ConPid :: pid(), Options :: list(), ProcedureUrl :: binary()) -> {ok, Details :: list(), ResA :: list() | undefined, ResAKw :: list() | undefined}.
-spec call(ConPid :: pid(), Options :: list(), ProcedureUrl :: binary()) ->
{ok, Details :: list(), ResA :: list() | undefined, ResAKw :: list() | undefined}.

call(ConPid,Options,ProcedureUrl) ->
Timeout = get_timeout(Options),
gen_server:call(
ConPid,
{awre_call, {call, Options, ProcedureUrl}},
Timeout
).
call(ConPid, Options, ProcedureUrl) ->
Timeout = get_timeout(Options),
gen_server:call(
ConPid,
{awre_call, {call, Options, ProcedureUrl}},
Timeout
).

%% @doc Call a remote procedure.
-spec call(ConPid :: pid(), Options :: list(), ProcedureUrl :: binary(), Arguments :: list()) -> {ok, Details :: list(), ResA :: list() | undefined, ResAKw :: list() | undefined}.
-spec call(ConPid :: pid(), Options :: list(), ProcedureUrl :: binary(), Arguments :: list()) ->
{ok, Details :: list(), ResA :: list() | undefined, ResAKw :: list() | undefined}.

call(ConPid, Options, ProcedureUrl, Arguments) ->
Timeout = get_timeout(Options),
gen_server:call(
ConPid,
{awre_call, {call, Options, ProcedureUrl, Arguments}},
Timeout
).
Timeout = get_timeout(Options),
gen_server:call(
ConPid,
{awre_call, {call, Options, ProcedureUrl, Arguments}},
Timeout
).

%% @doc Call a remote procedure.
-spec call(ConPid :: pid(), Options :: list(), ProcedureUrl :: binary(), Arguments::list() | undefined , ArgumentsKw :: list() | undefined) -> {ok, Details :: list(), ResA :: list() | undefined, ResAKw :: list() | undefined}.

call(ConPid,Options,ProcedureUrl,Arguments,ArgumentsKw) ->
Timeout = get_timeout(Options),
gen_server:call(
ConPid,
{awre_call, {call, Options, ProcedureUrl, Arguments, ArgumentsKw}},
Timeout
).

-spec call(ConPid :: pid(), Options :: list(), ProcedureUrl :: binary(), Arguments::list() | undefined , ArgumentsKw :: list() | undefined, timeout()) -> {ok, Details :: list(), ResA :: list() | undefined, ResAKw :: list() | undefined}.

call(ConPid,Options,ProcedureUrl,Arguments,ArgumentsKw, Timeout) ->
gen_server:call(ConPid,{awre_call,{call,Options,ProcedureUrl,Arguments,ArgumentsKw}}, Timeout).
-spec call(
ConPid :: pid(),
Options :: list(),
ProcedureUrl :: binary(),
Arguments :: list() | undefined,
ArgumentsKw :: list() | undefined
) -> {ok, Details :: list(), ResA :: list() | undefined, ResAKw :: list() | undefined}.

call(ConPid, Options, ProcedureUrl, Arguments, ArgumentsKw) ->
Timeout = get_timeout(Options),
gen_server:call(
ConPid,
{awre_call, {call, Options, ProcedureUrl, Arguments, ArgumentsKw}},
Timeout
).

-spec call(
ConPid :: pid(),
Options :: list(),
ProcedureUrl :: binary(),
Arguments :: list() | undefined,
ArgumentsKw :: list() | undefined,
timeout()
) -> {ok, Details :: list(), ResA :: list() | undefined, ResAKw :: list() | undefined}.

call(ConPid, Options, ProcedureUrl, Arguments, ArgumentsKw, Timeout) ->
gen_server:call(
ConPid, {awre_call, {call, Options, ProcedureUrl, Arguments, ArgumentsKw}}, Timeout
).

%% @doc Return the result to a call.
-spec yield(ConPid :: pid(), RequestId :: non_neg_integer(), Details :: list() ) -> ok.
yield(ConPid,RequestId,Details) ->
yield(ConPid,RequestId,Details,undefined,undefined).
-spec yield(ConPid :: pid(), RequestId :: non_neg_integer(), Details :: list()) -> ok.
yield(ConPid, RequestId, Details) ->
yield(ConPid, RequestId, Details, undefined, undefined).

%% @doc Return the result to a call.
-spec yield(ConPid :: pid(), RequestId :: non_neg_integer(), Details :: list(), Arguments :: list() ) -> ok.
yield(ConPid,RequestId,Details,Arguments) ->
yield(ConPid,RequestId,Details,Arguments,undefined).
-spec yield(
ConPid :: pid(), RequestId :: non_neg_integer(), Details :: list(), Arguments :: list()
) -> ok.
yield(ConPid, RequestId, Details, Arguments) ->
yield(ConPid, RequestId, Details, Arguments, undefined).

%% @doc Return the result to a call.
-spec yield(ConPid :: pid(), RequestId :: non_neg_integer(), Details :: list(), Arguments :: list() | undefined, ArgumentsKw :: list() | undefined ) -> ok.
yield(ConPid,RequestId,Details,Arguments,ArgumentsKw) ->
gen_server:call(ConPid,{awre_call,{yield,RequestId,Details,Arguments,ArgumentsKw}}).
-spec yield(
ConPid :: pid(),
RequestId :: non_neg_integer(),
Details :: list(),
Arguments :: list() | undefined,
ArgumentsKw :: list() | undefined
) -> ok.
yield(ConPid, RequestId, Details, Arguments, ArgumentsKw) ->
gen_server:call(ConPid, {awre_call, {yield, RequestId, Details, Arguments, ArgumentsKw}}).

%% @doc Return an error from a call.
error(ConPid,RequestId,Details,ErrorUri, Args, ArgsKw) ->
gen_server:call(
ConPid,
{awre_call, {error,invocation,RequestId,Details,ErrorUri,Args,ArgsKw}}
).


error(ConPid, RequestId, Details, ErrorUri, Args, ArgsKw) ->
gen_server:call(
ConPid,
{awre_call, {error, invocation, RequestId, Details, ErrorUri, Args, ArgsKw}}
).

get_timeout(L) ->
case lists:keyfind(timeout, 1, L) of
{timeout, Value} -> Value;
_ -> ?TIMEOUT
end.
case lists:keyfind(timeout, 1, L) of
{timeout, Value} -> Value;
_ -> ?TIMEOUT
end.
Loading

0 comments on commit 27ad9ce

Please sign in to comment.