.. include:: common_vars.rst


.. Custom Roles
.. role:: req
  :class: bold-italic

.. role:: required
  :class: bold-italic

.. role:: value(code)

.. role:: property(code)
  :class: rti-property

.. role:: type(emphasis)

.. role:: topic(emphasis)

.. role:: xmltag(code)

.. role:: xmlval(code)

.. role:: entity(emphasis)

.. role:: submsg

.. FIXME this role if for terms missing a proper definition
.. role:: misdef


.. General
.. |EP_disc| replace:: Endpoint Discovery
.. |DP_disc| replace:: Participant Discovery
.. |NDDS_Config_Logger| replace:: Connext DDS Builtin Logging System
.. FIXME use a role instead
.. |P0| replace:: **P0**
.. |P1| replace:: **P1**
.. |P2| replace:: **P2**
.. |P3| replace:: **P3**
.. |P6| replace:: **P6**
.. |DR1| replace:: **DR1**
.. |DR2| replace:: **DR2**
.. |DW1| replace:: **DW1**
.. |DW2| replace:: **DW2**
.. |A| replace:: **A**
.. |B| replace:: **B**
.. |C| replace:: **C**
.. |D| replace:: **D**
.. FIXME the following definitions should be in resource.2.0
.. FIXME endpoint (lower case)?
.. |DDS_EP| replace:: *DDS Endpoint*
.. |EP| replace:: *Endpoint*
.. |EPs| replace:: *Endpoints*
.. |DDS_Entity| replace:: *DDS Entity*
.. |Entity| replace:: *Entity*
.. |DDS_Entities| replace:: *DDS Entities*
.. |Entities| replace:: *Entities*

.. Security Products
.. |OpenSSL_TM| replace:: OpenSSL®

.. Security General
.. |SecDomain| replace:: *Secure Domain*
.. |SecDomains| replace:: *Secure Domains*
.. |GovRule| replace:: Governance Rule
.. |GovRules| replace:: Governance Rules
.. |RTPSmsg| replace:: RTPS message
.. |RTPSmsgs| replace:: RTPS messages
.. |RTPSsubmsg| replace:: RTPS submessage
.. |RTPSsubmsgs| replace:: RTPS submessages
.. |Submsg| replace:: submessage

.. Security Artifacts
.. |IdentityCert| replace:: Identity Certificate
.. |IdentityCerts| replace:: Identity Certificates
.. |PrivateKey| replace:: Private Key
.. |PrivateKeys| replace:: Private Keys
.. |PermissionsDoc| replace:: Permissions Document
.. |PermissionsDocs| replace:: Permissions Documents
.. |GovernanceDoc| replace:: Governance Document
.. |GovernanceDocs| replace:: Governance Documents

.. Authentication
.. |HS_REQ| replace:: Handshake Request
.. |HS_REP| replace:: Handshake Reply
.. |HS_FIN| replace:: Handshake Final
.. |PDATA| replace:: Participant Data
.. |AuthReq| replace:: Authentication Request
.. |SharedSecret| replace:: Shared Secret
.. |SharedKey| replace:: Shared Key

.. Cryptography
.. |KeyMaterial| replace:: Key Material
.. |RecSpecificKeyMaterial| replace:: Receiver-Specific Key Material
.. |SessionKey| replace:: Session Key
.. |SessionKeys| replace:: Session Keys
.. |SessionID| replace:: Session ID
.. |SenderKey| replace:: Sender Key
.. |SenderKeyID| replace:: Sender Key ID
.. |RecSpecificKey| replace:: Receiver-Specific Key
.. |RecSpecificKeys| replace:: Receiver-Specific Keys
.. |RecSpecificSessionKey| replace:: Receiver-Specific Session Key
.. |RecSpecificSessionKeys| replace:: Receiver-Specific Session Keys
.. |RecSpecificKeyID| replace:: Receiver-Specific Key ID
.. |RecSpecificKeyIDs| replace:: Receiver-Specific Key IDs
.. |CommonMAC| replace:: Common MAC
.. |RecSpecificMAC| replace:: Receiver-Specific MAC
.. |RecSpecificMACs| replace:: Receiver-Specific MACs
.. |IV| replace:: Initialization Vector
.. |IVsuffix| replace:: Initialization Vector Suffix
.. |SessionBlockCounter| replace:: Session Block Counter
.. |CryptoHeader| replace:: Crypto Header
.. |CryptoContent| replace:: Crypto Content
.. |CryptoFooter| replace:: Crypto Footer
.. |SerializedPayload| replace:: Serialized Payload
.. |TransformationKind| replace:: Transformation Kind

.. Builtin Topics
.. |SecKeyExchangeT| replace:: Secure Key Exchange Builtin |TOPIC|
.. |SecKeyExchangeTName| replace:: :topic:`ParticipantVolatileMessageSecure`
.. |SecKeyExchangeCh| replace:: Secure Key Exchange Channel
.. |AuthT| replace:: Authentication Builtin |TOPIC|
.. |AuthTName| replace:: :topic:`ParticipantStatelessMessage`
.. |LoggingT| replace:: Builtin Secure Logging |TOPIC|
.. |LoggingTName| replace:: :topic:`DDS:Security:LogTopicV2`
.. |SecDiscoveryTopics| replace:: Builtin Secure Discovery |TOPICs|
.. |SecLivelinessTopic| replace:: Builtin Secure Liveliness |TOPIC|
.. |SecServiceReqTopic| replace:: Builtin Secure ServiceRequest |TOPIC|

.. Builtin Endpoints FIXME
.. |SecKeyExchangeEPs| replace:: Secure Key Exchange Builtin |EPs|
.. |SecKeyExchangeDW| replace:: Secure Key Exchange Builtin |DW|
.. |SecKeyExchangeDR| replace:: Secure Key Exchange Builtin |DR|
.. |SecDiscoveryEPs| replace:: Builtin Secure Discovery |EPs|
.. |SecPublicationDW| replace:: Builtin Secure Publication |DW|
.. |SecLivelinessEPs| replace:: Builtin Secure Liveliness |EPs|
.. |SecServiceReqEPs| replace:: Builtin Secure ServiceRequest |EPs|

.. Secure Entities
.. |SecEntity| replace:: Secure Entity
.. |SecEntities| replace:: Secure Entities
.. |SecEP| replace:: *Secure Endpoint*
.. |SecEPs| replace:: *Secure Endpoints*
.. |SecDW| replace:: *Secure DataWriter*
.. |SecDWs| replace:: *Secure DataWriters*
.. |SecDR| replace:: *Secure DataReader*
.. |SecDRs| replace:: *Secure DataReaders*
.. |SecDP| replace:: *Secure DomainParticipant*
.. |SecDPs| replace:: *Secure DomainParticipants*

.. Protection Kinds
.. |DataProtection| replace:: Serialized Data Protection
.. |SubmsgProtection| replace:: Submessage Protection
.. |RTPSProtection| replace:: RTPS Protection
.. |OrigAuthProtection| replace:: Origin Authentication Protection
.. |DiscoveryProtection| replace:: :misdef:`Discovery Protection`
.. |LivelinessProtection| replace:: :misdef:`Liveliness Protection`

.. Plugins
.. |CryptoPlugin| replace:: Cryptography Plugin
.. |AuthPlugin| replace:: Authentication Plugin
.. |AccessControlPlugin| replace:: Access Control Plugin
.. |LoggingPlugin| replace:: Logging Plugin
