Differential D184

Adding reverse proxy support. Fixes T276
ClosedPublic
Actions

Authored by tflink on Jul 7 2014, 1:36 PM.

Details

Reviewers
mkrizek
jskladan
Maniphest Tasks
T276: support proxying in resultsdb_frontend
Commits
rRSFEd72d3d061925: Adding reverse proxy support. Fixes T276
Summary

Adds proxy handling support so that resultsdb_frontend can be proxied

Test Plan

Tested locally

Diff Detail

Repository
rRSFE resultsdb_frontend
Lint
Lint Skipped
Unit
Unit Tests Skipped
tflink retitled this revision from to Adding reverse proxy support. Fixes T276.Jul 7 2014, 1:36 PM
tflink updated this object.
tflink edited the test plan for this revision. (Show Details)
tflink added reviewers: mkrizek, jskladan.
tflink added a comment.Jul 7 2014, 1:52 PM

To test this, make sure that httpd is installed on the test machine. Then add a conf file in /etc/httpd/conf.d which contains:

RewriteEngine On

<Location /results/ >
  ProxyPass http://127.0.0.1:5001/
  ProxyPassReverse http://127.0.0.1:5001/
  RequestHeader add X-Script-Name /results/
</Location>

Then, while resultsdb and resultsdb_frontend are running, access http://127.0.0.1/results/. With resultsdb_frontend, you should be redirected to http://127.0.0.1/results/jobs instead of http://127.0.0.1/jobs

tflink abandoned this revision.Jul 7 2014, 4:22 PM

Since nobody who has time is willing to review this and it needs to be done, I'm just pushing the change since I'll be the one fixing stuff if it causes problems

tflink closed this revision.Jul 7 2014, 4:53 PM
tflink updated this revision to Diff 533.

Closed by commit rRSFEd72d3d061925 (authored by @tflink).

Revision Contents

Diff 533

View Options

resultsdb_frontend/__init__.py

Show All 15 Lines
16# 16​#
17# Authors: 17​# Authors:
18# Tim Flink <tflink@redhat.com> 18​# Tim Flink <tflink@redhat.com>
19# Josef Skladanka <jskladan@redhat.com> 19​# Josef Skladanka <jskladan@redhat.com>
20# Ralph Bean <rbean@redhat.com> 20​# Ralph Bean <rbean@redhat.com>
21 21​
22 22​
23from flask import Flask, render_template 23​from flask import Flask, render_template
24​from resultsdb_frontend import proxy
24 25​
25import logging 26​import logging
26import os 27​import os
27 28​
28# the version as used in setup.py 29​# the version as used in setup.py
29__version__ = "1.1.1" 30​__version__ = "1.1.1"
30 31​
31# Flask App 32​# Flask App
32app = Flask(__name__) 33​app = Flask(__name__)
33app.secret_key = 'not-really-a-secret' 34​app.secret_key = 'not-really-a-secret'
34 35​
36​app.wsgi_app = proxy.ReverseProxied(app.wsgi_app)
37​
35# Load default config, then override that with a config file 38​# Load default config, then override that with a config file
36if os.getenv('PROD') == 'true': 39​if os.getenv('PROD') == 'true':
37 default_config_obj = 'resultsdb_frontend.config.ProductionConfig' 40​ default_config_obj = 'resultsdb_frontend.config.ProductionConfig'
38 default_config_file = '/etc/resultsdb/settings.py' 41​ default_config_file = '/etc/resultsdb/settings.py'
39elif os.getenv('TEST') == 'true': 42​elif os.getenv('TEST') == 'true':
40 default_config_obj = 'resultsdb_frontend.config.TestingConfig' 43​ default_config_obj = 'resultsdb_frontend.config.TestingConfig'
41 default_config_file = os.getcwd() + '/conf/settings.py' 44​ default_config_file = os.getcwd() + '/conf/settings.py'
42else: 45​else:
▲ Show 20 Lines • Show All 55 Lines • Show Last 20 Lines
View Options

resultsdb_frontend/proxy.py

  • This file was added.
1​# -*- coding: utf-8 -*-
2​# Copyright 2009-2014, Red Hat, Inc.
3​# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
4​
5​'''
6​Makes fedocal an application behind a reverse proxy and thus ensure the
7​redirects are using ``https``.
8​
9​Original Source: http://flask.pocoo.org/snippets/35/ by Peter Hansen
10​Source: https://github.com/fedora-infra/fedocal/blob/master/fedocal/proxy.py
11​'''
12​
13​
14​class ReverseProxied(object):
15​ '''Wrap the application in this middleware and configure the
16​ front-end server to add these headers, to let you quietly bind
17​ this to a URL other than / and to an HTTP scheme that is
18​ different than what is used locally.
19​
20​ In apache:
21​ RewriteEngine On
22​
23​ <Location /myprefix/ >
24​ ProxyPass http://192.168.0.1:5001/
25​ ProxyPassReverse http://192.168.0.1:5001/
26​ RequestHeader set X-Forwarded-Scheme $scheme
27​ RequestHeader add X-Script-Name /myprefix/
28​ </Location>
29​
30​ In nginx:
31​ location /myprefix {
32​ proxy_pass http://192.168.0.1:5001;
33​ proxy_set_header Host $host;
34​ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
35​ proxy_set_header X-Scheme $scheme;
36​ proxy_set_header X-Script-Name /myprefix;
37​ }
38​
39​ :param app: the WSGI application
40​ '''
41​ def __init__(self, app):
42​ self.app = app
43​
44​ def __call__(self, environ, start_response):
45​ script_name = environ.get('HTTP_X_SCRIPT_NAME', '')
46​ if script_name:
47​ environ['SCRIPT_NAME'] = script_name
48​ path_info = environ['PATH_INFO']
49​ if path_info.startswith(script_name):
50​ environ['PATH_INFO'] = path_info[len(script_name):]
51​
52​ server = environ.get('HTTP_X_FORWARDED_HOST', '')
53​ if server:
54​ environ['HTTP_HOST'] = server
55​
56​ scheme = environ.get('HTTP_X_SCHEME', '')
57​ if scheme:
58​ environ['wsgi.url_scheme'] = scheme
59​ return self.app(environ, start_response)