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.

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

[22280] Add documentation for preferred_key_agreement property #963

Merged
merged 6 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
3 changes: 3 additions & 0 deletions code/DDSCodeTester.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -642,6 +642,9 @@ void dds_domain_examples()
pqos.properties().properties().emplace_back(
"dds.sec.auth.builtin.PKI-DH.password",
"domainParticipantPassword");
pqos.properties().properties().emplace_back(
"dds.sec.auth.builtin.PKI-DH.preferred_key_agreement",
"ECDH");
//!--
}
{
Expand Down
4 changes: 4 additions & 0 deletions code/XMLTester.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3050,6 +3050,10 @@
<name>dds.sec.auth.builtin.PKI-DH.password</name>
<value>domainParticipantPassword</value>
</property>
<property>
<name>dds.sec.auth.builtin.PKI-DH.preferred_key_agreement</name>
<value>ECDH</value>
</property>
</properties>
</propertiesPolicy>
</rtps>
Expand Down
6 changes: 6 additions & 0 deletions docs/fastdds/property_policies/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ The following table outlines the properties used for the :ref:`DDS\:Auth\:PKI-DH
If the *password* property is not present, then the value supplied in the |br|
*private_key* property must contain the decrypted private key. |br|
The *password* property is ignored if the *private_key* is given in PKCS#11 scheme.
* - ``preferred_key_agreement`` *(optional)*
- The preferred algorithm to use for generating the session's shared secret |br|
at the end of the authentication phase. Supported values are: |br|
a) ``DH``, ``DH+MODP-2048-256`` for Diffie-Hellman Ephemeral with 2048-bit MODP Group parameters. |br|
b) ``ECDH``, ``ECDH+prime256v1-CEUM`` for Elliptic Curve Diffie-Hellman Ephemeral with the NIST P-256 curve. |br|
Will default to ``ECDH`` if the property is not present.

.. note::
All properties listed above have the ``dds.sec.auth.builtin.PKI-DH."`` prefix.
Expand Down
6 changes: 6 additions & 0 deletions docs/fastdds/security/auth_plugin/auth_plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ The following table outlines the properties used for the DDS:\Auth\:PKI-DH plugi
If the *password* property is not present, then the value supplied in the |br|
*private_key* property must contain the decrypted private key. |br|
The *password* property is ignored if the *private_key* is given in PKCS#11 scheme.
* - preferred_key_agreement *(optional)*
- The preferred algorithm to use for generating the session's shared secret |br|
at the end of the authentication phase. Supported values are: |br|
a) ``DH``, ``DH+MODP-2048-256`` for Diffie-Hellman Ephemeral with 2048-bit MODP Group parameters. |br|
b) ``ECDH``, ``ECDH+prime256v1-CEUM`` for Elliptic Curve Diffie-Hellman Ephemeral with the NIST P-256 curve. |br|
Will default to ``ECDH`` if the property is not present.

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