Namespace astutedds::security

Namespace List > astutedds > security

Classes

Type	Name
class	AccessControlPlugin Access Control Service Plugin Interface (SPI)
class	AuthenticationPlugin Authentication Service Plugin Interface (SPI)
struct	BinaryProperty
struct	CertificateCredentials
class	CryptoPlugin Cryptographic Service Plugin Interface (SPI)
struct	DataTag Data tag for confidentiality classification.
class	DataTaggingPlugin Data Tagging Service Plugin Interface (SPI)
struct	DomainGovernanceRule
struct	EndpointSecurityAttributes
class	LoggingPlugin Logging Service Plugin Interface (SPI)
struct	ParticipantSecurityAttributes
struct	PermissionsCredentials
struct	Property
struct	SecurityConfig
struct	SecurityEvent Security log event.
struct	SecurityException
struct	SecurityPlugins Security plugin suite.
struct	Token
struct	TopicAccessRule

Public Types

Type	Name
typedef std::shared_ptr< AccessControlPlugin >	AccessControlPluginPtr
typedef std::shared_ptr< AuthenticationPlugin >	AuthenticationPluginPtr
typedef std::vector< BinaryProperty >	BinaryPropertySeq
typedef int64_t	CryptoHandle
typedef std::shared_ptr< CryptoPlugin >	CryptoPluginPtr
typedef std::vector< DataTag >	DataTagSeq
typedef std::shared_ptr< DataTaggingPlugin >	DataTaggingPluginPtr
typedef CryptoHandle	DatareaderCryptoHandle
typedef CryptoHandle	DatawriterCryptoHandle
typedef int64_t	IdentityHandle
typedef std::shared_ptr< LoggingPlugin >	LoggingPluginPtr
typedef CryptoHandle	ParticipantCryptoHandle
typedef int64_t	PermissionsHandle
typedef std::vector< Property >	PropertySeq
enum uint32_t	SecurityErrorKind
enum uint32_t	SecurityEventCategory Security event categories.
enum uint32_t	SecurityLogLevel Security event severity levels.
typedef std::vector< Token >	TokenSeq

Public Attributes

Type	Name
constexpr CryptoHandle	INVALID_CRYPTO_HANDLE = -1
constexpr IdentityHandle	INVALID_IDENTITY_HANDLE = -1
constexpr PermissionsHandle	INVALID_PERMISSIONS_HANDLE = -1

Public Functions

Type	Name
std::shared_ptr< CryptoPlugin >	create_aes_gcm_crypto_plugin () Factory function for AES-GCM crypto plugin.
std::shared_ptr< DataTaggingPlugin >	create_data_tagging_plugin () Factory function for data tagging plugin.
std::shared_ptr< LoggingPlugin >	create_file_logging_plugin (const std::string & log_path="astutedds_security.log") Factory function for file logging plugin.
std::shared_ptr< AuthenticationPlugin >	create_pki_authentication_plugin () Factory function for PKI authentication plugin.
std::shared_ptr< AccessControlPlugin >	create_xml_access_control_plugin () Factory function for XML access control plugin.

Public Types Documentation

typedef AccessControlPluginPtr

using astutedds::security::AccessControlPluginPtr = typedef std::shared_ptr<AccessControlPlugin>;

---

typedef AuthenticationPluginPtr

using astutedds::security::AuthenticationPluginPtr = typedef std::shared_ptr<AuthenticationPlugin>;

---

typedef BinaryPropertySeq

using astutedds::security::BinaryPropertySeq = typedef std::vector<BinaryProperty>;

---

typedef CryptoHandle

using astutedds::security::CryptoHandle = typedef int64_t;

---

typedef CryptoPluginPtr

using astutedds::security::CryptoPluginPtr = typedef std::shared_ptr<CryptoPlugin>;

---

typedef DataTagSeq

using astutedds::security::DataTagSeq = typedef std::vector<DataTag>;

---

typedef DataTaggingPluginPtr

using astutedds::security::DataTaggingPluginPtr = typedef std::shared_ptr<DataTaggingPlugin>;

---

typedef DatareaderCryptoHandle

using astutedds::security::DatareaderCryptoHandle = typedef CryptoHandle;

---

typedef DatawriterCryptoHandle

using astutedds::security::DatawriterCryptoHandle = typedef CryptoHandle;

---

typedef IdentityHandle

using astutedds::security::IdentityHandle = typedef int64_t;

---

typedef LoggingPluginPtr

using astutedds::security::LoggingPluginPtr = typedef std::shared_ptr<LoggingPlugin>;

---

typedef ParticipantCryptoHandle

using astutedds::security::ParticipantCryptoHandle = typedef CryptoHandle;

---

typedef PermissionsHandle

using astutedds::security::PermissionsHandle = typedef int64_t;

---

typedef PropertySeq

using astutedds::security::PropertySeq = typedef std::vector<Property>;

---

enum SecurityErrorKind

enum astutedds::security::SecurityErrorKind {
    OK = 0,
    INVALID_PARAMETER,
    UNSUPPORTED_OPERATION,
    ALREADY_EXISTS,
    NOT_FOUND,
    PRECONDITION_NOT_MET,
    RESOURCES_EXHAUSTED,
    INVALID_CRYPTO_HANDLE,
    INVALID_IDENTITY_HANDLE,
    INVALID_PERMISSION_HANDLE,
    AUTHENTICATION_FAILED,
    AUTHORIZATION_FAILED,
    CRYPTO_ERROR,
    CERTIFICATE_VALIDATION_FAILED,
    SIGNATURE_VERIFICATION_FAILED,
    DECRYPTION_FAILED,
    ENCRYPTION_FAILED,
    UNKNOWN_ERROR
};

---

enum SecurityEventCategory

Security event categories.

enum astutedds::security::SecurityEventCategory {
    AUTHENTICATION = 0,
    ACCESS_CONTROL = 1,
    CRYPTO = 2,
    DISCOVERY = 3,
    DATA_PROTECTION = 4,
    PARTICIPANT_LIFECYCLE = 5,
    ENDPOINT_LIFECYCLE = 6,
    CONFIGURATION = 7,
    GENERAL = 8
};

---

enum SecurityLogLevel

Security event severity levels.

enum astutedds::security::SecurityLogLevel {
    EMERGENCY = 0,
    ALERT = 1,
    CRITICAL = 2,
    ERROR = 3,
    WARNING = 4,
    NOTICE = 5,
    INFORMATIONAL = 6,
    DEBUG = 7
};

---

typedef TokenSeq

using astutedds::security::TokenSeq = typedef std::vector<Token>;

---

Public Attributes Documentation

variable INVALID_CRYPTO_HANDLE

constexpr CryptoHandle astutedds::security::INVALID_CRYPTO_HANDLE;

---

variable INVALID_IDENTITY_HANDLE

constexpr IdentityHandle astutedds::security::INVALID_IDENTITY_HANDLE;

---

variable INVALID_PERMISSIONS_HANDLE

constexpr PermissionsHandle astutedds::security::INVALID_PERMISSIONS_HANDLE;

---

Public Functions Documentation

function create_aes_gcm_crypto_plugin

Factory function for AES-GCM crypto plugin.

std::shared_ptr< CryptoPlugin > astutedds::security::create_aes_gcm_crypto_plugin () 

---

function create_data_tagging_plugin

Factory function for data tagging plugin.

std::shared_ptr< DataTaggingPlugin > astutedds::security::create_data_tagging_plugin () 

---

function create_file_logging_plugin

Factory function for file logging plugin.

std::shared_ptr< LoggingPlugin > astutedds::security::create_file_logging_plugin (
    const std::string & log_path="astutedds_security.log"
) 

Parameters:

• log_path Path to the log file (default: "astutedds_security.log")

---

function create_pki_authentication_plugin

Factory function for PKI authentication plugin.

std::shared_ptr< AuthenticationPlugin > astutedds::security::create_pki_authentication_plugin () 

---

function create_xml_access_control_plugin

Factory function for XML access control plugin.

std::shared_ptr< AccessControlPlugin > astutedds::security::create_xml_access_control_plugin () 

---

---

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