Versions Compared

Key

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

...

This compliant solution declares the FuncLoader static field final and treats it as a constant:

Code Block
bgColor#ccccff
public static final FuncLoader m_functions;
// Initialize m_functions in a static initialization block

Fields declared static and final are also safe for multithreaded use (see TSM03-J. Do not publish partially initialized objects for more information). However, remember that simply changing the modifier to final might not prevent attackers from indirectly retrieving an incorrect value from the static final variable before its initialization (see DCL00-J. Prevent class initialization cycles for more information). Furthermore, individual members of the referenced object can also be changed if the object itself is mutable.

It is also permissible to use a wrapper method to retrieve the value of m_functions, allowing m_functions to be declared private (see rule OBJ01-J. Limit accessibility of fields for more information).

...

Unauthorized modifications of public static variables can result in unexpected behavior and violation of class invariants. Furthermore, because static variables can be visible to code loaded by different class loaders when those class loaders are in the same delegation chain, such variables can be used as a covert communication channel between different application domains.

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

OBJ10-J

Medium

Probable

Medium

P8

L2

Automated Detection

ToolVersionCheckerDescription
CodeSonar4.2FB.MALICIOUS_CODE.MS_SHOULD_BE_FINAL
FB.MALICIOUS_CODE.MS_SHOULD_BE_REFACTORED_TO_BE_FINAL
Field isn't final but should be
Field isn't final but should be refactored to be so
Eclipse1.0
 

Implemented. The serializable class .* does not declare a static final serialVersionUID field of type long
Coverity7.5FB.MS_SHOULD_BE_FINALImplemented
Findbugs1.0MS_MUTABLE_ARRAY MS_SHOULD_BE_FINAL Implemented
Parasoft Jtest
Include Page
Parasoft_V
Parasoft_V
CERT.OBJ10.SPFF
CERT.OBJ10.RMO
Inspect 'static' fields which may have intended to be declared 'static final'
Avoid referencing mutable fields
SonarQube
Include Page
SonarQube_V
SonarQube_V
S1444"public static" fields should be constant
SpotBugs

Include Page
SpotBugs_V
SpotBugs_V

MS_SHOULD_BE_FINAL Implemented

Related Guidelines

MITRE CWE

CWE-493, Critical Public Variable without Final Modifier
CWE-500, Public Static Field Not Marked Final

Secure Coding Guidelines for

the

Java

Programming Language

SE, Version

3

5.0

Guideline

3-1. Treat public static fields as

6-10 / MUTABLE-10: Ensure public static final field values are constants

Bibliography

[FT 2008]

"Function Table"
"Class Function Table"

[Gong 2003]

Section 9.3, "Static Fields"

[Nisewanger 2007]

Antipattern 5, Misusing Public Static Variables

[Sterbenz 2006]

Antipattern 5, Misusing Public Static Variables

...


...

Field isn't final but should be refactored to be so