CertC++-EXP53¶
Do not read uninitialized memory
Required inputs: IR
Local, automatic variables assume unexpected values if they are read before they are initialized. The C++ Standard, [dcl.init], paragraph 12 [ ISO/IEC 14882-2014], states the following:
If no initializer is specified for an object, the object is default-initialized. When storage for an object with automatic or dynamic storage duration is obtained, the object has an indeterminate value, and if no initialization is performed for the object, that object retains an indeterminate value until that value is replaced. If an indeterminate value is produced by an evaluation, the behavior is undefined except in the following cases:
- If an indeterminate value of unsigned narrow character type is produced by the evaluation of:
- the second or third operand of a conditional expression,
- the right operand of a comma expression,
- the operand of a cast or conversion to an unsigned narrow character type, or
- a discarded-value expression,
then the result of the operation is an indeterminate value.
- If an indeterminate value of unsigned narrow character type is produced by the evaluation of the right operand of a simple assignment operator whose first operand is an lvalue of unsigned narrow character type, an indeterminate value replaces the value of the object referred to by the left operand.
- If an indeterminate value of unsigned narrow character type is produced by the evaluation of the initialization expression when initializing an object of unsigned narrow character type, that object is initialized to an indeterminate value.
The default initialization of an object is described by paragraph 7 of the same subclause:
To default-initialize an object of type
Tmeans:
- ifTis a (possibly cv-qualified) class type, the default constructor forTis called (and the initialization is ill-formed ifThas no default constructor or overload resolution results in an ambiguity or in a function that is deleted or inaccessible from the context of the initialization);
- ifTis an array type, each element is default-initialized;
- otherwise, no initialization is performed.
If a program calls for the default initialization of an object of a const-qualified typeT,Tshall be a class type with a user-provided default constructor.
As a result, objects of type
T with automatic or dynamic storage duration must be explicitly
initialized before having their value read as part of an expression unless
T is a class type or an array thereof or is an unsigned narrow
character type. If
T is an unsigned narrow character type, it may be used to
initialize an object of unsigned narrow character type, which results in both
objects having an
indeterminate
value. This technique can be used to implement copy operations such as
std::memcpy() without triggering
undefined
behavior.
Additionally, memory dynamically allocated
with a
new expression is default-initialized when the new-initialized is omitted. Memory allocated by the standard library
function
std::calloc() is zero-initialized. Memory allocated by the
standard library function
std::realloc() assumes the values of the original pointer but
may not initialize the full range of memory. Memory allocated by any other
means (
std::malloc(), allocator objects,
operator new(), and so on) is assumed to be
default-initialized.
Objects of static or thread storage duration are zero-initialized before any other initialization takes place [ ISO/IEC 14882-2014] and need not be explicitly initialized before having their value read.
Reading uninitialized variables for creating entropy is problematic because these memory accesses can be removed by compiler optimization. VU925211 is an example of a vulnerability caused by this coding error [ VU#925211].
Noncompliant Code Example
In this noncompliant code example, an uninitialized local variable is evaluated as part of an expression to print its value, resulting in undefined behavior.
#include <iostream>
void f() {
int i;
std::cout << i;
}
Compliant Solution
In this compliant solution, the object is initialized prior to printing its value.
#include <iostream>
void f() {
int i = 0;
std::cout << i;
}
Noncompliant Code Example
In this noncompliant code example, an
int * object is allocated by a new-expression, but the
memory it points to is not initialized. The object's pointer value and the
value it points to are printed to the standard output stream. Printing the
pointer value is well-defined, but attempting to print the value pointed to
yields an
indeterminate
value, resulting in
undefined
behavior.
#include <iostream>
void f() {
int *i = new int;
std::cout << i << ", " << *i;
}
Compliant Solution
In this compliant solution, the memory is direct-initialized to the value
12 prior to printing its value.
#include <iostream>
void f() {
int *i = new int(12);
std::cout << i << ", " << *i;
}
Initialization of an object produced by a new-expression is performed by placing (possibly empty) parenthesis or curly braces after the type being allocated. This causes direct initialization of the pointed-to object to occur, which will zero-initialize the object if the initialization omits a value, as illustrated by the following code.
int *i = new int(); // zero-initializes *i
int *j = new int{}; // zero-initializes *j
int *k = new int(12); // initializes *k to 12
int *l = new int{12}; // initializes *l to 12
Noncompliant Code Example
In this noncompliant code example, the class member variable
c is not explicitly initialized by a
ctor-initializer in the default constructor. Despite the local
variable
s being default-initialized, the use of
c within the call to
S::f() results in the evaluation of an object with indeterminate
value, resulting in undefined behavior.
class S {
int c;
public:
int f(int i) const { return i + c; }
};
void f() {
S s;
int i = s.f(10);
}
Compliant Solution
In this compliant solution,
S is given a default constructor that initializes the class member
variable
c.
class S {
int c;
public:
S() : c(0) {}
int f(int i) const { return i + c; }
};
void f() {
S s;
int i = s.f(10);
}
Risk Assessment
Reading uninitialized variables is undefined behavior and can result in unexpected program behavior. In some cases, these security flaws may allow the execution of arbitrary code.
| Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
|---|---|---|---|---|---|
| EXP53-CPP | High | Probable | Medium | P12 | L1 |
Related Guidelines
| SEI CERT C Coding Standard | EXP33-C. Do not read uninitialized memory |
Bibliography
| [ ISO/IEC 14882-2014] | Clause 5, "Expressions" Subclause 5.3.4, "New" Subclause 8.5, "Initializers" Subclause 12.6.2, "Initializing Bases and Members" |
| [ Lockheed Martin 2005] | Rule 142, All variables shall be initialized before use |
Possible Messages
Key |
Text |
Severity |
Disabled |
|---|---|---|---|
assigned_to_pointer_to_const |
Assigning the address of a partially initialized variable to some pointer-to-const |
None |
False |
pass_as_pointer_to_const_param |
Passing uninitialized variable by pointer as function parameter with pointer-to-const type |
None |
False |
possible_return_value_uninit |
Function return value is potentially not initialized |
None |
False |
possible_uninit |
Use of possibly uninitialized variable |
None |
False |
possibly_initialized |
Use of possibly uninitialized variable (previous call {node0} might have initialized the variable) |
None |
False |
return_value_uninit |
Function return value is not initialized |
None |
False |
uninit |
Use of uninitialized variable |
None |
False |
Options¶
This rule shares the following common options: exclude_in_macros, exclude_messages_in_system_headers, excludes, extend_exclude_to_macro_invocations, includes, justification_checker, languages, post_processing, provider, report_at, severity
The following places define options that affect this rule: Stylechecks, Analysis-GlobalOptions
additional_local_array_check¶
additional_local_array_check : bool = True
int example()
{
int a[10];
int b[20];
int uninit_var;
for (int i = 0; i < 10; ++i)
{
L1: a[i] = uninit_var; // use of uninit_var reported
b[i] = i;
}
int result = a[3]; // not reported, since already reported at L1
result += b[15]; // reported; c[] is not (completely) initialized
return result;
}
assume_globals_are_initialized¶
assume_globals_are_initialized : bool = True
check_array_access_with_unknown_index¶
check_array_access_with_unknown_index : bool = False
a[i] with non-literal index
i should be checked as well.
exclude_from_pointer_to_const_param_check¶
exclude_from_pointer_to_const_param_check : set[bauhaus.analysis.config.QualifiedName] = {'__builtin_object_size'}
track_conditional_initialization¶
track_conditional_initialization : bool = True
use_semantic_analysis¶
use_semantic_analysis : bool = True
writing_into_pointer_to_const¶
writing_into_pointer_to_const
Names of routines (mapping to parameter index, starting at 0) having a parameter declared as pointer-to-const yet they are still writing into the pointee.Type: dict[bauhaus.analysis.config.QualifiedName, int]
Default:
{ 'cudaMemcpyToSymbol': 0 }