Skip to content

[pull] main from zaproxy:main #36

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.

Sign up for GitHub

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

Merged
pull merged 2 commits into from
Jul 31, 2025
Merged

[pull] main from zaproxy:main #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0be4737
Do not warn on charset aliases
thc202 Jul 31, 2025
77a60d7
Merge pull request #9015 from thc202/no-warn-aliases
ricekot Jul 31, 2025
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
13 changes: 12 additions & 1 deletion zap/src/main/java/org/parosproxy/paros/network/HttpMessage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
package org.parosproxy.paros.network;

import java.net.HttpCookie;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
Expand Down Expand Up @@ -504,14 +505,24 @@ private static void setBodyCharset(HttpBody body, HttpHeader header) {
String charset = header.getCharset();
body.setCharset(charset);

if (charset != null && !charset.equalsIgnoreCase(body.getCharset())) {
if (charset != null
&& !charset.equalsIgnoreCase(body.getCharset())
&& !isCharsetSupported(charset)) {
LOGGER.warn(
"Failed to set charset {} from content-type value: {}",
charset,
header.getNormalisedContentTypeValue());
}
}

private static boolean isCharsetSupported(String charset) {
try {
return Charset.isSupported(charset);
} catch (IllegalArgumentException ignore) {
return false;
}
}

/**
* Sets the given string body as the response body.
*
Expand Down
85 changes: 78 additions & 7 deletions zap/src/test/java/org/parosproxy/paros/network/HttpMessageUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,10 @@

import static java.util.Arrays.asList;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.nullValue;
Expand All @@ -39,6 +41,10 @@
import java.util.List;
import java.util.stream.Stream;
import org.apache.commons.httpclient.URI;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.core.Logger;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.config.Configurator;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
Expand All @@ -55,14 +61,18 @@
import org.zaproxy.zap.network.HttpEncodingGzip;
import org.zaproxy.zap.network.HttpRequestBody;
import org.zaproxy.zap.network.HttpResponseBody;
import org.zaproxy.zap.testutils.Log4jTestAppender;
import org.zaproxy.zap.users.User;

/** Unit test for {@link HttpMessage}. */
class HttpMessageUnitTest {

private Log4jTestAppender testAppender;

@AfterEach
void cleanUp() {
void cleanUp() throws Exception {
HttpMessage.setContentEncodingsHandler(null);
Configurator.reconfigure(getClass().getResource("/log4j2-test.properties").toURI());
}

@Test
Expand Down Expand Up @@ -577,23 +587,52 @@ void shouldNotBeWebSocketUpgradeIfResponseMissUpgradeHeader() throws Exception {
@ParameterizedTest
@MethodSource(value = "setBodyData")
void shouldUseContentTypeCharsetWhenSettingRequestBody(
String charset, String body, String expectedBody) throws Exception {
String charset, String expectedCharset, String body, String expectedBody)
throws Exception {
// Given
HttpMessage message = new HttpMessage();
message.setRequestHeader(
new HttpRequestHeader(
"GET / HTTP/1.1\r\nContent-Type: text/plain; charset=" + charset));
withLoggerAppender();
// When
message.setRequestBody(body);
// Then
assertThat(message.getRequestBody().getCharset(), is(equalTo(charset)));
assertThat(message.getRequestBody().getCharset(), is(equalTo(expectedCharset)));
assertThat(message.getRequestBody().toString(), is(equalTo(expectedBody)));
assertThat(testAppender.getLogEvents(), hasSize(0));
}

@ParameterizedTest
@ValueSource(strings = {"unknown", "!~invalid~name~"})
void shouldUseDefaultAndWarnOnUnknownCharsetWhenSettingRequestBody(String charset)
throws Exception {
// Given
HttpMessage message = new HttpMessage();
message.setRequestHeader(
new HttpRequestHeader(
"GET / HTTP/1.1\r\nContent-Type: text/plain; charset=" + charset));
withLoggerAppender();
// When
message.setRequestBody("Body");
// Then
assertThat(message.getRequestBody().getCharset(), is(equalTo("ISO-8859-1")));
assertThat(message.getRequestBody().toString(), is(equalTo("Body")));
assertThat(testAppender.getLogEvents(), hasSize(1));
assertThat(
testAppender.getLogEvents().get(0).getMessage(),
containsString("Failed to set charset"));
}

static Stream<Arguments> setBodyData() {
String iso8851 = StandardCharsets.ISO_8859_1.name();
String utf8 = StandardCharsets.UTF_8.name();
return Stream.of(
arguments(StandardCharsets.ISO_8859_1.name(), "J/ψ → VP", "J/????VP"),
arguments(StandardCharsets.UTF_8.name(), "J/ψ → VP", "J/ψ → VP"));
arguments(iso8851, iso8851, "J/ψ → VP", "J/????VP"),
arguments(utf8, utf8, "J/ψ → VP", "J/ψ → VP"),
// Check aliases work as well and don't cause warns
arguments("ISO_8859-1:1987", iso8851, "J/ψ → VP", "J/????VP"),
arguments("utf8", utf8, "J/ψ → VP", "J/ψ → VP"));
}

static Stream<Arguments> getNonPostMethods() {
Expand All @@ -605,17 +644,41 @@ static Stream<Arguments> getNonPostMethods() {
@ParameterizedTest
@MethodSource(value = "setBodyData")
void shouldUseContentTypeCharsetWhenSettingResponseBody(
String charset, String body, String expectedBody) throws Exception {
String charset, String expectedCharset, String body, String expectedBody)
throws Exception {
// Given
HttpMessage message = new HttpMessage();
message.setResponseHeader(
new HttpResponseHeader(
"HTTP/1.1 200 OK\r\nContent-Type: text/plain; charset=" + charset));
withLoggerAppender();
// When
message.setResponseBody(body);
// Then
assertThat(message.getResponseBody().getCharset(), is(equalTo(charset)));
assertThat(message.getResponseBody().getCharset(), is(equalTo(expectedCharset)));
assertThat(message.getResponseBody().toString(), is(equalTo(expectedBody)));
assertThat(testAppender.getLogEvents(), hasSize(0));
}

@ParameterizedTest
@ValueSource(strings = {"unknown", "!~invalid~name~"})
void shouldUseDefaultAndWarnOnUnknownCharsetWhenSettingResponseBody(String charset)
throws Exception {
// Given
HttpMessage message = new HttpMessage();
message.setResponseHeader(
new HttpResponseHeader(
"HTTP/1.1 200 OK\r\nContent-Type: text/plain; charset=" + charset));
withLoggerAppender();
// When
message.setResponseBody("Body");
// Then
assertThat(message.getResponseBody().getCharset(), is(equalTo("UTF-8")));
assertThat(message.getResponseBody().toString(), is(equalTo("Body")));
assertThat(testAppender.getLogEvents(), hasSize(1));
assertThat(
testAppender.getLogEvents().get(0).getMessage(),
containsString("Failed to set charset"));
}

private static HttpMessage newHttpMessage() throws Exception {
Expand Down Expand Up @@ -644,4 +707,12 @@ private static List<HttpEncoding> encodings(HttpBody body) {
verify(body).setContentEncodings(arg.capture());
return arg.getValue();
}

private void withLoggerAppender() {
testAppender = new Log4jTestAppender();
LoggerContext context = LoggerContext.getContext();
Logger logger = context.getLogger(HttpMessage.class.getCanonicalName());
context.getConfiguration().addLoggerAppender(logger, testAppender);
logger.setLevel(Level.WARN);
}
}
Loading