神奇的端口變化

一個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閱讀 227,572評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,071評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,409評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,569評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,360評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,895評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,979評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,123評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,643評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,559評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,742評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,250評論 5 356
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,981評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,363評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,622評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,354評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,707評論 2 370

推薦閱讀更多精彩內容