[22280] Add documentation for `preferred_key_agreement` property #963

MiguelCompany · 2024-11-22T12:01:04Z

Description

This adds documentation for the new property allowing the selection of the preferred key agreement algorithm.

@Mergifyio backport 3.1.x

We will backport to 3.1.x, but leaving the default value of the new property to the old behavior.
We will then backport from there into 3.0.x 2.14.x 2.10.x

Related implementation PR:

[22280] New property to select preferred key agreement algorithm Fast-DDS#5413

Contributor Checklist

Commit messages follow the project guidelines.
Code snippets related to the added documentation have been provided.
Documentation tests pass locally.
Applicable backports have been included in the description.

Reviewer Checklist

The PR has a milestone assigned.
The title and description correctly express the PR's purpose.
Check contributor checklist is correct.
CI passes without warnings or errors.

…n section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

…olicies section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

Mario-DL

We may also clarify here and here that from now on the algorithm can be selected (not just ECDH). What do you think ?

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

Mario-DL

Two NITs

docs/fastdds/property_policies/security.rst

docs/fastdds/security/auth_plugin/auth_plugin.rst

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

Mario-DL

LGTM

Mario-DL · 2024-11-28T15:14:49Z

@Mergifyio backport 3.1.x

mergify · 2024-11-28T15:15:58Z

backport 3.1.x

✅ Backports have been created

#967 [22280] Add documentation for preferred_key_agreement property (backport #963) has been created for branch 3.1.x

* Refs #19921. Add new `preferred_key_agreement` property to auth plugin section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add new `preferred_key_agreement` property to property policies section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add new `preferred_key_agreement` property to snippets. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Fix doc8. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #22280. Apply suggestion. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add `AUTO` value to new option. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com> (cherry picked from commit 2f51e7c)

* Add documentation for `preferred_key_agreement` property (#963) * Refs #19921. Add new `preferred_key_agreement` property to auth plugin section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add new `preferred_key_agreement` property to property policies section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add new `preferred_key_agreement` property to snippets. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Fix doc8. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #22280. Apply suggestion. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add `AUTO` value to new option. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com> (cherry picked from commit 2f51e7c) * Change default value to `DH`. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com> Co-authored-by: Miguel Company <miguelcompany@eprosima.com>

* Add documentation for `preferred_key_agreement` property (#963) * Refs #19921. Add new `preferred_key_agreement` property to auth plugin section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add new `preferred_key_agreement` property to property policies section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add new `preferred_key_agreement` property to snippets. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Fix doc8. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #22280. Apply suggestion. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add `AUTO` value to new option. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com> (cherry picked from commit 2f51e7c) * Change default value to `DH`. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com> Co-authored-by: Miguel Company <miguelcompany@eprosima.com> (cherry picked from commit 949a673)

#968) * Add documentation for `preferred_key_agreement` property (#963) * Refs #19921. Add new `preferred_key_agreement` property to auth plugin section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add new `preferred_key_agreement` property to property policies section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add new `preferred_key_agreement` property to snippets. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Fix doc8. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #22280. Apply suggestion. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add `AUTO` value to new option. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com> (cherry picked from commit 2f51e7c) * Change default value to `DH`. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com> Co-authored-by: Miguel Company <miguelcompany@eprosima.com> (cherry picked from commit 949a673) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

#969) * Add documentation for `preferred_key_agreement` property (#963) * Refs #19921. Add new `preferred_key_agreement` property to auth plugin section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add new `preferred_key_agreement` property to property policies section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add new `preferred_key_agreement` property to snippets. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Fix doc8. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #22280. Apply suggestion. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #19921. Add `AUTO` value to new option. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com> (cherry picked from commit 2f51e7c) * Change default value to `DH`. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com> Co-authored-by: Miguel Company <miguelcompany@eprosima.com> (cherry picked from commit 949a673) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

MiguelCompany added 3 commits November 22, 2024 12:50

Refs #19921. Add new preferred_key_agreement property to auth plugi…

5222180

…n section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

Refs #19921. Add new preferred_key_agreement property to property p…

c267467

…olicies section. Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

Refs #19921. Add new preferred_key_agreement property to snippets.

48887ab

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

MiguelCompany mentioned this pull request Nov 22, 2024

[22280] New property to select preferred key agreement algorithm eProsima/Fast-DDS#5413

Merged

15 tasks

MiguelCompany requested a review from Mario-DL November 25, 2024 07:10

github-actions bot added the ci-pending label Nov 25, 2024

MiguelCompany requested review from Mario-DL and removed request for Mario-DL November 25, 2024 07:56

MiguelCompany force-pushed the feature/19921 branch from 262dbce to a2402e4 Compare November 25, 2024 08:28

MiguelCompany requested review from richiprosima and removed request for richiprosima November 25, 2024 08:28

Mario-DL added this to the v3.2.0 milestone Nov 25, 2024

Refs #19921. Fix doc8.

28d3334

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

MiguelCompany force-pushed the feature/19921 branch from a2402e4 to 28d3334 Compare November 25, 2024 09:11

Mario-DL reviewed Nov 25, 2024

View reviewed changes

MiguelCompany requested a review from Mario-DL November 25, 2024 09:58

Refs #22280. Apply suggestion.

c43e0bd

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

MiguelCompany requested review from Mario-DL and removed request for Mario-DL November 27, 2024 09:17

Mario-DL requested changes Nov 27, 2024

View reviewed changes

docs/fastdds/property_policies/security.rst Outdated Show resolved Hide resolved

docs/fastdds/security/auth_plugin/auth_plugin.rst Outdated Show resolved Hide resolved

Refs #19921. Add AUTO value to new option.

59be02f

Signed-off-by: Miguel Company <miguelcompany@eprosima.com>

MiguelCompany force-pushed the feature/19921 branch from a03e3b6 to 59be02f Compare November 27, 2024 09:22

MiguelCompany requested a review from Mario-DL November 27, 2024 09:23

Mario-DL approved these changes Nov 27, 2024

View reviewed changes

Mario-DL added ready-to-merge and removed ci-pending labels Nov 28, 2024

MiguelCompany merged commit 2f51e7c into master Nov 28, 2024
4 checks passed

MiguelCompany deleted the feature/19921 branch November 28, 2024 15:16

mergify bot mentioned this pull request Nov 28, 2024

[22280] New property to select preferred key agreement algorithm (backport #5413) eProsima/Fast-DDS#5442

Merged

15 tasks

mergify bot mentioned this pull request Nov 28, 2024

[22280] Add documentation for preferred_key_agreement property (backport #963) #967

Merged

8 tasks

mergify bot mentioned this pull request Nov 29, 2024

[22280] Add documentation for preferred_key_agreement property (backport #963) (backport #967) #968

Merged

8 tasks

mergify bot mentioned this pull request Nov 29, 2024

[22280] Add documentation for preferred_key_agreement property (backport #963) (backport #967) #969

Merged

8 tasks

mergify bot mentioned this pull request Nov 29, 2024

[22280] Add documentation for preferred_key_agreement property (backport #963) (backport #967) #970

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[22280] Add documentation for `preferred_key_agreement` property #963

[22280] Add documentation for `preferred_key_agreement` property #963

MiguelCompany commented Nov 22, 2024 •

edited

Loading

Mario-DL left a comment

Mario-DL left a comment

Mario-DL left a comment

Mario-DL commented Nov 28, 2024

mergify bot commented Nov 28, 2024 •

edited

Loading

[22280] Add documentation for preferred_key_agreement property #963

[22280] Add documentation for preferred_key_agreement property #963

Conversation

MiguelCompany commented Nov 22, 2024 • edited Loading

Description

Contributor Checklist

Reviewer Checklist

Mario-DL left a comment

Choose a reason for hiding this comment

Mario-DL left a comment

Choose a reason for hiding this comment

Mario-DL left a comment

Choose a reason for hiding this comment

Mario-DL commented Nov 28, 2024

mergify bot commented Nov 28, 2024 • edited Loading

✅ Backports have been created

[22280] Add documentation for `preferred_key_agreement` property #963

[22280] Add documentation for `preferred_key_agreement` property #963

MiguelCompany commented Nov 22, 2024 •

edited

Loading

mergify bot commented Nov 28, 2024 •

edited

Loading