DDS::Security Namespace Reference

Classes
interface	DynamicData
struct	MessageIdentity
struct	ParticipantGenericMessage
struct	ParticipantBuiltinTopicData
struct	ParticipantBuiltinTopicDataSecure
struct	PublicationBuiltinTopicData
struct	SubscriptionBuiltinTopicData
struct	PublicationBuiltinTopicDataSecure
struct	SubscriptionBuiltinTopicDataSecure
struct	SecurityException
interface	SharedSecretHandle
interface	AuthenticationListener
interface	Authentication
struct	ParticipantSecurityAttributes
struct	TopicSecurityAttributes
struct	EndpointSecurityAttributes
interface	AccessControlListener
interface	AccessControl
interface	CryptoKeyFactory
interface	CryptoKeyExchange
interface	CryptoTransform
struct	DataHolder
struct	Tag
struct	DataTags
struct	ParticipantSecurityInfo
struct	EndpointSecurityInfo
Typedefs
typedef DDS::Property_t	Property_t
typedef DDS::PropertySeq	PropertySeq
typedef DDS::BinaryProperty_t	BinaryProperty_t
typedef DDS::BinaryPropertySeq	BinaryPropertySeq
typedef DDS::PropertyQosPolicy	PropertyQosPolicy
typedef Token	MessageToken
typedef MessageToken	AuthRequestMessageToken
typedef MessageToken	HandshakeMessageToken
typedef Token	AuthenticatedPeerCredentialToken
typedef Token	PermissionsCredentialToken
typedef Token	CryptoToken
typedef sequence< CryptoToken >	CryptoTokenSeq
typedef Token	ParticipantCryptoToken
typedef Token	DatawriterCryptoToken
typedef Token	DatareaderCryptoToken
typedef CryptoTokenSeq	ParticipantCryptoTokenSeq
typedef CryptoTokenSeq	DatawriterCryptoTokenSeq
typedef CryptoTokenSeq	DatareaderCryptoTokenSeq
typedef string	GenericMessageClassId
typedef ParticipantGenericMessage	ParticipantStatelessMessage
typedef ParticipantGenericMessage	ParticipantVolatileMessageSecure
typedef DataTags	DataTagQosPolicy
typedef long	IdentityHandle
typedef long	HandshakeHandle
typedef long	PermissionsHandle
typedef long	ParticipantCryptoHandle
typedef sequence < ParticipantCryptoHandle >	ParticipantCryptoHandleSeq
typedef long	NativeCryptoHandle
typedef NativeCryptoHandle	DatawriterCryptoHandle
typedef sequence < DatawriterCryptoHandle >	DatawriterCryptoHandleSeq
typedef NativeCryptoHandle	DatareaderCryptoHandle
typedef sequence < DatareaderCryptoHandle >	DatareaderCryptoHandleSeq
typedef DDS::DomainId_t	DomainId_t
typedef unsigned short	ParameterId_t
typedef sequence< DataHolder >	DataHolderSeq
typedef DataHolder	Token
typedef Token	IdentityToken
typedef Token	PermissionsToken
typedef Token	IdentityStatusToken
typedef sequence< Tag >	TagSeq
typedef unsigned long	ParticipantSecurityAttributesMask
typedef unsigned long	PluginParticipantSecurityAttributesMask
typedef unsigned long	EndpointSecurityAttributesMask
typedef unsigned long	PluginEndpointSecurityAttributesMask
typedef unsigned long	BuiltinEndpointSet_t
Enumerations
enum	ValidationResult_t { VALIDATION_OK, VALIDATION_FAILED, VALIDATION_PENDING_RETRY, VALIDATION_PENDING_HANDSHAKE_REQUEST, VALIDATION_PENDING_HANDSHAKE_MESSAGE, VALIDATION_OK_FINAL_MESSAGE }
enum	AuthStatusKind { RESERVED_AUTH_STATUS_KIND_0, IDENTITY_STATUS }
enum	SecureSubmessageCategory_t { INFO_SUBMESSAGE, DATAWRITER_SUBMESSAGE, DATAREADER_SUBMESSAGE }
Variables
const string	GMCLASSID_SECURITY_AUTH_REQUEST = "dds.sec.auth_request"
const string	GMCLASSID_SECURITY_AUTH_HANDSHAKE = "dds.sec.auth"
const string	GMCLASSID_SECURITY_PARTICIPANT_CRYPTO_TOKENS = "dds.sec.participant_crypto_tokens"
const string	GMCLASSID_SECURITY_DATAWRITER_CRYPTO_TOKENS = "dds.sec.datawriter_crypto_tokens"
const string	GMCLASSID_SECURITY_DATAREADER_CRYPTO_TOKENS = "dds.sec.datareader_crypto_tokens"
const ReturnCode_t	RETCODE_NOT_ALLOWED_BY_SECURITY = 1000
const ParameterId_t	PID_IDENTITY_TOKEN = 0x1001
const ParameterId_t	PID_PERMISSIONS_TOKEN = 0x1002
const ParameterId_t	PID_DATA_TAGS = 0x1003
const ParameterId_t	PID_ENDPOINT_SECURITY_INFO = 0x1004
const ParameterId_t	PID_PARTICIPANT_SECURITY_INFO = 0x1005
const ParameterId_t	PID_IDENTITY_STATUS_TOKEN = 0x1006
const ParticipantSecurityAttributesMask	PARTICIPANT_SECURITY_ATTRIBUTES_FLAG_IS_RTPS_PROTECTED = 1 << 0
const ParticipantSecurityAttributesMask	PARTICIPANT_SECURITY_ATTRIBUTES_FLAG_IS_DISCOVERY_PROTECTED = 1 << 1
const ParticipantSecurityAttributesMask	PARTICIPANT_SECURITY_ATTRIBUTES_FLAG_IS_LIVELINESS_PROTECTED = 1 << 2
const ParticipantSecurityAttributesMask	PARTICIPANT_SECURITY_ATTRIBUTES_FLAG_IS_VALID = 1 << 31
const ParticipantSecurityAttributesMask	PLUGIN_PARTICIPANT_SECURITY_ATTRIBUTES_FLAG_IS_RTPS_ENCRYPTED = 1 << 0
const ParticipantSecurityAttributesMask	PLUGIN_PARTICIPANT_SECURITY_ATTRIBUTES_FLAG_BUILTIN_IS_DISCOVERY_ENCRYPTED = 1 << 1
const ParticipantSecurityAttributesMask	PLUGIN_PARTICIPANT_SECURITY_ATTRIBUTES_FLAG_IS_LIVELINESS_ENCRYPTED = 1 << 2
const ParticipantSecurityAttributesMask	PLUGIN_PARTICIPANT_SECURITY_ATTRIBUTES_FLAG_IS_RTPS_ORIGIN_AUTHENTICATED = 1 << 3
const ParticipantSecurityAttributesMask	PLUGIN_PARTICIPANT_SECURITY_ATTRIBUTES_FLAG_IS_DISCOVERY_ORIGIN_AUTHENTICATED = 1 << 4
const ParticipantSecurityAttributesMask	PLUGIN_PARTICIPANT_SECURITY_ATTRIBUTES_FLAG_IS_LIVELINESS_ORIGIN_AUTHENTICATED = 1 << 5
const ParticipantSecurityAttributesMask	PLUGIN_PARTICIPANT_SECURITY_ATTRIBUTES_FLAG_IS_VALID = 1 << 31
const EndpointSecurityAttributesMask	ENDPOINT_SECURITY_ATTRIBUTES_FLAG_IS_READ_PROTECTED = 1 << 0
const EndpointSecurityAttributesMask	ENDPOINT_SECURITY_ATTRIBUTES_FLAG_IS_WRITE_PROTECTED = 1 << 1
const EndpointSecurityAttributesMask	ENDPOINT_SECURITY_ATTRIBUTES_FLAG_IS_DISCOVERY_PROTECTED = 1 << 2
const EndpointSecurityAttributesMask	ENDPOINT_SECURITY_ATTRIBUTES_FLAG_IS_SUBMESSAGE_PROTECTED = 1 << 3
const EndpointSecurityAttributesMask	ENDPOINT_SECURITY_ATTRIBUTES_FLAG_IS_PAYLOAD_PROTECTED = 1 << 4
const EndpointSecurityAttributesMask	ENDPOINT_SECURITY_ATTRIBUTES_FLAG_IS_KEY_PROTECTED = 1 << 5
const EndpointSecurityAttributesMask	ENDPOINT_SECURITY_ATTRIBUTES_FLAG_IS_LIVELINESS_PROTECTED = 1 << 6
const EndpointSecurityAttributesMask	ENDPOINT_SECURITY_ATTRIBUTES_FLAG_IS_VALID = 1 << 31
const PluginEndpointSecurityAttributesMask	PLUGIN_ENDPOINT_SECURITY_ATTRIBUTES_FLAG_IS_SUBMESSAGE_ENCRYPTED = 1 << 0
const PluginEndpointSecurityAttributesMask	PLUGIN_ENDPOINT_SECURITY_ATTRIBUTES_FLAG_IS_PAYLOAD_ENCRYPTED = 1 << 1
const PluginEndpointSecurityAttributesMask	PLUGIN_ENDPOINT_SECURITY_ATTRIBUTES_FLAG_IS_SUBMESSAGE_ORIGIN_AUTHENTICATED = 1 << 2
const BuiltinEndpointSet_t	SEDP_BUILTIN_PUBLICATIONS_SECURE_WRITER = 1 << 16
const BuiltinEndpointSet_t	SEDP_BUILTIN_PUBLICATIONS_SECURE_READER = 1 << 17
const BuiltinEndpointSet_t	SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_WRITER = 1 << 18
const BuiltinEndpointSet_t	SEDP_BUILTIN_SUBSCRIPTIONS_SECURE_READER = 1 << 19
const BuiltinEndpointSet_t	BUILTIN_PARTICIPANT_MESSAGE_SECURE_WRITER = 1 << 20
const BuiltinEndpointSet_t	BUILTIN_PARTICIPANT_MESSAGE_SECURE_READER = 1 << 21
const BuiltinEndpointSet_t	BUILTIN_PARTICIPANT_STATELESS_MESSAGE_WRITER = 1 << 22
const BuiltinEndpointSet_t	BUILTIN_PARTICIPANT_STATELESS_MESSAGE_READER = 1 << 23
const BuiltinEndpointSet_t	BUILTIN_PARTICIPANT_VOLATILE_MESSAGE_SECURE_WRITER = 1 << 24
const BuiltinEndpointSet_t	BUILTIN_PARTICIPANT_VOLATILE_MESSAGE_SECURE_READER = 1 << 25
const BuiltinEndpointSet_t	SPDP_BUILTIN_PARTICIPANT_SECURE_WRITER = 1 << 26
const BuiltinEndpointSet_t	SPDP_BUILTIN_PARTICIPANT_SECURE_READER = 1 << 27

Typedef Documentation

typedef Token DDS::Security::AuthenticatedPeerCredentialToken

Definition at line 49 of file DdsSecurityCore.idl.

typedef MessageToken DDS::Security::AuthRequestMessageToken

Definition at line 46 of file DdsSecurityCore.idl.

typedef DDS::BinaryProperty_t DDS::Security::BinaryProperty_t

Definition at line 41 of file DdsSecurityCore.idl.

typedef DDS::BinaryPropertySeq DDS::Security::BinaryPropertySeq

Definition at line 42 of file DdsSecurityCore.idl.

typedef unsigned long DDS::Security::BuiltinEndpointSet_t

Definition at line 100 of file DdsSecurityParams.idl.

typedef Token DDS::Security::CryptoToken

Definition at line 52 of file DdsSecurityCore.idl.

typedef sequence<CryptoToken> DDS::Security::CryptoTokenSeq

Definition at line 53 of file DdsSecurityCore.idl.

typedef sequence<DataHolder> DDS::Security::DataHolderSeq

Definition at line 38 of file DdsSecurityParams.idl.

typedef NativeCryptoHandle DDS::Security::DatareaderCryptoHandle

Definition at line 191 of file DdsSecurityCore.idl.

typedef sequence<DatareaderCryptoHandle> DDS::Security::DatareaderCryptoHandleSeq

Definition at line 192 of file DdsSecurityCore.idl.

typedef Token DDS::Security::DatareaderCryptoToken

Definition at line 57 of file DdsSecurityCore.idl.

typedef CryptoTokenSeq DDS::Security::DatareaderCryptoTokenSeq

Definition at line 61 of file DdsSecurityCore.idl.

typedef DataTags DDS::Security::DataTagQosPolicy

Definition at line 92 of file DdsSecurityCore.idl.

typedef NativeCryptoHandle DDS::Security::DatawriterCryptoHandle

Definition at line 188 of file DdsSecurityCore.idl.

typedef sequence<DatawriterCryptoHandle> DDS::Security::DatawriterCryptoHandleSeq

Definition at line 189 of file DdsSecurityCore.idl.

typedef Token DDS::Security::DatawriterCryptoToken

Definition at line 56 of file DdsSecurityCore.idl.

typedef CryptoTokenSeq DDS::Security::DatawriterCryptoTokenSeq

Definition at line 60 of file DdsSecurityCore.idl.

typedef DDS::DomainId_t DDS::Security::DomainId_t

Definition at line 215 of file DdsSecurityCore.idl.

typedef unsigned long DDS::Security::EndpointSecurityAttributesMask

Definition at line 78 of file DdsSecurityParams.idl.

typedef string DDS::Security::GenericMessageClassId

Definition at line 68 of file DdsSecurityCore.idl.

typedef long DDS::Security::HandshakeHandle

Definition at line 174 of file DdsSecurityCore.idl.

typedef MessageToken DDS::Security::HandshakeMessageToken

Definition at line 47 of file DdsSecurityCore.idl.

typedef long DDS::Security::IdentityHandle

Definition at line 173 of file DdsSecurityCore.idl.

typedef Token DDS::Security::IdentityStatusToken

Definition at line 43 of file DdsSecurityParams.idl.

typedef Token DDS::Security::IdentityToken

Definition at line 41 of file DdsSecurityParams.idl.

typedef Token DDS::Security::MessageToken

Definition at line 45 of file DdsSecurityCore.idl.

typedef long DDS::Security::NativeCryptoHandle

Definition at line 186 of file DdsSecurityCore.idl.

typedef unsigned short DDS::Security::ParameterId_t

Definition at line 21 of file DdsSecurityParams.idl.

typedef long DDS::Security::ParticipantCryptoHandle

Definition at line 180 of file DdsSecurityCore.idl.

typedef sequence<ParticipantCryptoHandle> DDS::Security::ParticipantCryptoHandleSeq

Definition at line 183 of file DdsSecurityCore.idl.

typedef Token DDS::Security::ParticipantCryptoToken

Definition at line 55 of file DdsSecurityCore.idl.

typedef CryptoTokenSeq DDS::Security::ParticipantCryptoTokenSeq

Definition at line 59 of file DdsSecurityCore.idl.

typedef unsigned long DDS::Security::ParticipantSecurityAttributesMask

Definition at line 55 of file DdsSecurityParams.idl.

typedef ParticipantGenericMessage DDS::Security::ParticipantStatelessMessage

Definition at line 81 of file DdsSecurityCore.idl.

typedef ParticipantGenericMessage DDS::Security::ParticipantVolatileMessageSecure

Definition at line 82 of file DdsSecurityCore.idl.

typedef Token DDS::Security::PermissionsCredentialToken

Definition at line 50 of file DdsSecurityCore.idl.

typedef long DDS::Security::PermissionsHandle

Definition at line 175 of file DdsSecurityCore.idl.

typedef Token DDS::Security::PermissionsToken

Definition at line 42 of file DdsSecurityParams.idl.

typedef unsigned long DDS::Security::PluginEndpointSecurityAttributesMask

Definition at line 79 of file DdsSecurityParams.idl.

typedef unsigned long DDS::Security::PluginParticipantSecurityAttributesMask

Definition at line 62 of file DdsSecurityParams.idl.

typedef DDS::Property_t DDS::Security::Property_t

Definition at line 34 of file DdsSecurityCore.idl.

typedef DDS::PropertyQosPolicy DDS::Security::PropertyQosPolicy

Definition at line 43 of file DdsSecurityCore.idl.

typedef DDS::PropertySeq DDS::Security::PropertySeq

Definition at line 40 of file DdsSecurityCore.idl.

typedef sequence<Tag> DDS::Security::TagSeq

Definition at line 50 of file DdsSecurityParams.idl.

typedef DataHolder DDS::Security::Token

Definition at line 40 of file DdsSecurityParams.idl.

Enumeration Type Documentation

enum DDS::Security::AuthStatusKind

Enumerator:

RESERVED_AUTH_STATUS_KIND_0
IDENTITY_STATUS

Definition at line 196 of file DdsSecurityCore.idl.

00196                         {
00197       RESERVED_AUTH_STATUS_KIND_0,
00198       //@value(1) IDENTITY_STATUS
00199       IDENTITY_STATUS
00200     };

enum DDS::Security::SecureSubmessageCategory_t

Enumerator:

INFO_SUBMESSAGE
DATAWRITER_SUBMESSAGE
DATAREADER_SUBMESSAGE

Definition at line 684 of file DdsSecurityCore.idl.

00684                                     {
00685       INFO_SUBMESSAGE,
00686       DATAWRITER_SUBMESSAGE,
00687       DATAREADER_SUBMESSAGE
00688     };

enum DDS::Security::ValidationResult_t

Enumerator:

VALIDATION_OK
VALIDATION_FAILED
VALIDATION_PENDING_RETRY
VALIDATION_PENDING_HANDSHAKE_REQUEST
VALIDATION_PENDING_HANDSHAKE_MESSAGE
VALIDATION_OK_FINAL_MESSAGE

Definition at line 164 of file DdsSecurityCore.idl.

00164                             {
00165       VALIDATION_OK,
00166       VALIDATION_FAILED,
00167       VALIDATION_PENDING_RETRY,
00168       VALIDATION_PENDING_HANDSHAKE_REQUEST,
00169       VALIDATION_PENDING_HANDSHAKE_MESSAGE,
00170       VALIDATION_OK_FINAL_MESSAGE
00171     };