Differential D185

Adding support for reverse proxies to resultsdb. Fixes T277
ClosedPublic
Actions

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

Details

Reviewers
mkrizek
jskladan
Maniphest Tasks
T277: support proxying in resultsdb
Commits
rRSDBd05c620ce8d7: Adding support for reverse proxies to resultsdb. Fixes T277
Summary

Adding config changes to make sure resultsdb behaves when behind a proxy

Test Plan

Tested locally, will test in dev

Diff Detail

Repository
rRSDB resultsdb
Lint
Lint Skipped
Unit
Unit Tests Skipped
tflink retitled this revision from to Adding support for reverse proxies to resultsdb. Fixes T277.Jul 7 2014, 1:41 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:58 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:5000/
  ProxyPassReverse http://127.0.0.1:5000/
  RequestHeader add X-Script-Name /results/
</Location>

Then, while resultsdb is running, run curl http://127.0.0.1/results/api/v1.0/jobs.The href and next urls at the end of the json should be of the form http://127.0.0.1/results/api/v1.0/XXXXX and *not* http://127.0.0.1/api/v1.0/XXXX

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:27 PM
tflink updated this revision to Diff 532.

Closed by commit rRSDBd05c620ce8d7 (authored by @tflink).

Revision Contents

PathPackages
Mresultsdb/__init__.py (5 lines)
AMresultsdb/proxy.py (59 lines)

Diff 532

View Options

resultsdb/__init__.py

Show All 12 Lines
13# You should have received a copy of the GNU General Public License along 13​# You should have received a copy of the GNU General Public License along
14# with this program; if not, write to the Free Software Foundation, Inc., 14​# with this program; if not, write to the Free Software Foundation, Inc.,
15# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 15​# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16# 16​#
17# Authors: 17​# Authors:
18# Josef Skladanka <jskladan@redhat.com> 18​# Josef Skladanka <jskladan@redhat.com>
19# Ralph Bean <rbean@redhat.com> 19​# Ralph Bean <rbean@redhat.com>
20 20​
21​from resultsdb import proxy
22​
21import flask 23​import flask
22from flask import Flask 24​from flask import Flask
23from flask.ext.login import LoginManager 25​from flask.ext.login import LoginManager
24from flask.ext.sqlalchemy import SQLAlchemy 26​from flask.ext.sqlalchemy import SQLAlchemy
25 27​
26import logging 28​import logging
27import os 29​import os
28 30​
29 31​
30# the version as used in setup.py 32​# the version as used in setup.py
31__version__ = "1.1.4" 33​__version__ = "1.1.4"
32 34​
33 35​
34# Flask App 36​# Flask App
35app = Flask(__name__) 37​app = Flask(__name__)
36app.secret_key = 'not-really-a-secret' 38​app.secret_key = 'not-really-a-secret'
37 39​
40​# make sure app behaves when behind a proxy
41​app.wsgi_app = proxy.ReverseProxied(app.wsgi_app)
42​
38# Monkey patch Flask's "jsonify" to also handle JSONP 43​# Monkey patch Flask's "jsonify" to also handle JSONP
39original_jsonify = flask.jsonify 44​original_jsonify = flask.jsonify
40 45​
41def jsonify_with_jsonp(*args, **kwargs): 46​def jsonify_with_jsonp(*args, **kwargs):
42 response = original_jsonify(*args, **kwargs) 47​ response = original_jsonify(*args, **kwargs)
43 callback = flask.request.args.get('callback') 48​ callback = flask.request.args.get('callback')
44 49​
45 if callback: 50​ if callback:
▲ Show 20 Lines • Show All 92 Lines • Show Last 20 Lines
View Options

resultsdb/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)