Merge pull request #20 from flownative/underscores-in-headers

Introduce NGINX_ENABLE_UNDERSCORES_IN_HEADERS
flownative · Feb 21, 2024 · b703b83 · b703b83
2 parents fd8ee3d + f632bb5
commit b703b83
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -83,6 +83,7 @@ Instead of the default format, a JSON format can be used by setting
 | NGINX_AUTH_BASIC_REALM                   | string  | off                                   | Realm for HTTP Basic Authentication; if "off", authentication is disabled                                                                                                                                         |
 | NGINX_AUTH_BASIC_USERNAME                | string  |                                       | Username for HTTP Basic Authentication                                                                                                                                                                            |
 | NGINX_AUTH_BASIC_ENCODED_HASHED_PASSWORD | string  |                                       | Base64-encoded hashed password (using httpasswd) for HTTP Basic Authentication                                                                                                                                    |
+| NGINX_ENABLE_UNDERSCORES_IN_HEADERS      | boolean | no                                    | Enables or disables the use of underscores in client request header fields.                                                                                                                                       |
 | BEACH_NGINX_CUSTOM_METRICS_ENABLE        | boolean | no                                    | If support for a custom metrics endpoint should be enabled                                                                                                                                                        |
 | BEACH_NGINX_CUSTOM_METRICS_SOURCE_PATH   | string  | /metrics                              | Path where metrics are located                                                                                                                                                                                    |
 | BEACH_NGINX_CUSTOM_METRICS_TARGET_PORT   | integer | 8082                                  | Port at which Nginx should listen to provide the metrics for scraping                                                                                                                                             |

diff --git a/root-files/opt/flownative/lib/nginx-legacy.sh b/root-files/opt/flownative/lib/nginx-legacy.sh
@@ -68,6 +68,8 @@ export NGINX_AUTH_BASIC_REALM=${NGINX_AUTH_BASIC_REALM:-off}
 export NGINX_AUTH_BASIC_USERNAME=${NGINX_AUTH_BASIC_USERNAME:-}
 export NGINX_AUTH_BASIC_ENCODED_HASHED_PASSWORD=${NGINX_AUTH_BASIC_ENCODED_HASHED_PASSWORD:-}
 
+export NGINX_ENABLE_UNDERSCORES_IN_HEADERS=${NGINX_ENABLE_UNDERSCORES_IN_HEADERS:-no}
+
 export NGINX_STATIC_ROOT=${NGINX_STATIC_ROOT:-/var/www/html}
 EOF
 }
@@ -92,6 +94,13 @@ nginx_legacy_initialize_flow() {
         fi
     fi
 
+    if is_boolean_yes "${NGINX_ENABLE_UNDERSCORES_IN_HEADERS}"; then
+        info "Nginx: Enabling underscores in headers ..."
+        underScoresInHeadersDirective="underscores_in_headers on;"
+    else
+        underScoresInHeadersDirective="underscores_in_headers off;"
+    fi
+
     cat >"${NGINX_CONF_PATH}/sites-enabled/site.conf" <<-EOM
 
 server {
@@ -308,6 +317,8 @@ server {
         access_log off;
         log_not_found off;
     }
+
+    ${underScoresInHeadersDirective}
 }
 EOM
 }