svc-authentication.h File Reference

Functions required for handling authentication requests in a control client. More...

Data Structures
struct	connector_details_s
	This structure is populated in the authentication request when the detail type SESSION_DETAIL_CONNECTOR_NAME has been requested. More...
struct	svc_authentication_request_s
	The structure passed to an authentication handler. More...
struct	svc_authentication_response_s
	Structure holding the response message from the authentication handler. More...
struct	authentication_handlers_s
struct	authentication_params_s
	Parameters supplied when registering this authentication handler which are required for the authentication process but not related to the registration itself. More...

Macros
#define	AUTHENTICATION_HANDLERS
	Callbacks that can be supplied by an authentication service.

Typedefs
typedef struct connector_details_s	CONNECTOR_DETAILS_T
	This structure is populated in the authentication request when the detail type SESSION_DETAIL_CONNECTOR_NAME has been requested.
typedef struct svc_authentication_request_s	SVC_AUTHENTICATION_REQUEST_T
	The structure passed to an authentication handler.
typedef struct svc_authentication_response_s	SVC_AUTHENTICATION_RESPONSE_T
	Structure holding the response message from the authentication handler.
typedef int(*	on_authentication_cb )(SESSION_T *session, const SVC_AUTHENTICATION_REQUEST_T *request, SVC_AUTHENTICATION_RESPONSE_T *response, void *context)
	Callback for on_authentication(). More...
typedef struct authentication_params_s	AUTHENTICATION_PARAMS_T
	Parameters supplied when registering this authentication handler which are required for the authentication process but not related to the registration itself.

Enumerations
enum	SVC_AUTHENTICATION_RESPONSE_VALUE_T { AUTHENTICATION_DENY, AUTHENTICATION_ABSTAIN, AUTHENTICATION_ALLOW, AUTHENTICATION_ALLOW_WITH_RESULT }
	The action to take for the authentication request. More...

Detailed Description

Functions required for handling authentication requests in a control client.

Typedef Documentation

typedef int(* on_authentication_cb)(SESSION_T *session, const SVC_AUTHENTICATION_REQUEST_T *request, SVC_AUTHENTICATION_RESPONSE_T *response, void *context)

Callback for on_authentication().

Parameters

session	The current active session.
request	The incoming authentication request.
response	The response to be returned from the handler.
context	User-supplied context from initial authentication handler registration.

Returns

HANDLER_SUCCESS or HANDLER_FAILURE.

Enumeration Type Documentation

enum SVC_AUTHENTICATION_RESPONSE_VALUE_T

The action to take for the authentication request.

On receipt of an authentication request, the service may either deny the connecting client, allow it or abstain from answering which passes the request to the next handler in the chain.

Enumerator
AUTHENTICATION_DENY	Authentication failed.
AUTHENTICATION_ABSTAIN	Authentication has neither passed nor failed.
AUTHENTICATION_ALLOW	Authentication passed, no result supplied.
AUTHENTICATION_ALLOW_WITH_RESULT	Authentication passed, result supplied.