Fix URLs containing whitespace when GitLab used together with Apache

Turns off NoEscape flag. Adapted from https://gitlab.com/gitlab-org/gitlab-ce/issues/3163

web-server/apache/gitlab-apache22.conf

@@ -34,7 +34,7 @@
   RewriteEngine on
   #Forward all requests to gitlab-workhorse
-  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA,NE]
+  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA]
   # needed for downloading attachments
   DocumentRoot /home/git/gitlab/public

web-server/apache/gitlab-apache24.conf

@@ -35,7 +35,7 @@
   RewriteEngine on
   #Forward all requests to gitlab-workhorse
-  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA,NE]
+  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA]
   # needed for downloading attachments
   DocumentRoot /home/git/gitlab/public

web-server/apache/gitlab-omnibus-apache22.conf

@@ -35,7 +35,7 @@
   RewriteEngine on
   #Forward all requests to gitlab-workhorse
-  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA,NE]
+  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA]
   # needed for downloading attachments
   DocumentRoot /opt/gitlab/embedded/service/gitlab-rails/public

web-server/apache/gitlab-omnibus-apache24.conf

@@ -36,7 +36,7 @@
   RewriteEngine on
   #Forward these requests to gitlab-workhorse
-  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA,NE]
+  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA]
   # needed for downloading attachments
   DocumentRoot /opt/gitlab/embedded/service/gitlab-rails/public

web-server/apache/gitlab-omnibus-ssl-apache22.conf

@@ -61,7 +61,7 @@
   RewriteEngine on
   #Forward all requests to gitlab-workhorse
-  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA,NE]
+  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA]
   RequestHeader set X_FORWARDED_PROTO 'https'
   RequestHeader set X-Forwarded-Ssl on

web-server/apache/gitlab-omnibus-ssl-apache24.conf

@@ -62,7 +62,7 @@
   RewriteEngine on
   #Forward all requests to gitlab-workhorse
-  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA,NE]
+  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA]
   RequestHeader set X_FORWARDED_PROTO 'https'
   RequestHeader set X-Forwarded-Ssl on

web-server/apache/gitlab-ssl-apache22.conf

@@ -60,7 +60,7 @@
   RewriteEngine on
   #Forward all requests to gitlab-workhorse
-  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA,NE]
+  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA]
   RequestHeader set X_FORWARDED_PROTO 'https'
   RequestHeader set X-Forwarded-Ssl on

web-server/apache/gitlab-ssl-apache24.conf

@@ -61,7 +61,7 @@
   RewriteEngine on
   #Forward all requests to gitlab-workhorse
-  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA,NE]
+  RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA]
   RequestHeader set X_FORWARDED_PROTO 'https'
   RequestHeader set X-Forwarded-Ssl on

[username-removed-457275]

Removing the NE (No Escape ) flag from RewriteRule breaks accessing projects with the GitLab API via NAMESPACE/PROJECT_NAME. For example, now the request /api/v3/projects/foo%2Fbar/repository/branches will be forwarded to /api/v3/projects/foo%252Fbar/repository/branches -- it will percent encode the percent encode. See https://gitlab.com/gitlab-org/gitlab-recipes/commit/e44ea041dde57b5075f738046ec6316613cb790a

[Achilleas Pipinellis]

cc @Zenti

[username-removed-17194]

I'm currently adding another rule for api requests where the NE flag is set, as well as fixing error documents not displaying (see #43 (closed)). Will add a merge request soon.

[username-removed-17194]

Are there other URLs containing percent encoded characters other than the api?

[Achilleas Pipinellis]

Are there other URLs containing percent encoded characters other than the api?

@jacobvosmaer @ayufan do you have any idea?

[Achilleas Pipinellis]

@andy_schmidt can you try with the latest config?

[username-removed-5302]

@axil can't think of any right now.

[username-removed-457275]

@axil this fixes my API issue... thanks for the fast response, much appreciated! (Though I haven't tried out file uploads)

[username-removed-23770]

It does not work with my url. Im using apache 2.4 with the latest gitlab-omnibus-ssl-apache24.conf config

Here is an example: https://git.example.com/User/example/tree/master/test%20folder

[username-removed-17194]

I can verify your problem on a second GitLab instance I have recently set up, but not in my primary GitLab instance.

I found a solution for my second GitLab instance. In your gitlab-omnibus-ssl-apache24.conf file, can you replace the line

RewriteCond %{REQUEST_URI} ^/api/v3/.* [OR]

with

RewriteCond %{REQUEST_URI} ^/api/v3/.*

and try again?

Please report back whether that fixes your problem. If it does, I will submit it as a MR.

[username-removed-23770]

It works with RewriteCond {REQUEST_URI} ^/api/v3/.*

Thank you for your quick response.

[username-removed-17194]

No Problem. I will submit this fix as a MR.