-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Issue #7250 - Correct HostHeaderCustomizer
logic and add new RejectMissingAuthorityCustomizer
#7292
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
15 changes: 15 additions & 0 deletions
15
jetty-server/src/main/config/etc/jetty-host-header-customizer.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
<?xml version="1.0"?><!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_3.dtd"> | ||
<Configure id="httpConfig" class="org.eclipse.jetty.server.HttpConfiguration"> | ||
<Call name="addCustomizer"> | ||
<Arg> | ||
<New class="org.eclipse.jetty.server.HostHeaderCustomizer"> | ||
<Arg> | ||
<Property name="jetty.hostheader.serverName" /> | ||
</Arg> | ||
<Arg> | ||
<Property name="jetty.hostheader.serverPort" /> | ||
</Arg> | ||
</New> | ||
</Arg> | ||
</Call> | ||
</Configure> |
8 changes: 8 additions & 0 deletions
8
jetty-server/src/main/config/etc/jetty-reject-missing-authority-customizer.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
<?xml version="1.0"?><!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_3.dtd"> | ||
<Configure id="httpConfig" class="org.eclipse.jetty.server.HttpConfiguration"> | ||
<Call name="addCustomizer"> | ||
<Arg> | ||
<New class="org.eclipse.jetty.server.RejectMissingAuthorityCustomizer" /> | ||
</Arg> | ||
</Call> | ||
</Configure> |
23 changes: 23 additions & 0 deletions
23
jetty-server/src/main/config/modules/host-header-customizer.mod
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html | ||
|
||
[description] | ||
Adds a Host Header Customizer to the HTTP Connector to enforce a | ||
Request Host header on HTTP/1.0 and HTTP/2 requests. | ||
|
||
[tags] | ||
connector | ||
|
||
[depend] | ||
http | ||
|
||
[xml] | ||
etc/jetty-host-header-customizer.xml | ||
|
||
[ini-template] | ||
### HostHeaderCustomizer Configuration | ||
|
||
## The Server Name to force on null Host headers | ||
# jetty.hostheader.serverName=serverName | ||
|
||
## The Server Port to force on null Host headers | ||
# jetty.hostheader.serverPort=80 |
16 changes: 16 additions & 0 deletions
16
jetty-server/src/main/config/modules/reject-missing-authority-customizer.mod
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# DO NOT EDIT - See: https://www.eclipse.org/jetty/documentation/current/startup-modules.html | ||
|
||
[description] | ||
Reject Missing HTTP Authority Customizer. | ||
If an HTTP request arrives without a valid Authority it is rejected with a 400 Bad Request. | ||
This means empty Host headers, missing Host headers, or authority not being set from other | ||
means such as the ForwardedRequestCustomizer from Forwarding headers. | ||
|
||
[tags] | ||
connector | ||
|
||
[depend] | ||
http | ||
|
||
[xml] | ||
etc/jetty-reject-missing-authority-customizer.xml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
84 changes: 84 additions & 0 deletions
84
jetty-server/src/main/java/org/eclipse/jetty/server/RejectMissingAuthorityCustomizer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,84 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// ======================================================================== | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// Copyright (c) 1995-2021 Mort Bay Consulting Pty Ltd and others. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// ------------------------------------------------------------------------ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// All rights reserved. This program and the accompanying materials | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// are made available under the terms of the Eclipse Public License v1.0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// and Apache License v2.0 which accompanies this distribution. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// The Eclipse Public License is available at | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// http://www.eclipse.org/legal/epl-v10.html | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// The Apache License v2.0 is available at | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// http://www.opensource.org/licenses/apache2.0.php | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// You may elect to redistribute this code under either of these licenses. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// ======================================================================== | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
package org.eclipse.jetty.server; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
import org.eclipse.jetty.http.BadMessageException; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
import org.eclipse.jetty.http.HostPortHttpField; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
import org.eclipse.jetty.http.HttpField; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
import org.eclipse.jetty.http.HttpHeader; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
import org.eclipse.jetty.http.HttpStatus; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
import org.eclipse.jetty.http.MetaData; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
import org.eclipse.jetty.util.StringUtil; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
/** | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* Reject requests that have no request level authority. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* <p> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* This addresses requests that either have schemes with no authority | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* per https://datatracker.ietf.org/doc/html/rfc7230#section-5.4 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* Or badly declared requests that have a non-absolute URI in the request line and an empty or missing `Host` header. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* </p> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* <p> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* This will return a 400 Bad Request on failed authority checks. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* </p> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
*/ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
public class RejectMissingAuthorityCustomizer implements HttpConfiguration.Customizer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@Override | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
public void customize(Connector connector, HttpConfiguration channelConfig, Request request) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
if (!hasRequestAuthority(request)) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
throw new BadMessageException(HttpStatus.BAD_REQUEST_400, "Missing authority"); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
private boolean hasRequestAuthority(Request request) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MetaData.Request metadata = request.getMetaData(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
if (metadata != null) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// Investigate HttpURI (eg: from HTTP/2 :authority)? | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
if (StringUtil.isNotBlank(metadata.getURI().getHost())) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
return true; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
// Investigate Host Header (eg: from HTTP/1 request fields) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HttpField host = metadata.getFields().getField(HttpHeader.HOST); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
if (host != null) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
if (!(host instanceof HostPortHttpField) && StringUtil.isNotBlank(host.getValue())) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
return true; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
if (host instanceof HostPortHttpField) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HostPortHttpField authority = (HostPortHttpField)host; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metadata.getURI().setAuthority(authority.getHost(), authority.getPort()); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
if (StringUtil.isNotBlank(authority.getHost())) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
return true; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comment on lines
+65
to
+80
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this way reduces the number of tests in the hot path:
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
return false; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since getHeader is a linear lookup, it is best to avoid doing it if possible, and then to use efficient non string lookup: