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
Changes from 1 commit
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
Prev Previous commit
Refs #19921. Add AUTO value to new option.
Signed-off-by: Miguel Company <[email protected]>
MiguelCompany committed Nov 27, 2024
commit 59be02f5a85cae742ec13e8611b120f095a95af8
3 changes: 2 additions & 1 deletion docs/fastdds/property_policies/security.rst
Original file line number Diff line number Diff line change
@@ -47,7 +47,8 @@ The following table outlines the properties used for the :ref:`DDS\:Auth\:PKI-DH
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.
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.

.. note::
All properties listed above have the ``dds.sec.auth.builtin.PKI-DH."`` prefix.
3 changes: 2 additions & 1 deletion docs/fastdds/security/auth_plugin/auth_plugin.rst
Original file line number Diff line number Diff line change
@@ -62,7 +62,8 @@ The following table outlines the properties used for the DDS:\Auth\:PKI-DH plugi
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.
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.

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