authentication-control.h File Reference

Allows registering and deregistering an authentication service in a control client. More...

Data Structures
struct	diffusion_authentication_handler_s
	Structure supplied as part of a diffusion_set_authentication_handler request. More...
struct	diffusion_authentication_handler_params_s
	Structure supplied when issuing an diffusion_set_authentication_handler request. More...

Macros
#define	DEFAULT_AUTH_GROUP_NAME
	If not specified, the group name "default" is used when registering authentication handlers.

Typedefs
typedef int(*	authenticator_on_active) (SESSION_T *session, const DIFFUSION_REGISTRATION_T *registered_handler)
	Callback when an authentication handler is active.
typedef int(*	authenticator_on_authenticate) (SESSION_T *session, const char *principal, const CREDENTIALS_T *credentials, const HASH_T *session_properties, const HASH_T *proposed_session_properties, const DIFFUSION_AUTHENTICATOR_T *authenticator)
	Callback when an authentication handler has received a connection request to be authenticated.
typedef int(*	authenticator_on_error) (const DIFFUSION_ERROR_T *error)
	Callback when an authenticator has encountered an error.
typedef void(*	authenticator_on_close) (void)
	Callback when an authentication handler is closed.
typedef struct diffusion_authentication_handler_s	DIFFUSION_AUTHENTICATION_HANDLER_T
	Structure supplied as part of a diffusion_set_authentication_handler request.
typedef struct diffusion_authentication_handler_params_s	DIFFUSION_AUTHENTICATION_HANDLER_PARAMS_T
	Structure supplied when issuing an diffusion_set_authentication_handler request.

Functions
void	diffusion_set_authentication_handler (SESSION_T *session, const DIFFUSION_AUTHENTICATION_HANDLER_PARAMS_T params)
	Register an authentication handler for client authentication events.

Detailed Description

Allows registering and deregistering an authentication service in a control client.

Typedef Documentation

authenticator_on_active

typedef int(* authenticator_on_active) (SESSION_T *session, const DIFFUSION_REGISTRATION_T *registered_handler)

Callback when an authentication handler is active.

Parameters

session	The currently active session.
registered_handler	The registered handler

Returns

HANDLER_SUCCESS or HANDLER_FAILURE.

authenticator_on_authenticate

typedef int(* authenticator_on_authenticate) (SESSION_T *session, const char *principal, const CREDENTIALS_T *credentials, const HASH_T *session_properties, const HASH_T *proposed_session_properties, const DIFFUSION_AUTHENTICATOR_T *authenticator)

Callback when an authentication handler has received a connection request to be authenticated.

Parameters

session	The currently active session.
principal	The principal of the connection request to be authenticated
credentials	The credentials of the connection request to be authenticated
session_properties	The session properties of the connection request to be authenticated
proposed_session_properties	The proposed properties from the connection request to be authenticated
authenticator	The authenticator. Used to authenticate connection requests (see authenticator.h)

Returns

HANDLER_SUCCESS or HANDLER_FAILURE.

authenticator_on_error

typedef int(* authenticator_on_error) (const DIFFUSION_ERROR_T *error)

Callback when an authenticator has encountered an error.

Parameters

error

The received error.

Returns

HANDLER_SUCCESS or HANDLER_FAILURE.