Never use return
, break
, continue
or throw
statements within a finally
block. When program execution enters a try
block that has a finally
block, the finally
block always executes, regardless of whether the try
block (or any associated catch
blocks) execute to completion. Statements that cause the finally
block to terminate abruptly also cause the try
block to terminate abruptly, and consequently mask any exception thrown from the try
or catch
blocks (JLS 2005).
Noncompliant Code Example
In this noncompliant code example, the finally
block completes abruptly because of a return
statement in the finally
block.
class TryFinally { private static boolean doLogic() { try { throw new IllegalStateException(); } finally { System.out.println("Uncaught Exception"); return true; } } public static void main(String[] args) { doLogic(); } }
The IllegalStateException
is suppressed by the abrupt termination of the finally
block caused by the return
statement.
Compliant Solution
This compliant solution removes the return
statement from the finally
block.
class TryFinally { private static boolean doLogic() { try { throw new IllegalStateException(); } finally { System.out.println("Caught Exception"); } // Any return statements must go here; applicable only when exception is thrown conditionally } public static void main(String[] args) { doLogic(); } }
Risk Assessment
Exiting abruptly from a finally
block masks any exceptions thrown inside the associated try
and catch
blocks.
Guideline |
Severity |
Likelihood |
Remediation Cost |
Priority |
Level |
---|---|---|---|---|---|
EXC04-J |
low |
probable |
medium |
P4 |
L3 |
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this guideline on the CERT website.
Bibliography
[[Bloch 2005]] Puzzle 36: Indecision
[[Chess 2007]] 8.2 Managing Exceptions, "The Vanishing Exception"
[[JLS 2005]] Section 14.20.2, Execution of try-catch-finally[[MITRE 2009]] CWE ID 705 "Incorrect Control Flow Scoping", CWE ID 584 "Return Inside Finally Block"
ERR02-J. Use exceptions only for exceptional conditions 06. Exceptional Behavior (ERR)