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

com.alibaba.arthas.tunnel.server.TunnelSocketFrameHandler Maven / Gradle / Ivy

There is a newer version: 4.0.3
Show newest version

package com.alibaba.arthas.tunnel.server;

import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URLDecoder;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.TimeUnit;

import org.apache.commons.lang3.RandomStringUtils;
import org.apache.tomcat.util.codec.binary.Base64;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.MultiValueMap;
import org.springframework.web.util.UriComponentsBuilder;

import com.alibaba.arthas.tunnel.common.MethodConstants;
import com.alibaba.arthas.tunnel.common.SimpleHttpResponse;
import com.alibaba.arthas.tunnel.common.URIConstans;

import io.netty.channel.Channel;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.handler.codec.http.HttpHeaders;
import io.netty.handler.codec.http.QueryStringDecoder;
import io.netty.handler.codec.http.websocketx.CloseWebSocketFrame;
import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;
import io.netty.handler.codec.http.websocketx.WebSocketFrame;
import io.netty.handler.codec.http.websocketx.WebSocketServerProtocolHandler.HandshakeComplete;
import io.netty.util.concurrent.Future;
import io.netty.util.concurrent.FutureListener;
import io.netty.util.concurrent.GenericFutureListener;
import io.netty.util.concurrent.GlobalEventExecutor;
import io.netty.util.concurrent.Promise;

/**
 * 
 * @author hengyunabc 2019-08-27
 *
 */
public class TunnelSocketFrameHandler extends SimpleChannelInboundHandler {

    private final static Logger logger = LoggerFactory.getLogger(TunnelSocketFrameHandler.class);

    private TunnelServer tunnelServer;

    public TunnelSocketFrameHandler(TunnelServer tunnelServer) {
        this.tunnelServer = tunnelServer;
    }

    @Override
    public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
        if (evt instanceof HandshakeComplete) {
            HandshakeComplete handshake = (HandshakeComplete) evt;
            // http request uri
            String uri = handshake.requestUri();
            logger.info("websocket handshake complete, uri: {}", uri);

            MultiValueMap parameters = UriComponentsBuilder.fromUriString(uri).build().getQueryParams();
            String method = parameters.getFirst("method");

            if (MethodConstants.CONNECT_ARTHAS.equals(method)) { // form browser
                connectArthas(ctx, parameters);
            } else if (MethodConstants.AGENT_REGISTER.equals(method)) { // form arthas agent, register
                agentRegister(ctx, handshake, uri);
            }
            if (MethodConstants.OPEN_TUNNEL.equals(method)) { // from arthas agent open tunnel
                String clientConnectionId = parameters.getFirst("clientConnectionId");
                openTunnel(ctx, clientConnectionId);
            }
        } else {
            ctx.fireUserEventTriggered(evt);
        }
    }

    @Override
    protected void channelRead0(ChannelHandlerContext ctx, WebSocketFrame frame) throws Exception {
        // 只有 arthas agent register建立的 channel 才可能有数据到这里
        if (frame instanceof TextWebSocketFrame) {
            TextWebSocketFrame textFrame = (TextWebSocketFrame) frame;
            String text = textFrame.text();

            MultiValueMap parameters = UriComponentsBuilder.fromUriString(text).build()
                    .getQueryParams();

            String method = parameters.getFirst(URIConstans.METHOD);

            /**
             * 
             * 1. 之前http proxy请求已发送到 tunnel cleint,这里接收到 tunnel client的结果,并解析出SimpleHttpResponse
             * 2. 需要据 URIConstans.PROXY_REQUEST_ID 取出当时的 Promise,再设置SimpleHttpResponse进去
             * 
*/ if (MethodConstants.HTTP_PROXY.equals(method)) { String requestId = URLDecoder.decode(parameters.getFirst(URIConstans.PROXY_REQUEST_ID), "utf-8"); if (requestId == null) { logger.error("error, need {}, text: {}", URIConstans.PROXY_REQUEST_ID, text); return; } logger.info("received http proxy response, requestId: {}", requestId); Promise promise = tunnelServer.findProxyRequestPromise(requestId); String data = URLDecoder.decode(parameters.getFirst(URIConstans.PROXY_RESPONSE_DATA), "utf-8"); byte[] bytes = Base64.decodeBase64(data); SimpleHttpResponse simpleHttpResponse = SimpleHttpResponse.fromBytes(bytes); promise.setSuccess(simpleHttpResponse); } } } private void connectArthas(ChannelHandlerContext tunnelSocketCtx, MultiValueMap parameters) throws URISyntaxException { List agentId = parameters.getOrDefault("id", Collections.emptyList()); if (agentId.isEmpty()) { logger.error("arthas agent id can not be null, parameters: {}", parameters); throw new IllegalArgumentException("arthas agent id can not be null"); } logger.info("try to connect to arthas agent, id: " + agentId.get(0)); Optional findAgent = tunnelServer.findAgent(agentId.get(0)); if (findAgent.isPresent()) { ChannelHandlerContext agentCtx = findAgent.get().getChannelHandlerContext(); String clientConnectionId = RandomStringUtils.random(20, true, true).toUpperCase(); logger.info("random clientConnectionId: " + clientConnectionId); // URI uri = new URI("response", null, "/", // "method=" + MethodConstants.START_TUNNEL + "&id=" + agentId.get(0) + "&clientConnectionId=" + clientConnectionId, null); URI uri = UriComponentsBuilder.newInstance().scheme(URIConstans.RESPONSE).path("/") .queryParam(URIConstans.METHOD, MethodConstants.START_TUNNEL).queryParam(URIConstans.ID, agentId) .queryParam(URIConstans.CLIENT_CONNECTION_ID, clientConnectionId).build().toUri(); logger.info("startTunnel response: " + uri); ClientConnectionInfo clientConnectionInfo = new ClientConnectionInfo(); SocketAddress remoteAddress = tunnelSocketCtx.channel().remoteAddress(); if (remoteAddress instanceof InetSocketAddress) { InetSocketAddress inetSocketAddress = (InetSocketAddress) remoteAddress; clientConnectionInfo.setHost(inetSocketAddress.getHostString()); clientConnectionInfo.setPort(inetSocketAddress.getPort()); } clientConnectionInfo.setChannelHandlerContext(tunnelSocketCtx); // when the agent open tunnel success, will set result into the promise Promise promise = GlobalEventExecutor.INSTANCE.newPromise(); promise.addListener(new FutureListener() { @Override public void operationComplete(final Future future) throws Exception { final Channel outboundChannel = future.getNow(); if (future.isSuccess()) { tunnelSocketCtx.pipeline().remove(TunnelSocketFrameHandler.this); // outboundChannel is form arthas agent outboundChannel.pipeline().removeLast(); outboundChannel.pipeline().addLast(new RelayHandler(tunnelSocketCtx.channel())); tunnelSocketCtx.pipeline().addLast(new RelayHandler(outboundChannel)); } else { logger.error("wait for agent connect error. agentId: {}, clientConnectionId: {}", agentId, clientConnectionId); ChannelUtils.closeOnFlush(agentCtx.channel()); } } }); clientConnectionInfo.setPromise(promise); this.tunnelServer.addClientConnectionInfo(clientConnectionId, clientConnectionInfo); tunnelSocketCtx.channel().closeFuture().addListener(new GenericFutureListener>() { @Override public void operationComplete(Future future) throws Exception { tunnelServer.removeClientConnectionInfo(clientConnectionId); } }); agentCtx.channel().writeAndFlush(new TextWebSocketFrame(uri.toString())); logger.info("browser connect waitting for arthas agent open tunnel"); boolean watiResult = promise.awaitUninterruptibly(20, TimeUnit.SECONDS); if (watiResult) { logger.info( "browser connect wait for arthas agent open tunnel success, agentId: {}, clientConnectionId: {}", agentId, clientConnectionId); } else { logger.error( "browser connect wait for arthas agent open tunnel timeout, agentId: {}, clientConnectionId: {}", agentId, clientConnectionId); tunnelSocketCtx.close(); } } else { tunnelSocketCtx.channel().writeAndFlush(new CloseWebSocketFrame(2000, "Can not find arthas agent by id: "+ agentId)); logger.error("Can not find arthas agent by id: {}", agentId); throw new IllegalArgumentException("Can not find arthas agent by id: " + agentId); } } private void agentRegister(ChannelHandlerContext ctx, HandshakeComplete handshake, String requestUri) throws URISyntaxException { QueryStringDecoder queryDecoder = new QueryStringDecoder(requestUri); Map> parameters = queryDecoder.parameters(); String appName = null; List appNameList = parameters.get(URIConstans.APP_NAME); if (appNameList != null && !appNameList.isEmpty()) { appName = appNameList.get(0); } // generate a random agent id String id = null; if (appName != null) { // 如果有传 app name,则生成带 app name前缀的id,方便管理 id = appName + "_" + RandomStringUtils.random(20, true, true).toUpperCase(); } else { id = RandomStringUtils.random(20, true, true).toUpperCase(); } // agent传过来,则优先用 agent的 List idList = parameters.get(URIConstans.ID); if (idList != null && !idList.isEmpty()) { id = idList.get(0); } String arthasVersion = null; List arthasVersionList = parameters.get(URIConstans.ARTHAS_VERSION); if (arthasVersionList != null && !arthasVersionList.isEmpty()) { arthasVersion = arthasVersionList.get(0); } final String finalId = id; // URI responseUri = new URI("response", null, "/", "method=" + MethodConstants.AGENT_REGISTER + "&id=" + id, null); URI responseUri = UriComponentsBuilder.newInstance().scheme(URIConstans.RESPONSE).path("/") .queryParam(URIConstans.METHOD, MethodConstants.AGENT_REGISTER).queryParam(URIConstans.ID, id).build() .encode().toUri(); AgentInfo info = new AgentInfo(); // 前面可能有nginx代理 HttpHeaders headers = handshake.requestHeaders(); String host = headers.get("X-Real-IP"); String portStr = headers.get("X-Real-Port"); if (host == null) { SocketAddress remoteAddress = ctx.channel().remoteAddress(); if (remoteAddress instanceof InetSocketAddress) { InetSocketAddress inetSocketAddress = (InetSocketAddress) remoteAddress; info.setHost(inetSocketAddress.getHostString()); info.setPort(inetSocketAddress.getPort()); } } else { info.setHost(host); try { if (portStr != null) { int port = Integer.parseInt(portStr); info.setPort(port); } } catch (Throwable e) { // ignore } } info.setChannelHandlerContext(ctx); if (arthasVersion != null) { info.setArthasVersion(arthasVersion); } tunnelServer.addAgent(id, info); ctx.channel().closeFuture().addListener(new GenericFutureListener>() { @Override public void operationComplete(Future future) throws Exception { tunnelServer.removeAgent(finalId); } }); ctx.channel().writeAndFlush(new TextWebSocketFrame(responseUri.toString())); } private void openTunnel(ChannelHandlerContext ctx, String clientConnectionId) { Optional infoOptional = this.tunnelServer.findClientConnection(clientConnectionId); if (infoOptional.isPresent()) { ClientConnectionInfo info = infoOptional.get(); logger.info("openTunnel clientConnectionId:" + clientConnectionId); Promise promise = info.getPromise(); promise.setSuccess(ctx.channel()); } else { logger.error("Can not find client connection by id: {}", clientConnectionId); } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy