The C99 exit()
function is used for normal program termination. Nested calls to exit()
result in undefined behavior. This can only occur when exit()
is invoked from a function registered with atexit()
, or when exit()
is called from within a signal handler (see SIG30-C. Call only asynchronous-safe functions within signal handlers).C Standard provides three functions that cause an application to terminate normally: _Exit()
, exit()
, and quick_exit()
. These are collectively called exit functions. When the exit()
function is called, or control transfers out of the main()
entry point function, functions registered with atexit()
are called (but not at_quick_exit()
). When the quick_exit()
function is called, functions registered with at_quick_exit()
(but not atexit()
) are called. These functions are collectively called exit handlers. When the _Exit()
function is called, no exit handlers or signal handlers are called.
Exit handlers must terminate No atexit()
registered handler should terminate in any way other than by returning. It is important and potentially safety-critical for all the atexit()
exit handlers to be allowed to perform their cleanup actions. This is particularly true because the main program application programmer does not always know about handlers that may have been installed by support libraries.
...
Two specific issues include nested calls to an exit function and terminating a call to an exit handler by invoking longjmp
.
A nested call to an exit function is undefined behavior. (See undefined behavior 182.) This behavior can occur only when an exit function is invoked from an exit handler or when an exit function is called from within a signal handler. (See SIG30-C. Call only asynchronous-safe functions within signal handlers.)
If a call to the longjmp()
function is made that would terminate the call to a function registered with atexit()
, the behavior is undefined.
Noncompliant Code Example
In this non-compliant noncompliant code example, the exit1()
and exit2()
functions are registered by atexit()
to perform required cleanup upon program termination. However, if some_condition
evaluates to true, exit()
is called a second time, resulting in undefined behavior.
Code Block | ||||
---|---|---|---|---|
| ||||
#include <stdio.h> #include <stdlib.h> void exit1(void) { /* ...cleanup Cleanup code ... */ return; } void exit2(void) { extern int some_condition; if (/* condition */some_condition) { /* ...more More cleanup code ... */ exit(0); } return; } int main(void) { if (atexit(exit1);) != 0) { /* Handle error */ } if (atexit(exit2);) != 0) { /* Handle error */ } /* ...program Program code ... */ return exit(0); } |
Because all functions Functions registered by the atexit()
function are called in the reverse order of their registrationfrom which they were registered. Consequently, if exit2()
exits in any way other than by returning, exit1()
will not be executed. This The same may also be true for atexit()
handlers installed by support libraries.
Compliant Solution
A function that is registered as an exit handler by atexit()
must exit by returning, and not in any other manner.as in this compliant solution:
Code Block | ||||
---|---|---|---|---|
| ||||
#include <stdio.h> #include <stdlib.h> void exit1(void) { /* ...cleanup Cleanup code ... */ return; } void exit2(void) { extern int some_condition; if (/* condition */some_condition) { /* ...more More cleanup code ... */ } return; } int main(void) { if (atexit(exit1);) != 0) { /* Handle error */ } if (atexit(exit2); != 0) { /* Handle error */ } /* ... Program code ...program code... */ exit(0) */ return 0; } |
Noncompliant Code Example
In this noncompliant code example, exit1()
is registered by atexit()
so that upon program termination, exit1()
is called. The exit1()
function jumps back to main()
to return, with undefined results.
Code Block | ||||
---|---|---|---|---|
| ||||
#include <stdlib.h>
#include <setjmp.h>
jmp_buf env;
int val;
void exit1(void) {
longjmp(env, 1);
}
int main(void) {
if (atexit(exit1) != 0) {
/* Handle error */
}
if (setjmp(env) == 0) {
exit(0);
} else {
return 0;
}
}
|
Compliant Solution
This compliant solution does not call longjmp()
but instead returns from the exit handler normally:
Code Block | ||||
---|---|---|---|---|
| ||||
#include <stdlib.h>
void exit1(void) {
return;
}
int main(void) {
if (atexit(exit1) != 0) {
/* Handle error */
}
return 0;
}
|
Risk Assessment
Multiple calls Terminating a call to exit()
are unlikely, and at worst will only cause denial-of-service attacks or abnormal program terminationan exit handler in any way other than by returning is undefined behavior and may result in abnormal program termination or other unpredictable behavior. It may also prevent other registered handlers from being invoked.
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
ENV32-C |
Medium |
Likely |
Medium | P12 | L1 |
Automated Detection
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
Astrée |
| user_defined bad-function bad-function-use | Soundly supported | ||||||
Axivion Bauhaus Suite |
| CertC-ENV32 | |||||||
CodeSonar |
| BADFUNC.ABORT | Use of abort | ||||||
Compass/ROSE | Can detect violations of this rule. In particular, it ensures that all functions registered with | ||||||||
Cppcheck Premium | 24.9.0 | premium-cert-env32-c | Partially Implemented | ||||||
Helix QAC |
| DF4856, DF4857, DF4858 | |||||||
Klocwork |
| CERT.EXIT.HANDLER_TERMINATE | |||||||
LDRA tool suite |
| 122 S 7 S | Enhanced enforcement | ||||||
Parasoft C/C++test |
| CERT_C-ENV32-a | Properly define exit handlers | ||||||
| CERT C: Rule ENV32-C | Checks for abnormal termination of exit handler (rule fully covered) | |||||||
RuleChecker |
| bad-function bad-function-use | Supported |
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
References
Wiki Markup |
---|
\[[ISO/IEC 9899:1999|AA. C References#ISO/IEC 9899-1999]\] Section 7.20.4.3, "The {{exit}} function"
\[[ISO/IEC PDTR 24772|AA. C References#ISO/IEC PDTR 24772]\] "EWD Structured Programming" |
Related Guidelines
Key here (explains table format and definitions)
Taxonomy | Taxonomy item | Relationship |
---|---|---|
CERT C Secure Coding Standard | SIG30-C. Call only asynchronous-safe functions within signal handlers | Prior to 2018-01-12: CERT: Unspecified Relationship |
ISO/IEC TR 24772:2013 | Structured Programming [EWD] | Prior to 2018-01-12: CERT: Unspecified Relationship |
ISO/IEC TR 24772:2013 | Termination Strategy [REU] | Prior to 2018-01-12: CERT: Unspecified Relationship |
CWE 2.11 | CWE-705, Incorrect Control Flow Scoping | 2017-07-10: CERT: Rule subset of CWE |
CERT-CWE Mapping Notes
Key here for mapping notes
CWE-705 and ENV32-C
CWE-705 = Union( ENV32-C, list) where list =
- Improper control flow besides a non-returning exit handler
...
10. Environment (ENV) ENV33-C. Do not call the longjmp function to terminate a call to a function registered by atexit()