Skip to content

Commit

Permalink
Refs #19921. Fix doc8.
Browse files Browse the repository at this point in the history
Signed-off-by: Miguel Company <[email protected]>
  • Loading branch information
MiguelCompany committed Nov 25, 2024
1 parent 48887ab commit 28d3334
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions docs/fastdds/property_policies/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +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)*
* - ``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.
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: 3 additions & 3 deletions docs/fastdds/security/auth_plugin/auth_plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ The following table outlines the properties used for the DDS:\Auth\:PKI-DH plugi
* - 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.
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

0 comments on commit 28d3334

Please sign in to comment.