Normalize the HTTP Host Header with the new HttpClientWrapper
Description
The core problem with the HTTP Host Header has been explained on NMS-5884.
Starting from 15, a big refactoring has been made in order to normalize the creation and usage of the HttpClient instances across the whole code base of OpenNMS, through a new class called HttpClientWrapper.
Because the HttpClient library is always going to force the Host header, it would be very helpful to check the Host header format on the request before send it to the target host inside the wrapper implementation. That way, all the OpenNMS components that uses HttpClient (PageSequenceMonitor, WebMonitor, WebDetector, HttpCollector, XmlCollector, etc.) would benefit from it.
As explained before, the problem is not the HttpClient, it is an issue of certain Web Servers like Microsoft IIS. The issue is: the web server complains if the host header includes the default ports (80 or 443 according with the selected schema) even knowing that adding the ports is valid according with the HTTP specificiation.
So, the idea, is: if the Host header exist and it contains the default ports, remove the port and leave only the FQDN on the host header (at the wrapper level).
Also, the PageSequenceMonitor provides a way to suppress the Host header, if the virtual-host parameter is not set on a page sequence. With the latest HttpClient, in order to suppress the host header, a request interceptor must be configured for this purpose, otherwise it is always going to be sent (which is the behavior in latest 1.12 and 14).
Acceptance / Success Criteria
None
Lucidchart Diagrams
Activity
Show:
Alejandro Galue February 5, 2015 at 9:20 AM
A fix for OpenNMS 16 has been pushed to develop on revision 1ba19c77b8df36848fdd0d7c1a564c625d1329fb. The solution has been cherry-picked for 15.0.1 on revision 430bb8f14b2532aaaf66059ae584acb0198d694d.
The solution for OpenNMS 14 (i.e. the solution for Foundation in order to have it in 14 and Meridian) is a little bit different. HttpClientWrapper doesn't exist in 14, so only the request interceptor on the PSM is required.
The core problem with the HTTP Host Header has been explained on NMS-5884.
Starting from 15, a big refactoring has been made in order to normalize the creation and usage of the HttpClient instances across the whole code base of OpenNMS, through a new class called HttpClientWrapper.
Because the HttpClient library is always going to force the Host header, it would be very helpful to check the Host header format on the request before send it to the target host inside the wrapper implementation. That way, all the OpenNMS components that uses HttpClient (PageSequenceMonitor, WebMonitor, WebDetector, HttpCollector, XmlCollector, etc.) would benefit from it.
As explained before, the problem is not the HttpClient, it is an issue of certain Web Servers like Microsoft IIS. The issue is: the web server complains if the host header includes the default ports (80 or 443 according with the selected schema) even knowing that adding the ports is valid according with the HTTP specificiation.
So, the idea, is: if the Host header exist and it contains the default ports, remove the port and leave only the FQDN on the host header (at the wrapper level).
Also, the PageSequenceMonitor provides a way to suppress the Host header, if the virtual-host parameter is not set on a page sequence. With the latest HttpClient, in order to suppress the host header, a request interceptor must be configured for this purpose, otherwise it is always going to be sent (which is the behavior in latest 1.12 and 14).