This is an automated email from the ASF dual-hosted git repository. chibenwa pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-jdkim.git
commit cc3aac52d2c7d242ad3da184313f6ed9473b7005 Author: Benoit TELLIER <[email protected]> AuthorDate: Fri Nov 13 15:18:04 2026 +0100 [FIX] Message: fold only the ASCII letters of a field name The field index lower-cased names with String#toLowerCase(Locale.US), which applies Unicode case mapping. An 8-bit name, decoded with ISO-8859-1, then matched names that differ only in the case of a Latin-1 letter: getFields("\xf6\xe3") also returned the "\xf6\xc3:" field, and since selection is bottom-up such a field added below the signed one was hashed instead of it. Headers.lowerCaseFieldName maps only 'A'-'Z', as RFC 5322 and RFC 6376 compare field names. Message uses it for the index key and the lookup, and DKIMCommon (per-name counter, relaxed canonicalization of the name), the single-instance field check and VerifierOptions use it too, so all of them agree on which names are equal. --- .../java/org/apache/james/jdkim/DKIMCommon.java | 7 ++- .../java/org/apache/james/jdkim/DKIMVerifier.java | 2 +- .../java/org/apache/james/jdkim/api/Headers.java | 26 ++++++++++- .../apache/james/jdkim/api/VerifierOptions.java | 2 +- .../java/org/apache/james/jdkim/impl/Message.java | 5 +-- .../james/jdkim/impl/MessageFieldNameCaseTest.java | 52 ++++++++++++++++++++++ 6 files changed, 84 insertions(+), 10 deletions(-) diff --git a/main/src/main/java/org/apache/james/jdkim/DKIMCommon.java b/main/src/main/java/org/apache/james/jdkim/DKIMCommon.java index de14849..124b0b4 100644 --- a/main/src/main/java/org/apache/james/jdkim/DKIMCommon.java +++ b/main/src/main/java/org/apache/james/jdkim/DKIMCommon.java @@ -34,7 +34,6 @@ import java.security.Signature; import java.security.SignatureException; import java.util.HashMap; import java.util.List; -import java.util.Locale; import java.util.Map; public abstract class DKIMCommon { @@ -80,8 +79,8 @@ public abstract class DKIMCommon { if (relaxed) { if (DEEP_DEBUG) System.out - .println("#" + header.toString().toLowerCase(Locale.US) + ":-"); - signature.update(octets(header.toString().toLowerCase(Locale.US))); + .println("#" + Headers.lowerCaseFieldName(header) + ":-"); + signature.update(octets(Headers.lowerCaseFieldName(header))); signature.update(octets(":")); String headerValue = fv.substring(fv.indexOf(':') + 1); headerValue = headerValue.replaceAll("\r\n[\t ]", " "); @@ -140,7 +139,7 @@ public abstract class DKIMCommon { Map<String, List<String>> fieldsByName = new HashMap<>(); for (CharSequence header : headers) { - String lowerCaseHeader = header.toString().toLowerCase(Locale.US); + String lowerCaseHeader = Headers.lowerCaseFieldName(header); List<String> hl = fieldsByName.computeIfAbsent(lowerCaseHeader, h::getFields); if (hl != null && !hl.isEmpty()) { Integer done = processedHeader.get(lowerCaseHeader); diff --git a/main/src/main/java/org/apache/james/jdkim/DKIMVerifier.java b/main/src/main/java/org/apache/james/jdkim/DKIMVerifier.java index 1cef2da..284f7bc 100644 --- a/main/src/main/java/org/apache/james/jdkim/DKIMVerifier.java +++ b/main/src/main/java/org/apache/james/jdkim/DKIMVerifier.java @@ -393,7 +393,7 @@ public class DKIMVerifier { } Map<String, Integer> signedCounts = new HashMap<>(); for (CharSequence header : signatureRecord.getHeaders()) { - signedCounts.merge(header.toString().trim().toLowerCase(Locale.US), 1, Integer::sum); + signedCounts.merge(Headers.lowerCaseFieldName(header.toString().trim()), 1, Integer::sum); } for (String name : options.getSingleInstanceFields()) { List<String> instances = messageHeaders.getFields(name); diff --git a/main/src/main/java/org/apache/james/jdkim/api/Headers.java b/main/src/main/java/org/apache/james/jdkim/api/Headers.java index b7d0106..e6095a8 100644 --- a/main/src/main/java/org/apache/james/jdkim/api/Headers.java +++ b/main/src/main/java/org/apache/james/jdkim/api/Headers.java @@ -42,7 +42,8 @@ public interface Headers { /** * Gets all <code>Field</code>s having the specified field name in a case - * insensitive way. + * insensitive way: only the ASCII letters are folded, see + * {@link #lowerCaseFieldName(CharSequence)}. * * @param name * the field name (e.g. From, Subject). @@ -50,4 +51,27 @@ public interface Headers { */ List<String> getFields(final String name); + /** + * Lower-cases a field name the way RFC 5322 and RFC 6376 compare them: + * field names are ASCII, so only 'A'-'Z' are folded. String#toLowerCase + * would also fold the Latin-1 letters of an 8-bit name decoded with + * ISO-8859-1, making two distinct names match. + * + * @param name a field name, one octet per char + * @return the name with 'A'-'Z' mapped to 'a'-'z' + */ + static String lowerCaseFieldName(CharSequence name) { + StringBuilder sb = null; + for (int i = 0; i < name.length(); i++) { + char c = name.charAt(i); + if (c >= 'A' && c <= 'Z') { + if (sb == null) { + sb = new StringBuilder(name); + } + sb.setCharAt(i, (char) (c + ('a' - 'A'))); + } + } + return sb == null ? name.toString() : sb.toString(); + } + } \ No newline at end of file diff --git a/main/src/main/java/org/apache/james/jdkim/api/VerifierOptions.java b/main/src/main/java/org/apache/james/jdkim/api/VerifierOptions.java index ad879d5..72eb4f9 100644 --- a/main/src/main/java/org/apache/james/jdkim/api/VerifierOptions.java +++ b/main/src/main/java/org/apache/james/jdkim/api/VerifierOptions.java @@ -191,7 +191,7 @@ public class VerifierOptions { if (name == null || name.trim().isEmpty()) { throw new IllegalArgumentException("singleInstanceFields can not hold a blank name"); } - names.add(name.trim().toLowerCase(Locale.US)); + names.add(Headers.lowerCaseFieldName(name.trim())); } this.singleInstanceFields = Collections.unmodifiableSet(names); return this; diff --git a/main/src/main/java/org/apache/james/jdkim/impl/Message.java b/main/src/main/java/org/apache/james/jdkim/impl/Message.java index 91a89e0..4f7b335 100644 --- a/main/src/main/java/org/apache/james/jdkim/impl/Message.java +++ b/main/src/main/java/org/apache/james/jdkim/impl/Message.java @@ -35,7 +35,6 @@ import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; import java.util.List; -import java.util.Locale; import java.util.Map; /** @@ -148,7 +147,7 @@ public class Message implements Headers { while (end > 0 && (field.charAt(end - 1) == ' ' || field.charAt(end - 1) == '\t')) { end--; } - return field.substring(0, end).toLowerCase(Locale.US); + return Headers.lowerCaseFieldName(field.substring(0, end)); } public InputStream getBodyInputStream() { @@ -170,7 +169,7 @@ public class Message implements Headers { * @see org.apache.james.jdkim.api.Headers#getFields(java.lang.String) */ public List<String> getFields(final String name) { - return fieldsByName.getOrDefault(name.toLowerCase(Locale.US), Collections.emptyList()); + return fieldsByName.getOrDefault(Headers.lowerCaseFieldName(name), Collections.emptyList()); } /** diff --git a/main/src/test/java/org/apache/james/jdkim/impl/MessageFieldNameCaseTest.java b/main/src/test/java/org/apache/james/jdkim/impl/MessageFieldNameCaseTest.java new file mode 100644 index 0000000..587a934 --- /dev/null +++ b/main/src/test/java/org/apache/james/jdkim/impl/MessageFieldNameCaseTest.java @@ -0,0 +1,52 @@ +/**************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one * + * or more contributor license agreements. See the NOTICE file * + * distributed with this work for additional information * + * regarding copyright ownership. The ASF licenses this file * + * to you 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 org.apache.james.jdkim.impl; + +import static org.assertj.core.api.Assertions.assertThat; + +import java.io.ByteArrayInputStream; +import java.nio.charset.StandardCharsets; + +import org.junit.Test; + +public class MessageFieldNameCaseTest { + + // ISO-8859-1: 0xf6 o-umlaut, 0xe3 a-tilde, 0xc3 A-tilde + private static final String LOWER = "\u00f6\u00e3"; + private static final String UPPER = "\u00f6\u00c3"; + + @Test + public void getFieldsShouldFoldOnlyAsciiLetters() throws Exception { + byte[] raw = (LOWER + ": a\r\n" + UPPER + ": b\r\n\r\nbody\r\n").getBytes(StandardCharsets.ISO_8859_1); + Message message = new Message(new ByteArrayInputStream(raw)); + + assertThat(message.getFields(LOWER)).containsExactly(LOWER + ": a"); + assertThat(message.getFields(UPPER)).containsExactly(UPPER + ": b"); + } + + @Test + public void getFieldsShouldStillFoldAsciiLetters() throws Exception { + byte[] raw = "From: a\r\nfROM: b\r\n\r\nbody\r\n".getBytes(StandardCharsets.ISO_8859_1); + Message message = new Message(new ByteArrayInputStream(raw)); + + assertThat(message.getFields("from")).containsExactly("From: a", "fROM: b"); + assertThat(message.getFields("FROM")).containsExactly("From: a", "fROM: b"); + } +} --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
