Skip to content

Commit

Permalink
[WFLY-14255] Make reuseXForwarded and rewriteHost configurable
Browse files Browse the repository at this point in the history
  • Loading branch information
baranowb committed Mar 13, 2024
1 parent 14a2174 commit 3471a4c
Showing 1 changed file with 130 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
= [Community]Make ReuseXForwarded and RewriteHost configurable
:author: Bartosz Baranowski
:email: bbaranow@redhat.com
:toc: left
:icons: font
:idprefix:
:idseparator: -

== Overview

In some scenarios it is a requirement to reuse x forwarded or rewrite host header. Currently ProxyHandler flags controlling both are hardcoded to 'false', meaning mentioned functionality is not accessible.
This RFE adress this by introduction of model values that control mentioned flags.

== Issue Metadata

=== Issue

* https://issues.redhat.com/browse/WFLY[WFLY-14255]

=== Related Issues

=== Stability Level
// Choose the planned stability level for the proposed functionality
* [ ] Experimental

* [ ] Preview

* [X] Community

* [ ] default

=== Dev Contacts

* mailto:{email}[{author}]

=== QE Contacts

* mailto:msvehla@redhat.com[Martin Svehla]

=== Testing By
// Put an x in the relevant field to indicate if testing will be done by Engineering or QE.
// Discuss with QE during the Kickoff state to decide this
* [ ] Engineering

* [x] QE

=== Affected Projects or Components

* Web/Undertow

=== Other Interested Projects

=== Relevant Installation Types
// Remove the x next to the relevant field if the feature in question is not relevant
// to that kind of WildFly installation
* [x] Traditional standalone server (unzipped or provisioned by Galleon)

* [x] Managed domain

* [x] OpenShift s2i

* [x] Bootable jar

== Requirements

=== Hard Requirements

* Being able to configure both flags via model:
- reuse-x-forwarded-header
- rewrite-host-header

[literal]
<subsystem xmlns="urn:jboss:domain:undertow:14.0" default-server="some-server" default-servlet-container="myContainer" default-virtual-host="default-virtual-host" instance-id="some-id" statistics-enabled="true">
....
<handlers>
<file case-sensitive="false" directory-listing="true" follow-symlink="true" name="welcome-content" path="${jboss.home.dir}" safe-symlink-paths="/path/to/folder /second/path"/>
<reverse-proxy ... reuse-x-forwarded-header="true" rewrite-host-header="false">
</reverse-proxy>
</handlers>
....
</subsystem>

=== Nice-to-Have Requirements

=== Non-Requirements

== Backwards Compatibility

Subsystem transformers should be able to handle it.

=== Default Configuration

No change.

=== Importing Existing Configuration

No steps, transformers should handle purging default value for previous configs.


=== Deployments

No. Default is still false for both, so there should be no change in behavior.

=== Interoperability

Not affected.

== Security Considerations

////
Identification if any security implications that may need to be considered with this feature
or a confirmation that there are no security implications to consider.
////

== Test Plan

== Community Documentation

Should be part of model reference. Possibly could be documented in Undertow as well?

== Release Note Content
////
Draft verbiage for up to a few sentences on the feature for inclusion in the
Release Note blog article for the release that first includes this feature.
Example article: http://wildfly.org/news/2018/08/30/WildFly14-Final-Released/.
This content will be edited, so there is no need to make it perfect or discuss
what release it appears in. "See Overview" is acceptable if the overview is
suitable. For simple features best covered as an item in a bullet-point list
of features containing a few words on each, use "Bullet point: <The few words>"
////

0 comments on commit 3471a4c

Please sign in to comment.