Skip to content

Conversation

@pixeebot
Copy link

@pixeebot pixeebot bot commented Jan 28, 2025

This change ensures that HTTP response header values can't contain newline characters, leaving you vulnerable to HTTP response splitting and other attacks.

If malicious users can get newline characters into an HTTP response header, they can inject and forge new header values that look like they came from the server, and trick web gateways, proxies, and browsers. This leads to vulnerabilities like Cross-site Scripting (XSS), HTTP response splitting, and more attacks from there.

Our change simply makes sure that if the string passed to be a new response header value is non-null, all the newline characters (CR and LF) will be removed:

+ import io.github.pixee.security.Newlines;
  ...
  String orderId = getUserOrderId();
- response.setHeader("X-Acme-Order-ID", orderId);
+ response.setHeader("X-Acme-Order-ID", Newlines.stripAll(orderId));

Note: Many modern application servers will sanitize these values, but it's almost never specified in documentation, and thus there is little guarantee against regression. Given that, we still recommend this practice.

More reading

🧚🤖 Powered by Pixeebot

Feedback | Community | Docs | Codemod ID: pixee:java/strip-http-header-newlines

<sonar.host.url>https://sonarcloud.io</sonar.host.url>
<sonar.organization>pixee</sonar.organization>
</properties>
<versions.java-security-toolkit>1.2.1</versions.java-security-toolkit>
Copy link
Author

Choose a reason for hiding this comment

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

This library holds security tools for protecting Java API calls.

License: MIT ✅ | Open source ✅ | More facts

@sonarqubecloud
Copy link

@pixeebot
Copy link
Author

pixeebot bot commented Feb 5, 2025

I'm confident in this change, but I'm not a maintainer of this project. Do you see any reason not to merge it?

If this change was not helpful, or you have suggestions for improvements, please let me know!

@pixeebot
Copy link
Author

pixeebot bot commented Feb 6, 2025

Unless you want to allow metacharacters that could, in some situations, drive unexpected behavior -- we recommend merging this change. The drop-in solution provided doesn't change anything besides removing newlines in the outgoing header value.

If there are other concerns about this change, I'd love to hear about them!

@pixeebot
Copy link
Author

pixeebot bot commented Feb 12, 2025

This change may not be a priority right now, so I'll close it. If there was something I could have done better, please let me know!

You can also customize me to make sure I'm working with you in the way you want.

@pixeebot pixeebot bot closed this Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants