Skip to content

Add all security plugins (#27) #1302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zesk1999 merged 3 commits into from
Aug 20, 2026
Merged

Add all security plugins (#27) #1302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b022e73
Add all security plugins (#27)
cferreiragonz Jul 10, 2026
fe0f4f8
Code removed
zesk1999 Aug 20, 2026
f3a72b1
Mark all-plugins security note as Pro exclusive
zesk1999 Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions code/CodeTester.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,7 @@ bool permissions_test(
part_attr.properties.properties().emplace_back(
"dds.sec.access.builtin.Access-Permissions.permissions",
permissions_file);

RTPSParticipant* participant = RTPSDomain::createParticipant(0, part_attr);
if (participant != nullptr)
{
Expand Down
5 changes: 5 additions & 0 deletions docs/fastdds/faq/security/security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ Authentication

|br| By setting the |DomainParticipantQos::properties-api| ``dds.sec.auth.plugin`` with the value`` ``builtin.PKI-DH``.
For further information, refer to :ref:`auth-pki-dh`.
Note that since Fast DDS Pro ``v3.7.0``, secure participants must configure the authentication, access control, and
cryptography plugins together.


----------

Expand Down Expand Up @@ -133,6 +136,8 @@ Data encryption
.. collapse:: How is the DDS:Crypto:AES-GCM-GMAC authentication plugin activated?

|br| By setting the |DomainParticipantQos::properties-api| ``dds.sec.crypto.plugin`` with the value ``builtin.AES-GCM-GMAC``.
Note that since Fast DDS Pro ``v3.7.0``, secure participants must configure the authentication, access control, and
cryptography plugins together.
Moreover, this plugin needs the activation of the Authentication plugin: ``DDS:Auth:PKI-DH`` and the ``DDS:Access:Permissions``.
For further information, refer to :ref:`crypto-aes-gcm-gmac`.

Expand Down
6 changes: 6 additions & 0 deletions docs/fastdds/property_policies/security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ Authentication plugin settings
The :ref:`DDS\:Auth\:PKI-DH <auth-pki-dh>` authentication plugin, can be activated setting the |DomainParticipantQos|
|DomainParticipantQos::properties-api|
``dds.sec.auth.plugin`` with the value ``builtin.PKI-DH``.
Note that since Fast DDS Pro ``v3.7.0``, secure participants must configure the authentication, access control, and
cryptography plugins together.

The following table outlines the properties used for the :ref:`DDS\:Auth\:PKI-DH <auth-pki-dh>` plugin configuration.

.. list-table::
Expand Down Expand Up @@ -130,6 +133,9 @@ Cryptographic plugin settings
The :ref:`DDS\:Crypto\:AES-GCM-GMAC <crypto-aes-gcm-gmac>` authentication plugin,
can be activated setting the |DomainParticipantQos| |DomainParticipantQos::properties-api|
``dds.sec.crypto.plugin`` with the value ``builtin.AES-GCM-GMAC``.
Note that since Fast DDS Pro ``v3.7.0``, secure participants must configure the authentication, access control, and
cryptography plugins together.

Moreover, this plugin needs the activation of the :ref:`auth-pki-dh`.
The :ref:`DDS\:Crypto\:AES-GCM-GMAC <crypto-aes-gcm-gmac>` plugin is configured using the
:ref:`access-permissions`, i.e the cryptography plugin is configured through the properties
Expand Down
8 changes: 8 additions & 0 deletions docs/fastdds/security/access_control_plugin/access_control_plugin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ in detail below.
The DDS\:Access\:Permissions authentication plugin, can be activated setting the |DomainParticipantQos|
|DomainParticipantQos::properties-api|
``dds.sec.access.plugin`` with the value ``builtin.Access-Permissions``.
Note that since Fast DDS Pro ``v3.7.0``, secure participants must configure the authentication, access control, and
cryptography plugins together.

The following table outlines the properties used for the DDS\:Access\:Permissions plugin configuration.

.. list-table::
Expand Down Expand Up @@ -80,6 +83,11 @@ configuration.
:start-after: <!-->DDS_SECURITY_ACCESS_CONTROL_PLUGIN<-->
:end-before: <!--><-->

.. important::
Since version v3.7.0, Fast DDS Pro enforces to configure the three main security plugins
(authentication, access control and cryptography) to enable secure communication.
The previous example focuses only on the access control plugin, but all three plugins must be configured.

.. _permissions_ca_cert:

Permissions CA Certificate
Expand Down
8 changes: 8 additions & 0 deletions docs/fastdds/security/auth_plugin/auth_plugin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ This shared secret can be used by other security plugins as :ref:`crypto-aes-gcm
The DDS:\Auth\:PKI-DH authentication plugin, can be activated setting the |DomainParticipantQos|
|DomainParticipantQos::properties-api|
``dds.sec.auth.plugin`` with the value ``builtin.PKI-DH``.
Note that since Fast DDS Pro ``v3.7.0``, secure participants must configure the authentication, access control, and
cryptography plugins together.

The following table outlines the properties used for the DDS:\Auth\:PKI-DH plugin configuration.

.. list-table::
Expand Down Expand Up @@ -88,6 +91,11 @@ configuration.
:start-after: <!-->DDS_SECURITY_AUTH_PLUGIN<-->
:end-before: <!--><-->

.. important::
Since version v3.7.0, Fast DDS Pro enforces to configure the three main security plugins
(authentication, access control and cryptography) to enable secure communication.
The previous example focuses only on the authentication plugin, but all three plugins must be configured.

.. _generate_x509:

Generation of X.509 certificates
Expand Down
8 changes: 8 additions & 0 deletions docs/fastdds/security/crypto_plugin/crypto_plugin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ It may also provide additional DataReader-specific Message Authentication Codes
The DDS\:Crypto\:AES-GCM-GMAC authentication plugin, can be activated setting the |DomainParticipantQos|
|DomainParticipantQos::properties-api|
``dds.sec.crypto.plugin`` with the value ``builtin.AES-GCM-GMAC``.
Note that since Fast DDS Pro ``v3.7.0``, secure participants must configure the authentication, access control, and
cryptography plugins together.

Moreover, this plugin needs the activation of the :ref:`auth-pki-dh`.
The DDS\:Crypto\:\AES-GCM-GMAC plugin is configured using the :ref:`access-permissions`, i.e the cryptography
plugin is configured through the properties and configuration files of the access control plugin.
Expand All @@ -48,3 +51,8 @@ configuration.
:language: xml
:start-after: <!-->DDS_SECURITY_CRYPTO_PLUGIN_DOMAINPARTICIPANT<-->
:end-before: <!--><-->

.. important::
Since version v3.7.0, Fast DDS Pro enforces to configure the three main security plugins
(authentication, access control and cryptography) to enable secure communication.
The previous example focuses only on the authentication plugin, but all three plugins must be configured.
6 changes: 6 additions & 0 deletions docs/fastdds/security/includes/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ Security plugins can be activated through the |DomainParticipantQos| properties.
A |Property-api| is defined by its name (:class:`std::string`)
and its value (:class:`std::string`).

.. important::
Since version v3.7.0, Fast DDS Pro enforces to configure the three main security plugins
(authentication, access control and cryptography) to enable secure communication.
A laxer configuration can be achieved by configuring the access control plugin to be
permissive, but it is still mandatory to configure the authentication and cryptography plugins.

.. warning::
For the full understanding of this documentation it is required the user to have basic knowledge of network security
since terms like Certificate Authority (CA), Public Key Infrastructure (PKI), and Diffie-Hellman encryption protocol
Expand Down
Loading