class ReverseProxyMiddleware

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/StackMiddleware/ReverseProxyMiddleware.php \Drupal\Core\StackMiddleware\ReverseProxyMiddleware
  2. 8.9.x core/lib/Drupal/Core/StackMiddleware/ReverseProxyMiddleware.php \Drupal\Core\StackMiddleware\ReverseProxyMiddleware
  3. 11.x core/lib/Drupal/Core/StackMiddleware/ReverseProxyMiddleware.php \Drupal\Core\StackMiddleware\ReverseProxyMiddleware

Provides support for reverse proxies.

Hierarchy

  • class \Drupal\Core\StackMiddleware\ReverseProxyMiddleware extends \Symfony\Component\HttpKernel\HttpKernelInterface

Expanded class hierarchy of ReverseProxyMiddleware

3 files declare their use of ReverseProxyMiddleware
install.core.inc in core/includes/install.core.inc
API functions for installing Drupal.
ReverseProxyMiddlewareTest.php in core/tests/Drupal/Tests/Core/StackMiddleware/ReverseProxyMiddlewareTest.php
UpdateKernel.php in core/lib/Drupal/Core/Update/UpdateKernel.php
1 string reference to 'ReverseProxyMiddleware'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses ReverseProxyMiddleware
http_middleware.reverse_proxy in core/core.services.yml
Drupal\Core\StackMiddleware\ReverseProxyMiddleware

File

core/lib/Drupal/Core/StackMiddleware/ReverseProxyMiddleware.php, line 13

Namespace

Drupal\Core\StackMiddleware
View source
class ReverseProxyMiddleware implements HttpKernelInterface {
  
  /**
   * The decorated kernel.
   *
   * @var \Symfony\Component\HttpKernel\HttpKernelInterface
   */
  protected $httpKernel;
  
  /**
   * The site settings.
   *
   * @var \Drupal\Core\Site\Settings
   */
  protected $settings;
  
  /**
   * Constructs a ReverseProxyMiddleware object.
   *
   * @param \Symfony\Component\HttpKernel\HttpKernelInterface $http_kernel
   *   The decorated kernel.
   * @param \Drupal\Core\Site\Settings $settings
   *   The site settings.
   */
  public function __construct(HttpKernelInterface $http_kernel, Settings $settings) {
    $this->httpKernel = $http_kernel;
    $this->settings = $settings;
  }
  
  /**
   * {@inheritdoc}
   */
  public function handle(Request $request, $type = self::MAIN_REQUEST, $catch = TRUE) : Response {
    // Initialize proxy settings.
    static::setSettingsOnRequest($request, $this->settings);
    return $this->httpKernel
      ->handle($request, $type, $catch);
  }
  
  /**
   * Sets reverse proxy settings on Request object.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   A Request instance.
   * @param \Drupal\Core\Site\Settings $settings
   *   The site settings.
   */
  public static function setSettingsOnRequest(Request $request, Settings $settings) {
    // Initialize proxy settings.
    if ($settings->get('reverse_proxy', FALSE)) {
      $proxies = $settings->get('reverse_proxy_addresses', []);
      if (count($proxies) > 0) {
        // Set the default value. This is the most relaxed setting possible and
        // not recommended for production.
        $trusted_header_set = Request::HEADER_X_FORWARDED_FOR | Request::HEADER_X_FORWARDED_HOST | Request::HEADER_X_FORWARDED_PORT | Request::HEADER_X_FORWARDED_PROTO | Request::HEADER_FORWARDED;
        $request::setTrustedProxies($proxies, $settings->get('reverse_proxy_trusted_headers', $trusted_header_set));
      }
    }
  }

}

Members

Title Sort descending Modifiers Object type Summary
ReverseProxyMiddleware::$httpKernel protected property The decorated kernel.
ReverseProxyMiddleware::$settings protected property The site settings.
ReverseProxyMiddleware::handle public function
ReverseProxyMiddleware::setSettingsOnRequest public static function Sets reverse proxy settings on Request object.
ReverseProxyMiddleware::__construct public function Constructs a ReverseProxyMiddleware object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.