Skip to content
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.

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

Allow configuring RemoteIPProxyProtocol at VHost level #2582

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 22 additions & 0 deletions manifests/vhost.pp
Original file line number Diff line number Diff line change
Expand Up @@ -1705,6 +1705,11 @@
# @param userdir
# Instances of apache::mod::userdir
#
# @param proxy_protocol
# Enable or disable PROXY protocol handling
#
# @param proxy_protocol_exceptions
# Disable processing of PROXY header for certain hosts or networks
define apache::vhost (
Variant[Stdlib::Absolutepath, Boolean] $docroot,
Boolean $manage_docroot = true,
Expand Down Expand Up @@ -1966,6 +1971,8 @@
Apache::OIDCSettings $oidc_settings = {},
Optional[Variant[Boolean, String]] $mdomain = undef,
Optional[Variant[String[1], Array[String[1]]]] $userdir = undef,
Optional[Boolean] $proxy_protocol = undef,
Array[Stdlib::Host] $proxy_protocol_exceptions = [],
) {
# The base class must be included first because it is used by parameter defaults
if ! defined(Class['apache']) {
Expand Down Expand Up @@ -2955,6 +2962,21 @@
}
}

if $proxy_protocol != undef {
include apache::mod::remoteip

$proxy_protocol_params = {
proxy_protocol => $proxy_protocol,
proxy_protocol_exceptions => $proxy_protocol_exceptions,
}

concat::fragment { "${name}-proxy_protocol":
target => "${priority_real}${filename}.conf",
order => 400,
content => epp('apache/vhost/_proxy_protocol.epp', $proxy_protocol_params),
}
}

$file_footer_params = {
'define' => $define,
'passenger_pre_start' => $passenger_pre_start,
Expand Down
11 changes: 10 additions & 1 deletion spec/defines/vhost_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,9 @@
'ClientSecret' => 'aae053a9-4abf-4824-8956-e94b2af335c8',
'CryptoPassphrase' => '4ad1bb46-9979-450e-ae58-c696967df3cd' },
'mdomain' => 'example.com example.net auto',
'userdir' => 'disabled'
'userdir' => 'disabled',
'proxy_protocol' => true,
'proxy_protocol_exceptions' => ['127.0.0.1', '10.0.0.0/8'],
}
end

Expand Down Expand Up @@ -968,6 +970,13 @@
content: %r{^MDomain example\.com example\.net auto$},
)
}

it {
expect(subject).to contain_concat__fragment('rspec.example.com-proxy_protocol')
.with_content(%r{^\s+RemoteIPProxyProtocol On$})
.with_content(%r{^\s+RemoteIPProxyProtocolExceptions 127\.0\.0\.1$})
.with_content(%r{^\s+RemoteIPProxyProtocolExceptions 10\.0\.0\.0/8$})
}
end

context 'vhost with proxy_add_headers true' do
Expand Down
8 changes: 8 additions & 0 deletions templates/vhost/_proxy_protocol.epp
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<%- |
Boolean $proxy_protocol,
Array[Stdlib::Host] $proxy_protocol_exceptions,
| -%>
RemoteIPProxyProtocol <%= apache::bool2httpd($proxy_protocol) %>
<% $proxy_protocol_exceptions.each |$exception| { -%>
RemoteIPProxyProtocolExceptions <%= $exception %>
<% } -%>