Class astutedds::security::DataTaggingPlugin

Class astutedds::security::DataTaggingPlugin

ClassList > astutedds > security > DataTaggingPlugin

Data Tagging Service Plugin Interface (SPI) More...

  • #include <data_tagging_spi.hpp>

Public Functions

Type Name
virtual DataTagSeq get_datareader_tags (DatareaderCryptoHandle reader_crypto_handle, SecurityException & ex) = 0
Get tags for a DataReader.
virtual DataTagSeq get_datawriter_tags (DatawriterCryptoHandle writer_crypto_handle, SecurityException & ex) = 0
Get tags for a DataWriter.
virtual bool match_tags (const DataTagSeq & writer_tags, const DataTagSeq & reader_tags, SecurityException & ex) = 0
Check if tags match (for endpoint matching)
virtual bool set_datareader_tags (DatareaderCryptoHandle reader_crypto_handle, const DataTagSeq & tags, SecurityException & ex) = 0
Set tags for a DataReader.
virtual bool set_datawriter_tags (DatawriterCryptoHandle writer_crypto_handle, const DataTagSeq & tags, SecurityException & ex) = 0
Set tags for a DataWriter.
virtual ~DataTaggingPlugin () = default

Detailed Description

Based on DDS Security 1.1 Section 8.7 Provides data confidentiality labeling

Public Functions Documentation

function get_datareader_tags

Get tags for a DataReader. 

virtual DataTagSeq astutedds::security::DataTaggingPlugin::get_datareader_tags (
    DatareaderCryptoHandle reader_crypto_handle,
    SecurityException & ex
) = 0

Parameters:

  • reader_crypto_handle Reader crypto handle
  • ex Security exception output

Returns:

Tags applied to reader

function get_datawriter_tags

Get tags for a DataWriter. 

virtual DataTagSeq astutedds::security::DataTaggingPlugin::get_datawriter_tags (
    DatawriterCryptoHandle writer_crypto_handle,
    SecurityException & ex
) = 0

Parameters:

  • writer_crypto_handle Writer crypto handle
  • ex Security exception output

Returns:

Tags applied to writer

function match_tags

Check if tags match (for endpoint matching) 

virtual bool astutedds::security::DataTaggingPlugin::match_tags (
    const DataTagSeq & writer_tags,
    const DataTagSeq & reader_tags,
    SecurityException & ex
) = 0

Parameters:

  • writer_tags Writer's tags
  • reader_tags Reader's tags
  • ex Security exception output

Returns:

True if tags are compatible

function set_datareader_tags

Set tags for a DataReader. 

virtual bool astutedds::security::DataTaggingPlugin::set_datareader_tags (
    DatareaderCryptoHandle reader_crypto_handle,
    const DataTagSeq & tags,
    SecurityException & ex
) = 0

Parameters:

  • reader_crypto_handle Reader crypto handle
  • tags Tags to apply
  • ex Security exception output

Returns:

True if successful

function set_datawriter_tags

Set tags for a DataWriter. 

virtual bool astutedds::security::DataTaggingPlugin::set_datawriter_tags (
    DatawriterCryptoHandle writer_crypto_handle,
    const DataTagSeq & tags,
    SecurityException & ex
) = 0

Parameters:

  • writer_crypto_handle Writer crypto handle
  • tags Tags to apply
  • ex Security exception output

Returns:

True if successful

function ~DataTaggingPlugin

virtual astutedds::security::DataTaggingPlugin::~DataTaggingPlugin () = default

The documentation for this class was generated from the following file include/astutedds/security/data_tagging_spi.hpp