Invocation of System.exit()
terminates the Java Virtual Machine (JVM), consequently terminating all running programs and threads. This can result in denial-of-service (DoS) attacks. For example, a call to System.exit()
that is embedded in Java Server Pages (JSP) code can cause a web server to terminate, preventing further service for users. Programs must prevent both inadvertent and malicious calls to System.exit()
. Additionally, programs should perform necessary cleanup actions when forcibly terminated (for example, by using the Windows Task Manager, POSIX kill
command, or other mechanisms).
...
This noncompliant code example uses System.exit()
to forcefully shutdown shut down the JVM and terminate the running process. The program lacks a security manager; consequently, it lacks the capability to check whether the caller is permitted to invoke System.exit()
.
Code Block | ||
---|---|---|
| ||
public class InterceptExit {
public static void main(String[] args) {
// ...
System.exit(1); // Abrupt exit
System.out.println("This never executes");
}
}
|
...
This compliant solution installs a custom security manager PasswordSecurityManager
that overrides the checkExit()
method defined in the SecurityManager
class. This override is required to enable invocation of cleanup code before allowing the exit. The default checkExit()
method in the SecurityManager
class lacks this facility.
Code Block | ||
---|---|---|
| ||
class PasswordSecurityManager extends SecurityManager {
private boolean isExitAllowedFlag;
public PasswordSecurityManager(){
super();
isExitAllowedFlag = false;
}
public boolean isExitAllowed(){
return isExitAllowedFlag;
}
@Override
public void checkExit(int status) {
if (!isExitAllowed()) {
throw new SecurityException();
}
super.checkExit(status);
}
public void setExitAllowed(boolean f) {
isExitAllowedFlag = f;
}
}
public class InterceptExit {
public static void main(String[] args) {
PasswordSecurityManager secManager =
new PasswordSecurityManager();
System.setSecurityManager(secManager);
try {
// ...
System.exit(1); // Abrupt exit call
} catch (Throwable x) {
if (x instanceof SecurityException) {
System.out.println("Intercepted System.exit()");
// Log exception
} else {
// Forward to exception handler
}
}
// ...
secManager.setExitAllowed(true); // Permit exit
// System.exit() will work subsequently
// ...
}
}
|
This implementation uses an internal flag to track whether the exit is permitted. The method setExitAllowed()
sets this flag. The checkExit()
method throws a SecurityException
when the flag is unset (that is, false). Because this flag is not initially set, normal exception processing bypasses the initial call to System.exit()
. The program catches the SecurityException
and performs mandatory cleanup operations, including logging the exception. The System.exit()
method is enabled only after cleanup is complete.
Exceptions
*ERR09ERR09-J-EX0:* It is permissible for a command-line utility to call {{ Wiki Markup System.exit()
}}, for example, when the required number of arguments are not input \[ [Bloch 2008|AA. Bibliography#Bloch 08]\, \ [ESA 2005|AA. Bibliography#ESA 05]\].
Risk Assessment
Allowing unauthorized calls to System.exit()
may lead to denial of service (DoS).
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
ERR09-J |
Low |
Unlikely |
Medium | P2 | L3 |
Automated Detection
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
CodeSonar |
| JAVA.DEBUG.CALL | Debug Call (Java) | ||||||
Coverity | 7.5 | DC.CODING_STYLE | Implemented | ||||||
Parasoft Jtest |
| CERT.ERR09.JVM CERT.ERR09.EXIT | Do not stop the JVM in a web component Do not call methods which terminates Java Virtual Machine | ||||||
SonarQube |
| S1147 | Exit methods should not be called |
Related Guidelines
Bibliography
Android Implementation Details
On Android, System.exit()
should not be used because it will terminate the virtual machine abruptly, ignoring the activity life cycle, which may prevent proper garbage collection.
Bibliography
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6c5efb3e-8c83-4cc9-aa16-b3388b0a24e7"><ac:plain-text-body><![CDATA[
[[API 2006
AA. Bibliography#API 06]]
[API 2014] |
http://java.sun.com/j2se/1.4.2/docs/api/java/lang/SecurityManager.html#checkExit(int)], class Runtime
, method addShutdownHook
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="3174afc9-ef16-4d1e-8fe6-f4e4645582b5"><ac:plain-text-body><![CDATA[
[[Austin 2000
AA. Bibliography#Austin 00]]
[Writing a Security Manager
http://java.sun.com/developer/onlineTraining/Programming/JDCBook/signed2.html]
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6083548e-38f5-4089-be25-04dfe7e2cb4e"><ac:plain-text-body><![CDATA[
[[Darwin 2004
AA. Bibliography#Darwin 04]]
9.5, The Finalize Method
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b8fa9b82-4b57-475c-b8ea-a8bc2d66ce7c"><ac:plain-text-body><![CDATA[
Class | |
Section 9.5, "The Finalize Method" | |
[ESA 2005] | Rule 78, |
[[ESA 2005
AA. Bibliography#ESA 05]]
Restrict the use of the |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9217cd74-adc1-465e-939b-b754150a1515"><ac:plain-text-body><![CDATA[
] |
Section 7.4, |
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9f056a93-a20d-4969-9765-53feaa873f7f"><ac:plain-text-body><![CDATA[
[[Kalinovsky 2004
"JVM Shutdown" |
] | Chapter 16, "Intercepting a Call to |
]]></ac:plain-text-body></ac:structured-macro>
" |
...
06. Exceptional Behavior (ERR) 07. Visibility and Atomicity (VNA)