Java: Update qhelp: SnakeYaml is safe from version 2.0

[owen-mc]

It was brought to our attention in #19664 that SnakeYaml is not vulnerable to java/unsafe-deserialization as of version 2.0 (released in 2023). This is because all constructors now extend SafeConstructor. We already had an exclusion for constructors which extend SafeConstructor, so the query does not need to be updated. This PR updates the qhelp file.

[Copilot]

Pull Request Overview

This PR updates the documentation for the java/unsafe-deserialization query to reflect that SnakeYAML is secure by default starting from version 2.0. The change clarifies that the previous vulnerability recommendations only apply to versions before 2.0, since all constructors now extend SafeConstructor in version 2.0 and later.

• Updates SnakeYAML security status from "No" to "As of version 2.0"
• Modifies the recommendation to specify it only applies to versions before 2.0

[github-actions]

QHelp previews:

java/ql/src/Security/CWE/CWE-502/UnsafeDeserialization.qhelp

Deserialization of user-controlled data

Deserializing untrusted data using any deserialization framework that allows the construction of arbitrary serializable objects is easily exploitable and in many cases allows an attacker to execute arbitrary code. Even before a deserialized object is returned to the caller of a deserialization method a lot of code may have been executed, including static initializers, constructors, and finalizers. Automatic deserialization of fields means that an attacker may craft a nested combination of objects on which the executed initialization code may have unforeseen effects, such as the execution of arbitrary code.

There are many different serialization frameworks. This query currently supports Kryo, XmlDecoder, XStream, SnakeYaml, JYaml, JsonIO, YAMLBeans, HessianBurlap, Castor, Burlap, Jackson, Jabsorb, Jodd JSON, Flexjson, Gson, JMS, and Java IO serialization through ObjectInputStream/ObjectOutputStream.

Recommendation

Avoid deserialization of untrusted data if at all possible. If the architecture permits it then use other formats instead of serialized objects, for example JSON or XML. However, these formats should not be deserialized into complex objects because this provides further opportunities for attack. For example, XML-based deserialization attacks are possible through libraries such as XStream and XmlDecoder.

Alternatively, a tightly controlled whitelist can limit the vulnerability of code, but be aware of the existence of so-called Bypass Gadgets, which can circumvent such protection measures.

Recommendations specific to particular frameworks supported by this query:

FastJson - com.alibaba:fastjson

• Secure by Default: Partially
• Recommendation: Call com.alibaba.fastjson.parser.ParserConfig#setSafeMode with the argument true before deserializing untrusted data.

FasterXML - com.fasterxml.jackson.core:jackson-databind

• Secure by Default: Yes
• Recommendation: Don't call com.fasterxml.jackson.databind.ObjectMapper#enableDefaultTyping and don't annotate any object fields with com.fasterxml.jackson.annotation.JsonTypeInfo passing either the CLASS or MINIMAL_CLASS values to the annotation. Read this guide.

Kryo - com.esotericsoftware:kryo and com.esotericsoftware:kryo5

• Secure by Default: Yes for com.esotericsoftware:kryo5 and for com.esotericsoftware:kryo >= v5.0.0
• Recommendation: Don't call com.esotericsoftware.kryo(5).Kryo#setRegistrationRequired with the argument false on any Kryo instance that may deserialize untrusted data.

ObjectInputStream - Java Standard Library

• Secure by Default: No
• Recommendation: Use a validating input stream, such as org.apache.commons.io.serialization.ValidatingObjectInputStream.

SnakeYAML - org.yaml:snakeyaml

• Secure by Default: As of version 2.0.
• Recommendation: For versions before 2.0, pass an instance of org.yaml.snakeyaml.constructor.SafeConstructor to org.yaml.snakeyaml.Yaml's constructor before using it to deserialize untrusted data.

XML Decoder - Standard Java Library

• Secure by Default: No
• Recommendation: Do not use with untrusted user input.

ObjectMesssage - Java EE/Jakarta EE

• Secure by Default: Depends on the JMS implementation.
• Recommendation: Do not use with untrusted user input.

Example

The following example calls readObject directly on an ObjectInputStream that is constructed from untrusted data, and is therefore inherently unsafe.

public MyObject {
  public int field;
  MyObject(int field) {
    this.field = field;
  }
}

public MyObject deserialize(Socket sock) {
  try(ObjectInputStream in = new ObjectInputStream(sock.getInputStream())) {
    return (MyObject)in.readObject(); // BAD: in is from untrusted source
  }
}

Rewriting the communication protocol to only rely on reading primitive types from the input stream removes the vulnerability.

public MyObject deserialize(Socket sock) {
  try(DataInputStream in = new DataInputStream(sock.getInputStream())) {
    return new MyObject(in.readInt()); // GOOD: read only an int
  }
}

References

• OWASP vulnerability description: Deserialization of untrusted data.
• OWASP guidance on deserializing objects: Deserialization Cheat Sheet.
• Talks by Chris Frohoff & Gabriel Lawrence: AppSecCali 2015: Marshalling Pickles - how deserializing objects will ruin your day, OWASP SD: Deserialize My Shorts: Or How I Learned to Start Worrying and Hate Java Object Deserialization.
• Alvaro Muñoz & Christian Schneider, RSAConference 2016: Serial Killer: Silently Pwning Your Java Endpoints.
• SnakeYaml documentation on deserialization: SnakeYaml deserialization (not updated for new behaviour in version 2.0).
• Hessian deserialization and related gadget chains: Hessian deserialization.
• Castor and Hessian java deserialization vulnerabilities: Castor and Hessian deserialization.
• Remote code execution in JYaml library: JYaml deserialization.
• JsonIO deserialization vulnerabilities: JsonIO deserialization.
• Research by Moritz Bechler: Java Unmarshaller Security - Turning your data into code execution
• Blog posts by the developer of Jackson libraries: On Jackson CVEs: Don’t Panic — Here is what you need to know Jackson 2.10: Safe Default Typing
• Jabsorb documentation on deserialization: Jabsorb JSON Serializer.
• Jodd JSON documentation on deserialization: JoddJson Parser.
• RCE in Flexjson: Flexjson deserialization.
• Android Intent deserialization vulnerabilities with GSON parser: Insecure use of JSON parsers.
• Research by Matthias Kaiser: Pwning Your Java Messaging With Deserialization Vulnerabilities.
• Common Weakness Enumeration: CWE-502.

[JLLeitschuh]

Is the link on line 124 still accurate as well?

https://github.com/github/codeql/pull/20018/files#diff-ea936bc17ce097b3a3eb43e1118671ceba58b022c04a03e4687fb74c06372c6aR124

[owen-mc]

Good question. The link still seems to work, and to link to SnakeYaml documentation. But it seems the documentation hasn't been updated for the new behaviour since version 2.0. E.g. it still says:

Note: if you want to limit objects to standard Java objects like List or Long you need to use SafeConstructor.

There is a note at the top of the file that "This documentation is very brief and incomplete. Feel free to fix or improve it." The options are to delete the link because it is confusing, or add a note like "(not updated for new behaviour in version 2.0)". I'm leaning towards the latter. What do you think, @JLLeitschuh ?

[JLLeitschuh]

The latter sounds reasonable

[jcogs33]

LGTM