Wiki Markup |
---|
As noted in [undefined behavior 169|CC. Undefined Behavior#ub_169] of Annex J of \[[ISO/IEC 9899-1999|AA. Bibliography#ISO/IEC 9899-1999]\], the behavior a program is [undefined |BB. Definitions#undefined behavior] when |
the pointer argument to the
free
orrealloc
function does not match a pointer earlier returned bycalloc
,malloc
, orrealloc
, or the space has been deallocated by a call tofree
orrealloc
.
Freeing memory multiple times has similar consequences to accessing memory after it is freed. (See rule MEM30-C. Do not access freed memory.) First, reading a pointer to deallocated memory is undefined because the pointer value is indeterminate and can have a trap representation . In the latter case, doing so can cause a hardware trap. When reading a freed pointer doesn't cause a trap, the underlying data structures that manage the heap can become corrupted in a way that can introduce security vulnerabilities into a program. These types of issues are referred to as double-free vulnerabilities. In practice, double-free vulnerabilities can be exploited to execute arbitrary code. One example of this is VU#623332, which describes a double-free vulnerability in the MIT Kerberos 5 function krb5_recvauth().
To eliminate double-free vulnerabilities, it is necessary to guarantee that dynamic memory is freed exactly one time. Programmers should be wary when freeing memory in a loop or conditional statement; if coded incorrectly, these constructs can lead to double-free vulnerabilities. It is also a common error to misuse the realloc()
function in a manner that results in double-free vulnerabilities. (See recommendation MEM04-C. Do not perform zero length allocations.)
The C99 standard says (7.20.3):
If the size of the space requested is zero, the behavior is implementation defined: either a null pointer is returned, or the behavior is as if the size were some nonzero value, except that the returned pointer shall not be used to access an object.
and (7.20.3.4):
If memory for the new object cannot be allocated, the old object is not deallocated and its value is unchanged.
If realloc()
is called with size
equal to 0, then if a NULL pointer is returned, the old value should be unchanged. However, there are some implementations that free the pointer, which means that calling free
on the original pointer is indeterminateBefore the lifetime of the last pointer that stores the return value of a call to a standard memory allocation function has ended, it must be matched by a call to free()
with that pointer value.
Noncompliant Code Example
In this noncompliant code example, the memory referred to by x
may be freed twice: once if error_condition
is true and again at the end of the code.object allocated by the call to malloc()
is not freed before the end of the lifetime of the last pointer text_buffer
referring to the object:
Code Block | ||||
---|---|---|---|---|
| ||||
int f(size_t n) { int error_condition = 0; int *x = (int*)malloc(n * sizeof(int));#include <stdlib.h> enum { BUFFER_SIZE = 32 }; int f(void) { char *text_buffer = (char *)malloc(BUFFER_SIZE); if (xtext_buffer == NULL) { return -1; } /* Use x and set error_condition on error. */ if (error_condition == 1) { /* Handle error condition*/ free(x); } /* ... */ free(xreturn 0; } |
Compliant Solution
In this compliant solution, the pointer is deallocated with a call to free()
:
Code Block | ||||
---|---|---|---|---|
| ||||
#include <stdlib.h> enum { BUFFER_SIZE = 32 }; int f(void) { char *text_buffer = (char *)malloc(BUFFER_SIZE); if (text_buffer == NULL) { return -1; } free(text_buffer); return error_condition0; } |
Compliant Solution
Exceptions
MEM31-C-EX1: Allocated memory does not need to be freed if it is assigned to a pointer whose lifetime includes program termination. The following code example illustrates a pointer that stores the return value from malloc()
in a static
variable:In this compliant solution, the free a referenced by x
is only freed once. This is accomplished by eliminating the call to free()
when error_condition
is set.
Code Block | ||||
---|---|---|---|---|
| ||||
#include <stdlib.h> int f(size_t n) enum { int error_conditionBUFFER_SIZE = 32 0}; int if (n > SIZE_MAX / sizeof(int))f(void) { errno = EOVERFLOW; return -1; } int *x = (int*)malloc(n * sizeof(int))static char *text_buffer = NULL; if (xtext_buffer == NULL) { /* Report allocation failure to caller. */ return -1; } /* Use x and set error_condition on error. */ text_buffer = (char *)malloc(BUFFER_SIZE); if (errortext_conditionbuffer !== 0NULL) { /* Handle error condition and proceed. */ } free(x); return -1; } } return error_condition0; } |
Note that this solution checks for numeric overflow. (See rule INT32-C. Ensure that operations on signed integers do not result in overflow.)
Risk Assessment
Freeing Failing to free memory multiple times can result in an attacker executing arbitrary code with the permissions of the vulnerable processthe exhaustion of system memory resources, which can lead to a denial-of-service attack.
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
MEM31-C |
Medium |
Probable |
Medium |
P8 |
L2 |
Automated Detection
Tool | Version | Checker | Description |
---|
Astrée |
|
|
|
Section |
---|
Fortify SCA |
Section |
---|
V. 5.0 |
Section |
---|
Double Free |
Supported, but no explicit checker | |||||||||
Axivion Bauhaus Suite |
| CertC-MEM31 | Can detect dynamically allocated resources that are not freed | ||||||
CodeSonar |
| ALLOC.LEAK | Leak | ||||||
Compass/ROSE | |||||||||
| RESOURCE_LEAK ALLOC_FREE_MISMATCH | Finds |
Section |
---|
Splint |
Section |
---|
RESOURCE_LEAK |
resource leaks from variables that go out of scope while owning a resource |
Cppcheck |
|
|
Section |
---|
USE_AFTER_FREE |
Section |
---|
can find the instances where a freed memory is freed again. Coverity Prevent cannot discover all violations of this rule so further verification is necessary |
| memleak leakReturnValNotUsed leakUnsafeArgAlloc memleakOnRealloc | Doesn't use return value of memory allocation function | |||||||
Cppcheck Premium |
| memleak leakReturnValNotUsed leakUnsafeArgAlloc memleakOnRealloc | Doesn't use return value of memory allocation function | ||||||
Helix QAC |
| DF2706, DF2707, DF2708 C++3337, C++3338 | |||||||
Klocwork |
| CL.FFM.ASSIGN CL.FFM.COPY CL.SHALLOW.ASSIGN CL.SHALLOW.COPY FMM.MIGHT FMM.MUST | |||||||
LDRA tool suite |
| 50 D | Partially implemented | ||||||
Parasoft C/C++test |
| CERT_C-MEM31-a | Ensure resources are freed | ||||||
Parasoft Insure++ | Runtime analysis | ||||||||
PC-lint Plus |
| 429 | Fully supported | ||||||
Polyspace Bug Finder |
| CERT C: Rule MEM31-C | Checks for memory leak (rule fully covered) | ||||||
PVS-Studio |
| V773 | |||||||
SonarQube C/C++ Plugin |
| S3584 | |||||||
Splint |
| ||||||||
TrustInSoft Analyzer |
| malloc | Exhaustively verified. |
Section |
---|
Compass/ROSE |
Section |
---|
can detect some violations of this rule. In particular, false positives may be raised if a variable is freed by a different function than the one that allocated it. Also, it is unable to warn on cases where a call to |
Section |
---|
MLK |
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
Related Guidelines
Key here (explains table format and definitions)
Taxonomy | Taxonomy item | Relationship |
---|---|---|
ISO/IEC TR 24772:2013 | Memory Leak [XYL] |
CERT C++ Secure Coding Standard: MEM31-CPP. Free dynamically allocated memory exactly once
ISO/IEC TR 24772 "XYK Dangling Reference to Heap" and "XYL Memory Leak"
MITRE CWE: CWE-415, "Double Free"
Bibliography
Wiki Markup |
---|
\[[MIT 2005|AA. Bibliography#MIT 05]\]
\[[OWASP, Double Free|AA. Bibliography#OWASP Double Free]\]
\[[Viega 2005|AA. Bibliography#Viega 05]\] "Doubly freeing memory"
\[[VU#623332|AA. Bibliography#VU623332]\] |
Prior to 2018-01-12: CERT: Unspecified Relationship | ||
ISO/IEC TS 17961 | Failing to close files or free dynamic memory when they are no longer needed [fileclose] | Prior to 2018-01-12: CERT: Unspecified Relationship |
CWE 2.11 | CWE-401, Improper Release of Memory Before Removing Last Reference ("Memory Leak") | 2017-07-05: CERT: Exact |
CWE 2.11 | CWE-404 | 2017-07-06: CERT: Rule subset of CWE |
CWE 2.11 | CWE-459 | 2017-07-06: CERT: Rule subset of CWE |
CWE 2.11 | CWE-771 | 2017-07-06: CERT: Rule subset of CWE |
CWE 2.11 | CWE-772 | 2017-07-06: CERT: Rule subset of CWE |
CERT-CWE Mapping Notes
Key here for mapping notes
CWE-404/CWE-459/CWE-771/CWE-772 and FIO42-C/MEM31-C
Intersection( FIO42-C, MEM31-C) = Ø
CWE-404 = CWE-459 = CWE-771 = CWE-772
CWE-404 = Union( FIO42-C, MEM31-C list) where list =
- Failure to free resources besides files or memory chunks, such as mutexes)
Bibliography
[ISO/IEC 9899:2024] | Subclause 7.24.3, "Memory Management Functions" |
...
08. Memory Management (MEM) MEM32-C. Detect and handle memory allocation errors