Versions Compared

Key

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

Callers can trivially access and modify public static non-final static fields. Neither accesses nor any modifications can be checked by a security manager, and newly set values cannot be validated. Furthermore, multiple threads can modify non-final public static data fields in inconsistent ways that are not consistent.

Wiki Markup
Improper use of {{public static}} fields can also result in type safety issues. For example, untrusted code may supply an unexpected subtype when the variable is defined to be of a more general type such as {{java.lang.Object}}. \[[Gong 03|AA. Java References#Gong 03]\]

...

Wiki Markup
This noncompliant code example is adopted from JDK v1.4.2 \[[FT 08|AA. Java References#FT 08]\]. It declares a function table.

Code Block
bgColor#FFCCCC
package org.apache.xpath.compiler;

public class FunctionTable {
  public static FuncLoader m_functions;
}

An attacker can replace the function table as follows.

Code Block
bgColor#FFCCCC
FunctionTable.m_functions = <new_table>;

Replacing the function table gives the attacker access to the XPathContext used to evaluate XPath expressions. The XPathContext is used to set the reference node for evaluating XPath expressions. Manipulating this can cause unexpected behavior and it can allow XML fields can to be modified in inconsistent ways, resulting in unexpected behavior. Also, static variables are global across the Java Runtime Environment (JRE). They can be used as a covert communication channel between different application domains (e.g., through code loaded by different class loaders).

Compliant Solution

Treat public static fields as constants and declare them as final. Consider the use of enum types in the following example.

Code Block
bgColor#ccccff

public class MyClass {
    public static final int LEFT  = 1;
    public static final int RIGHT = 2;
}

The FuncLoader static instance described in the noncompliant example must be declared as final as shown belowThis compliant solution declares the FuncLoader static field as final and treats it like a constant.

Code Block
bgColor#ccccff

...
public static final FuncLoader m_functions;
...

Compliant Solution

Additionally, for mutable static variables assessor methods can be defined and appropriate security checks added. Note that this is a different example, wherein the scope of the static variable has been changed to private.

Code Block
bgColor#ccccff

public class MyClass {

  private static byte[] data;
  
  public static byte[] getData() {
    return data.clone();
  }

  public static void setData(byte[] b) {
    securityCheck();
    data = b.clone();
  }
}

As a cautionary note, however, simply changing the modifier to final may not prevent attackers from indirectly retrieving an incorrect value from the static final variable before its initialization. See MSC00-J. Eliminate class initialization cycles and OBJ03-J. Be careful about final reference for more on this problemdetails about these problems.

Risk Assessment

Unauthorized modifications of public static variables can result in unexpected behavior and violation of the various class invariants.

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

OBJ31- J

medium

probable

medium

P8

L2

...