Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note that a private field of a superclass might be accessible to a subclass (for example, if both classes are members of the same class). Nevertheless, a private field is never inherited by a subclass.

Noncompliant Code Example

This noncompliant code example exposes the sensitive (x,y) coordinates through the getPoint() method of the inner class. Consequently, the AnotherClass class that belongs to the same package can access the coordinates.

Code Block
bgColor#FFcccc
class Coordinates {
  private int x;
  private int y;

  public class Point {
    public void getPoint() {
      System.out.println("(" + x + "," + y + ")");
    }
  }
}

class AnotherClass {
  public static void main(String[] args) {
    Coordinates c = new Coordinates();
    Coordinates.Point p = c.new Point();
    p.getPoint();
  }
}

Compliant Solution

Use the private access specifier for hiding the inner class and all contained methods and constructors.

...

Compilation of AnotherClass now results in a compilation error because the class attempts to access a private nested class.

Risk Assessment

The Java language system weakens the accessibility of sensitive, private entities in inner classes, which can result in a security weakness.

Recommendation

Severity

Likelihood

Remediation Cost

Priority

Level

OBJ13-J

medium

probable

medium

P8

L2

Automated Detection

Automated detection of non-private nested classes that define non-private members and constructors is straightforward. However, this rule applies only when those classes could potentially expose sensitive data or operations from the outer class. Detection of sensitive data or operations requires programmer assistance.

Related Guidelines

MITRE CWE

CWE-492 "Use of Inner Class Containing Sensitive Data"

Bibliography

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2cb8bfaba4ee4dd8-e340b09e-4ce243bc-9cb0b66a-49ae4129d36ea08c4e165c42"><ac:plain-text-body><![CDATA[

[[JLS 2005

AA. Bibliography#JLS 05]]

[§8.1.3, Inner Classes and Enclosing Instances

http://java.sun.com/docs/books/jls/third_edition/html/classes.html#8.1.3] ]]></ac:plain-text-body></ac:structured-macro>

 

§8.3 "Field Declarations"

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a1d9818a2c211cd7-bc90fda6-42a4408d-8e4590e7-f7789b88176df0aacebf04ef"><ac:plain-text-body><![CDATA[

[[Long 2005

AA. Bibliography#Long 05]]

§2.3, Inner Classes

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="14237017c1bfb6c5-7e20b4af-44824fc3-ac27a678-b9da8ae6be2f041e1b53e99e"><ac:plain-text-body><![CDATA[

[[McGraw 1999

AA. Bibliography#McGraw 99]]

Securing Java, Getting Down to Business with Mobile Code

]]></ac:plain-text-body></ac:structured-macro>

...