Diffusion C API  6.7.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
authentication-control.h File Reference

Authentication control feature. 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. More...
 
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. More...
 
typedef int(* authenticator_on_error )(const DIFFUSION_ERROR_T *error)
 Callback when an authenticator has encountered an error. More...
 
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. More...
 

Detailed Description

Authentication control feature.

Functions required for registering and deregistering an authentication service in a control client.

Typedef Documentation

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

Callback when an authentication handler is active.

Parameters
sessionThe currently active session.
registered_handlerThe registered handler
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.
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
sessionThe currently active session.
principalThe principal of the connection request to be authenticated
credentialsThe credentials of the connection request to be authenticated
session_propertiesThe session properties of the connection request to be authenticated
proposed_session_propertiesThe proposed properties from the connection request to be authenticated
authenticatorThe authenticator. Used to authenticate connection requests (see authenticator.h)
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.
typedef int(* authenticator_on_error)(const DIFFUSION_ERROR_T *error)

Callback when an authenticator has encountered an error.

Parameters
errorThe received error.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.