Skip to content

ZOOKEEPER-4940: Enabling zookeeper.ssl.ocsp with JRE TLS provider errors out #2270

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

Merged
merged 7 commits into from
Jul 18, 2025
Merged

ZOOKEEPER-4940: Enabling zookeeper.ssl.ocsp with JRE TLS provider errors out #2270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
671ecb7
ZOOKEEPER-4940: Enabling zookeeper.ssl.ocsp with JRE TLS provider err…
stoty Jun 18, 2025
098e7c5
add docs
stoty Jul 7, 2025
964f353
rename property
stoty Jul 8, 2025
3af6fda
factor out the stapling handling code to a new method
stoty Jul 17, 2025
ab1065a
rearrange code to make patch smaller
stoty Jul 17, 2025
e2504e1
add comment for clarification
stoty Jul 17, 2025
f417041
remove new property
stoty Jul 18, 2025
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
16 changes: 14 additions & 2 deletions zookeeper-server/src/main/java/org/apache/zookeeper/common/ClientX509Util.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
package org.apache.zookeeper.common;

import io.netty.handler.ssl.DelegatingSslContext;
import io.netty.handler.ssl.OpenSsl;
import io.netty.handler.ssl.SslContext;
import io.netty.handler.ssl.SslContextBuilder;
import io.netty.handler.ssl.SslProvider;
Expand Down Expand Up @@ -79,7 +80,7 @@ public SslContext createNettySslContextForClient(ZKConfig config)
sslContextBuilder.trustManager(tm);
}

sslContextBuilder.enableOcsp(config.getBoolean(getSslOcspEnabledProperty()));
handleTcnativeOcspStapling(sslContextBuilder, config);
String[] enabledProtocols = getEnabledProtocols(config);
if (enabledProtocols != null) {
sslContextBuilder.protocols(enabledProtocols);
Expand Down Expand Up @@ -123,7 +124,7 @@ public SslContext createNettySslContextForServer(ZKConfig config, KeyManager key
sslContextBuilder.trustManager(trustManager);
}

sslContextBuilder.enableOcsp(config.getBoolean(getSslOcspEnabledProperty()));
handleTcnativeOcspStapling(sslContextBuilder, config);
String[] enabledProtocols = getEnabledProtocols(config);
if (enabledProtocols != null) {
sslContextBuilder.protocols(enabledProtocols);
Expand All @@ -144,6 +145,17 @@ public SslContext createNettySslContextForServer(ZKConfig config, KeyManager key
}
}

private SslContextBuilder handleTcnativeOcspStapling(SslContextBuilder builder, ZKConfig config) {
SslProvider sslProvider = getSslProvider(config);
boolean tcnative = sslProvider == SslProvider.OPENSSL || sslProvider == SslProvider.OPENSSL_REFCNT;
boolean ocspEnabled = config.getBoolean(getSslOcspEnabledProperty());

if (tcnative && ocspEnabled && OpenSsl.isOcspSupported()) {
builder.enableOcsp(ocspEnabled);
}
return builder;
}

private SslContext addHostnameVerification(SslContext sslContext, String clientOrServer) {
return new DelegatingSslContext(sslContext) {
@Override
Expand Down
14 changes: 14 additions & 0 deletions zookeeper-server/src/test/java/org/apache/zookeeper/common/X509UtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -740,6 +740,20 @@ public void testCreateSSLContext_validCustomSSLContextClass(
assertEquals(SSLContext.getDefault(), sslContext);
}

@ParameterizedTest
@MethodSource("data")
public void testCreateSSLContext_ocspWithJreProvider(
X509KeyType caKeyType, X509KeyType certKeyType, String keyPassword, Integer paramIndex)
throws Exception {
init(caKeyType, certKeyType, keyPassword, paramIndex);
ZKConfig zkConfig = new ZKConfig();
try (ClientX509Util clientX509Util = new ClientX509Util();) {
zkConfig.setProperty(clientX509Util.getSslOcspEnabledProperty(), "true");
// Must not throw IllegalArgumentException
clientX509Util.createSSLContext(zkConfig);
}
}

private static void forceClose(Socket s) {
if (s == null || s.isClosed()) {
return;
Expand Down