Skip to content

Commit 397c992

Browse files
Document new transmit_algorithms_as_legacy on builtin security plugins (#974) (#976)
* 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> (cherry picked from commit cc95496) Co-authored-by: Miguel Company <miguelcompany@eprosima.com>
1 parent 2208e89 commit 397c992

File tree

5 files changed

+25
-2
lines changed

5 files changed

+25
-2
lines changed

code/DDSCodeTester.cpp

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -645,6 +645,9 @@ void dds_domain_examples()
645645
pqos.properties().properties().emplace_back(
646646
"dds.sec.auth.builtin.PKI-DH.preferred_key_agreement",
647647
"ECDH");
648+
pqos.properties().properties().emplace_back(
649+
"dds.sec.auth.builtin.PKI-DH.transmit_algorithms_as_legacy",
650+
"true");
648651
//!--
649652
}
650653
{
@@ -680,6 +683,9 @@ void dds_domain_examples()
680683
pqos.properties().properties().emplace_back(
681684
"dds.sec.access.builtin.Access-Permissions.permissions",
682685
"file://certs/permissions.smime");
686+
pqos.properties().properties().emplace_back(
687+
"dds.sec.access.builtin.Access-Permissions.transmit_algorithms_as_legacy",
688+
"true");
683689
//!--
684690
}
685691
{

code/XMLTester.xml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3054,6 +3054,10 @@
30543054
<name>dds.sec.auth.builtin.PKI-DH.preferred_key_agreement</name>
30553055
<value>ECDH</value>
30563056
</property>
3057+
<property>
3058+
<name>dds.sec.auth.builtin.PKI-DH.transmit_algorithms_as_legacy</name>
3059+
<value>true</value>
3060+
</property>
30573061
</properties>
30583062
</propertiesPolicy>
30593063
</rtps>
@@ -3106,6 +3110,10 @@
31063110
<name>dds.sec.access.builtin.Access-Permissions.permissions</name>
31073111
<value>file://permissions.smime</value>
31083112
</property>
3113+
<property>
3114+
<name>dds.sec.access.builtin.Access-Permissions.transmit_algorithms_as_legacy</name>
3115+
<value>true</value>
3116+
</property>
31093117
</properties>
31103118
</propertiesPolicy>
31113119
</rtps>

docs/fastdds/property_policies/security.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,10 @@ The following table outlines the properties used for the :ref:`DDS\:Auth\:PKI-DH
4848
a) ``DH``, ``DH+MODP-2048-256`` for Diffie-Hellman Ephemeral with 2048-bit MODP Group parameters. |br|
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|
51-
Will default to ``DH`` if the property is not present.
51+
Will default to ``AUTO`` 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 ``false`` 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 ``false`` 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: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,10 @@ The following table outlines the properties used for the DDS:\Auth\:PKI-DH plugi
6363
a) ``DH``, ``DH+MODP-2048-256`` for Diffie-Hellman Ephemeral with 2048-bit MODP Group parameters. |br|
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|
66-
Will default to ``DH`` if the property is not present.
66+
Will default to ``AUTO`` 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 ``false`` 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)