DDS_PskServiceFactoryProperty Struct Reference

Property used to register the Lightweight Security Plugin. More...

#include <dds_psk_service.h>

Data Fields
const char *	service_name
	The name the plugin is registered with.
DDS_PskTransform_get_interfaceFunc_T *	psl_get_interface_func
	A function pointer to retrieve the Transform PSL implementation interface.
struct DDS_SecTransform_Configuration *	psl_config
	Pass-through opaque pointer to the Transform PSL implementation, to provide the implementation with custom configuration settings.
DDS_PskPassTracker_get_interfaceFunc_T *	pass_tracker_get_interface_func
	A function pointer to retrieve the passphrase tracker implementation interface.
struct PSK_PassTrackerConfiguration *	pass_tracker_config
	Pass-through opaque pointer to the passphrase tracker implementation to provide the implementation with custom configuration settings.

Detailed Description

Property used to register the Lightweight Security Plugin.

Field Documentation

service_name

const char* DDS_PskServiceFactoryProperty::service_name

The name the plugin is registered with.

Specifies the unique identifier used when registering the plugin. Multiple plugins can be registered under distinct names. This identifier is referenced within DDS_DomainParticipantQos::trust to determine which plugin is applied. If NULL is provided, the plugin is registered with DDS_PSK_DEFAULT_PLUGIN_NAME.

[default] NULL

psl_get_interface_func

DDS_PskTransform_get_interfaceFunc_T* DDS_PskServiceFactoryProperty::psl_get_interface_func

A function pointer to retrieve the Transform PSL implementation interface.

The Lightweight Security Plugin calls the function this to retrieve the Transform PSL implementation. When using the RTI-provided OpenSSL-based PSL implementation, this should be set to 'PSK_OSSL_get_interface'.

Note

include "pskpsl/psk_ossl_transform.h" when using the RTI provided OpenSSL-based PSL implementation.

psl_config

struct DDS_SecTransform_Configuration* DDS_PskServiceFactoryProperty::psl_config

Pass-through opaque pointer to the Transform PSL implementation, to provide the implementation with custom configuration settings.

When using the RTI-provided OpenSSL-based implementation, this resolves to DDS_SecTransform_Configuration.

[default] NULL

Note

include "pskpsl/psk_ossl_transform.h" when using the RTI provided OpenSSL-based PSL implementation.

pass_tracker_get_interface_func

DDS_PskPassTracker_get_interfaceFunc_T* DDS_PskServiceFactoryProperty::pass_tracker_get_interface_func

A function pointer to retrieve the passphrase tracker implementation interface.

The Lightweight Security Plugin calls this function to retrieve the passphrase tracker implementation. When using the RTI-provided file-based passphrase tracker implementation, this should be set to PSK_FilePassTracker_get_interface.

Note

Include psk_file_tracker/psk_file_pass_tracker.h when using the RTI-provided file-based passphrase pracker implementation.

pass_tracker_config

struct PSK_PassTrackerConfiguration* DDS_PskServiceFactoryProperty::pass_tracker_config

Pass-through opaque pointer to the passphrase tracker implementation to provide the implementation with custom configuration settings.

When using the RTI-provided file-based implementation, this resolves to PSK_PassTrackerConfiguration.

[default] NULL

Note

Include psk_file_tracker/psk_file_pass_tracker.h when using the RTI-provided file-based passphrase tracker implementation.