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

[Backport] [2.x] Refactor SSL handler retrieval to use HttpChannel / TranportChannel APIs instead of typecasting (#3917) #3922

Merged
merged 1 commit into from
Jan 5, 2024
Merged

[Backport] [2.x] Refactor SSL handler retrieval to use HttpChannel / TranportChannel APIs instead of typecasting (#3917) #3922

Show file tree
Hide file tree
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
17 changes: 9 additions & 8 deletions src/main/java/org/opensearch/security/filter/NettyAttribute.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import java.util.Optional;

import org.opensearch.http.netty4.Netty4HttpChannel;
import org.opensearch.http.HttpChannel;
import org.opensearch.rest.RestRequest;

import io.netty.channel.Channel;
Expand All @@ -15,11 +15,12 @@ public class NettyAttribute {
* Gets an attribute value from the request context and clears it from that context
*/
public static <T> Optional<T> popFrom(final RestRequest request, final AttributeKey<T> attribute) {
if (request.getHttpChannel() instanceof Netty4HttpChannel) {
Channel nettyChannel = ((Netty4HttpChannel) request.getHttpChannel()).getNettyChannel();
return Optional.ofNullable(nettyChannel.attr(attribute).getAndSet(null));
final HttpChannel httpChannel = request.getHttpChannel();
if (httpChannel != null) {
return httpChannel.get("channel", Channel.class).map(channel -> channel.attr(attribute).getAndSet(null));
} else {
return Optional.empty();
}
return Optional.empty();
}

/**
Expand All @@ -40,9 +41,9 @@ public static <T> Optional<T> peekFrom(final ChannelHandlerContext ctx, final At
* Clears an attribute value from the channel handler context
*/
public static <T> void clearAttribute(final RestRequest request, final AttributeKey<T> attribute) {
if (request.getHttpChannel() instanceof Netty4HttpChannel) {
Channel nettyChannel = ((Netty4HttpChannel) request.getHttpChannel()).getNettyChannel();
nettyChannel.attr(attribute).set(null);
final HttpChannel httpChannel = request.getHttpChannel();
if (httpChannel != null) {
httpChannel.get("channel", Channel.class).ifPresent(channel -> channel.attr(attribute).set(null));
}
}

Expand Down
9 changes: 2 additions & 7 deletions src/main/java/org/opensearch/security/filter/OpenSearchRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
import java.util.Optional;
import javax.net.ssl.SSLEngine;

import org.opensearch.http.netty4.Netty4HttpChannel;
import org.opensearch.rest.RestRequest;
import org.opensearch.rest.RestRequest.Method;

Expand All @@ -41,17 +40,13 @@ public Map<String, List<String>> getHeaders() {

@Override
public SSLEngine getSSLEngine() {
if (underlyingRequest == null
|| underlyingRequest.getHttpChannel() == null
|| !(underlyingRequest.getHttpChannel() instanceof Netty4HttpChannel)) {
if (underlyingRequest == null || underlyingRequest.getHttpChannel() == null) {
return null;
}

// We look for Ssl_handler called `ssl_http` in the outbound pipeline of Netty channel first, and if its not
// present we look for it in inbound channel. If its present in neither we return null, else we return the sslHandler.
final Netty4HttpChannel httpChannel = (Netty4HttpChannel) underlyingRequest.getHttpChannel();
SslHandler sslhandler = (SslHandler) httpChannel.getNettyChannel().pipeline().get("ssl_http");
return sslhandler != null ? sslhandler.engine() : null;
return underlyingRequest.getHttpChannel().get("ssl_http", SslHandler.class).map(SslHandler::engine).orElse(null);
}

@Override
Expand Down
20 changes: 1 addition & 19 deletions src/main/java/org/opensearch/security/ssl/transport/SecuritySSLRequestHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,9 @@
import org.opensearch.security.support.ConfigConstants;
import org.opensearch.tasks.Task;
import org.opensearch.threadpool.ThreadPool;
import org.opensearch.transport.TaskTransportChannel;
import org.opensearch.transport.TcpChannel;
import org.opensearch.transport.TcpTransportChannel;
import org.opensearch.transport.TransportChannel;
import org.opensearch.transport.TransportRequest;
import org.opensearch.transport.TransportRequestHandler;
import org.opensearch.transport.netty4.Netty4TcpChannel;

import io.netty.handler.ssl.SslHandler;

Expand Down Expand Up @@ -111,21 +107,7 @@ public final void messageReceived(T request, TransportChannel channel, Task task
}

try {

Netty4TcpChannel nettyChannel = null;

if (channel instanceof TaskTransportChannel) {
final TransportChannel inner = ((TaskTransportChannel) channel).getChannel();
nettyChannel = (Netty4TcpChannel) ((TcpTransportChannel) inner).getChannel();
} else if (channel instanceof TcpTransportChannel) {
final TcpChannel inner = ((TcpTransportChannel) channel).getChannel();
nettyChannel = (Netty4TcpChannel) inner;
} else {
throw new Exception("Invalid channel of type " + channel.getClass() + " (" + channel.getChannelType() + ")");
}

final SslHandler sslhandler = (SslHandler) nettyChannel.getNettyChannel().pipeline().get("ssl_server");

final SslHandler sslhandler = channel.get("ssl_server", SslHandler.class).orElse(null);
if (sslhandler == null) {
if (SSLConfig.isDualModeEnabled()) {
log.info("Communication in dual mode. Skipping SSL handler check");
Expand Down
Loading