SOPC_UserAuthentication_Functions Struct Reference

#include <sopc_user_manager.h>

Data Fields
SOPC_UserAuthentication_Free_Func *	pFuncFree
	Deallocation function, called upon SOPC_UserAuthentication_Manager destruction.
SOPC_UserAuthentication_ValidateUserIdentity_Func *	pFuncValidateUserIdentity
	Called to authorize a user connection, when receiving an ActivateSession request.

Field Documentation

pFuncFree

SOPC_UserAuthentication_Free_Func* SOPC_UserAuthentication_Functions::pFuncFree

Deallocation function, called upon SOPC_UserAuthentication_Manager destruction.

This function can be the standard free function if nothing is stored in pData.

pFuncValidateUserIdentity

SOPC_UserAuthentication_ValidateUserIdentity_Func* SOPC_UserAuthentication_Functions::pFuncValidateUserIdentity

Called to authorize a user connection, when receiving an ActivateSession request.

Warning

This callback should not block the thread that calls it, and shall return immediately. It also needs to be thread safe.

Parameters

authenticationManager	The SOPC_UserAuthentication_Manager instance.
pUser	The user identity token which was received in the ActivateSession request (Note: anonymous user identity is never requested to be validated by this function)
pbUserAuthenticated	A valid pointer to the uninitialized result of the operation. The callback shall set it to one of the following values: SOPC_USER_AUTHENTICATION_INVALID_TOKEN: the callback could not read the user identity token, SOPC_USER_AUTHENTICATION_REJECTED_TOKEN: the proposed identity could not be authenticated, SOPC_USER_AUTHENTICATION_OK: the identity token correctly authenticates a user.

Returns

SOPC_STATUS_OK when pbUserAuthenticated was set.

---

The documentation for this struct was generated from the following file:

• /builds/systerel/test-for-analyses-s2opc/src/ClientServer/configuration/sopc_user_manager.h