Skip to content
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

[22353] Document new transmit_algorithms_as_legacy on builtin security plugins #974

Merged
merged 3 commits into from
Dec 11, 2024
Merged

[22353] Document new transmit_algorithms_as_legacy on builtin security plugins #974

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
0b41a61
Refs #19925. Add documentation of new property in PKIDH.
MiguelCompany Dec 11, 2024
28b7c0e
Refs #19925. Add documentation of new property in Permissions.
MiguelCompany Dec 11, 2024
2f87bca
Apply suggestions from code review
MiguelCompany Dec 11, 2024
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
6 changes: 6 additions & 0 deletions code/DDSCodeTester.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -645,6 +645,9 @@ void dds_domain_examples()
pqos.properties().properties().emplace_back(
"dds.sec.auth.builtin.PKI-DH.preferred_key_agreement",
"ECDH");
pqos.properties().properties().emplace_back(
"dds.sec.auth.builtin.PKI-DH.transmit_algorithms_as_legacy",
"true");
//!--
}
{
Expand Down Expand Up @@ -680,6 +683,9 @@ void dds_domain_examples()
pqos.properties().properties().emplace_back(
"dds.sec.access.builtin.Access-Permissions.permissions",
"file://certs/permissions.smime");
pqos.properties().properties().emplace_back(
"dds.sec.access.builtin.Access-Permissions.transmit_algorithms_as_legacy",
"true");
//!--
}
{
Expand Down
8 changes: 8 additions & 0 deletions code/XMLTester.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3054,6 +3054,10 @@
<name>dds.sec.auth.builtin.PKI-DH.preferred_key_agreement</name>
<value>ECDH</value>
</property>
<property>
<name>dds.sec.auth.builtin.PKI-DH.transmit_algorithms_as_legacy</name>
<value>true</value>
</property>
</properties>
</propertiesPolicy>
</rtps>
Expand Down Expand Up @@ -3106,6 +3110,10 @@
<name>dds.sec.access.builtin.Access-Permissions.permissions</name>
<value>file://permissions.smime</value>
</property>
<property>
<name>dds.sec.access.builtin.Access-Permissions.transmit_algorithms_as_legacy</name>
<value>true</value>
</property>
</properties>
</propertiesPolicy>
</rtps>
Expand Down
3 changes: 3 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 @@ -49,6 +49,9 @@ The following table outlines the properties used for the :ref:`DDS\:Auth\:PKI-DH
b) ``ECDH``, ``ECDH+prime256v1-CEUM`` for Elliptic Curve Diffie-Hellman Ephemeral with the NIST P-256 curve. |br|
c) ``AUTO`` for selecting the key agreement based on the signature algorithm in the Identity CA's certificate. |br|
Will default to ``AUTO`` if the property is not present.
* - ``transmit_algorithms_as_legacy`` *(optional)*
- Whether to transmit algorithm identifiers in non-standard legacy format. |br|
Will default to ``false`` if the property is not present.

.. note::
All properties listed above have the ``dds.sec.auth.builtin.PKI-DH."`` prefix.
Expand Down
3 changes: 3 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 @@ -55,6 +55,9 @@ The following table outlines the properties used for the DDS\:Access\:Permission
* - permissions
- URI to the Participant permissions document signed by the |br| Permissions CA in S/MIME format. |br|
Supported URI schemes: file.
* - transmit_algorithms_as_legacy *(optional)*
- Whether to transmit algorithm identifiers in non-standard legacy format. |br|
Will default to ``false`` if the property is not present.

.. note::
All listed properties have "dds.sec.access.builtin.Access-Permissions." prefix.
Expand Down
3 changes: 3 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 @@ -64,6 +64,9 @@ The following table outlines the properties used for the DDS:\Auth\:PKI-DH plugi
b) ``ECDH``, ``ECDH+prime256v1-CEUM`` for Elliptic Curve Diffie-Hellman Ephemeral with the NIST P-256 curve. |br|
c) ``AUTO`` for selecting the key agreement based on the signature algorithm in the Identity CA's certificate. |br|
Will default to ``AUTO`` if the property is not present.
* - transmit_algorithms_as_legacy *(optional)*
- Whether to transmit algorithm identifiers in non-standard legacy format. |br|
Will default to ``false`` if the property is not present.

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