Wiki Markup |
---|
C99, Section 7.2.1.1, defines {{assert()}} to have the following behavior \[[ISO/IEC 9899:1999|AA. Bibliography#ISO/IEC 9899-1999]\]:
<blockquote><p>The <code>assert</code> macro puts diagnostic tests into programs; it expands to a void expression. When it is executed, if <code>expression</code> (which shall have a scalar type) is false (that is, compares equal to 0), the <code>assert</code> macro writes information about the particular call that failed (including the text of the argument, the name of the source file, the source line number, and the name of the enclosing function---the latter are respectively the values of the preprocessing macros <code>_<em>FILE</em>_</code> and <code>_<em>LINE</em>_</code> and of the identifier <code>_<em>func</em>_)</code> on the standard error stream in an implementation-defined format. It then calls the <code>abort</code> function.</p></blockquote>Because {{assert()}} calls {{abort()}}, cleanup functions registered with {{atexit()}} are not called. If the intention of the programmer is to properly clean up in the case of a failed assertion, then runtime assertions should be replaced with static assertions where possible (see [DCL03-C. Use a static assertion to test the value of a constant expression|DCL03-C. Use a static assertion to test the value of a constant expression]). When the assertion is based on runtime data, the {{assert}} should be replaced with a runtime check that implements the adopted error strategy (see [ERR00-C. Adopt and implement a consistent and comprehensive error-handling policy|ERR00-C. Adopt and implement a consistent and comprehensive error-handling policy]). |
The
assert
macro puts diagnostic tests into programs; it expands to a void expression. When it is executed, ifexpression
(which shall have a scalar type) is false (that is, compares equal to 0), theassert
macro writes information about the particular call that failed (including the text of the argument, the name of the source file, the source line number, and the name of the enclosing functionâ”the latter are respectively the values of the pre-processing macros_FILE_
and_LINE_
and of the identifier_func_)
on the standard error stream in an implementation-defined format. It then calls theabort
function.
Because assert()
calls abort()
, cleanup functions registered with atexit()
are not called. If the intention of the programmer is to properly clean up in the case of a failed assertion, then runtime assertions should be replaced with static assertions where possible. (See recommendation DCL03-C. Use a static assertion to test the value of a constant expression.) When the assertion is based on runtime data, the assert
should be replaced with a runtime check that implements the adopted error strategy. (See recommendation ERR00-C. Adopt and implement a consistent and comprehensive error-handling policy.)
See recommendation See ERR04-C. Choose an appropriate termination strategy, for more information on program termination strategies and recommendation MSC11-C. Incorporate diagnostic tests using assertions, for more information on using the assert()
macro.
...
This noncompliant code example defines a function that is called before the program exits to clean up.
Code Block | ||
---|---|---|
| ||
void cleanup(void) {
/* Delete temporary files, restore consistent state, etc. */
}
int main(void) {
if (atexit(cleanup) != 0) {
/* Handle error */
}
/* ... */
assert(/* something bad didn't happen */);
/* ... */
}
|
...
Recommendation | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
ERR06-C | medium | unlikely | medium | P4 | L3 |
Automated Detection
Tool | Version | Checker | Description | ||||
---|---|---|---|---|---|---|---|
|
|
|
|
...
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
Other Languages
Related Guidelines
CERT This rule appears in the C++ Secure Coding Standard as : ERR06-CPP. Understand the termination behavior of assert() and abort().
Bibliography
unmigrated-wiki-markup
\[[ISO/IEC 9899:1999|AA. Bibliography#ISO/IEC 9899-1999]\] Section 7.2.1.1, "The {{assert
}} macro," and Section 7.20.4.1, "The {{abort
}} function"
\[[ISO/IEC PDTR 24772|AA. Bibliography#ISO
ISO/IEC PDTR 24772]\] "REU Termination Strategy"
Bibliography
...