thomasw / djproxy / 173

pending completion

Build # 173

Build Type

Pull #45

travis-ci-com

Committed by

web-flow

Commit Message

<a href="https://github.com/thomasw/djproxy/commit/<a class=hub.com/thomasw/djproxy/commit/<a class="double-link" href="https://git"><a class=hub.com/thomasw/djproxy/commit/<a class="double-link" href="https://git"><a class=hub.com/thomasw/djproxy/commit/<a class="double-link" href="https://git"><a class=hub.com/thomasw/djproxy/commit/<a class="double-link" href="https://git"><a class=hub.com/thomasw/djproxy/commit/483315063062e3d24e74c2567eaf56808bd38ea5">483315063">&lt;a href=&quot;https://github.com/thomasw/djproxy/commit/</a><a class="double-link" href="https://github.com/thomasw/djproxy/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/thomasw/djproxy/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/thomasw/djproxy/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/thomasw/djproxy/commit/483315063062e3d24e74c2567eaf56808bd38ea5">483315063</a><a href="https://github.com/thomasw/djproxy/commit/483315063062e3d24e74c2567eaf56808bd38ea5">&lt;a href=&quot;https://github.com/thomasw/djproxy/commit/483315063062e3d24e74c2567eaf56808bd38ea5&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/thomasw/djproxy/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/thomasw/djproxy/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://git&amp;quot;&amp;gt;&amp;amp;lt;a class=&amp;lt;/a&amp;gt;hub.com/thomasw/djproxy/commit/483315063062e3d24e74c2567eaf56808bd38ea5&amp;quot;&amp;gt;483315063&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/thomasw/djproxy/commit/483315063062e3d24e74c2567eaf56808bd38ea5&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/thomasw/djproxy/commit/483315063062e3d24e74c2567eaf5680&amp;lt;/a&amp;gt;8bd</a>38ea5&quot;&gt;&amp;quot;&amp;gt;Merge &amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/thomasw/djproxy/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/thomasw/djproxy/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/thomasw/djproxy/commit/8cb0b43dc&quot;&gt;8cb0b43dc&lt;/a&gt;&lt;a href=&quot;htt... (continued)

Pull Request Pull Request #45: Implement middleware to handle multi set cookie

Run Details

20 of 20 new or added lines in 2 files covered. (100.0%)

169 of 183 relevant lines covered (92.35%)

9.15 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

91.8

/djproxy/proxy_middleware.py

import re

# The Cookie module has been renamed to http.cookies in Python 3.0.
# We use its equivalent re_path to maintain compatibility
# with older versions of django
try:
    from http.cookies import SimpleCookie
except ImportError as exception:
    from Cookie import SimpleCookie

from .util import import_string


class MiddlewareSet(object):
    def __init__(self, middleware):
        self.middleware = [import_string(x)() for x in middleware]

    def process_request(self, proxy, request, **kwargs):
        for x in self.middleware:
            if not getattr(x, 'process_request', False):
                continue

            kwargs = x.process_request(proxy, request, **kwargs)

        return kwargs

    def process_response(self, proxy, request, upstream_response, response):
        for x in self.middleware:
            if not getattr(x, 'process_response', False):
                continue

            response = x.process_response(
                proxy=proxy, request=request,
                upstream_response=upstream_response,
                response=response)

        return response


class ProxyMiddlewareTemplate(object):

    """An example proxy middleware that does nothing.

    process_request(): This is called before the proxy makes a request to
    the upstream proxied endpoint. Use this method to modify what is sent
    upstream.

    process_response(): This is called before the proxy returns the results
    to the client. Use this method to modify what is sent back downstream (to
    the user).

    """

    def process_request(self, proxy, request, **kwargs):
        """Modify the keyword arguments for requests.

        proxy - the HttpProxy instance calling this method
        request - an DownstreamRequest wrapper for the django request
        kwargs - the keyword arguments to be passed to requests.request

        Returns a modified kwargs dict that will then be passed to
        request.requests.

        """
        pass

    def process_response(self, proxy, request, upstream_response, response):
        """Modify the HttpResponse object before sending it downstream.

        proxy - the HttpProxy instance calling thid method
        request - a DownstreamRequest wrapper for the django request
        upstream_response - the response object resulting from requesting the
                            proxied endpoint
        response - the django HttpResponse object to be send downstream

        Returns a modified django HttpResponse object that is then sent to
        the end user.

        """
        pass


class AddXFF(object):

    """Add an updated X-Forwarded-For header to the upstream request."""

    def process_request(self, proxy, request, **kwargs):
        kwargs['headers']['X-Forwarded-For'] = request.x_forwarded_for

        return kwargs


class AddXFH(object):
    """Add a X-Forwarded-Host header to the upstream request."""

    def process_request(self, proxy, request, **kwargs):
        kwargs['headers']['X-Forwarded-Host'] = request.get_host()

        return kwargs


class AddXFP(object):
    """Add a X-Forwarded-Proto header to the upstream request."""

    def process_request(self, proxy, request, **kwargs):
        proto = 'https' if request.is_secure() else 'http'
        kwargs['headers']['X-Forwarded-Proto'] = proto

        return kwargs


class ForwardSetCookie(object):
    """
    Handles the transmission of multiple cookies returned by a server as multiple set-cookie headers.

    Request merges the set-cookie headers into one. The default behavior is ok
    if the server returns only one cookie per http response.

    The browser will receive only one cookie.

    {
        Set-Cookie: hello=world; Expires=Wed, 21 Oct 2015 07:28:00 GMT, world=hello
    }

    instead

    {
        Set-Cookie: hello=world; Expires=Wed, 21 Oct 2015 07:28:00 GMT
        Set-Cookie: world=hello
    }

    more about this behavior

    * https://github.com/urllib3/urllib3/commit/d8013cb111644a06eb5cb9bccce174a1a996078d
    * https://stackoverflow.com/a/57131320
    * https://github.com/psf/requests/issues/3957#issuecomment-1047539652
    """
    def process_response(self, proxy, request, upstream_response, response):
        if 'set-cookie' in response:
            # The set-cookie headers are well present in the headers of urlib3 forwarded by request
            # On its own interface, request has merged those cookies in one single header
            for header, value in  upstream_response.raw.headers.items():
                if header.lower() == 'set-cookie':
                    cookies = SimpleCookie(value)
                    for key in cookies.keys():
                        cookie = cookies.get(key)
                        response.set_cookie(cookie.key,
                                            value=cookie.value,
                                            expires=cookie.get('expires'),
                                            path=cookie.get('path'),
                                            domain=cookie.get('domain'),
                                            secure=True if cookie.get('secure') else False,
                                            httponly=True if cookie.get('httponly') else False)

            # remove the default header added by request
            del response['set-cookie']

        return response


class ProxyPassReverse(object):

    """Applies reverse url rules to location headers like ProxyPassReverse.

    If the proxies reverse urls are defined as:

    [
        ('/yay/', 'http://backend.example.com/')
    ]

    Then, this middleware will search the given response object's Location,
    Content-Location, and URI headers for '^http://backend.example.com/'
    and replace matches with current hostname + /yay/.

    This is similar to Apache's ProxyPassReverse directive.

    """

    location_headers = ['URI', 'Location', 'Content-Location']

    def process_response(self, proxy, request, upstream_response, response):
        for replacement, pattern in proxy.reverse_urls:
            pattern = r'^%s' % re.escape(pattern)
            replacement = request.build_absolute_uri(replacement)

            for loc in self.location_headers:
                if not response.has_header(loc):
                    continue

                response[loc] = re.sub(pattern, replacement, response[loc])

        return response

1	import re	10✔
2
3	# The Cookie module has been renamed to http.cookies in Python 3.0.
4	# We use its equivalent re_path to maintain compatibility
5	# with older versions of django
6	try:	10✔
7	from http.cookies import SimpleCookie	10✔
8	except ImportError as exception:	×
9	from Cookie import SimpleCookie	×
10
11	from .util import import_string	10✔
12
13
14	class MiddlewareSet(object):	10✔
15	def __init__(self, middleware):	10✔
16	self.middleware = [import_string(x)() for x in middleware]	10✔
17
18	def process_request(self, proxy, request, **kwargs):	10✔
19	for x in self.middleware:	10✔
20	if not getattr(x, 'process_request', False):	10✔
21	continue	10✔
22
23	kwargs = x.process_request(proxy, request, **kwargs)	10✔
24
25	return kwargs	10✔
26
27	def process_response(self, proxy, request, upstream_response, response):	10✔
28	for x in self.middleware:	10✔
29	if not getattr(x, 'process_response', False):	10✔
30	continue	10✔
31
32	response = x.process_response(	10✔
33	proxy=proxy, request=request,
34	upstream_response=upstream_response,
35	response=response)
36
37	return response	10✔
38
39
40	class ProxyMiddlewareTemplate(object):	10✔
41
42	"""An example proxy middleware that does nothing.
43
44	process_request(): This is called before the proxy makes a request to
45	the upstream proxied endpoint. Use this method to modify what is sent
46	upstream.
47
48	process_response(): This is called before the proxy returns the results
49	to the client. Use this method to modify what is sent back downstream (to
50	the user).
51
52	"""
53
54	def process_request(self, proxy, request, **kwargs):	10✔
55	"""Modify the keyword arguments for requests.
56
57	proxy - the HttpProxy instance calling this method
58	request - an DownstreamRequest wrapper for the django request
59	kwargs - the keyword arguments to be passed to requests.request
60
61	Returns a modified kwargs dict that will then be passed to
62	request.requests.
63
64	"""
65	pass	×
66
67	def process_response(self, proxy, request, upstream_response, response):	10✔
68	"""Modify the HttpResponse object before sending it downstream.
69
70	proxy - the HttpProxy instance calling thid method
71	request - a DownstreamRequest wrapper for the django request
72	upstream_response - the response object resulting from requesting the
73	proxied endpoint
74	response - the django HttpResponse object to be send downstream
75
76	Returns a modified django HttpResponse object that is then sent to
77	the end user.
78
79	"""
80	pass	×
81
82
83	class AddXFF(object):	10✔
84
85	"""Add an updated X-Forwarded-For header to the upstream request."""
86
87	def process_request(self, proxy, request, **kwargs):	10✔
88	kwargs['headers']['X-Forwarded-For'] = request.x_forwarded_for	10✔
89
90	return kwargs	10✔
91
92
93	class AddXFH(object):	10✔
94	"""Add a X-Forwarded-Host header to the upstream request."""
95
96	def process_request(self, proxy, request, **kwargs):	10✔
97	kwargs['headers']['X-Forwarded-Host'] = request.get_host()	10✔
98
99	return kwargs	10✔
100
101
102	class AddXFP(object):	10✔
103	"""Add a X-Forwarded-Proto header to the upstream request."""
104
105	def process_request(self, proxy, request, **kwargs):	10✔
106	proto = 'https' if request.is_secure() else 'http'	10✔
107	kwargs['headers']['X-Forwarded-Proto'] = proto	10✔
108
109	return kwargs	10✔
110
111
112	class ForwardSetCookie(object):	10✔
113	"""
114	Handles the transmission of multiple cookies returned by a server as multiple set-cookie headers.
115
116	Request merges the set-cookie headers into one. The default behavior is ok
117	if the server returns only one cookie per http response.
118
119	The browser will receive only one cookie.
120
121	{
122	Set-Cookie: hello=world; Expires=Wed, 21 Oct 2015 07:28:00 GMT, world=hello
123	}
124
125	instead
126
127	{
128	Set-Cookie: hello=world; Expires=Wed, 21 Oct 2015 07:28:00 GMT
129	Set-Cookie: world=hello
130	}
131
132	more about this behavior
133
134	* https://github.com/urllib3/urllib3/commit/d8013cb111644a06eb5cb9bccce174a1a996078d
135	* https://stackoverflow.com/a/57131320
136	* https://github.com/psf/requests/issues/3957#issuecomment-1047539652
137	"""
138	def process_response(self, proxy, request, upstream_response, response):	10✔
139	if 'set-cookie' in response:	10✔
140	# The set-cookie headers are well present in the headers of urlib3 forwarded by request
141	# On its own interface, request has merged those cookies in one single header
142	for header, value in upstream_response.raw.headers.items():	10✔
143	if header.lower() == 'set-cookie':	10✔
144	cookies = SimpleCookie(value)	10✔
145	for key in cookies.keys():	10✔
146	cookie = cookies.get(key)	10✔
147	response.set_cookie(cookie.key,	10✔
148	value=cookie.value,
149	expires=cookie.get('expires'),
150	path=cookie.get('path'),
151	domain=cookie.get('domain'),
152	secure=True if cookie.get('secure') else False,
153	httponly=True if cookie.get('httponly') else False)
154
155	# remove the default header added by request
156	del response['set-cookie']	10✔
157
158	return response	10✔
159
160
161	class ProxyPassReverse(object):	10✔
162
163	"""Applies reverse url rules to location headers like ProxyPassReverse.
164
165	If the proxies reverse urls are defined as:
166
167	[
168	('/yay/', 'http://backend.example.com/')
169	]
170
171	Then, this middleware will search the given response object's Location,
172	Content-Location, and URI headers for '^http://backend.example.com/'
173	and replace matches with current hostname + /yay/.
174
175	This is similar to Apache's ProxyPassReverse directive.
176
177	"""
178
179	location_headers = ['URI', 'Location', 'Content-Location']	10✔
180
181	def process_response(self, proxy, request, upstream_response, response):	10✔
182	for replacement, pattern in proxy.reverse_urls:	10✔
183	pattern = r'^%s' % re.escape(pattern)	10✔
184	replacement = request.build_absolute_uri(replacement)	10✔
185
186	for loc in self.location_headers:	10✔
187	if not response.has_header(loc):	10✔
188	continue	×
189
190	response[loc] = re.sub(pattern, replacement, response[loc])	10✔
191
192	return response	10✔

thomasw / djproxy / 173

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous