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

Jump to bottom

[22280] Add documentation for preferred_key_agreement property #963

Merged
merged 6 commits into from
Nov 28, 2024
Merged

[22280] Add documentation for preferred_key_agreement property #963

merged 6 commits into from
Nov 28, 2024

Conversation

MiguelCompany
Copy link
Member

@MiguelCompany MiguelCompany commented Nov 22, 2024 •
edited
Loading

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:

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.

@MiguelCompany MiguelCompany mentioned this pull request Nov 22, 2024
Merged
15 tasks
@MiguelCompany MiguelCompany requested review from Mario-DL and removed request for Mario-DL November 25, 2024 07:56
@MiguelCompany MiguelCompany requested review from richiprosima and removed request for richiprosima November 25, 2024 08:28
@Mario-DL Mario-DL added this to the v3.2.0 milestone Nov 25, 2024
@MiguelCompany
Refs #19921. Fix doc8.
28d3334 
Signed-off-by: Miguel Company <[email protected]>
Mario-DL
Mario-DL reviewed Nov 25, 2024
View reviewed changes
Copy link
Member

@Mario-DL Mario-DL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@MiguelCompany
Refs #22280. Apply suggestion.
c43e0bd 
Signed-off-by: Miguel Company <[email protected]>
@MiguelCompany MiguelCompany requested review from Mario-DL and removed request for Mario-DL November 27, 2024 09:17
Mario-DL
Mario-DL requested changes Nov 27, 2024
View reviewed changes
Copy link
Member

@Mario-DL Mario-DL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two NITs

docs/fastdds/property_policies/security.rst Outdated Show resolved Hide resolved
docs/fastdds/security/auth_plugin/auth_plugin.rst Outdated Show resolved Hide resolved
Mario-DL
Mario-DL approved these changes Nov 27, 2024
View reviewed changes
Copy link
Member

@Mario-DL Mario-DL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Mario-DL
Copy link
Member

@Mergifyio backport 3.1.x

@mergify Mergify
Copy link

mergify bot commented Nov 28, 2024 •
edited
Loading

backport 3.1.x

✅ Backports have been created

@MiguelCompany MiguelCompany merged commit 2f51e7c into master Nov 28, 2024
4 checks passed
@MiguelCompany MiguelCompany deleted the feature/19921 branch November 28, 2024 15:16
@mergify mergify bot mentioned this pull request Nov 28, 2024
Merged
15 tasks
mergify bot pushed a commit that referenced this pull request Nov 28, 2024
@MiguelCompany @mergify
Add documentation for preferred_key_agreement property (#963)
8692711 
* Refs #19921. Add new `preferred_key_agreement` property to auth plugin section.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Add new `preferred_key_agreement` property to property policies section.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Add new `preferred_key_agreement` property to snippets.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Fix doc8.

Signed-off-by: Miguel Company <[email protected]>

* Refs #22280. Apply suggestion.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Add `AUTO` value to new option.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 2f51e7c)
@mergify mergify bot mentioned this pull request Nov 28, 2024
Merged
8 tasks
MiguelCompany added a commit that referenced this pull request Nov 29, 2024
@mergify @MiguelCompany
Add documentation for preferred_key_agreement property (#963) (#967)
949a673 
* 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 <[email protected]>

* Refs #19921. Add new `preferred_key_agreement` property to property policies section.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Add new `preferred_key_agreement` property to snippets.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Fix doc8.

Signed-off-by: Miguel Company <[email protected]>

* Refs #22280. Apply suggestion.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Add `AUTO` value to new option.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 2f51e7c)

* Change default value to `DH`.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
This was referenced Nov 29, 2024
Merged
Open
Open
mergify bot added a commit that referenced this pull request Nov 29, 2024
@mergify
Add documentation for preferred_key_agreement property (#963) (#967)
d53afe3 
* 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 <[email protected]>

* Refs #19921. Add new `preferred_key_agreement` property to property policies section.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Add new `preferred_key_agreement` property to snippets.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Fix doc8.

Signed-off-by: Miguel Company <[email protected]>

* Refs #22280. Apply suggestion.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Add `AUTO` value to new option.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 2f51e7c)

* Change default value to `DH`.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit 949a673)
@mergify mergify bot mentioned this pull request Nov 29, 2024
Open
8 tasks
mergify bot added a commit that referenced this pull request Nov 29, 2024
@mergify
Add documentation for preferred_key_agreement property (#963) (#967)
25b91a4 
* 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 <[email protected]>

* Refs #19921. Add new `preferred_key_agreement` property to property policies section.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Add new `preferred_key_agreement` property to snippets.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Fix doc8.

Signed-off-by: Miguel Company <[email protected]>

* Refs #22280. Apply suggestion.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Add `AUTO` value to new option.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 2f51e7c)

* Change default value to `DH`.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit 949a673)
@mergify mergify bot mentioned this pull request Nov 29, 2024
Open
8 tasks
mergify bot added a commit that referenced this pull request Nov 29, 2024
@mergify
Add documentation for preferred_key_agreement property (#963) (#967)
89052b3 
* 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 <[email protected]>

* Refs #19921. Add new `preferred_key_agreement` property to property policies section.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Add new `preferred_key_agreement` property to snippets.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Fix doc8.

Signed-off-by: Miguel Company <[email protected]>

* Refs #22280. Apply suggestion.

Signed-off-by: Miguel Company <[email protected]>

* Refs #19921. Add `AUTO` value to new option.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
(cherry picked from commit 2f51e7c)

* Change default value to `DH`.

Signed-off-by: Miguel Company <[email protected]>

---------

Signed-off-by: Miguel Company <[email protected]>
Co-authored-by: Miguel Company <[email protected]>
(cherry picked from commit 949a673)
@mergify mergify bot mentioned this pull request Nov 29, 2024
Open
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mario-DL Mario-DL Mario-DL approved these changes

Assignees
No one assigned
Labels
ready-to-merge
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging this pull request may close these issues.
2 participants
@MiguelCompany @Mario-DL