All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.flink.runtime.net.RedirectingSslHandler Maven / Gradle / Ivy

There is a newer version: 1.13.6
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.runtime.net;

import org.apache.flink.runtime.io.network.netty.SSLHandlerFactory;
import org.apache.flink.runtime.rest.handler.util.HandlerRedirectUtils;
import org.apache.flink.runtime.rest.handler.util.KeepAliveWrite;

import org.apache.flink.shaded.netty4.io.netty.buffer.ByteBuf;
import org.apache.flink.shaded.netty4.io.netty.channel.ChannelFutureListener;
import org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext;
import org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter;
import org.apache.flink.shaded.netty4.io.netty.handler.codec.ByteToMessageDecoder;
import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest;
import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponse;
import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus;
import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpServerCodec;
import org.apache.flink.shaded.netty4.io.netty.handler.ssl.SslHandler;
import org.apache.flink.shaded.netty4.io.netty.util.ReferenceCountUtil;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.annotation.Nonnull;

import java.net.InetSocketAddress;
import java.util.List;
import java.util.concurrent.CompletableFuture;

/** SSL handler which automatically redirects Non-SSL requests to SSL address. */
public class RedirectingSslHandler extends ByteToMessageDecoder {
	private static final Logger log = LoggerFactory.getLogger(RedirectingSslHandler.class);

	private static final String SSL_HANDLER_NAME = "ssl";
	private static final String HTTP_CODEC_HANDLER_NAME = "http-codec";
	private static final String NON_SSL_HANDLER_NAME = "redirecting-non-ssl";

	/** the length of the ssl record header (in bytes). */
	private static final int SSL_RECORD_HEADER_LENGTH = 5;

	@Nonnull private final String confRedirectBaseUrl;
	@Nonnull private final CompletableFuture redirectBaseUrl;
	@Nonnull private final SSLHandlerFactory sslHandlerFactory;

	public RedirectingSslHandler(
		@Nonnull String confRedirectHost,
		@Nonnull CompletableFuture redirectBaseUrl,
		@Nonnull SSLHandlerFactory sslHandlerFactory) {
		this.confRedirectBaseUrl = "https://" + confRedirectHost + ":";
		this.redirectBaseUrl = redirectBaseUrl;
		this.sslHandlerFactory = sslHandlerFactory;
	}

	@Override
	protected void decode(ChannelHandlerContext context, ByteBuf in, List out) {
		if (in.readableBytes() >= SSL_RECORD_HEADER_LENGTH && SslHandler.isEncrypted(in)) {
			handleSsl(context);
		} else {
			context.pipeline().replace(this, HTTP_CODEC_HANDLER_NAME, new HttpServerCodec());
			context.pipeline().addAfter(HTTP_CODEC_HANDLER_NAME, NON_SSL_HANDLER_NAME, new NonSslHandler());
		}
	}

	private void handleSsl(ChannelHandlerContext context) {
		SslHandler sslHandler = sslHandlerFactory.createNettySSLHandler(context.alloc());
		try {
			context.pipeline().replace(this, SSL_HANDLER_NAME, sslHandler);
		} catch (Throwable t) {
			ReferenceCountUtil.safeRelease(sslHandler.engine());
			throw t;
		}
	}

	private class NonSslHandler extends ChannelInboundHandlerAdapter {
		@Override
		public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
			HttpRequest request = msg instanceof HttpRequest ? (HttpRequest) msg : null;
			String path = request == null ? "" : request.uri();
			String redirectAddress = getRedirectAddress(ctx);
			log.trace("Received non-SSL request, redirecting to {}{}", redirectAddress, path);
			HttpResponse response = HandlerRedirectUtils.getRedirectResponse(
				redirectAddress, path, HttpResponseStatus.MOVED_PERMANENTLY);
			if (request != null) {
				KeepAliveWrite.flush(ctx, request, response);
			} else {
				ctx.writeAndFlush(response).addListener(ChannelFutureListener.CLOSE);
			}
		}

		private String getRedirectAddress(ChannelHandlerContext ctx) throws Exception {
			return redirectBaseUrl.isDone() ? redirectBaseUrl.get() :
				confRedirectBaseUrl + ((InetSocketAddress) (ctx.channel()).localAddress()).getPort();
		}
	}
}