You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2022/03/04 19:07:50 UTC

[GitHub] [nifi] exceptionfactory opened a new pull request #5836: NIFI-9761 Correct PeerChannel processing for TLS 1.3

exceptionfactory opened a new pull request #5836:
URL: https://github.com/apache/nifi/pull/5836


   #### Description of PR
   
   NIFI-9761 Corrects `PeerChannel` handling of TLS 1.3 post-handshake messages, avoiding unexpected behavior when attempting to read from the underlying `SocketChannel` after previous calls have already put data in the stream buffer. This resolves a latent issue with Load-Balanced Connections and TLS 1.3 communication.
   
   The new `TestPeerChannel` leverages a simple socket server based on Netty to confirm expected behavior for both TLS 1.2 and TLS 1.3.
   
   In order to streamline the review of the contribution we ask you
   to ensure the following steps have been taken:
   
   ### For all changes:
   - [X] Is there a JIRA ticket associated with this PR? Is it referenced 
        in the commit message?
   
   - [X] 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.
   
   - [X] Has your PR been rebased against the latest commit within the target branch (typically `main`)?
   
   - [X] 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?
   - [X] 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](http://www.apache.org/legal/resolved.html#category-a)?
   - [ ] 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.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [nifi] exceptionfactory commented on a change in pull request #5836: NIFI-9761 Correct PeerChannel processing for TLS 1.3

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on a change in pull request #5836:
URL: https://github.com/apache/nifi/pull/5836#discussion_r822838085



##########
File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/queue/clustered/client/async/nio/PeerChannel.java
##########
@@ -50,7 +55,37 @@ public PeerChannel(final SocketChannel socketChannel, final SSLEngine sslEngine,
 
     @Override
     public void close() throws IOException {
-        socketChannel.close();
+        try {
+            if (sslEngine == null) {
+                logger.debug("Closing Peer Channel [{}] SSLEngine not configured", peerDescription);
+            } else {
+                logger.debug("Closing Peer Channel [{}] SSLEngine close started", peerDescription);
+                sslEngine.closeOutbound();

Review comment:
       Thanks for the feedback, I can add a comment below mentioning that writing the close notification to the socket channel is required after closing the SSLEngine.

##########
File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/queue/clustered/client/async/nio/PeerChannel.java
##########
@@ -79,9 +114,9 @@ public OptionalInt read() throws IOException {
         singleByteBuffer.clear();
         final int bytesRead = read(singleByteBuffer);
         if (bytesRead < 0) {
-             return OptionalInt.of(-1);
+             return OptionalInt.of(END_OF_FILE);
         }
-        if (bytesRead == 0) {
+        if (bytesRead == EMPTY_BUFFER) {

Review comment:
       This change was just for variable reuse, but that seems like a reasonable improvement.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [nifi] joewitt commented on pull request #5836: NIFI-9761 Correct PeerChannel processing for TLS 1.3

Posted by GitBox <gi...@apache.org>.
joewitt commented on pull request #5836:
URL: https://github.com/apache/nifi/pull/5836#issuecomment-1059447362


   such a great find/fix.  


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [nifi] greyp9 commented on a change in pull request #5836: NIFI-9761 Correct PeerChannel processing for TLS 1.3

Posted by GitBox <gi...@apache.org>.
greyp9 commented on a change in pull request #5836:
URL: https://github.com/apache/nifi/pull/5836#discussion_r822805247



##########
File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/queue/clustered/client/async/nio/PeerChannel.java
##########
@@ -79,9 +114,9 @@ public OptionalInt read() throws IOException {
         singleByteBuffer.clear();
         final int bytesRead = read(singleByteBuffer);
         if (bytesRead < 0) {
-             return OptionalInt.of(-1);
+             return OptionalInt.of(END_OF_FILE);
         }
-        if (bytesRead == 0) {
+        if (bytesRead == EMPTY_BUFFER) {

Review comment:
       Maybe a chained `else if` here?

##########
File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/queue/clustered/client/async/nio/PeerChannel.java
##########
@@ -50,7 +55,37 @@ public PeerChannel(final SocketChannel socketChannel, final SSLEngine sslEngine,
 
     @Override
     public void close() throws IOException {
-        socketChannel.close();
+        try {
+            if (sslEngine == null) {
+                logger.debug("Closing Peer Channel [{}] SSLEngine not configured", peerDescription);
+            } else {
+                logger.debug("Closing Peer Channel [{}] SSLEngine close started", peerDescription);
+                sslEngine.closeOutbound();

Review comment:
       The write after the `closeOutbound()` is not intuitive.  Maybe a comment explaining the needed sequence of actions?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [nifi] exceptionfactory commented on pull request #5836: NIFI-9761 Correct PeerChannel processing for TLS 1.3

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on pull request #5836:
URL: https://github.com/apache/nifi/pull/5836#issuecomment-1062417534


   Further testing with the `LoadBalanceIT` in `nifi-system-test-suite` uncovered an issue with an unnecessary call to `streamBuffer.compact()`, as well as missing `SSLEngine` close notification processing.  The current version includes additional trace logging.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [nifi] markap14 commented on pull request #5836: NIFI-9761 Correct PeerChannel processing for TLS 1.3

Posted by GitBox <gi...@apache.org>.
markap14 commented on pull request #5836:
URL: https://github.com/apache/nifi/pull/5836#issuecomment-1063324555


   That's a great catch @exceptionfactory , thanks for finding & fixing that! I'm a +1 will merge


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [nifi] markap14 merged pull request #5836: NIFI-9761 Correct PeerChannel processing for TLS 1.3

Posted by GitBox <gi...@apache.org>.
markap14 merged pull request #5836:
URL: https://github.com/apache/nifi/pull/5836


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org