Skip to content
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

Set SslContextBuilder.endpointIdentificationAlgorithm for Netty 4.2.x #2985

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Set SslContextBuilder.endpointIdentificationAlgorithm for Netty 4.2.x #2985

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
61 changes: 55 additions & 6 deletions ...tty-internal/src/main/java/io/servicetalk/transport/netty/internal/SslContextFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@
import java.io.InputStream;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
import java.lang.invoke.MethodType;
import java.util.List;
import java.util.function.Supplier;
import javax.annotation.Nullable;
Expand All @@ -51,6 +50,7 @@
import static io.servicetalk.transport.netty.internal.SslUtils.nettyApplicationProtocol;
import static io.servicetalk.transport.netty.internal.SslUtils.toNettySslProvider;
import static io.servicetalk.utils.internal.ThrowableUtils.throwException;
import static java.lang.invoke.MethodType.methodType;

/**
* A factory for creating {@link SslContext}s.
Expand All @@ -63,26 +63,73 @@ public final class SslContextFactory {

@Nullable
private static final MethodHandle SSL_PROVIDER_OPTION_SUPPORTED;
@Nullable
private static final MethodHandle ENDPOINT_IDENTIFICATION_ALGORITHM;

static {
MethodHandle sslProviderOptionSupported;
try {
sslProviderOptionSupported = MethodHandles.publicLookup().findStatic(
SslProvider.class, "isOptionSupported",
MethodType.methodType(boolean.class, SslProvider.class, SslContextOption.class));
// Find a new method that exists only in Netty starting from 4.1.88.Final:
sslProviderOptionSupported = MethodHandles.publicLookup().findStatic(SslProvider.class, "isOptionSupported",
methodType(boolean.class, SslProvider.class, SslContextOption.class));
// Verify the method is working as expected:
isOptionSupported(sslProviderOptionSupported,
SslContext.defaultClientProvider(), OpenSslContextOption.CERTIFICATE_COMPRESSION_ALGORITHMS);
} catch (Throwable cause) {
LOGGER.debug("SSLProvider#isOptionSupported(SslProvider, SslContextOption) is available only " +
"starting from Netty 4.1.88.Final. Detected Netty version: {}",
SslProvider.class.getPackage().getImplementationVersion(), cause);
sslProviderOptionSupported = null;
}
SSL_PROVIDER_OPTION_SUPPORTED = sslProviderOptionSupported;

MethodHandle endpointIdentificationAlgorithm;
try {
// Find a new method that exists only in Netty starting from 4.2.0.Final:
endpointIdentificationAlgorithm = MethodHandles.publicLookup().findVirtual(SslContextBuilder.class,
"endpointIdentificationAlgorithm", methodType(SslContextBuilder.class, String.class));
// Verify the method is working as expected:
setEndpointIdentificationAlgorithm(endpointIdentificationAlgorithm,
SslContextBuilder.forClient(), "HTTPS");
} catch (Throwable cause) {
LOGGER.debug("SslContextBuilder#endpointIdentificationAlgorithm(String) is available only " +
"starting from Netty 4.2.0.Final. Detected Netty version: {}",
SslContextBuilder.class.getPackage().getImplementationVersion(), cause);
endpointIdentificationAlgorithm = null;
}
ENDPOINT_IDENTIFICATION_ALGORITHM = endpointIdentificationAlgorithm;
}

private SslContextFactory() {
// No instances.
}

private static boolean isOptionSupported(final MethodHandle isOptionSupportedMethod,
final SslProvider sslProvider, final SslContextOption<?> option) {
try {
// invokeExact requires return type cast to match the type signature
return (boolean) isOptionSupportedMethod.invokeExact(sslProvider, option);
} catch (Throwable t) {
throwException(t);
return false; // fool compiler
}
}

private static SslContextBuilder setEndpointIdentificationAlgorithm(@Nullable final MethodHandle methodHandle,
final SslContextBuilder builderInstance,
@Nullable final String algorithm) {
if (methodHandle == null) {
return builderInstance;
}
try {
// invokeExact requires return type cast to match the type signature
return (SslContextBuilder) methodHandle.invokeExact(builderInstance, algorithm == null ? "" : algorithm);
} catch (Throwable t) {
throwException(t);
return builderInstance;
}
}

/**
* A new context for a client using the passed {@code config}.
*
Expand All @@ -91,6 +138,8 @@ private SslContextFactory() {
*/
public static SslContext forClient(ClientSslConfig config) {
final SslContextBuilder builder = SslContextBuilder.forClient();
setEndpointIdentificationAlgorithm(ENDPOINT_IDENTIFICATION_ALGORITHM, builder,
config.hostnameVerificationAlgorithm());
KeyManagerFactory keyManagerFactory = config.keyManagerFactory();
if (keyManagerFactory != null) {
builder.keyManager(keyManagerFactory);
Expand Down Expand Up @@ -200,8 +249,8 @@ private static void configureCertificateCompression(SslConfig config, SslContext
// If the newer SSL_PROVIDER_OPTION_SUPPORTED is available through the MethodHandle, use this option
// to check since it more targeted/narrow to what we need.
if (SSL_PROVIDER_OPTION_SUPPORTED != null) {
if (!((boolean) SSL_PROVIDER_OPTION_SUPPORTED.invokeExact(nettySslProvider,
(SslContextOption<?>) OpenSslContextOption.CERTIFICATE_COMPRESSION_ALGORITHMS))) {
if (!isOptionSupported(SSL_PROVIDER_OPTION_SUPPORTED,
nettySslProvider, OpenSslContextOption.CERTIFICATE_COMPRESSION_ALGORITHMS)) {
return;
}
// Otherwise fall-back to just checking if OpenSSL is used which is good enough as a fallback.
Expand Down
Loading