Module ocs_simple_auth_fsm

Description
Data Types
Function Index
Function Details

This library module implements functions for simple authentication in the ocs application.

Behaviours: gen_fsm.

References

RFC2865 - Remote Authentication Dial In User Service (RADIUS)

Description

This library module implements functions for simple authentication in the ocs application.

statedata() = #statedata{protocol = radius | diameter, server_address = undefined | inet:ip_address(), server_port = undefined | pos_integer(), client_address = undefined | inet:ip_address(), client_port = undefined | pos_integer(), radius_fsm = undefined | pid(), shared_secret = undefined | binary(), session_id = string() | {NAS::inet:ip_address() | string(), Port::string(), Peer::string()}, radius_id = undefined | byte(), req_auth = undefined | [byte()] | binary(), req_attr = undefined | radius_attributes:attributes(), res_attr = undefined | radius_attributes:attributes(), subscriber = undefined | string(), multisession = undefined | boolean(), app_id = undefined | non_neg_integer(), auth_request_type = undefined | 1..3, origin_host = undefined | string(), origin_realm = undefined | string(), dest_host = undefined | string(), dest_realm = undefined | string(), password = undefined | binary() | {ChapId::0..255, ChapPassword::binary(), Challenge::binary()}, diameter_port_server = undefined | pid(), request = undefined | #diameter_nas_app_AAR{}, password_required = boolean(), trusted = boolean(), service_type = undefined | integer()}

Function Index

init/1	Initialize the ocs_simple_auth_fsm finite state machine.
request/2	Handle events sent with gen_fsm:send_event/2 in the request state.
handle_event/3	Handle an event sent with gen_fsm:send_all_state_event/2.
handle_sync_event/4	Handle an event sent with gen_fsm:sync_send_all_state_event/2,3.
handle_info/3	Handle a received message.
terminate/3	Cleanup and exit.
code_change/4	Update internal state data during a release upgrade/downgrade.
get_service_type/1*

Function Details

init/1

init(Args) -> Result

Args = list()
Result = {ok, StateName::atom(), StateData::statedata()} | {ok, StateName::atom(), StateData::statedata(), Timeout::non_neg_integer() | infinity} | {ok, StateName::atom(), StateData::statedata(), hibernate} | {stop, Reason::term()} | ignore

Initialize the ocs_simple_auth_fsm finite state machine.

See also: //stdlib/gen_fsm:init/1.

request/2

request(Event, StateData) -> Result

Event = timeout | term()
StateData = statedata()
Result = {next_state, NextStateName::atom(), NewStateData::statedata()} | {next_state, NextStateName::atom(), NewStateData::statedata(), Timeout::non_neg_integer() | infinity} | {next_state, NextStateName::atom(), NewStateData::statedata(), hibernate} | {stop, Reason::normal | term(), NewStateData::statedata()}

Handle events sent with gen_fsm:send_event/2 in the request state. @see //stdlib/gen_fsm:StateName/2

To do

handle muliti session for diameter

handle_event/3

handle_event(Event, StateName, StateData) -> Result

Event = term()
StateName = atom()
StateData = statedata()
Result = {next_state, NextStateName::atom(), NewStateData::statedata()} | {next_state, NextStateName::atom(), NewStateData::statedata(), Timeout::non_neg_integer() | infinity} | {next_state, NextStateName::atom(), NewStateData::statedata(), hibernate} | {stop, Reason::normal | term(), NewStateData::statedata()}

Handle an event sent with gen_fsm:send_all_state_event/2.

See also: //stdlib/gen_fsm:handle_event/3.

handle_sync_event/4

handle_sync_event(Event, From, StateName, StateData) -> Result

Event = term()
From = {Pid::pid(), Tag::term()}
StateName = atom()
StateData = statedata()
Result = {reply, Reply::term(), NextStateName::atom(), NewStateData::statedata()} | {reply, Reply::term(), NextStateName::atom(), NewStateData::statedata(), Timeout::non_neg_integer() | infinity} | {reply, Reply::term(), NextStateName::atom(), NewStateData::statedata(), hibernate} | {next_state, NextStateName::atom(), NewStateData::statedata()} | {next_state, NextStateName::atom(), NewStateData::statedata(), Timeout::non_neg_integer() | infinity} | {next_state, NextStateName::atom(), NewStateData::statedata(), hibernate} | {stop, Reason::normal | term(), Reply::term(), NewStateData::statedata()} | {stop, Reason::normal | term(), NewStateData::statedata()}

Handle an event sent with gen_fsm:sync_send_all_state_event/2,3.

handle_info/3

handle_info(Info, StateName, StateData) -> Result

Info = term()
StateName = atom()
StateData = statedata()
Result = {next_state, NextStateName::atom(), NewStateData::statedata()} | {next_state, NextStateName::atom(), NewStateData::statedata(), Timeout::non_neg_integer() | infinity} | {next_state, NextStateName::atom(), NewStateData::statedata(), hibernate} | {stop, Reason::normal | term(), NewStateData::statedata()}

Handle a received message.

See also: //stdlib/gen_fsm:handle_info/3.

terminate/3

terminate(Reason, StateName, StateData) -> any()

Reason = normal | shutdown | term()
StateName = atom()
StateData = statedata()

Cleanup and exit.

See also: //stdlib/gen_fsm:terminate/3.

code_change/4

code_change(OldVsn, StateName, StateData, Extra) -> Result

OldVsn = term() | {down, Vsn::term()}
StateName = atom()
StateData = statedata()
Extra = term()
Result = {ok, NextStateName::atom(), NewStateData::statedata()}

Update internal state data during a release upgrade/downgrade.

See also: //stdlib/gen_fsm:code_change/4.

get_service_type/1 *

get_service_type(Attr) -> any()

Generated by EDoc