神奇的端口变化

一个app 启动之后,当访问8083端口的URL发现出现redirect 死循环。 我们确实在servlet的filter(a filter) 里有个逻辑,如果访问的端口不是8083 的话,就回redirect 到8083 (保证这个URL的访问都是内部的). 所以出现redirect死循环,肯定是端口发生了变化。进来8083,到达filter 时候变成了别的端口。
所以当时第一个猜想就是是不是有另外一个filter (b filter) 把8083 redirect 到别的端口,然后这个端口的request 被a filter 重新redirect 到8083. 这个两个filter 就形成了死循环。

我们的思路是先要看这个8083 的request被redirect 到哪个端口, 通过加入debug 信息发现端口是80. 由于这个app 用了shiro, Shiro过滤器里有个PortFilter,PortFilter 正好强制把端口转向80。 所以我们开始查配置,发现8083请求request 配置了跳过Shiro ,所以跟Shiro无关。

通过下面代码查过了所有的filter 发现没有filter 在干redirect 的事情。

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import java.util.Map;
@Component
public class FilterLister {
    private final ApplicationContext applicationContext;
    public FilterLister(ApplicationContext applicationContext) {
        this.applicationContext = applicationContext;
    }
    @PostConstruct
    public void listAllFilters() {
        Map<String, FilterRegistrationBean> filters = applicationContext.getBeansOfType(FilterRegistrationBean.class);
        for (Map.Entry<String, FilterRegistrationBean> entry : filters.entrySet()) {
            System.out.println("Filter name: " + entry.getKey());
            System.out.println("Filter instance: " + entry.getValue().getFilter());
        }
    }
}

那么还有什么情况能改变request 端口呢,我们不得不在org.apache.coyote.Request 里的 setServerPort 方法打印 stack trace, 因为只有这里会 setServerPort。 通过这个方式发现了
org.apache.catalina.valves.RemoteIpValve

同时在配置中也发现用户enable 了这个值

server.tomcat.remoteip.remote-ip-header=x-forwarded-for
server.tomcat.remoteip.protocol-header=x-forwarded-proto

这些配置到底有什么关联呢? 首先看在RemoteIpValve是怎么进入到tomcat request pipeline里去的。

配置RemoteIpValve

在创建tomcat容器时的ServletWebServerApplicationContext#createWebServer。

ServletWebServerFactory factory = getWebServerFactory();
this.webServer = factory.getWebServer(getSelfInitializer());

getWebServerFactory()方法会从beanFactory中获取ServletWebServerFactory对象。构造这个bean的过程中,会执行提前注册好的WebServerFactoryCustomizerBeanPostProcessor。
WebServerFactoryCustomizerBeanPostProcessor.postProcessBeforeInitialization会获取所有实现WebServerFactoryCustomizer的bean,并执行他们的customize()方法。
这其中就包括TomcatWebServerFactoryCustomizer,这里增加了tomcat专用的一些features.

Customization for Tomcat-specific features common for both Servlet and Reactive servers.

其中的customizeRemoteIpValve()方法会根据条件向tomcat中加入RemoteIpValve

  private void customizeRemoteIpValve(ConfigurableTomcatWebServerFactory factory) {
      Remoteip remoteIpProperties = this.serverProperties.getTomcat().getRemoteip();
      String protocolHeader = remoteIpProperties.getProtocolHeader();
      String remoteIpHeader = remoteIpProperties.getRemoteIpHeader();
      // For back compatibility the valve is also enabled if protocol-header is set
      if (StringUtils.hasText(protocolHeader) || StringUtils.hasText(remoteIpHeader)
              || getOrDeduceUseForwardHeaders()) {
          RemoteIpValve valve = new RemoteIpValve();
          valve.setProtocolHeader(StringUtils.hasLength(protocolHeader) ? protocolHeader : "X-Forwarded-Proto");
          if (StringUtils.hasLength(remoteIpHeader)) {
              valve.setRemoteIpHeader(remoteIpHeader);
          }
          // The internal proxies default to a list of "safe" internal IP addresses
          valve.setInternalProxies(remoteIpProperties.getInternalProxies());
          try {
              valve.setHostHeader(remoteIpProperties.getHostHeader());
          }
          catch (NoSuchMethodError ex) {
              // Avoid failure with war deployments to Tomcat 8.5 before 8.5.44 and
              // Tomcat 9 before 9.0.23
          }
          valve.setPortHeader(remoteIpProperties.getPortHeader());
          valve.setProtocolHeaderHttpsValue(remoteIpProperties.getProtocolHeaderHttpsValue());
          // ... so it's safe to add this valve by default.
          factory.addEngineValves(valve);
      }
  }


我本地用自己Sample 的项目,加上那两个配置后,debug 走到这,分别是protocolHeader : x-forwarded-proto 和remoteIpHeader: x-forwarded-for ,这就体现application.proprties的配置作用。 配了任意一个都会激活RemoteIpValve,被加入到了tocat pipeline 中factory.addEngineValves(valve); 。从90.3 Enable HTTPS When Running behind a Proxy Server ,https://docs.spring.io/spring-boot/docs/2.1.x/reference/html/howto-security.html 也证明了我们的判断。

RemoteIpValve 的作用

tomcat会将原始的http报文封装成org.apache.catalina.connector.Request,我们可以从中获取到remoteAddr和http header。
具体细节可以参考 : https://www.cnblogs.com/zhongchang/articles/10345333.html 以及https://blog.csdn.net/weixin_40562288/article/details/96131975

我们这个case 就是在enable RemoteIpValve,如果request header 里有x-forwarded-proto 就会导致severport 被改写。

if (protocolHeader != null) {
                String protocolHeaderValue = request.getHeader(protocolHeader);
                if (protocolHeaderValue == null) {
                    // Don't modify the secure, scheme and serverPort attributes
                    // of the request
                } else if (isForwardedProtoHeaderValueSecure(protocolHeaderValue)) {
                    request.setSecure(true);
                    request.getCoyoteRequest().scheme().setString("https");
                    setPorts(request, httpsServerPort);
                } else {
                    request.setSecure(false);
                    request.getCoyoteRequest().scheme().setString("http");
                    setPorts(request, httpServerPort);
                }
            }

为啥我们的会多出来一个x-forwarded-proto ,就涉及到另外一个问题。我们app 是在istio 的环境中。X-Forwarded-Proto header set to http instead of https on subsequent request https://github.com/istio/istio/issues/36612

这就完全解释了为啥端口会被设置成80, 导致8083 a filter 无限发生作用。

总结

如果让端口发生变化,要有两个条件
1 要配置tomcat,让RemoteIpValve配置到pipeline 中去

server.tomcat.remoteip.remote-ip-header=x-forwarded-for
server.tomcat.remoteip.protocol-header=x-forwarded-proto
  1. 要在header 传入x-forwarded-proto 或者x-forwarded-for 的值

两者缺一不可。 我们的app 正好在code 配置了RemoteIpValve, 在istio 里加了x-forwarded-proto , 所以激活了RemoteIpValve set request port。

扩展

Tomcat 改port 的地方一共有三处 ,都在Http11Processor

server.tomcat.remoteip.remote-ip-header=x-forwarded-for
server.tomcat.remoteip.protocol-header=x-forwarded-proto

这两行配置,访问http://abc:8083时,内存中 request 端口的变化

  1. 在prepareRequest, prepareRequest(Http11Processor.java:784), 根据 URL 里面的 "冒号+port", 在 parseHost 去设置从 old ServerPort = -1 变成 newServerPort = 8083
java.base/java.lang.Thread.getStackTrace(Unknown Source)
org.apache.coyote.Request.setServerPort(Request.java:345)
org.apache.coyote.AbstractProcessor.parseHost(AbstractProcessor.java:311)
org.apache.coyote.http11.Http11Processor.prepareRequest(Http11Processor.java:784)
org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:367)
org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:63)
org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:928)
org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1794)
org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:52)
org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191)
org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659)
org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
java.base/java.lang.Thread.run(Unknown Source)

  1. 在(Http11Processor.java:390),CoyoteAdapter.serviceservicepipeline 中如果有 org.apache.catalina.valves.RemoteIpValve, 它又会改port
    old ServerPort = 8083
    newServerPort = 80
java.base/java.lang.Thread.getStackTrace(Unknown Source)
org.apache.coyote.Request.setServerPort(Request.java:345)
org.apache.coyote.AbstractProcessor.parseHost(AbstractProcessor.java:311)
org.apache.coyote.http11.Http11Processor.prepareRequest(Http11Processor.java:784)
org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:367)
org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:63)
org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:928)
org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1794)
org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:52)
org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191)
org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659)
org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
java.base/java.lang.Thread.run(Unknown Source)
  1. postParseRequest(CoyoteAdapter.java:585) 在前面两个都不起作用的时候来设置port
org.apache.coyote.Request.setServerPort(Request.java:345) 
org.apache.catalina.connector.CoyoteAdapter.postParseRequest(CoyoteAdapter.java:585) 
org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:337) 
org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:390) 
org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:63) 
org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:928) 
org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1794) 
org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:52) 
org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191) 
org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659) 
org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61) 
java.base/java.lang.Thread.run(Unknown Source)

例如 访问 api: https://tmsapp-staging-2-tmsappcont.istio-staging.svc.130.tess.io/instance-access/10.42.231.252/api/v1/internal/get-request-info?ab=cd时, prepareRequest(Http11Processor.java:784)里面不会 setServerPort,因为这个 URL 里面不带 "冒号+port",它里面在 parseHost 找不到端口去设置 随后在 postParseRequest(CoyoteAdapter.java:585) 时,因为 req.getServerPort() 还是 -1,所以会基于 scheme 去改port。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,063评论 6 510
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,805评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,403评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,110评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,130评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,877评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,533评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,429评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,947评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,078评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,204评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,894评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,546评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,086评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,195评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,519评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,198评论 2 357

推荐阅读更多精彩内容