Security: fromJson() performs unrestricted reflective field binding (mass assignment); Javadoc claims a non-existent allowlist

Abierto
#1,076 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
java
Área
api, security

Línea de trabajo

Start in src/main/java/org/json/JSONObject.java at fromJson(Class) and the static fromJson(String, Class), then compare deserialization with the serialize-side handling of transient fields and @JSONPropertyIgnore. Confirm the preferred binding policy with maintainers; done means the agreed security behavior is implemented, the Javadoc matches it, and the supplied reproduction no longer overwrites excluded fields.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Active discussion

Summary

JSONObject.fromJson(Class) (and the static fromJson(String, Class)) in current master performs unrestricted reflective field binding from untrusted JSON — a classic mass-assignment primitive. It iterates every non-static declared field, calls field.setAccessible(true) unconditionally, and writes any field whose name matches a JSON key. There is:

  • no allowlist / registry (despite the Javadoc claiming one — see below),
  • no transient exclusion,
  • no honoring of the library's own @JSONPropertyIgnore opt-out (which is honored on the serialize side).

Filing as a normal issue because this API is not in any release yet (not in 20250517); ideally it's hardened or gated before it ships.

The Javadoc claims a protection that does not exist

The fromJson(Class) Javadoc states:

"Only classes that are explicitly supported and registered within the JSONObject context can be deserialized... This ensures that only a limited and controlled set of types can be instantiated from JSON for safety and predictability."

There is no such registry anywhere in the source. Every class with a no-arg constructor is eligible and every non-static field is writable.

Code (src/main/java/org/json/JSONObject.java, fromJson(Class))

T obj = clazz.getDeclaredConstructor().newInstance();
for (Field field : clazz.getDeclaredFields()) {
    if (Modifier.isStatic(field.getModifiers())) {
        continue;                 // ONLY static is skipped
    }
    field.setAccessible(true);    // unconditional
    String fieldName = field.getName();
    if (has(fieldName)) {
        Object value = get(fieldName);
        Object convertedValue = convertValue(value, field.getGenericType());
        field.set(obj, convertedValue);   // writes transient / private / @JSONPropertyIgnore fields
    }
}

Reproduction

import org.json.JSONObject;
import org.json.JSONPropertyIgnore;

public class Repro {
    public static class UserUpdate {
        public String displayName;
        private boolean admin = false;
        private String tenantId = "own-tenant";
        private transient String sessionKey = "server-issued";
        private boolean superAdmin = false;

        public boolean isAdmin() { return admin; }
        public String getTenantId() { return tenantId; }
        public String getSessionKey() { return sessionKey; }
        @JSONPropertyIgnore
        public boolean isSuperAdmin() { return superAdmin; }
    }

    public static void main(String[] args) {
        String json = "{\"displayName\":\"bob\",\"admin\":true,\"tenantId\":\"victim-tenant\","
                + "\"sessionKey\":\"attacker-supplied\",\"superAdmin\":true}";
        UserUpdate u = JSONObject.fromJson(json, UserUpdate.class);
        System.out.println("admin=" + u.isAdmin() + " tenantId=" + u.getTenantId()
                + " sessionKey=" + u.getSessionKey() + " superAdmin=" + u.isSuperAdmin());
    }
}

Output:

admin=true tenantId=victim-tenant sessionKey=attacker-supplied superAdmin=true

A private boolean admin, a private String tenantId, a transient sessionKey, and a @JSONPropertyIgnore-annotated superAdmin are all overwritten from untrusted JSON and observable through the object's own getters.

Why this matters

If fromJson(requestBody, SomePojo.class) is used the way the API documents, an anonymous caller can set fields the developer never meant to expose — privilege flags, tenant-isolation fields, or values explicitly marked transient/@JSONPropertyIgnore — the same class of bug as the Rails attr_accessible and Spring DataBinder mass-assignment issues.

Suggested fix

  • Skip transient fields (Modifier.isTransient), matching the serialize side.
  • Honor @JSONPropertyIgnore (or a field-level ignore) on deserialize.
  • Don't unconditionally setAccessible(true); default to public fields or require an explicit opt-in for private-field binding.
  • Fix the Javadoc so it no longer claims a registry/allowlist that isn't implemented.

Happy to open a PR if the maintainers agree on the preferred approach (skip transient + honor @JSONPropertyIgnore, vs. an opt-in binding model).

Lenguaje dominante
Java
Estrellas
4.7k
Forks
2.6k
Merge medio
11 d 18 min
PR fusionados (30 d)
1

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de stleary/JSON-java

Todos los issues de stleary/JSON-java

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.