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

NIFI-9253 Corrected SSLSocketChannel.available() for TLSv1.3 #5421

Closed
wants to merge 1 commit into from

Conversation

exceptionfactory
Copy link
Contributor

Description of PR

NIFI-9253 Corrects SSLSocketChannel to avoid intermittent unit test and runtime failures related to TLSv1.3. The available() method implementation resulted in sporadic unit test failures for TLSv1.3 due to partial reads from the connected channel while attempting to determine available bytes. Partial reads produced incomplete TLS messages, causing AES-GCM decryption failures reported as Tag mismatch messages with SSLException.

The previous unit test used a loop for checking the available() bytes, causing intermittent failures. The updated unit test class includes separate methods with and without calls to available() in order to reproduce the potential problem. The corrected available() method in SSLSocketChannel avoids direct reads from the socket channel and instead returns the size of the application data buffer. This approach aligns with the documentation for InputStream.available(), which states that the method returns an estimate of the number of bytes that may be read, without blocking. Additional changes include refactoring and isolating the readChannel() and unwrap() methods in SSLSocketChannel for more streamlined handling of buffer underflow status.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically main)?

  • Is your initial contribution a single, squashed commit? Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not squash or use --force when pushing to allow for clean monitoring of changes.

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
  • Have you written or updated unit tests to verify your changes?
  • Have you verified that the full build is successful on JDK 8?
  • Have you verified that the full build is successful on JDK 11?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
  • If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
  • If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.

- Added unit tests to reproduce issues with available() method
- Changed available() to return size of application buffer
- Removed unused isDataAvailable()
- Refactored unwrap handling to read from channel for buffer underflow
@joewitt
Copy link
Contributor

joewitt commented Sep 29, 2021

local build is happy and github checks are happy. But i'm not sure I can give the code changes justice for a review. Anyone else available to look?

@exceptionfactory
Copy link
Contributor Author

local build is happy and github checks are happy. But i'm not sure I can give the code changes justice for a review. Anyone else available to look?

Thanks for the feedback @joewitt!

@gresockj can you take a look at the changes based on reviewing previous updates to this class?

Copy link
Contributor

@gresockj gresockj left a comment

Choose a reason for hiding this comment

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

I don't have any problems with the code changes, and I've run the unit tests several times, as well as verifying TLSv1.3 on PutTCP/ListenTCP and DistributedMapCacheClient. Since the problem has not surfaced, this is a +1 for me.

Copy link
Contributor

@pvillard31 pvillard31 left a comment

Choose a reason for hiding this comment

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

Merging based on @gresockj 's review and green builds.

@asfgit asfgit closed this in defea61 Oct 2, 2021
krisztina-zsihovszki pushed a commit to krisztina-zsihovszki/nifi that referenced this pull request Jun 28, 2022
- Added unit tests to reproduce issues with available() method
- Changed available() to return size of application buffer
- Removed unused isDataAvailable()
- Refactored unwrap handling to read from channel for buffer underflow

Signed-off-by: Pierre Villard <pierre.villard.fr@gmail.com>

This closes apache#5421.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants