MSC07-J. Do not assume infinite heap space

A Java OutofMemoryError occurs if the program attempts to use more heap space than what is available. Among other causes, this error may result from

• a memory leak. See MSC05-J. Do not leak memory for information on preventing memory leaks.
• an infinite loop
• limited amounts of default heap memory available
• incorrect implementation of common data structures (hash tables, vectors and so on)
• unbound deserialization.
• writing a large number of objects to an ObjectOutputStream. For more information, see SER10-J. Avoid memory and resource leaks during serialization.
• creating a large number of threads
• uncompressing a file. See IDS04-J. Limit the size of files passed to ZipInputStream for example.

Some of these causes are platform-dependent, and difficult to anticipate. Others are fairly easy to anticipate, such as reading data from a file. As a result, programs must not accept untrusted input in a manner that can cause the program to exhaust memory.

Noncompliant Code Example (readLine())

This noncompliant code example reads lines of text from a file, and adds each one to a vector, until a line with the word "quit" is encountered.

class ShowHeapError {
  private Vector<String> names = new Vector<String>();
  private final InputStreamReader input;
  private final BufferedReader reader;

  public ShowHeapError(String filename) throws IOException {
    this.input = new FileReader(filename);
    this.reader = new BufferedReader(input);
  }

  public void addNames() throws IOException {
    try {
      String newName;
      while (((newName = reader.readLine()) != null) &&
             (newName.equalsIgnoreCase("quit") == false)) {
        names.addElement(newName);
        System.out.println("adding " + newName);
      }
    } finally {
      input.close();
    }
  }

  public static void main(String[] args) throws IOException {
    if (args.length != 1) {
      System.out.println("Arguments: [filename]");
      return;
    }
    ShowHeapError demo = new ShowHeapError(args[0]);
    demo.addNames();
  }
}

The code places no upper bounds on the memory space required to execute the program. Consequently, the program can easily exhaust the available heap space in two ways. First, an attacker can supply arbitrarily many lines in the file, causing the vector to grow until memory is exhausted. Second, an attacker can simply supply an arbitrarily long line, causing the readLine() method to exhaust memory. According to the Java API [[API 2006]], BufferedReader.readLine() method documentation

[readLine()] Reads a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.

Any code that uses this method is susceptible to abuse because the user can enter a string of any length.

Compliant Solution (limited length input)

This compliant solution imposes limits, both on the length of each line, and on the total number of items to add to the vector.

class ShowHeapError {
  // ... other methods

  static public String readLimitedLine(Reader reader, int limit) throws IOException {
    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < limit; i++) {
      int c = reader.read();
      if (c == -1) {
        return null;
      }
      if (((char) c == '\n') || ((char) c == '\r')) {
        break;
      }
      sb.append((char) c);
    }
    return sb.toString();
  }

  static public final int lineLengthLimit = 1024;
  static public final int lineCountLimit = 1000000;

  public void addNames() throws IOException {
    try {
      String newName;
      for (int i = 0; i < lineCountLimit; i++) {
        newName = readLimitedLine( reader, lineLengthLimit);
        if (newName == null) {
          break;
        }
        if (newName.equalsIgnoreCase("quit")) {
          break;
        }

        names.addElement(newName);
        System.out.println("adding " + newName);
      }
    } finally {
      input.close();
    }
  }

}

The readLimitedLine() method defined above takes a numeric limit, indicating the total number of characters that may exist on one line. If a line contains more characters, the line is truncated, and they are returned on the next invocation. This prevents an attacker from exhausting memory by supplying input with no line breaks.

Compliant Solution (Java 1.7, limited file size)

This compliant solution impose a limit on the size of the file being read. This is accomplished with the Files.size() method which is new to Java 1.7. If the file is within the limit, we can assume the standard readLine() method will not exhaust memory, nor will memory be exhausted by the while loop.

class ShowHeapError {
  static public final int fileSizeLimit = 1000000;

  public ShowHeapError(String filename) throws IOException {
    if (Files.size( Paths.get( filename)) > fileSizeLimit) {
      throw new IOException("File too large");
    }
    this.input = new FileReader(filename);
    this.reader = new BufferedReader(input);
  }

  // ...other methods
}

Noncompliant Code Example

In a server-class machine using a parallel garbage collector, the default initial and maximum heap sizes are as follows for J2SE 6.0 [[Sun 2006]]:

• initial heap size: larger of 1/64th of the machine's physical memory on the machine or some reasonable minimum
• maximum heap size: smaller of 1/4th of the physical memory or 1GB

This noncompliant code example requires more memory on the heap than is available by default.

/** Assuming the heap size as 512 MB (calculated as 1/4th of 2 GB RAM = 512 MB)
 *  Considering long values being entered (64 bits each, the max number of elements
 *  would be 512 MB/64bits = 67108864)
 */
public class ShowHeapError {
  Vector<Long> names = new Vector<Long>(); // Accepts unknown number of records
  long newID = 0L;
  int count = 67108865;
  int i = 0;
  InputStreamReader input = new InputStreamReader(System.in);
  Scanner reader = new Scanner(input);

  public void addNames() {
    try {
      do {
        // Adding unknown number of records to a list
        // The user can enter more IDs than the heap can support and as a result,
        // exhaust the heap. Assume that the record ID is a 64 bit long value

        System.out.print("Enter recordID (To quit, enter -1): ");
        newID = reader.nextLong();

        names.addElement(newID);
        i++;
      } while (i < count || newID != -1);
    } finally {
      input.close();
    }
  }

  public static void main(String[] args) {
    ShowHeapError demo = new ShowHeapError();
    demo.addNames();
  }
}

Compliant Solution

A simple compliant solution is to lower the number of names to read.

  // ...
  int count = 10000000;
  // ...

Compliant Solution

The OutOfMemoryError can be avoided by ensuring that the absence of infinite loops, memory leaks, and unnecessary object retention. When memory requirements are known ahead of time, the heap size can be tailored to fit the requirements using the following runtime parameters [[Java 2006]]:

java -Xms<initial heap size> -Xmx<maximum heap size>

For example,

java -Xms128m -Xmx512m ShowHeapError

Here the initial heap size is set to 128 MB and the maximum heap size to 512 MB.

This setting can be changed either using the Java Control Panel or from the command line. It cannot be adjusted through the application itself.

Risk Assessment

Assuming that infinite heap space is available can result in denial of service.

Related Vulnerabilities

GERONIMO-4224

Related Guidelines

Bibliography

MSC06-J. Do not place a semicolon on the same line as an if, for, or while statement      49. Miscellaneous (MSC)      MSC08-J. Do not modify the underlying collection when an iteration is in progress