Skip to content

Commit aac4ff5

Browse files
Document new transmit_algorithms_as_legacy on builtin security plugins (#974)
* Refs #19925. Add documentation of new property in PKIDH. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19925. Add documentation of new property in Permissions. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Apply suggestions from code review Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com> Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com> Co-authored-by: Mario Domínguez López <116071334+Mario-DL@users.noreply.github.com>
1 parent 3bedaee commit aac4ff5

File tree

5 files changed

+23
-0
lines changed

5 files changed

+23
-0
lines changed

code/DDSCodeTester.cpp

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -591,6 +591,9 @@ void dds_domain_examples()
591591
pqos.properties().properties().emplace_back(
592592
"dds.sec.auth.builtin.PKI-DH.preferred_key_agreement",
593593
"ECDH");
594+
pqos.properties().properties().emplace_back(
595+
"dds.sec.auth.builtin.PKI-DH.transmit_algorithms_as_legacy",
596+
"true");
594597
//!--
595598
}
596599
{
@@ -626,6 +629,9 @@ void dds_domain_examples()
626629
pqos.properties().properties().emplace_back(
627630
"dds.sec.access.builtin.Access-Permissions.permissions",
628631
"file://certs/permissions.smime");
632+
pqos.properties().properties().emplace_back(
633+
"dds.sec.access.builtin.Access-Permissions.transmit_algorithms_as_legacy",
634+
"true");
629635
//!--
630636
}
631637
{

code/XMLTester.xml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2645,6 +2645,10 @@
26452645
<name>dds.sec.auth.builtin.PKI-DH.preferred_key_agreement</name>
26462646
<value>ECDH</value>
26472647
</property>
2648+
<property>
2649+
<name>dds.sec.auth.builtin.PKI-DH.transmit_algorithms_as_legacy</name>
2650+
<value>true</value>
2651+
</property>
26482652
</properties>
26492653
</propertiesPolicy>
26502654
</rtps>
@@ -2697,6 +2701,10 @@
26972701
<name>dds.sec.access.builtin.Access-Permissions.permissions</name>
26982702
<value>file://permissions.smime</value>
26992703
</property>
2704+
<property>
2705+
<name>dds.sec.access.builtin.Access-Permissions.transmit_algorithms_as_legacy</name>
2706+
<value>true</value>
2707+
</property>
27002708
</properties>
27012709
</propertiesPolicy>
27022710
</rtps>

docs/fastdds/property_policies/security.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ The following table outlines the properties used for the :ref:`DDS\:Auth\:PKI-DH
4949
b) ``ECDH``, ``ECDH+prime256v1-CEUM`` for Elliptic Curve Diffie-Hellman Ephemeral with the NIST P-256 curve. |br|
5050
c) ``AUTO`` for selecting the key agreement based on the signature algorithm in the Identity CA's certificate. |br|
5151
Will default to ``DH`` if the property is not present.
52+
* - ``transmit_algorithms_as_legacy`` *(optional)*
53+
- Whether to transmit algorithm identifiers in non-standard legacy format. |br|
54+
Will default to ``true`` if the property is not present.
5255

5356
.. note::
5457
All properties listed above have the ``dds.sec.auth.builtin.PKI-DH."`` prefix.

docs/fastdds/security/access_control_plugin/access_control_plugin.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ The following table outlines the properties used for the DDS\:Access\:Permission
5555
* - permissions
5656
- URI to the Participant permissions document signed by the |br| Permissions CA in S/MIME format. |br|
5757
Supported URI schemes: file.
58+
* - transmit_algorithms_as_legacy *(optional)*
59+
- Whether to transmit algorithm identifiers in non-standard legacy format. |br|
60+
Will default to ``true`` if the property is not present.
5861

5962
.. note::
6063
All listed properties have "dds.sec.access.builtin.Access-Permissions." prefix.

docs/fastdds/security/auth_plugin/auth_plugin.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,9 @@ The following table outlines the properties used for the DDS:\Auth\:PKI-DH plugi
6464
b) ``ECDH``, ``ECDH+prime256v1-CEUM`` for Elliptic Curve Diffie-Hellman Ephemeral with the NIST P-256 curve. |br|
6565
c) ``AUTO`` for selecting the key agreement based on the signature algorithm in the Identity CA's certificate. |br|
6666
Will default to ``DH`` if the property is not present.
67+
* - transmit_algorithms_as_legacy *(optional)*
68+
- Whether to transmit algorithm identifiers in non-standard legacy format. |br|
69+
Will default to ``true`` if the property is not present.
6770

6871
.. note::
6972
All listed properties have "dds.sec.auth.builtin.PKI-DH." prefix.

0 commit comments

Comments
 (0)