Module ocs_eap_aka_fsm

This gen_fsm behaviour callback module implements the functions associated with an EAP server within EAP 3rd Generation Authentication and Key Agreement (EAP-AKA/AKA') in the ocs application.

Copyright © 2016 - 2026 SigScale Global Inc.

Behaviours: gen_fsm.

References

Description

This gen_fsm behaviour callback module implements the functions associated with an EAP server within EAP 3rd Generation Authentication and Key Agreement (EAP-AKA/AKA') in the ocs application.

Data Types

statedata()

statedata() = #statedata{sup = pid(), server_address = inet:ip_address(), server_port = pos_integer(), client_address = undefined | inet:ip_address(), client_port = undefined | pos_integer(), radius_fsm = undefined | pid(), auc_fsm = undefined | pid(), session_id = diameter:'OctetString'() | {NAS::inet:ip_address() | string(), Port::string(), Peer::string()}, request = undefined | #diameter_eap_app_DER{} | #'3gpp_swm_DER'{} | #radius{code = byte(), id = byte(), authenticator = binary() | [byte()], attributes = binary() | radius_attributes:attributes()}, response = undefined | {EapMessage::binary(), radius_attributes:attributes()}, secret = undefined | binary(), eap_id = byte(), auth_app_id = undefined | integer(), auth_req_type = undefined | integer(), origin_host = undefined | binary(), origin_realm = undefined | binary(), nas_host = undefined | binary(), nas_realm = undefined | binary(), diameter_port_server = undefined | pid(), password_required = boolean(), trusted = boolean(), service_type = undefined | integer(), keys = [{pos_integer(), binary()}], id_req = any | full | permanent | undefined, identity = binary() | [], imsi = binary() | undefined, res = binary() | undefined, ck = binary() | undefined, ik = binary() | undefined, msk = binary() | undefined, emsk = binary() | undefined, kaut = binary() | undefined, kencr = binary() | undefined, failure = integer() | undefined}

Function Index

init/1
eap_start/2Handle events sent with gen_fsm:send_event/2 in the eap_start state.
identity/2Handle events sent with gen_fsm:send_event/2 in the identity state.
vector/2Handle events sent with gen_fsm:send_event/2 in the vector state.
challenge/2Handle events sent with gen_fsm:send_event/2 in the challenge state.
register/2Handle events sent with gen_fsm:send_event/2 in the register state.
failure/2Handle events sent with gen_fsm:send_event/2 in the failure state.
handle_event/3Handle an event sent with gen_fsm:send_all_state_event/2.
handle_sync_event/4Handle an event sent with gen_fsm:sync_send_all_state_event/2,3.
handle_info/3Handle a received message.
terminate/3Cleanup and exit.
code_change/4Update internal state data during a release upgrade/downgrade.

Function Details

init/1

init(Args) -> any()

eap_start/2

eap_start(Event, StateData) -> Result

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

identity/2

identity(Event, StateData) -> Result

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

vector/2

vector(Event, StateData) -> Result

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

challenge/2

challenge(Event, StateData) -> Result

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

register/2

register(Event, StateData) -> Result

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

failure/2

failure(Event, StateData) -> Result

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

handle_event/3

handle_event(Event, StateName, StateData) -> Result

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

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

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

handle_info/3

handle_info(Info, StateName, StateData) -> Result

Handle a received message.

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

terminate/3

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

Cleanup and exit.

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

code_change/4

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

Update internal state data during a release upgrade/downgrade.

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


Generated by EDoc