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

Escape HTML in rendered error messages #9829

Merged
merged 1 commit into from Nov 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Escape any HTML that happens to be inside an error message when rende…
…ring as HTML
  • Loading branch information
chadlwilson committed Nov 1, 2021
commit bda81084c0401234b168437cf35a63390e3064d1
Expand Up @@ -16,6 +16,7 @@
package com.thoughtworks.go.spark;

import org.apache.commons.io.IOUtils;
import org.apache.commons.text.StringEscapeUtils;

import java.io.IOException;
import java.io.InputStream;
Expand All @@ -27,7 +28,7 @@ public abstract class HtmlErrorPage {

public static String errorPage(int code, String message) {
return Holder.INSTANCE.replaceAll(buildRegex("status_code"), valueOf(code))
.replaceAll(buildRegex("error_message"), message);
.replaceAll(buildRegex("error_message"), StringEscapeUtils.escapeHtml4(message));
}

private static String buildRegex(final String value) {
Expand Down
@@ -0,0 +1,40 @@
/*
* Copyright 2021 ThoughtWorks, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.thoughtworks.go.spark;

import org.junit.jupiter.api.Test;

import static com.thoughtworks.go.spark.HtmlErrorPage.errorPage;
import static org.assertj.core.api.Assertions.assertThat;

class HtmlErrorPageTest {

@Test
public void shouldReplaceStatusCodeAndMessage() {
assertThat(errorPage(404, "Error message"))
.contains("<h1>404</h1>")
.contains("<h2>Error message</h2>");
}

@Test
public void shouldEscapeHtmlInMessages() {
String htmlInMessage = "<img src=\"blah\"/>";
assertThat(errorPage(404, htmlInMessage))
.doesNotContain(htmlInMessage)
.contains("<h2>&lt;img src=&quot;blah&quot;/&gt;</h2>");
}
}