From 8a587d1d12f709dd509e5800e340cccc30f3342c Mon Sep 17 00:00:00 2001 From: Jon Chambers Date: Tue, 26 Mar 2024 16:52:43 -0400 Subject: [PATCH] Rename `NoiseStreamHandler` to `NoiseTransportHandler` for consistency with Noise specification terminology --- .../grpc/net/NoiseNXHandshakeHandler.java | 2 +- ...eamHandler.java => NoiseTransportHandler.java} | 8 ++++---- .../grpc/net/NoiseXXHandshakeHandler.java | 2 +- .../grpc/net/NoiseNXClientHandshakeHandler.java | 2 +- .../grpc/net/NoiseNXHandshakeHandlerTest.java | 2 +- ...erTest.java => NoiseTransportHandlerTest.java} | 4 ++-- .../grpc/net/NoiseXXClientHandshakeHandler.java | 2 +- .../grpc/net/NoiseXXHandshakeHandlerTest.java | 15 +++++++-------- 8 files changed, 18 insertions(+), 19 deletions(-) rename service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/{NoiseStreamHandler.java => NoiseTransportHandler.java} (94%) rename service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/{NoiseStreamHandlerTest.java => NoiseTransportHandlerTest.java} (97%) diff --git a/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXHandshakeHandler.java b/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXHandshakeHandler.java index 8cddd32cf..f59bdcd45 100644 --- a/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXHandshakeHandler.java +++ b/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXHandshakeHandler.java @@ -29,7 +29,7 @@ class NoiseNXHandshakeHandler extends AbstractNoiseHandshakeHandler { // All we need to do is accept the client's ephemeral key and send our own static keys; after that, we can consider // the handshake complete context.fireUserEventTriggered(new NoiseHandshakeCompleteEvent(Optional.empty())); - context.pipeline().replace(NoiseNXHandshakeHandler.this, null, new NoiseStreamHandler(getHandshakeState().split())); + context.pipeline().replace(NoiseNXHandshakeHandler.this, null, new NoiseTransportHandler(getHandshakeState().split())); } else { // Anything except binary WebSocket frames should have been filtered out of the pipeline by now; treat this as an // error diff --git a/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseStreamHandler.java b/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseTransportHandler.java similarity index 94% rename from service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseStreamHandler.java rename to service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseTransportHandler.java index b2776b2cc..dff884046 100644 --- a/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseStreamHandler.java +++ b/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseTransportHandler.java @@ -17,15 +17,15 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * A Noise stream handler manages a bidirectional Noise session after a handshake has completed. + * A Noise transport handler manages a bidirectional Noise session after a handshake has completed. */ -class NoiseStreamHandler extends ChannelDuplexHandler { +class NoiseTransportHandler extends ChannelDuplexHandler { private final CipherStatePair cipherStatePair; - private static final Logger log = LoggerFactory.getLogger(NoiseStreamHandler.class); + private static final Logger log = LoggerFactory.getLogger(NoiseTransportHandler.class); - NoiseStreamHandler(CipherStatePair cipherStatePair) { + NoiseTransportHandler(CipherStatePair cipherStatePair) { this.cipherStatePair = cipherStatePair; } diff --git a/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXHandshakeHandler.java b/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXHandshakeHandler.java index 2ebc9ea85..c8a944791 100644 --- a/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXHandshakeHandler.java +++ b/service/src/main/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXHandshakeHandler.java @@ -147,7 +147,7 @@ class NoiseXXHandshakeHandler extends AbstractNoiseHandshakeHandler { context.fireUserEventTriggered(new NoiseHandshakeCompleteEvent( Optional.of(new AuthenticatedDevice(accountIdentifier, deviceId)))); - context.pipeline().addAfter(context.name(), null, new NoiseStreamHandler(handshakeState.split())); + context.pipeline().addAfter(context.name(), null, new NoiseTransportHandler(handshakeState.split())); // Flush any buffered reads pendingInboundFrames.forEach(context::fireChannelRead); diff --git a/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXClientHandshakeHandler.java b/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXClientHandshakeHandler.java index fc8b68e85..8e39de99d 100644 --- a/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXClientHandshakeHandler.java +++ b/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXClientHandshakeHandler.java @@ -35,7 +35,7 @@ class NoiseNXClientHandshakeHandler extends AbstractNoiseClientHandler { receivedServerStaticKeyMessage = true; handleServerStaticKeyMessage(context, frame); - context.pipeline().replace(this, null, new NoiseStreamHandler(getHandshakeState().split())); + context.pipeline().replace(this, null, new NoiseTransportHandler(getHandshakeState().split())); context.fireUserEventTriggered(new NoiseHandshakeCompleteEvent(Optional.empty())); } finally { frame.release(); diff --git a/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXHandshakeHandlerTest.java b/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXHandshakeHandlerTest.java index 8ceb485e7..53760e265 100644 --- a/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXHandshakeHandlerTest.java +++ b/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseNXHandshakeHandlerTest.java @@ -78,7 +78,7 @@ class NoiseNXHandshakeHandlerTest extends AbstractNoiseHandshakeHandlerTest { assertNull(embeddedChannel.pipeline().get(NoiseNXHandshakeHandler.class), "Handshake handler should remove self from pipeline after successful handshake"); - assertNotNull(embeddedChannel.pipeline().get(NoiseStreamHandler.class), + assertNotNull(embeddedChannel.pipeline().get(NoiseTransportHandler.class), "Handshake handler should insert a Noise stream handler after successful handshake"); } } diff --git a/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseStreamHandlerTest.java b/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseTransportHandlerTest.java similarity index 97% rename from service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseStreamHandlerTest.java rename to service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseTransportHandlerTest.java index 749818d99..08d290702 100644 --- a/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseStreamHandlerTest.java +++ b/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseTransportHandlerTest.java @@ -21,7 +21,7 @@ import java.security.NoSuchAlgorithmException; import static org.junit.jupiter.api.Assertions.*; -class NoiseStreamHandlerTest extends AbstractLeakDetectionTest { +class NoiseTransportHandlerTest extends AbstractLeakDetectionTest { private CipherStatePair clientCipherStatePair; private EmbeddedChannel embeddedChannel; @@ -51,7 +51,7 @@ class NoiseStreamHandlerTest extends AbstractLeakDetectionTest { clientHandshakeState.readMessage(serverEphemeralKeyMessage, 0, serverEphemeralKeyMessage.length, EmptyArrays.EMPTY_BYTES, 0); clientCipherStatePair = clientHandshakeState.split(); - embeddedChannel = new EmbeddedChannel(new NoiseStreamHandler(serverHandshakeState.split())); + embeddedChannel = new EmbeddedChannel(new NoiseTransportHandler(serverHandshakeState.split())); clientHandshakeState.destroy(); serverHandshakeState.destroy(); diff --git a/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXClientHandshakeHandler.java b/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXClientHandshakeHandler.java index 1966cee12..7b8dab92e 100644 --- a/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXClientHandshakeHandler.java +++ b/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXClientHandshakeHandler.java @@ -77,7 +77,7 @@ class NoiseXXClientHandshakeHandler extends AbstractNoiseClientHandler { context.writeAndFlush(new BinaryWebSocketFrame(Unpooled.wrappedBuffer(staticKeyAndIdentityMessage))) .addListener(ChannelFutureListener.FIRE_EXCEPTION_ON_FAILURE); - context.pipeline().replace(this, null, new NoiseStreamHandler(handshakeState.split())); + context.pipeline().replace(this, null, new NoiseTransportHandler(handshakeState.split())); context.fireUserEventTriggered(new NoiseHandshakeCompleteEvent(Optional.empty())); } finally { frame.release(); diff --git a/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXHandshakeHandlerTest.java b/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXHandshakeHandlerTest.java index 239762aa5..6718b3532 100644 --- a/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXHandshakeHandlerTest.java +++ b/service/src/test/java/org/whispersystems/textsecuregcm/grpc/net/NoiseXXHandshakeHandlerTest.java @@ -25,7 +25,6 @@ import java.util.concurrent.CompletableFuture; import java.util.concurrent.ThreadLocalRandom; import javax.crypto.BadPaddingException; import javax.crypto.ShortBufferException; -import io.netty.util.ReferenceCountUtil; import io.netty.util.internal.EmptyArrays; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -84,7 +83,7 @@ class NoiseXXHandshakeHandlerTest extends AbstractNoiseHandshakeHandlerTest { assertNull(embeddedChannel.pipeline().get(NoiseXXHandshakeHandler.class), "Handshake handler should remove self from pipeline after successful handshake"); - assertNotNull(embeddedChannel.pipeline().get(NoiseStreamHandler.class), + assertNotNull(embeddedChannel.pipeline().get(NoiseTransportHandler.class), "Handshake handler should insert a Noise stream handler after successful handshake"); } @@ -133,7 +132,7 @@ class NoiseXXHandshakeHandlerTest extends AbstractNoiseHandshakeHandlerTest { assertNotNull(embeddedChannel.pipeline().get(NoiseXXHandshakeHandler.class), "Handshake handler should not remove self from pipeline after failed handshake"); - assertNull(embeddedChannel.pipeline().get(NoiseStreamHandler.class), + assertNull(embeddedChannel.pipeline().get(NoiseTransportHandler.class), "Noise stream handler should not be added to pipeline after failed handshake"); } @@ -182,7 +181,7 @@ class NoiseXXHandshakeHandlerTest extends AbstractNoiseHandshakeHandlerTest { assertNotNull(embeddedChannel.pipeline().get(NoiseXXHandshakeHandler.class), "Handshake handler should not remove self from pipeline after failed handshake"); - assertNull(embeddedChannel.pipeline().get(NoiseStreamHandler.class), + assertNull(embeddedChannel.pipeline().get(NoiseTransportHandler.class), "Noise stream handler should not be added to pipeline after failed handshake"); } @@ -216,7 +215,7 @@ class NoiseXXHandshakeHandlerTest extends AbstractNoiseHandshakeHandlerTest { assertNotNull(embeddedChannel.pipeline().get(NoiseXXHandshakeHandler.class), "Handshake handler should not remove self from pipeline after failed handshake"); - assertNull(embeddedChannel.pipeline().get(NoiseStreamHandler.class), + assertNull(embeddedChannel.pipeline().get(NoiseTransportHandler.class), "Noise stream handler should not be added to pipeline after failed handshake"); } @@ -250,7 +249,7 @@ class NoiseXXHandshakeHandlerTest extends AbstractNoiseHandshakeHandlerTest { assertNotNull(embeddedChannel.pipeline().get(NoiseXXHandshakeHandler.class), "Handshake handler should not remove self from pipeline after failed handshake"); - assertNull(embeddedChannel.pipeline().get(NoiseStreamHandler.class), + assertNull(embeddedChannel.pipeline().get(NoiseTransportHandler.class), "Noise stream handler should not be added to pipeline after failed handshake"); } @@ -306,7 +305,7 @@ class NoiseXXHandshakeHandlerTest extends AbstractNoiseHandshakeHandlerTest { assertNull(embeddedChannel.pipeline().get(NoiseXXHandshakeHandler.class), "Handshake handler should remove self from pipeline after successful handshake"); - assertNotNull(embeddedChannel.pipeline().get(NoiseStreamHandler.class), + assertNotNull(embeddedChannel.pipeline().get(NoiseTransportHandler.class), "Handshake handler should insert a Noise stream handler after successful handshake"); for (final ByteBuf additionalMessage : additionalMessages) { @@ -369,7 +368,7 @@ class NoiseXXHandshakeHandlerTest extends AbstractNoiseHandshakeHandlerTest { assertNotNull(embeddedChannel.pipeline().get(NoiseXXHandshakeHandler.class), "Handshake handler should not remove self from pipeline after failed handshake"); - assertNull(embeddedChannel.pipeline().get(NoiseStreamHandler.class), + assertNull(embeddedChannel.pipeline().get(NoiseTransportHandler.class), "Noise stream handler should not be added to pipeline after failed handshake"); assertTrue(embeddedChannel.inboundMessages().isEmpty(),