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

[22024] Improve OpenSSL lifecycle handling #5384

Merged
merged 4 commits into from
Nov 14, 2024
Merged

[22024] Improve OpenSSL lifecycle handling #5384

merged 4 commits into from
Nov 14, 2024

Conversation

Mario-DL
Copy link
Member

@Mario-DL Mario-DL commented Nov 5, 2024 •
edited by MiguelCompany
Loading

Description

This PR fixes a crash in OpenSSL provoked when the atexit callback from openssl is triggered upon process destruction, making it to trigger a SIGSEV on an already released OpenSSL resource.

In addition, OpenSSL is now a Meyers singleton attached to RTPSDomainImpl.

In accordance with the best practices using OpenSSL and its documentation:

  • Initialization is done through OpenSSL_init_crypto (available in all versions along with the OPENSSL_INIT_NO_ATEXIT option) that makes atexit not being registered.
  • If atexit is not registered, user has to explicitly call OpenSSL_cleanup() (also, supported across versions).

@Mergifyio backport 3.1.x 3.0.x 2.14.x 2.10.x

Contributor Checklist

  • Commit messages follow the project guidelines.
  • The code follows the style guidelines of this project.
  • Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
  • Any new/modified methods have been properly documented using Doxygen.
  • Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
  • Changes are backport compatible: they do NOT break ABI nor change library core behavior.
  • Changes are API compatible.
  • N/A New feature has been added to the versions.md file (if applicable).
  • N/A New feature has been documented/Current behavior is correctly described in the documentation.
  • 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.
  • If this is a critical bug fix, backports to the critical-only supported branches have been requested.
  • Check CI results: changes do not issue any warning.
  • Check CI results: failing tests are unrelated with the changes.

@Mario-DL Mario-DL added this to the v3.2.0 milestone Nov 5, 2024
@Mario-DL Mario-DL requested review from richiprosima and removed request for richiprosima November 5, 2024 16:35
@github-actions github-actions bot added the ci-pending PR which CI is running label Nov 5, 2024
MiguelCompany
MiguelCompany requested changes Nov 7, 2024
View reviewed changes
Copy link
Member

@MiguelCompany MiguelCompany left a comment

Choose a reason for hiding this comment

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

Changes look good to me, but this will not build if openssl is not in the system

@Mario-DL
Copy link
Member Author

Mario-DL commented Nov 8, 2024

Follow up of this PR will be in task 22090

MiguelCompany
MiguelCompany previously approved these changes Nov 8, 2024
View reviewed changes
MiguelCompany
MiguelCompany approved these changes Nov 12, 2024
View reviewed changes
Copy link
Member

@MiguelCompany MiguelCompany left a comment

Choose a reason for hiding this comment

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

LGTM with green CI

@MiguelCompany MiguelCompany merged commit 44310c4 into master Nov 14, 2024
15 of 17 checks passed
@MiguelCompany MiguelCompany deleted the feature/22024 branch November 14, 2024 10:03
@MiguelCompany
Copy link
Member

@Mergifyio backport 3.1.x 3.0.x

@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 14, 2024 •
edited
Loading

backport 3.1.x 3.0.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Nov 14, 2024
@Mario-DL @mergify
[22024] Improve OpenSSL lifecycle handling (#5384)
a12b9f4 
* Refs #22024: Add BB test

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Make OpenSSLInit Mayers singleton

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Fix: Do not register atexit in OPenSSL. Instead, Comply with OpenSSL initialization and destruction.

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Do not reference OpenSSLInit if security features are no present

Signed-off-by: Mario Dominguez <[email protected]>

---------

Signed-off-by: Mario Dominguez <[email protected]>
(cherry picked from commit 44310c4)
@mergify mergify bot mentioned this pull request Nov 14, 2024
Open
14 tasks
mergify bot pushed a commit that referenced this pull request Nov 14, 2024
@Mario-DL @mergify
[22024] Improve OpenSSL lifecycle handling (#5384)
dffcf2d 
* Refs #22024: Add BB test

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Make OpenSSLInit Mayers singleton

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Fix: Do not register atexit in OPenSSL. Instead, Comply with OpenSSL initialization and destruction.

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Do not reference OpenSSLInit if security features are no present

Signed-off-by: Mario Dominguez <[email protected]>

---------

Signed-off-by: Mario Dominguez <[email protected]>
(cherry picked from commit 44310c4)
@mergify mergify bot mentioned this pull request Nov 14, 2024
Open
14 tasks
@MiguelCompany
Copy link
Member

@Mergifyio backport mergify/bp/2.14.x/pr-5386 mergify/bp/2.10.x/pr-5386

@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 14, 2024 •
edited
Loading

backport mergify/bp/2.14.x/pr-5386 mergify/bp/2.10.x/pr-5386

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Nov 14, 2024
@Mario-DL @mergify
[22024] Improve OpenSSL lifecycle handling (#5384)
b4b1064 
* Refs #22024: Add BB test

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Make OpenSSLInit Mayers singleton

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Fix: Do not register atexit in OPenSSL. Instead, Comply with OpenSSL initialization and destruction.

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Do not reference OpenSSLInit if security features are no present

Signed-off-by: Mario Dominguez <[email protected]>

---------

Signed-off-by: Mario Dominguez <[email protected]>
(cherry picked from commit 44310c4)

# Conflicts:
#	src/cpp/rtps/RTPSDomainImpl.hpp
mergify bot pushed a commit that referenced this pull request Nov 14, 2024
@Mario-DL @mergify
[22024] Improve OpenSSL lifecycle handling (#5384)
633931b 
* Refs #22024: Add BB test

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Make OpenSSLInit Mayers singleton

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Fix: Do not register atexit in OPenSSL. Instead, Comply with OpenSSL initialization and destruction.

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #22024: Do not reference OpenSSLInit if security features are no present

Signed-off-by: Mario Dominguez <[email protected]>

---------

Signed-off-by: Mario Dominguez <[email protected]>
(cherry picked from commit 44310c4)

# Conflicts:
#	src/cpp/rtps/RTPSDomainImpl.hpp
This was referenced Nov 14, 2024
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MiguelCompany MiguelCompany MiguelCompany approved these changes

Assignees
No one assigned
Labels
ci-pending PR which CI is running
Projects
None yet
Milestone
v3.2.0
Development

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