Skip to content

SSLSocket related improvements #351

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.

Sign up for GitHub

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

Open
kares wants to merge 4 commits into
base: master
Choose a base branch
from
Open

SSLSocket related improvements #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0d5a194
[fix] read_nonblock(exception: false) throwing on TLS 1.3
kares Mar 26, 2026
08c2017
[refactor] avoid wasted iteration on TLS 1.3 post-handshake
kares Mar 26, 2026
02ce78d
[test] buffered I/O tests for TLS 1.3 and TLS 1.2 SSL read paths
kares Mar 26, 2026
61760b6
[fix] SSL write data loss on non-blocking partial flush (#242)
kares Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 66 additions & 21 deletions src/main/java/org/jruby/ext/openssl/SSLSocket.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,8 +539,18 @@ public void wakeup() {
}
}

private static final int READ_WOULD_BLOCK_RESULT = Integer.MIN_VALUE + 1;
private static final int WRITE_WOULD_BLOCK_RESULT = Integer.MIN_VALUE + 2;
// Legitimate return values are -1 (EOF) and >= 0 (byte counts), so any value < -1 is safely in sentinel territory.
private static final int READ_WOULD_BLOCK_RESULT = -2;
private static final int WRITE_WOULD_BLOCK_RESULT = -3;

private static boolean isWouldBlockResult(final int result) {
return result < -1;
}

private RubySymbol wouldBlockSymbol(final int result) {
assert isWouldBlockResult(result) : "unexpected result: " + result;
return getRuntime().newSymbol(result == READ_WOULD_BLOCK_RESULT ? "wait_readable" : "wait_writable");
}

private static void readWouldBlock(final Ruby runtime, final boolean exception, final int[] result) {
if ( exception ) throw newSSLErrorWaitReadable(runtime, "read would block");
Expand All @@ -552,10 +562,6 @@ private static void writeWouldBlock(final Ruby runtime, final boolean exception,
result[0] = WRITE_WOULD_BLOCK_RESULT;
}

private void doHandshake(final boolean blocking) throws IOException {
doHandshake(blocking, true);
}

// might return :wait_readable | :wait_writable in case (true, false)
private IRubyObject doHandshake(final boolean blocking, final boolean exception) throws IOException {
while (true) {
Expand All @@ -577,7 +583,11 @@ private IRubyObject doHandshake(final boolean blocking, final boolean exception)
doTasks();
break;
case NEED_UNWRAP:
if (readAndUnwrap(blocking) == -1 && handshakeStatus != SSLEngineResult.HandshakeStatus.FINISHED) {
int unwrapResult = readAndUnwrap(blocking, exception);
if (isWouldBlockResult(unwrapResult)) {
return wouldBlockSymbol(unwrapResult);
}
if (unwrapResult == -1 && handshakeStatus != SSLEngineResult.HandshakeStatus.FINISHED) {
throw new SSLHandshakeException("Socket closed");
}
// during initialHandshake, calling readAndUnwrap that results UNDERFLOW does not mean writable.
Expand Down Expand Up @@ -688,7 +698,9 @@ public int write(ByteBuffer src, boolean blocking) throws SSLException, IOExcept
if ( netWriteData.hasRemaining() ) {
flushData(blocking);
}
netWriteData.clear();
// use compact() to preserve any encrypted bytes that flushData could not send (non-blocking partial write)
// clear() would discard them, corrupting the TLS record stream:
netWriteData.compact();
final SSLEngineResult result = engine.wrap(src, netWriteData);
if ( result.getStatus() == SSLEngineResult.Status.CLOSED ) {
throw getRuntime().newIOError("closed SSL engine");
Expand All @@ -703,12 +715,16 @@ public int write(ByteBuffer src, boolean blocking) throws SSLException, IOExcept
}

public int read(final ByteBuffer dst, final boolean blocking) throws IOException {
return read(dst, blocking, true);
}

private int read(final ByteBuffer dst, final boolean blocking, final boolean exception) throws IOException {
if ( initialHandshake ) return 0;
if ( engine.isInboundDone() ) return -1;

if ( ! appReadData.hasRemaining() ) {
int appBytesProduced = readAndUnwrap(blocking);
if (appBytesProduced == -1 || appBytesProduced == 0) {
final int appBytesProduced = readAndUnwrap(blocking, exception);
if (appBytesProduced == -1 || appBytesProduced == 0 || isWouldBlockResult(appBytesProduced)) {
return appBytesProduced;
}
}
Expand All @@ -718,7 +734,15 @@ public int read(final ByteBuffer dst, final boolean blocking) throws IOException
return limit;
}

private int readAndUnwrap(final boolean blocking) throws IOException {
/**
* @param blocking whether to block on I/O
* @param exception when false, returns {@link #READ_WOULD_BLOCK_RESULT} or
* {@link #WRITE_WOULD_BLOCK_RESULT} instead of throwing if the
* post-handshake processing would block
* @return application bytes available, -1 on EOF/close, 0 when no app data
* produced, or a WOULD_BLOCK sentinel when would-block with exception=false
*/
private int readAndUnwrap(final boolean blocking, final boolean exception) throws IOException {
final int bytesRead = socketChannelImpl().read(netReadData);
if ( bytesRead == -1 ) {
if ( ! netReadData.hasRemaining() ||
Expand Down Expand Up @@ -767,7 +791,11 @@ private int readAndUnwrap(final boolean blocking) throws IOException {
handshakeStatus == SSLEngineResult.HandshakeStatus.NEED_TASK ||
handshakeStatus == SSLEngineResult.HandshakeStatus.NEED_WRAP ||
handshakeStatus == SSLEngineResult.HandshakeStatus.FINISHED ) ) {
doHandshake(blocking);
IRubyObject ex = doHandshake(blocking, exception);
if ( ex != null ) { // :wait_readable | :wait_writable
// TODO needs refactoring to avoid Symbol -> int -> Symbol
return "wait_writable".equals(ex.asJavaString()) ? WRITE_WOULD_BLOCK_RESULT : READ_WOULD_BLOCK_RESULT;
}
}
return appReadData.remaining();
}
Expand Down Expand Up @@ -830,6 +858,14 @@ private IRubyObject sysreadImpl(final ThreadContext context, final IRubyObject l
}

try {
// Flush any pending encrypted write data before reading.
// After write_nonblock, encrypted bytes may remain in netWriteData that haven't been sent to the server.
// If we read without flushing, the server may not have received the complete request
// (e.g. net/http POST body) and will not send a response.
if ( engine != null && netWriteData.hasRemaining() ) {
flushData(blocking);
}

// So we need to make sure to only block when there is no data left to process
if ( engine == null || ! ( appReadData.hasRemaining() || netReadData.position() > 0 ) ) {
final Object ex = waitSelect(SelectionKey.OP_READ, blocking, exception);
Expand All @@ -843,19 +879,28 @@ private IRubyObject sysreadImpl(final ThreadContext context, final IRubyObject l
if ( engine == null ) {
read = socketChannelImpl().read(dst);
} else {
read = read(dst, blocking);
read = read(dst, blocking, exception);
}

if ( read == -1 ) {
if ( exception ) throw runtime.newEOFError();
return context.nil;
switch ( read ) {
case -1 :
if ( exception ) throw runtime.newEOFError();
return context.nil;
// Post-handshake processing (e.g. TLS 1.3 NewSessionTicket) signaled would-block
case READ_WOULD_BLOCK_RESULT :
return runtime.newSymbol("wait_readable");
case WRITE_WOULD_BLOCK_RESULT :
return runtime.newSymbol("wait_writable");
}

if ( read == 0 && status == SSLEngineResult.Status.BUFFER_UNDERFLOW ) {
// If we didn't get any data back because we only read in a partial TLS record,
// instead of spinning until the rest comes in, call waitSelect to either block
// until the rest is available, or throw a "read would block" error if we are in
// non-blocking mode.
if ( read == 0 && netReadData.position() == 0 ) {
// If we didn't get any data back and there is no buffered network data left to process,
// wait for more data from the network instead of spinning until it arrives.
// In blocking mode this blocks; in non-blocking mode it raises/returns "read would block".
//
// We check netReadData.position() rather than status == BUFFER_UNDERFLOW because readAndUnwrap
// may have successfully consumed a non-application record (e.g. a TLS 1.3 NewSessionTicket)
// leaving status == OK with zero app bytes produced and nothing left in the network buffer.
final Object ex = waitSelect(SelectionKey.OP_READ, blocking, exception);
if ( ex instanceof IRubyObject ) return (IRubyObject) ex; // :wait_readable
}
Expand Down
Loading
Loading