Add support for re-keying with TLS 1.3
diff --git a/java/org/apache/tomcat/util/net/LocalStrings.properties b/java/org/apache/tomcat/util/net/LocalStrings.properties
index f10dfaf..2cc689c 100644
--- a/java/org/apache/tomcat/util/net/LocalStrings.properties
+++ b/java/org/apache/tomcat/util/net/LocalStrings.properties
@@ -26,6 +26,8 @@
channel.nio.ssl.expandNetOutBuffer=Expanding network output buffer to [{0}] bytes
channel.nio.ssl.foundHttp=Found an plain text HTTP request on what should be an encrypted TLS connection
channel.nio.ssl.handshakeError=Handshake error
+channel.nio.ssl.handshakeWrapPending=There is already handshake data waiting to be wrapped
+channel.nio.ssl.handshakeWrapQueueTooLong=The queue of handshake data to be wrapped has grown too long
channel.nio.ssl.incompleteHandshake=Handshake incomplete, you must complete handshake before reading data.
channel.nio.ssl.invalidCloseState=Invalid close state, will not send network data.
channel.nio.ssl.invalidStatus=Unexpected status [{0}].
diff --git a/java/org/apache/tomcat/util/net/SecureNio2Channel.java b/java/org/apache/tomcat/util/net/SecureNio2Channel.java
index 92b5f3d..7d5df2e 100644
--- a/java/org/apache/tomcat/util/net/SecureNio2Channel.java
+++ b/java/org/apache/tomcat/util/net/SecureNio2Channel.java
@@ -53,10 +53,12 @@
private static final Log log = LogFactory.getLog(SecureNio2Channel.class);
private static final StringManager sm = StringManager.getManager(SecureNio2Channel.class);
- // Value determined by observation of what the SSL Engine requested in
- // various scenarios
+ // Value determined by observation of what the SSL Engine requested in various scenarios
private static final int DEFAULT_NET_BUFFER_SIZE = 16921;
+ // Much longer than it should ever need to be but short enough to trigger connection closure if something goes wrong
+ private static final int HANDSHAKE_WRAP_QUEUE_LENGTH_LIMIT = 100;
+
protected final Nio2Endpoint endpoint;
protected ByteBuffer netInBuffer;
@@ -67,6 +69,7 @@
protected volatile boolean sniComplete = false;
private volatile boolean handshakeComplete = false;
+ private volatile int handshakeWrapQueueLength = 0;
private volatile HandshakeStatus handshakeStatus; //gets set by handshake
protected boolean closed;
@@ -767,6 +770,11 @@
//perform any tasks if needed
if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_TASK) {
tasks();
+ } else if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_WRAP) {
+ if (++handshakeWrapQueueLength > HANDSHAKE_WRAP_QUEUE_LENGTH_LIMIT) {
+ throw new ExecutionException(
+ new IOException(sm.getString("channel.nio.ssl.handshakeWrapQueueTooLong")));
+ }
}
//if we need more network data, then bail out for now.
if (unwrap.getStatus() == Status.BUFFER_UNDERFLOW) {
@@ -897,6 +905,8 @@
if (!netOutBuffer.hasRemaining()) {
netOutBuffer.clear();
SSLEngineResult result = sslEngine.wrap(src, netOutBuffer);
+ // Call to wrap() will have included any required handshake data
+ handshakeWrapQueueLength = 0;
written = result.bytesConsumed();
netOutBuffer.flip();
if (result.getStatus() == Status.OK) {
@@ -962,6 +972,11 @@
//perform any tasks if needed
if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_TASK) {
tasks();
+ } else if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_WRAP) {
+ if (++handshakeWrapQueueLength > HANDSHAKE_WRAP_QUEUE_LENGTH_LIMIT) {
+ throw new ExecutionException(new IOException(
+ sm.getString("channel.nio.ssl.handshakeWrapQueueTooLong")));
+ }
}
//if we need more network data, then bail out for now.
if (unwrap.getStatus() == Status.BUFFER_UNDERFLOW) {
@@ -1075,6 +1090,11 @@
//perform any tasks if needed
if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_TASK) {
tasks();
+ } else if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_WRAP) {
+ if (++handshakeWrapQueueLength > HANDSHAKE_WRAP_QUEUE_LENGTH_LIMIT) {
+ throw new ExecutionException(new IOException(
+ sm.getString("channel.nio.ssl.handshakeWrapQueueTooLong")));
+ }
}
//if we need more network data, then bail out for now.
if (unwrap.getStatus() == Status.BUFFER_UNDERFLOW) {
@@ -1184,6 +1204,8 @@
netOutBuffer.clear();
// Wrap the source data into the internal buffer
SSLEngineResult result = sslEngine.wrap(src, netOutBuffer);
+ // Call to wrap() will have included any required handshake data
+ handshakeWrapQueueLength = 0;
final int written = result.bytesConsumed();
netOutBuffer.flip();
if (result.getStatus() == Status.OK) {
diff --git a/java/org/apache/tomcat/util/net/SecureNioChannel.java b/java/org/apache/tomcat/util/net/SecureNioChannel.java
index 768ec45..1d18fc9 100644
--- a/java/org/apache/tomcat/util/net/SecureNioChannel.java
+++ b/java/org/apache/tomcat/util/net/SecureNioChannel.java
@@ -65,6 +65,7 @@
protected boolean sniComplete = false;
protected boolean handshakeComplete = false;
+ protected boolean needHandshakeWrap = false;
protected HandshakeStatus handshakeStatus; //gets set by handshake
protected boolean closed = false;
@@ -622,6 +623,14 @@
//perform any tasks if needed
if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_TASK) {
tasks();
+ } else if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_WRAP) {
+ if (getOutboundRemaining() == 0) {
+ handshakeWrap(true);
+ } else if (needHandshakeWrap) {
+ throw new IOException(sm.getString("channel.nio.ssl.handshakeWrapPending"));
+ } else {
+ needHandshakeWrap = true;
+ }
}
//if we need more network data, then bail out for now.
if (unwrap.getStatus() == Status.BUFFER_UNDERFLOW) {
@@ -711,6 +720,14 @@
//perform any tasks if needed
if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_TASK) {
tasks();
+ } else if (unwrap.getHandshakeStatus() == HandshakeStatus.NEED_WRAP) {
+ if (getOutboundRemaining() == 0) {
+ handshakeWrap(true);
+ } else if (needHandshakeWrap) {
+ throw new IOException(sm.getString("channel.nio.ssl.handshakeWrapPending"));
+ } else {
+ needHandshakeWrap = true;
+ }
}
//if we need more network data, then bail out for now.
if (unwrap.getStatus() == Status.BUFFER_UNDERFLOW) {
@@ -809,6 +826,8 @@
netOutBuffer.clear();
SSLEngineResult result = sslEngine.wrap(src, netOutBuffer);
+ // Call to wrap() will have included any required handshake data
+ needHandshakeWrap = false;
// The number of bytes written
int written = result.bytesConsumed();
netOutBuffer.flip();
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index de09f33..74e4f09 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -165,6 +165,9 @@
Make counting of active HTTP/2 streams per connection more robust.
(markt)
</fix>
+ <add>
+ Add support for TLS 1.3 client initiated re-keying. (markt)
+ </add>
</changelog>
</subsection>
<subsection name="Jasper">
