NIFI-7468 Updated SSLSocketChannel to support TLS 1.3 #5152
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
exceptionfactory
force-pushed
the
NIFI-7468-1
branch
from
039b125
to
6359e99
Compare
- Handling additional FINISHED Handshake Status for TLS 1.3 Post-Handshake Messages per RFC 8446 Section 4.6 - Removed clearing buffers after handshake to avoid losing packets - Updated read() method to check Handshake Status after SSLEngine.unwrap() - Changed SSLSocketChannelSender to close SSLSocketChannel before other resources - Added ChannelStatus enum and convenience logging methods for tracing status - Added unit tests for TLS 1.2 and 1.3 using Netty server and client handlers
exceptionfactory
force-pushed
the
NIFI-7468-1
branch
from
6359e99
to
7401d21
Compare
markobean
reviewed
Jun 15, 2021
gresockj
approved these changes
Jun 15, 2021
Thanks for the review and verification @gresockj! |
|
@gresockj Did you test using Java 8 or 11 (or both)? |
Only 8. I'll try 11 tomorrow |
|
Will test this out |
|
+1, changes look good. I tested this in a 2 node secure cluster with a S2S and PostHTTP and ListenHTTP using RestrictedSSLContext for TLS 1.2 and TLS 1.3 using Java 8 (Zulu 1.8.0_292-b10) and Java 11 (11.0.10+9-LTS) at run time. Also tested PutTCP/ListenTCP with TLS 1.3 and Java 11 (11.0.10+9-LTS). |
|
@exceptionfactory did you say the DistributedMapCacheClient should benefit from this fix? I just tried a flow with DetectDuplicate using DistributedMapCacheClient configured with a RestrictedSSLContext on TLS 1.3 (Java 11.0.11+9-LTS), and got the following exception: This only occurred once at the very beginning of processing ~100,000 flow files, and with a retry, it was successful. |
|
@gresockj The Thanks for noting that problem, the updated I corrected the |
|
Thanks for the update, @exceptionfactory! This appears to have resolved the issue. |
gresockj
approved these changes
Jun 19, 2021
|
Tested again, nothing more from me. Merging. |
timeabarna
pushed a commit
to timeabarna/nifi
that referenced
this pull request
Jul 6, 2021
- Handling additional FINISHED Handshake Status for TLS 1.3 Post-Handshake Messages per RFC 8446 Section 4.6 - Removed clearing buffers after handshake to avoid losing packets - Updated read() method to check Handshake Status after SSLEngine.unwrap() - Changed SSLSocketChannelSender to close SSLSocketChannel before other resources - Added ChannelStatus enum and convenience logging methods for tracing status - Added unit tests for TLS 1.2 and 1.3 using Netty server and client handlers NIFI-8704 Updated netty-handler to 4.1.65.Final NIFI-7468 Corrected SSLSocketChannel.read() to return byte read NIFI-7468 Adjusted comment formatting Signed-off-by: Nathan Gough <thenatog@gmail.com> This closes apache#5152.
timeabarna
pushed a commit
to timeabarna/nifi
that referenced
this pull request
Jul 21, 2021
- Handling additional FINISHED Handshake Status for TLS 1.3 Post-Handshake Messages per RFC 8446 Section 4.6 - Removed clearing buffers after handshake to avoid losing packets - Updated read() method to check Handshake Status after SSLEngine.unwrap() - Changed SSLSocketChannelSender to close SSLSocketChannel before other resources - Added ChannelStatus enum and convenience logging methods for tracing status - Added unit tests for TLS 1.2 and 1.3 using Netty server and client handlers NIFI-8704 Updated netty-handler to 4.1.65.Final NIFI-7468 Corrected SSLSocketChannel.read() to return byte read NIFI-7468 Adjusted comment formatting Signed-off-by: Nathan Gough <thenatog@gmail.com> This closes apache#5152.
krisztina-zsihovszki
pushed a commit
to krisztina-zsihovszki/nifi
that referenced
this pull request
Jun 28, 2022
- Handling additional FINISHED Handshake Status for TLS 1.3 Post-Handshake Messages per RFC 8446 Section 4.6 - Removed clearing buffers after handshake to avoid losing packets - Updated read() method to check Handshake Status after SSLEngine.unwrap() - Changed SSLSocketChannelSender to close SSLSocketChannel before other resources - Added ChannelStatus enum and convenience logging methods for tracing status - Added unit tests for TLS 1.2 and 1.3 using Netty server and client handlers NIFI-8704 Updated netty-handler to 4.1.65.Final NIFI-7468 Corrected SSLSocketChannel.read() to return byte read NIFI-7468 Adjusted comment formatting Signed-off-by: Nathan Gough <thenatog@gmail.com> This closes apache#5152.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of PR
NIFI-7468 Resolves several issues with
SSLSocketChannelhandshake processing in order to work with TLS 1.3.SSLSocketChannelincludes custom handling ofjavax.net.ssl.SSLEngine, which did not respond properly to Post-Handshake Messages in TLS 1.3, described in RFC 8446 Section 4.6. TheSSLSocketChannel.connect()method was clearing stream and application buffers after completing the TLS handshake, resulting in the loss of Post-Handshake messages as well as network packets. This loss of data resulted in exceptions suchTag mismatchunder both TLS 1.2 and TLS 1.3 when using AES-GCM cipher suites.The
SSLSocketChannelSender.close()method was also closing the connectedSocketChannel, resulting inSSLSocketChannelbeing unable to process TLS close notify messages.NIFI-7468 introduces a private
ChannelStatusenum and convenience logging methods to support detailed logging at theTRACElevel when necessary. Logs and exception messages now include both the remote address and remote port number to improve troubleshooting options.The new
SSLSocketChannelTestleverages a TLS server and client using the Netty framework to verify expected behavior for both TLS 1.2 and 1.3. Unit testing and runtime testing of TLS 1.3 requires either Java 11, or a version of Java 8 with update 272 or higher.These changes address issues with several processors, including as
ListenTCPandPutTCP, as well as Distributed Cache Clients running with TLS.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
squashor use--forcewhen pushing to allow for clean monitoring of changes.For code changes:
mvn -Pcontrib-check clean installat the rootnififolder?LICENSEfile, including the mainLICENSEfile undernifi-assembly?NOTICEfile, including the mainNOTICEfile found undernifi-assembly?.displayNamein addition to .name (programmatic access) for each of the new properties?For documentation related changes:
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.