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

SSL client handshake check not called #951

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

sonnin
Copy link

@sonnin sonnin commented Aug 26, 2019

With the former ACE 6.1.7, I have observed that a SSL client sometimes fails to establish connection. It looks like a chicken-and-egg problem where the SSL handshake sometimes is completed when SSL_connect returns and sometimes it is not. Resulting in client post_handshake_check first being called later on when client attempts to read/write some data.
This may be a result of how we use ACE to initiate a connection.
But I found that when a ACE SSL client calls SSL_connect as part of do_SSL_state_machine and this returns 1 meaning:
"The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been established."
see https://www.openssl.org/docs/man1.0.2/man3/SSL_connect.html
The do_SSL_handshake will also return 1 which according to the code comments means"SSL handshake is finished already, success". But this is not entirely true from a ACE perspective, as it did not call post_handshake_check.

Ensuring that post_handshake_check is called within the function, resolves the issue I observe.

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced secure connection reliability by ensuring that verification steps run immediately after a successful secure connection is established. This update improves overall stability and reduces the risk of connection issues. Users may experience a more consistent and robust secure connectivity, resulting in a smoother experience when establishing protected network connections.

SSL handshake must be done once connected
@jwillemsen jwillemsen added the needs review Needs to be reviewed label May 7, 2020
Copy link
Contributor

coderabbitai bot commented Feb 10, 2025

Walkthrough

The changes modify the SSL handshake process within the ACE_SSL_Asynch_Stream class. After a successful SSL handshake—indicated by ::SSL_connect returning 1—the function now recursively calls do_SSL_handshake() to immediately execute the post-handshake verification. This update alters the control flow to ensure that the additional handshake check is performed without delay upon successful connection.

Changes

Files Change Summary
ACE/ace/SSL/SSL_Asynch_Stream.cpp Updated the do_SSL_handshake method to include a recursive call when ::SSL_connect returns 1, ensuring that post_handshake_check() is executed immediately.

Sequence Diagram(s)

sequenceDiagram
    participant Stream as ACE_SSL_Asynch_Stream
    participant SSL as ::SSL_connect
    participant PostCheck as post_handshake_check

    Stream->>SSL: Initiate SSL_connect
    SSL-->>Stream: Return retval (1)
    alt Handshake Successful
        Stream->>Stream: Recursive call do_SSL_handshake()
        Stream->>PostCheck: Execute post_handshake_check()
    end
Loading

Poem

I'm a rabbit with a coding cheer,
Hoping through handshakes without fear.
A recursive leap, a post-check dance,
Ensures our SSL gets its chance.
Happy hops and secure bounds, my dear!
🐇💻✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
ACE/ace/SSL/SSL_Asynch_Stream.cpp (1)

513-514: LGTM! The fix correctly ensures post_handshake_check is called.

The recursive call to do_SSL_handshake() after a successful SSL handshake completion is a good solution to ensure that post_handshake_check is called at the right time, eliminating the race condition in the handshake process.

Consider adding a comment to explain the timing issue and why the recursive call is necessary:

-      if (retval == 1) // handshake was successfully completed - ensure that we call post_handshake_check
+      // When SSL_connect returns 1, the handshake is complete but post_handshake_check
+      // needs to be called immediately to avoid a race condition where it might be
+      // called too late during subsequent read/write operations.
+      if (retval == 1)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6dec8f2 and 981313e.

📒 Files selected for processing (1)
  • ACE/ace/SSL/SSL_Asynch_Stream.cpp (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Codacy Static Code Analysis

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs review Needs to be reviewed
Development

Successfully merging this pull request may close these issues.

2 participants