Mercurial > kallithea
changeset 8887:070b8c39736f
auth: only use X- headers instead of wsgi.url_scheme if explicitly told so in url_scheme_header - drop https_fixup setting
Before, several X- headers would be trusted to overrule the actual connection
protocol (http or https) seen by the Kallithea WSGI server. That was mainly
when https_fixup were set, but it incorrectly also kicked in if https_fixup or
use_htsts were configured. The ambiguity of which headers were used also made
it less reliable. The proxy server not only had to be configured to set one of
the headers correctly, it also had to make sure other headers were not passed
on from the client. It would thus in some cases be possible for clients to fake
the connection scheme, and thus potentially be possible to bypass restrictions
configured in Kallithea.
Fixed by making it configurable which WSGI environment variable to use for the
protocol. Users can configure url_scheme_header to for example
HTTP_X_FORWARDED_PROTO instead of using the default wsgi.url_scheme .
This change is a bit similar to what is going on in the https_fixup middleware,
but is doing a bit more of what for example is happening in similar code in
werkzeug/middleware/proxy_fix.py .
The semantics of the old https_fixup were unsafe, so it has been dropped.
Admins that are upgrading must change their configuration to use the new
url_scheme_header option.
| author | Mads Kiilerich <mads@kiilerich.com> |
|---|---|
| date | Sun, 09 May 2021 22:40:56 +0200 |
| parents | 3d7ba590f6f5 |
| children | f0fbb0fe4462 |
| files | development.ini docs/setup.rst kallithea/config/application.py kallithea/config/middleware/https_fixup.py kallithea/templates/ini/template.ini.mako |
| diffstat | 5 files changed, 22 insertions(+), 20 deletions(-) [+] |
line wrap: on
line diff
--- a/development.ini Sun May 09 22:34:02 2021 +0200 +++ b/development.ini Sun May 09 22:40:56 2021 +0200 @@ -114,6 +114,9 @@ ## WSGI environment variable to get the IP address of the client (default REMOTE_ADDR) #remote_addr_variable = HTTP_X_FORWARDED_FOR +## WSGI environment variable to get the protocol (http or https) of the client connection (default wsgi.url_scheme) +#url_scheme_variable = HTTP_X_FORWARDED_PROTO + ## always pretend the client connected using HTTPS (default false) #force_https = true
--- a/docs/setup.rst Sun May 09 22:34:02 2021 +0200 +++ b/docs/setup.rst Sun May 09 22:40:56 2021 +0200 @@ -432,11 +432,10 @@ Kallithea will by default rely on finding the protocol (``http`` or ``https``) in the WSGI environment as ``wsgi.url_scheme``. If the proxy server puts -the protocol of the client request in the ``X-Url-Scheme``, -``X-Forwarded-Scheme``, or ``X-Forwarded-Proto`` HTTP header, -Kallithea can be configured to trust these headers by setting:: +the protocol of the client request in the ``X-Forwarded-Proto`` HTTP header, +Kallithea can be configured to trust that header by setting:: - https_fixup = true + url_scheme_variable = HTTP_X_FORWARDED_PROTO HTTPS support @@ -447,9 +446,8 @@ Alternatively, you can use some special configuration settings to control directly which scheme/protocol Kallithea will use when generating URLs: -- With ``https_fixup = true``, the scheme will be taken from the - ``X-Url-Scheme``, ``X-Forwarded-Scheme`` or ``X-Forwarded-Proto`` HTTP header - (default ``http``). +- With ``url_scheme_variable`` set, the scheme will be taken from that HTTP + header. - With ``force_https = true``, the scheme will be seen as ``https``. - With ``use_htsts = true``, Kallithea will set ``Strict-Transport-Security`` when using https.
--- a/kallithea/config/application.py Sun May 09 22:34:02 2021 +0200 +++ b/kallithea/config/application.py Sun May 09 22:40:56 2021 +0200 @@ -35,7 +35,7 @@ app = SimpleGit(app, config) # Enable https redirects based on HTTP_X_URL_SCHEME set by proxy - if any(asbool(config.get(x)) for x in ['https_fixup', 'force_https', 'use_htsts']): + if any(asbool(config.get(x)) for x in ['url_scheme_variable', 'force_https', 'use_htsts']): app = HttpsFixup(app, config) app = PermanentRepoUrl(app, config)
--- a/kallithea/config/middleware/https_fixup.py Sun May 09 22:34:02 2021 +0200 +++ b/kallithea/config/middleware/https_fixup.py Sun May 09 22:40:56 2021 +0200 @@ -26,6 +26,7 @@ """ +import kallithea from kallithea.lib.utils2 import asbool @@ -54,20 +55,17 @@ middleware you should set this header inside your proxy ie. nginx, apache etc. """ - # DETECT PROTOCOL ! - if 'HTTP_X_URL_SCHEME' in environ: - proto = environ.get('HTTP_X_URL_SCHEME') - elif 'HTTP_X_FORWARDED_SCHEME' in environ: - proto = environ.get('HTTP_X_FORWARDED_SCHEME') - elif 'HTTP_X_FORWARDED_PROTO' in environ: - proto = environ.get('HTTP_X_FORWARDED_PROTO') - else: - proto = 'http' - org_proto = proto + proto = None # if we have force, just override if asbool(self.config.get('force_https')): proto = 'https' + else: + # get protocol from configured WSGI environment variable + url_scheme_variable = kallithea.CONFIG.get('url_scheme_variable') + if url_scheme_variable: + proto = environ.get(url_scheme_variable) - environ['wsgi.url_scheme'] = proto - environ['wsgi._org_proto'] = org_proto + if proto: + environ['wsgi._org_proto'] = environ.get('wsgi.url_scheme') + environ['wsgi.url_scheme'] = proto
--- a/kallithea/templates/ini/template.ini.mako Sun May 09 22:34:02 2021 +0200 +++ b/kallithea/templates/ini/template.ini.mako Sun May 09 22:40:56 2021 +0200 @@ -177,6 +177,9 @@ <%text>##</%text> WSGI environment variable to get the IP address of the client (default REMOTE_ADDR) #remote_addr_variable = HTTP_X_FORWARDED_FOR +<%text>##</%text> WSGI environment variable to get the protocol (http or https) of the client connection (default wsgi.url_scheme) +#url_scheme_variable = HTTP_X_FORWARDED_PROTO + <%text>##</%text> always pretend the client connected using HTTPS (default false) #force_https = true