Null pointer dereferencing refers to treating occurs when a null
variable is treated as if it were a valid object or field and proceeding to use it used without checking its state. This condition results in a NullPointerException
, which could result in denial of service. Null pointer dereferencing bugs commonly appear in security contexts. For instance, Java Web Start applications and applets particular to JDK version 1.6, prior to update 4, were affected by a bug that had some noteworthy security consequences. A {{NullPointerException}} was generated in some isolated cases when the application or applet attempted to establish an https connection with a server \[[SDN 2008|AA. Bibliography#SDN 08]\]. The failure to establish a secure https connection with the server caused a denial of service issue: clients were temporarily forced to use an insecure http channel for data exchangeadditional information, see the related guideline EXC15-J. Do not catch NullPointerException. Wiki Markup
Noncompliant Code Example
Wiki Markup |
---|
This noncompliant example shows a bug in Tomcat version 4.1.24, initially discovered by Reasoning \[[Reasoning 2003|AA. Bibliography#Reasoning 03]\]. The {{cardinality}} method was designed to return the number of occurrences of object {{obj}} in collection {{col}}. AOne valid use of the {{cardinality}} method is to determine how many objects in the collection are {{null}}. However, because membership in the collection is checked with the expression {{obj.equals(elt)}}, a null pointer dereference is guaranteed whenever {{obj}} is {{null}}. |
Code Block | ||
---|---|---|
| ||
public static int cardinality(Object obj, final Collection col) { int count = 0; Iterator it = col.iterator(); while (it.hasNext()) { Object elt = it.next(); if ((null == obj && null == elt) || obj.equals(elt)) { // null pointer dereference count++; } } return count; } |
Compliant Solution
This compliant solution eliminates the null
pointer dereference.
Code Block | ||
---|---|---|
| ||
public static int cardinality(Object obj, final Collection col) {
int count = 0;
Iterator it = col.iterator();
while (it.hasNext()) {
Object elt = it.next();
if ((null == obj && null == elt) ||
(null != obj && obj.equals(elt))) {
count++;
}
}
return count;
}
|
Automated Detection
Wiki Markup |
---|
Null pointer dereferences can happen in many path dependent ways. Because of the limitationsLimitations of automatic detection tools, itcan is required tomanual manuallyinspection inspectof code \[[Hovemeyer 2007|AA. Bibliography#Hovemeyer 07]\] to detect instances of null pointer dereferences. Annotations for method parameters that must be non-null can also alleviatereduce the problemneed tofor amanual certain extentinspection by aidingassisting automaticautomated null pointer dereference detection. |
Risk Assessment
Wiki Markup |
---|
Dereferencing a {{null}} pointer can lead to denial of service. For example, Java Web Start applications and applets particular to JDK version 1.6, prior to update 4, were affected by a bug that had some noteworthy security consequences. A {{NullPointerException}} was generated in some isolated cases when the application or applet attempted to establish an https connection with a server \[[SDN 2008|AA. Bibliography#SDN 08]\]. The failure to establish a secure HTTPS connection with the server caused a denial of service: clients were temporarily forced to use an insecure http channel for data exchange. In multithreaded programs, |
null pointer dereferences can violate cache coherency policies and can cause resource leaks. |
Guideline | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
EXP12-J | low | likely | high | P3 | L3 |
Automated Detection
The Coverity Prevent Version 5.0 FORWARD_NULL checker can detect the instance where reference is checked against null but then dereferenced anyway.
Related Vulnerabilities
Related Guidelines
CERT C Secure Coding Standard: EXP34-C. Do not dereference null pointers
CERT C++ Secure Coding Standard: EXP34-CPP. Ensure a null pointer is not dereferenced
Bibliography
Wiki Markup |
---|
\[[API 2006|AA. Bibliography#API 06]\] [method doPrivileged()|http://java.sun.com/javase/6/docs/api/java/security/AccessController.html#doPrivileged(java.security.PrivilegedAction)] \[[Hovemeyer 2007|AA. Bibliography#Hovemeyer 07]\] \[[Reasoning 2003|AA. Bibliography#Reasoning 03]\] Defect ID 00-0001, Null Pointer Dereference \[[SDN 2008|AA. Bibliography#SDN 08]\] [Bug ID 6514454|http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6514454] |
...