sopc_pubsub_sks.h File Reference

PubSub Security Keys Service configuration: define the SOPC_SKManager to use to retrieve the keys. More...

#include "sopc_secret_buffer.h"
#include "sopc_sk_manager.h"

Go to the source code of this file.

Data Structures
struct	SOPC_PubSubSKS_Keys

Macros
#define	SOPC_PUBSUB_SKS_DEFAULT_GROUPID   1
#define	SOPC_PUBSUB_SKS_DEFAULT_TOKENID   1
#define	SOPC_PUBSUB_SKS_CURRENT_TOKENID   SOPC_SK_MANAGER_CURRENT_TOKEN_ID

Typedefs
typedef struct SOPC_PubSubSKS_Keys	SOPC_PubSubSKS_Keys

Functions
void	SOPC_PubSubSKS_Init (void)
	Initialise the PubSubSKS.
void	SOPC_PubSubSKS_Clear (void)
	Clear the PubSubSKS and set SKManager to NULL.
void	SOPC_PubSubSKS_SetSkManager (SOPC_SKManager *skm)
	Set the Security Keys Manager to use to retrieve the keys for UADP secure exchanges Only one SK Manager is used. Set to NULL to stop the service.
SOPC_PubSubSKS_Keys *	SOPC_PubSubSKS_GetSecurityKeys (uint32_t groupid, uint32_t tokenId)
	Return security key from a security group id. This function is automatically called by Publisher and Subscriber schedulers.
void	SOPC_PubSubSKS_Keys_Delete (SOPC_PubSubSKS_Keys *keys)
	Clear a SOPC_PubSubSKS_Keys the given parameter can be freed after the function returns.

Detailed Description

PubSub Security Keys Service configuration: define the SOPC_SKManager to use to retrieve the keys.

To define a security keys service, SOPC_PubSubSKS_Init and SOPC_PubSubSKS_SetSkManager shall be called.

The Publisher and Subscriber schedulers will then automatically call SOPC_PubSubSKS_GetSecurityKeys.

Macro Definition Documentation

SOPC_PUBSUB_SKS_DEFAULT_GROUPID

#define SOPC_PUBSUB_SKS_DEFAULT_GROUPID   1

SOPC_PUBSUB_SKS_DEFAULT_TOKENID

#define SOPC_PUBSUB_SKS_DEFAULT_TOKENID   1

SOPC_PUBSUB_SKS_CURRENT_TOKENID

#define SOPC_PUBSUB_SKS_CURRENT_TOKENID   SOPC_SK_MANAGER_CURRENT_TOKEN_ID

Typedef Documentation

SOPC_PubSubSKS_Keys

typedef struct SOPC_PubSubSKS_Keys SOPC_PubSubSKS_Keys

Function Documentation

SOPC_PubSubSKS_Init()

void SOPC_PubSubSKS_Init

(

void

)

Initialise the PubSubSKS.

SOPC_PubSubSKS_Clear()

void SOPC_PubSubSKS_Clear

(

void

)

Clear the PubSubSKS and set SKManager to NULL.

SOPC_PubSubSKS_SetSkManager()

void SOPC_PubSubSKS_SetSkManager

(

SOPC_SKManager *

skm

)

Set the Security Keys Manager to use to retrieve the keys for UADP secure exchanges Only one SK Manager is used. Set to NULL to stop the service.

Parameters

skm	the Security Keys Manager to use to get keys.

SOPC_PubSubSKS_GetSecurityKeys()

SOPC_PubSubSKS_Keys * SOPC_PubSubSKS_GetSecurityKeys	(	uint32_t	groupid,
		uint32_t	tokenId )

Return security key from a security group id. This function is automatically called by Publisher and Subscriber schedulers.

Warning

Only SOPC_PUBSUB_SKS_DEFAULT_GROUPID is accepted in this version

Parameters

groupid	a Security Group Id
tokenId	token id of the requested keys. Current token is requested with SOPC_PUBSUB_SKS_CURRENT_TOKENID

Returns

tokenid and group keys

SOPC_PubSubSKS_Keys_Delete()

void SOPC_PubSubSKS_Keys_Delete

(

SOPC_PubSubSKS_Keys *

keys

)

Clear a SOPC_PubSubSKS_Keys the given parameter can be freed after the function returns.

Parameters

keys	object to clear