submodule.h File Reference

Submodule interface. More...

#include <freeradius-devel/server/dl_module.h>
#include <freeradius-devel/server/module.h>

Include dependency graph for submodule.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	rlm_eap_method_t
	Private structure to hold handles and interfaces for an EAP method. More...
struct	rlm_eap_submodule_t
	Interface exported by EAP submodules. More...

Macros
#define	MAX_PROVIDED_METHODS   5

Typedefs
typedef eap_type_t(*	eap_type_identity_t) (void *inst, char const *id, size_t id_len)
	Allow a module to vouch explicitly for an identity. More...

Detailed Description

Submodule interface.

Id

0e4e04b4ab041fadf13e2de758402b9d1a065cc7

Copyright

2019 The FreeRADIUS server project

Definition in file submodule.h.

---

Data Structure Documentation

rlm_eap_method_t

struct rlm_eap_method_t

Private structure to hold handles and interfaces for an EAP method.

Definition at line 67 of file submodule.h.

Collaboration diagram for rlm_eap_method_t:

Data Fields
rlm_eap_submodule_t const *	submodule	Submodule's exported interface.
module_instance_t *	submodule_inst	Submodule's instance data.

rlm_eap_submodule_t

struct rlm_eap_submodule_t

Interface exported by EAP submodules.

Definition at line 49 of file submodule.h.

Collaboration diagram for rlm_eap_submodule_t:

Data Fields
bool	clone_parent_lists	< Namespace children should be allocated in. HACK until all eap methods run their own sections.
module_t	common	Common fields provided by all modules.
eap_type_t	provides[MAX_PROVIDED_METHODS]	Allow the module to register itself for more than one EAP-Method.
module_method_t	session_init	Callback for creating a new eap_session_t.
eap_type_identity_t	type_identity	Do we recognise this identity?

Macro Definition Documentation

MAX_PROVIDED_METHODS

#define MAX_PROVIDED_METHODS   5

Definition at line 28 of file submodule.h.

Typedef Documentation

eap_type_identity_t

typedef eap_type_t(* eap_type_identity_t) (void *inst, char const *id, size_t id_len)

Allow a module to vouch explicitly for an identity.

This is mainly used for EAP-SIM/EAP-AKA/EAP-AKA' where the preferred eap method is specified by the first byte of the identity.

Parameters

[in]	inst	Submodule instance.
[in]	id	To check. Do NOT assume the identity is binary safe, it is common for some identities to be prefixed with a \0 byte.
[in]	id_len	Length of the identity.

Returns

• FR_EAP_METHOD_INVALID if we don't recognise the identity.
• Another FR_EAP_METHOD_* to run as the initial EAP method.

Definition at line 44 of file submodule.h.