JAVA.CLASS.SER.DNS : Deserializing Non-Serializable Class (Java)

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

Java

JAVA.CLASS.SER.DNS : Deserializing Non-Serializable Class (Java)

Summary

A non-private, non-interface class C does not implement Serializable, but also does not define method void readObject(java.io.ObjectInputStream).

An attacker can therefore subclass C with a class that implements Serializable and use this as the basis of a deserialization attack.

The checker takes the existence of a readObject() method to indicate that the programmer has accounted for the possibility of deserialization and taken steps to prevent it, for example by throwing an exception whenever readObject() is invoked.

Properties

Class Name

Deserializing Non-Serializable Class (Java)

Significance

security

Mnemonic

JAVA.CLASS.SER.DNS

Example

// C.java
import java.io.Serializable;

public class C implements Serializable {    /* Deserializable Class (Java) warning issued here
                                             * C is explicitly serializable. 
                                             */ 
  private static final long serialVersionUID = 6045080196558799656L;
}

// D.java
public class D {}                           /* Deserializing Non-Serializable Class (Java) warning issued here
                                             * D is not explicitly serializable but does not implement a readObject() method. 
                                             */

// B.java
import java.io.ObjectInputStream;

public class B {                                                       // ok: not explicitly serializable, and implements readObject() method (which always throws an exception) 
  private void readObject(ObjectInputStream stream) {
        throw new RuntimeException("Deserialization is not allowed");
  }
}

In this example, the programmer should:

make class C non-serializable, and
in each of classes C and D, define a readObject() method that prevents deserialization, for example by always throwing an exception.

import java.io.Serializable;

public class C {
  private void readObject(ObjectInputStream stream) {
      throw new RuntimeException("Deserialization is not allowed");
  }
}

public class D {
  private void readObject(ObjectInputStream stream) {
      throw new RuntimeException("Deserialization is not allowed");
  }
}

Relevant Configuration File Parameters

The following configuration file parameters affect checks for this warning class.

To report problems with this documentation, please visit https://support.codesecure.com/.