Before 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 example, the 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 | ||||
---|---|---|---|---|
| ||||
#include <stdlib.h>
enum { BUFFER_SIZE = 32 };
int f(void |
Freeing memory multiple times has similar consequences to accessing memory after it is freed. The underlying data structures that manage the heap can become corrupted in a way that could introduce security vulnerabilities into a program. In practice, these are referred to as double-free vulnerabilities. To eliminate double-free vulnerabilities, it is necessary to guarantee that dynamic memory is freed only once. Programmers should be wary when freeing memory in a loop or conditional statement, if coded incorrectly, these constructs can lead to double-free vulnerabilities.
Non-compliant Code Example 1
In this example, a string of upper case characters is converted to lower all case characters. The pointer to the uppercase string, str is passed to the routine func()
. In this routine, a pointer, temp, is set to str and used convert the string "ABCD"
to "abcd"
. Once the string is converted, temp
is freed and the function returns. However, because temp
references the same storage as str
, when temp was freed so was str. As a result, when str
is freed a second time in main, freed memory may accessed leading to unpredictable program behavior.
Code Block |
---|
#include <stdlib.h> #include <stdio.h> int func(char *str, size_t size) { char *temptext_buffer = str; (char /*str and temp reference same location */ size_t i; for (i = 0; i < size-1; i++) temp[i] += 32; free(temp); return 0; } int main*)malloc(BUFFER_SIZE); if (text_buffer == NULL) { return -1; } return 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 size*text_tbuffer size = 5; (char *str = )malloc(sizeBUFFER_SIZE); if strncpy(str,"ABCD",size); printf("%s\n",str); /* 1st printing of str */ func(str,size);(text_buffer == NULL) { return -1; } free(strtext_buffer); return 0; } |
Compliant Solution 1
Only free a pointer to dynamic memory once. This can be accomplished in this example by removing the call to free(str)
in main()
.
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:
Code Block | ||||
---|---|---|---|---|
| ||||
Code Block | ||||
#include <stdlib.h> #include <stdio.h> enum { BUFFER_SIZE = 32 }; int func(char *str, size_t sizef(void) { static char *temptext_buffer = strNULL; /*str and temp reference same location */ size_t i; for (i = 0; i < size-1; i++) temp[i] += 32; free(temp);if (text_buffer == NULL) { text_buffer = (char *)malloc(BUFFER_SIZE); if (text_buffer == NULL) { return -1; } } return 0; } int main(void) { size_t size = 5; char *str = malloc(size); strncpy(str,"ABCD",size); printf("%s\n",str); /* 1st printing of str */ func(str,size); return 0; } |
Risk Assessment
Failing to free memory can result in the 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 |
| 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 resource leaks from variables that go out of scope while owning a resource | |||||||
Cppcheck |
| 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. |
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] | 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" |
...