Module ocs_eap_aka_auc_fsm

Description
Data Types
Function Index
Function Details

This gen_fsm behaviour callback module implements the functions associated with an Authentication Center (AuC) in the user's home domain within EAP 3rd Generation Authentication and Key Agreement (EAP-AKA') in the ocs application.

Behaviours: gen_fsm.

References

RFC4187 - Extensible Authentication Protocol Method for 3rd Generation Authentication and Key Agreement (EAP-AKA)
RFC5448 - Improved Extensible Authentication Protocol Method for 3rd Generation Authentication and Key Agreement (EAP-AKA')
3GPP TS 33.402 - Security Aspects of non-3GPP Accesses
3GPP TS 29.273 - 3GPP EPS AAA interfaces

Description

The users of this module are the EAP-AKA/AKA' handlers which request authentication vectors by sending the event:
{vector, {AkaFsm, Identity, AUTS, RAT, ANID}} (AKA')
{vector, {AkaFsm, Identity, AUTS, RAT}} (AKA)
and expect one of these replies:
{ok, {RAND, AUTN, CKprime, IKprime, XRES}} (AKA')
{ok, {RAND, AUTN, CK, IK, XRES}} (AKA)
{error, Reason}

After successful authentication an EAP-AKA/AKA' handler should send a registration request event:
{register, {AkaFsm, Identity}
{register, {AkaFsm, Identity, APN}
and one of these replies is expected:
{ok, UserProfile, HssRealm, HssHost}
{error, Reason}

Data Types

statedata()

statedata() = #statedata{aka_fsm = pid() | undefined, identity = binary() | undefined, apn = binary() | undefined, rand = binary() | undefined, auts = binary() | undefined, rat_type = non_neg_integer() | undefined, anid = string() | undefined, service = tuple() | false, origin_host = binary(), origin_realm = binary(), hss_realm = string() | undefined, hss_host = string() | undefined, nas_host = string() | undefined, nas_realm = string() | undefined, nas_address = inet:ip_address() | undefined, session_id = string(), aaa_failure = boolean(), attributes = radius_attributes:attributes()}

Function Index

init/1	Initialize the ocs_eap_aka_auc_fsm finite state machine.
idle/2	Handle events sent with gen_fsm:send_event/2 in the idle state.
vector/2	Handle events sent with gen_fsm:send_event/2 in the vector state.
register/2	Handle events sent with gen_fsm:send_event/2 in the register 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.
sqn/1*	Sequence Number (SQN).
autn/4*	Network Authentication Token (AUTN).
sqn_ms/4*	Retrieve concealed `SQNms` from AUTS.
dif/1*	The DIF value represents the current difference between generated SEQ values for that user and the GLC.
amf/1*	Authentication Management Field (AMF).
kdf/5*	Key Derivation Function (KDF).

Function Details

init/1

init(Args) -> Result

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

Initialize the ocs_eap_aka_auc_fsm finite state machine.

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

idle/2

idle(Event, StateData) -> Result

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

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

vector/2

vector(Event, StateData) -> Result

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

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

register/2

register(Event, StateData) -> Result

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

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

handle_event/3

handle_event(Event, StateName, StateData) -> Result

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

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, Tag}
Pid = pid()
Tag = term()
StateName = atom()
StateData = statedata()
Result = {reply, Reply, NextStateName, NewStateData} | {reply, Reply, NextStateName, NewStateData, Timeout} | {reply, Reply, NextStateName, NewStateData, hibernate} | {next_state, NextStateName, NewStateData} | {next_state, NextStateName, NewStateData, Timeout} | {next_state, NextStateName, NewStateData, hibernate} | {stop, Reason, Reply, NewStateData} | {stop, Reason, NewStateData}
Reply = term()
NextStateName = atom()
NewStateData = statedata()
Timeout = non_neg_integer() | infinity
Reason = normal | term()

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, NewStateData} | {next_state, NextStateName, NewStateData, Timeout} | {next_state, NextStateName, NewStateData, hibernate} | {stop, Reason, NewStateData}
NextStateName = atom()
NewStateData = statedata()
Timeout = non_neg_integer() | infinity
Reason = normal | term()

Handle a received message.

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