Module ocs_radius_auth_port_server

Description
Data Types
Function Index
Function Details

This gen_server behaviour callback module receives radius messages on a port assigned for authentication in the ocs application.

Behaviours: gen_server.

References

RFC3579 - RADIUS Support For EAP

Description

This gen_server behaviour callback module receives radius messages on a port assigned for authentication in the ocs application.

state() = #state{auth_port_sup = pid(), simple_auth_sup = undefined | pid(), pwd_sup = undefined | pid(), ttls_sup = undefined | pid(), aka_sup = undefined | pid(), akap_sup = undefined | pid(), address = inet:ip_address(), port = non_neg_integer(), method_prefer = ocs:eap_method(), method_order = [ocs:eap_method()], handlers = gb_trees:tree(Key::{NAS::string() | inet:ip_address(), Port::string(), Peer::string()}, Value::(Fsm::pid()))}

Function Index

init/1	Initialize the ocs_radius_auth_port_server server.
handle_call/3	Handle a request sent using gen_server:call/2,3 or gen_server:multi_call/2,3,4.
handle_cast/2	Handle a request sent using gen_server:cast/2 or gen_server:abcast/2,3.
handle_info/2	Handle a received message.
terminate/2	Cleanup and exit.
code_change/3	Update internal state data during a release upgrade/downgrade.
request/9*	Handle a received RADIUS Access-Request packet.

Function Details

init/1

init(Args) -> Result

Args = list()
Result = {ok, State} | {ok, State, Timeout} | {stop, Reason} | ignore
State = state()
Timeout = non_neg_integer() | infinity
Reason = term()

Initialize the ocs_radius_auth_port_server server. Args :: [Sup :: pid(), Module :: atom(), Port :: non_neg_integer(), Address :: inet:ip_address()].

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

handle_call/3

handle_call(Request, From, State) -> Result

Request = term()
From = {Pid, Tag}
Pid = pid()
Tag = any()
State = state()
Result = {reply, Reply, NewState} | {reply, Reply, NewState, Timeout} | {reply, Reply, NewState, hibernate} | {noreply, NewState} | {noreply, NewState, Timeout} | {noreply, NewState, hibernate} | {stop, Reason, Reply, NewState} | {stop, Reason, NewState}
Reply = term()
NewState = state()
Timeout = non_neg_integer() | infinity
Reason = term()

Handle a request sent using gen_server:call/2,3 or gen_server:multi_call/2,3,4.

See also: //stdlib/gen_server:handle_call/3.

handle_cast/2

handle_cast(Request, State) -> Result

Request = term()
State = state()
Result = {noreply, NewState} | {noreply, NewState, Timeout | infinity} | {noreply, NewState, hibernate} | {stop, Reason, NewState}
NewState = state()
Timeout = non_neg_integer() | infinity
Reason = term()

Handle a request sent using gen_server:cast/2 or gen_server:abcast/2,3.

See also: //stdlib/gen_server:handle_cast/2.

handle_info/2

handle_info(Info, State) -> Result

Info = timeout | term()
State = state()
Result = {noreply, NewState} | {noreply, NewState, Timeout} | {noreply, NewState, hibernate} | {stop, Reason, NewState}
NewState = state()
Timeout = non_neg_integer() | infinity
Reason = term()

Handle a received message.

See also: //stdlib/gen_server:handle_info/2.

terminate/2

terminate(Reason, State) -> any()

Reason = normal | shutdown | term()
State = state()

Cleanup and exit.

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

code_change/3

code_change(OldVsn, State, Extra) -> Result

OldVsn = Vsn | {down, Vsn}
Vsn = term()
State = state()
Extra = term()
Result = {ok, NewState}
NewState = state()

Update internal state data during a release upgrade/downgrade.

See also: //stdlib/gen_server:code_change/3.

request/9 *

request(IsEap, Address, Port, Secret, PasswordReq, Trusted, Radius, From, State) -> Result

IsEap = {eap, binary()} | none
Address = inet:ip_address()
Port = pos_integer()
Secret = string()
PasswordReq = boolean()
Trusted = boolean()
Radius = #radius{code = byte(), id = byte(), authenticator = binary() | [byte()], attributes = binary() | radius_attributes:attributes()}
From = {Pid, Tag}
Pid = pid()
Tag = term()
State = state()
Result = {reply, {ok, wait}, NewState} | {reply, {error, ignore}, NewState}
NewState = state()

Handle a received RADIUS Access-Request packet.

Generated by EDoc