Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

fix(sdk-java): refuse a bad default header without quoting its value

Yudhi Armyndharis741d793d2e74
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/ClientConfig.java b/sdk/java/src/main/java/com/rmyndharis/openwa/ClientConfig.java
index 79f59cd80..6cb183204 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/ClientConfig.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/ClientConfig.java
@@ -47,9 +47,47 @@ public final class ClientConfig {
} catch (NullPointerException e) {
throw new IllegalArgumentException("OpenWAClient: defaultHeaders must not contain null keys or values");
}
+ // A value the HTTP stack refuses (a trailing newline from a token file) is named here, without the
+ // value: the stack's own message would quote it, and a proxy credential carried in a header would
+ // reach the application's logs.
+ for (Map.Entry<String, String> header : this.defaultHeaders.entrySet()) {
+ if (!isToken(header.getKey())) {
+ throw new IllegalArgumentException(
+ "OpenWAClient: defaultHeaders has a header name that is not a valid HTTP token");
+ }
+ if (hasIllegalHeaderValueChar(header.getValue())) {
+ throw new IllegalArgumentException(
+ "OpenWAClient: defaultHeaders value for '" + header.getKey()
+ + "' contains illegal characters (control or non-ASCII) - check for a stray newline");
+ }
+ }
this.transport = b.transport;
}
+ private static boolean isToken(String name) {
+ if (name.isEmpty()) {
+ return false;
+ }
+ for (int i = 0; i < name.length(); i++) {
+ char c = name.charAt(i);
+ boolean alnum = (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z');
+ if (!alnum && "!#$%&'*+-.^_`|~".indexOf(c) < 0) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ private static boolean hasIllegalHeaderValueChar(String value) {
+ for (int i = 0; i < value.length(); i++) {
+ char c = value.charAt(i);
+ if (c != '\t' && (c < 0x20 || c > 0x7e)) {
+ return true;
+ }
+ }
+ return false;
+ }
+
private static boolean hasIllegalChar(String s) {
for (int i = 0; i < s.length(); i++) {
char c = s.charAt(i);
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/OpenWAClient.java b/sdk/java/src/main/java/com/rmyndharis/openwa/OpenWAClient.java
index 09d2d2022..5c1be9503 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/OpenWAClient.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/OpenWAClient.java
@@ -255,7 +255,12 @@ public final class OpenWAClient {
} catch (IllegalArgumentException e) {
// e.g. a JDK-restricted header name in defaultHeaders, or a URI-illegal char — keep it
// inside the OpenWAError contract instead of leaking a raw JDK exception to the caller.
- throw new OpenWAError("Invalid request — " + method + " " + path + ": " + reason(e));
+ // The JDK words a refused header as: invalid header value: "<the value>". Never repeat that.
+ String why = reason(e);
+ if (why.toLowerCase(java.util.Locale.ROOT).contains("header")) {
+ why = "a header was refused by the HTTP stack (check defaultHeaders for control or non-ASCII characters)";
+ }
+ throw new OpenWAError("Invalid request — " + method + " " + path + ": " + why);
}
if (res.status() < 200 || res.status() >= 300) {
throw OpenWAApiError.fromResponse(res.status(), "", utf8(res.body()), method + " " + path, res.headers());
diff --git a/sdk/java/src/test/java/com/rmyndharis/openwa/ConfigTest.java b/sdk/java/src/test/java/com/rmyndharis/openwa/ConfigTest.java
index fc97649be..14133fa6d 100644
--- a/sdk/java/src/test/java/com/rmyndharis/openwa/ConfigTest.java
+++ b/sdk/java/src/test/java/com/rmyndharis/openwa/ConfigTest.java
@@ -51,6 +51,20 @@ class ConfigTest {
assertTrue(tx.lastRequest().url().startsWith("http://h/"));
}
+ @Test
+ void aDefaultHeaderValueWithAStrayNewlineIsRefusedWithoutBeingQuoted() {
+ Map<String, String> h = new HashMap<>();
+ h.put("CF-Access-Client-Secret", "s3cret-token\n");
+ IllegalArgumentException e =
+ assertThrows(IllegalArgumentException.class, () -> base().defaultHeaders(h).build());
+ assertTrue(e.getMessage().contains("CF-Access-Client-Secret"));
+ assertFalse(e.getMessage().contains("s3cret-token"));
+ Map<String, String> badName = Map.of("X Bad Name", "v");
+ assertThrows(IllegalArgumentException.class, () -> base().defaultHeaders(badName).build());
+ // A tab and plain printable ASCII are fine.
+ base().defaultHeaders(Map.of("X-Trace", "a\tb c")).build();
+ }
+
@Test
void defaultHeadersAreCopiedAtBuildTime() {
Map<String, String> h = new HashMap<>(Map.of("X-Tenant", "a"));