Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

`XML.unescape` rejects the character references `XML.escape` produces for control characters

Aperta
  • Qualcosa non va?
#1,089 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
72/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
java
Ambito
api, backend

Direzione di ricerca

Start by reading XML.escape and XMLTokener.unescapeEntity; the stack trace identifies XMLTokener.java as the failing entry point, and the report also names XML.toJSONObject as an affected path. Check the existing XML tests for escaping and parsing, then add coverage for round-tripping the listed control characters. Done means the escape/unescape pair agrees and XML.toJSONObject can read back the reported string value.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

This bug was found by an automated program we have running that writes tests with hegel (but I have personally reviewed it). More details at the bottom, but the short version is that I am not personally affected by this bug, and if that's not welcome then please feel free to disregard it.

Escaping a string that contains U+0001, a form feed, U+007F, U+0085, a lone surrogate or U+FFFF with XML.escape gives a numeric character reference that XML.unescape then refuses with "Invalid numeric character reference"; a tab in the same position comes back unchanged. The same pair of calls sits under XML.toString and XML.toJSONObject, so a JSONObject whose string value contains a form feed converts to XML that the library cannot read back:

import org.json.JSONObject;
import org.json.XML;

public class Main {
    public static void main(String[] args) {
        for (String s : new String[] {"a\tb", "a\u0001b", "a\fb", "a\u007fb", "a\u0085b", "a\ud83db", "a\uffffb"}) {
            String escaped = XML.escape(s);
            System.out.print("escape -> " + escaped.replace("\t", "\\t") + "   unescape -> ");
            try {
                System.out.println(XML.unescape(escaped).equals(s) ? "same string" : "different string");
            } catch (Exception e) {
                System.out.println(e);
            }
        }
        String xml = XML.toString(new JSONObject().put("msg", "page\fbreak"));
        System.out.println(xml);
        System.out.println(XML.toJSONObject(xml));
    }
}

Output:

escape -> a\tb   unescape -> same string
escape -> ab   unescape -> org.json.JSONException: Invalid numeric character reference: 
escape -> ab   unescape -> org.json.JSONException: Invalid numeric character reference: 
escape -> ab   unescape -> org.json.JSONException: Invalid numeric character reference: 
escape -> a…b   unescape -> org.json.JSONException: Invalid numeric character reference: …
escape -> a�b   unescape -> org.json.JSONException: Invalid numeric character reference: �
escape -> ab   unescape -> org.json.JSONException: Invalid numeric character reference: 
<msg>page&#xc;break</msg>
Exception in thread "main" org.json.JSONException: Invalid numeric character reference: &#xc;
	at org.json.XMLTokener.unescapeEntity(XMLTokener.java:171)
	at org.json.XMLTokener.nextEntity(XMLTokener.java:148)
	at org.json.XMLTokener.nextContent(XMLTokener.java:117)
	at org.json.XML.parse(XML.java:422)
	at org.json.XML.toJSONObject(XML.java:821)
	at org.json.XML.toJSONObject(XML.java:907)
	at org.json.XML.toJSONObject(XML.java:706)
	at Main.main(Main.java:17)

For every one of these characters XML.escape writes an &#x…; reference and XML.unescape (and so XML.toJSONObject) throws on it. Whether escape should stop producing these references or unescape should accept them, the two ends of the pair disagree, and XML.toJSONObject(XML.toString(o)) fails for any object with such a character in a string value.

Tested on org.json:json 20260814 and on current master (4f822e0).

As mentioned at the top, this was found by an automated program that writes property-based tests for various open source projects using hegel, and the report was reviewed by hand before filing. We've also potentially found (but not yet hand validated) 17 other bugs in json-java. You can see the tests at https://github.com/hegeldev/hegel-zoo/tree/main/targets/java/json-java. Let us know if you would like us to file the other bugs found and/or contribute the tests. NB the tests are currently LLM generated and probably not yet suitable for inclusion as is, but we're happy to help get them into a better state if you want them.

Lingua principale
Java
Stelle
4.7k
Fork
2.6k
Merge medio
4g 11h
PR unite (30g)
7

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stleary/JSON-java

Tutte le issue di stleary/JSON-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.