Skip to content

use dashes, not underscores when settings HTTP headers #1214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ekohl merged 1 commit into from
Feb 20, 2025
Merged

use dashes, not underscores when settings HTTP headers #1214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions manifests/config/apache.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,10 @@
}

$vhost_http_request_headers = [
'set X_FORWARDED_PROTO "http"',
'set SSL_CLIENT_S_DN ""',
'set SSL_CLIENT_CERT ""',
'set SSL_CLIENT_VERIFY ""',
'set X-FORWARDED-PROTO "http"',
'set SSL-CLIENT-S-DN ""',
'set SSL-CLIENT-CERT ""',
'set SSL-CLIENT-VERIFY ""',
] +
$request_headers_to_unset.map |$header| {
"unset ${header}"
Expand All @@ -212,10 +212,10 @@
}

$vhost_https_request_headers = [
'set X_FORWARDED_PROTO "https"',
'set SSL_CLIENT_S_DN "%{SSL_CLIENT_S_DN}s"',
'set SSL_CLIENT_CERT "%{SSL_CLIENT_CERT}s"',
'set SSL_CLIENT_VERIFY "%{SSL_CLIENT_VERIFY}s"',
'set X-FORWARDED-PROTO "https"',
Copy link
Member

@ekohl ekohl Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this break https://github.com/theforeman/puppet-pulpcore/blob/8288f3736a1543417eba6322e7013d0f230bd85e/templates/settings.py.erb#L65-L66?

Copy link
Member Author

@evgeni evgeni Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it will make it work!

My-Cool-Header gets translated to HTTP_MY_COOL_HEADER by gunicorn. It's just in the past it also allowed My_Cool_Header to become HTTP_MY_COOL_HEADER (you remember, huh?) and this used to work for us, and now it doesn't anymore.

Copy link
Member Author

@evgeni evgeni Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, puppet-pulpcore should really not depend on puppet-foreman setting things up -- it can be deployed standalone after all :)

Copy link
Member

@ekohl ekohl Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, but I don't see us setting it in puppet-pulpcore nor puppet-foreman_proxy_content so on content proxies it's actually broken as well. Just in a different way.

Copy link
Member

@ekohl ekohl Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see you came to the same conclusion.

Copy link
Member Author

@evgeni evgeni Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

theforeman/puppet-pulpcore#376

'set SSL-CLIENT-S-DN "%{SSL_CLIENT_S_DN}s"',
'set SSL-CLIENT-CERT "%{SSL_CLIENT_CERT}s"',
'set SSL-CLIENT-VERIFY "%{SSL_CLIENT_VERIFY}s"',
] +
$request_headers_to_unset.map |$header| {
"unset ${header}"
Expand Down
32 changes: 16 additions & 16 deletions spec/classes/foreman_config_apache_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@
.with_proxy_preserve_host(true)
.with_proxy_add_headers(true)
.with_request_headers([
'set X_FORWARDED_PROTO "http"',
'set SSL_CLIENT_S_DN ""',
'set SSL_CLIENT_CERT ""',
'set SSL_CLIENT_VERIFY ""',
'set X-FORWARDED-PROTO "http"',
'set SSL-CLIENT-S-DN ""',
'set SSL-CLIENT-CERT ""',
'set SSL-CLIENT-VERIFY ""',
'unset REMOTE-USER',
'unset REMOTE_USER',
'unset REMOTE-USER-EMAIL',
Expand Down Expand Up @@ -127,10 +127,10 @@ class { 'apache':

it { should contain_apache__vhost('foreman')
.with_request_headers([
'set X_FORWARDED_PROTO "http"',
'set SSL_CLIENT_S_DN ""',
'set SSL_CLIENT_CERT ""',
'set SSL_CLIENT_VERIFY ""',
'set X-FORWARDED-PROTO "http"',
'set SSL-CLIENT-S-DN ""',
'set SSL-CLIENT-CERT ""',
'set SSL-CLIENT-VERIFY ""',
'unset OIDC_FOO',
])
}
Expand Down Expand Up @@ -197,10 +197,10 @@ class { 'apache':
.with_proxy_preserve_host(true)
.with_proxy_add_headers(true)
.with_request_headers([
'set X_FORWARDED_PROTO "https"',
'set SSL_CLIENT_S_DN "%{SSL_CLIENT_S_DN}s"',
'set SSL_CLIENT_CERT "%{SSL_CLIENT_CERT}s"',
'set SSL_CLIENT_VERIFY "%{SSL_CLIENT_VERIFY}s"',
'set X-FORWARDED-PROTO "https"',
'set SSL-CLIENT-S-DN "%{SSL_CLIENT_S_DN}s"',
'set SSL-CLIENT-CERT "%{SSL_CLIENT_CERT}s"',
'set SSL-CLIENT-VERIFY "%{SSL_CLIENT_VERIFY}s"',
'unset REMOTE-USER',
'unset REMOTE_USER',
'unset REMOTE-USER-EMAIL',
Expand Down Expand Up @@ -289,10 +289,10 @@ class { 'apache':

it { should contain_apache__vhost('foreman-ssl')
.with_request_headers([
'set X_FORWARDED_PROTO "https"',
'set SSL_CLIENT_S_DN "%{SSL_CLIENT_S_DN}s"',
'set SSL_CLIENT_CERT "%{SSL_CLIENT_CERT}s"',
'set SSL_CLIENT_VERIFY "%{SSL_CLIENT_VERIFY}s"',
'set X-FORWARDED-PROTO "https"',
'set SSL-CLIENT-S-DN "%{SSL_CLIENT_S_DN}s"',
'set SSL-CLIENT-CERT "%{SSL_CLIENT_CERT}s"',
'set SSL-CLIENT-VERIFY "%{SSL_CLIENT_VERIFY}s"',
'unset OIDC_FOO',
])
}
Expand Down
Loading