Difference between revisions of "Overly-Broad Catch Block"

From OWASP
Jump to: navigation, search
Line 1: Line 1:
 
{{Template:Vulnerability}}
 
{{Template:Vulnerability}}
 +
{{Template:Fortify}}
 +
 +
==Abstract==
 +
 +
The catch block handles a broad swath of exceptions, potentially trapping dissimilar issues or problems that should not be dealt with at this point in the program.
  
 
==Description==
 
==Description==
 +
 +
Multiple catch blocks can get ugly and repetitive, but "condensing" catch blocks by catching a high-level class like Exception can obscure exceptions that deserve special treatment or that should not be caught at this point in the program. Catching an overly broad exception essentially defeats the purpose of Java's typed exceptions, and can become particularly dangerous if the program grows and begins to throw new types of exceptions. The new exception types will not receive any attention.
  
 
==Examples ==
 
==Examples ==
 +
 +
The following code excerpt handles three types of exceptions in an identical fashion.
 +
 +
<pre>
 +
  try {
 +
doExchange();
 +
  }
 +
  catch (IOException e) {
 +
logger.error("doExchange failed", e);
 +
  }
 +
  catch (InvocationTargetException e) {
 +
logger.error("doExchange failed", e);
 +
  }
 +
  catch (SQLException e) {
 +
logger.error("doExchange failed", e);
 +
  }
 +
</pre>
 +
 +
At first blush, it may seem preferable to deal with these exceptions in a single catch block, as follows:
 +
 +
<pre>
 +
  try {
 +
doExchange();
 +
  }
 +
  catch (Exception e) {
 +
logger.error("doExchange failed", e);
 +
  }
 +
</pre>
 +
 +
However, if doExchange() is modified to throw a new type of exception that should be handled in some different kind of way, the broad catch block will prevent the compiler from pointing out the situation. Further, the new catch block will now also handle exceptions derived from RuntimeException such as ClassCastException, and NullPointerException, which is not the programmer's intent.
  
 
==Related Threats==
 
==Related Threats==
Line 14: Line 51:
  
 
==Categories==
 
==Categories==
 
{{Template:Stub}}
 
  
 
[[Category:Implementation]]
 
[[Category:Implementation]]
 
[[Category:General Logic Error Vulnerability]]
 
  
 
[[Category:Error Handling Vulnerability]]
 
[[Category:Error Handling Vulnerability]]
 +
 +
[[Category:Java]]
 +
 +
[[Category:Code Snippet]]

Revision as of 12:25, 19 July 2006

This is a Vulnerability. To view all vulnerabilities, please see the Vulnerability Category page.


This article includes content generously donated to OWASP by Fortify.JPG.

Abstract

The catch block handles a broad swath of exceptions, potentially trapping dissimilar issues or problems that should not be dealt with at this point in the program.

Description

Multiple catch blocks can get ugly and repetitive, but "condensing" catch blocks by catching a high-level class like Exception can obscure exceptions that deserve special treatment or that should not be caught at this point in the program. Catching an overly broad exception essentially defeats the purpose of Java's typed exceptions, and can become particularly dangerous if the program grows and begins to throw new types of exceptions. The new exception types will not receive any attention.

Examples

The following code excerpt handles three types of exceptions in an identical fashion.

	  try {
		doExchange();
	  }
	  catch (IOException e) {
		logger.error("doExchange failed", e);
	  }
	  catch (InvocationTargetException e) {
		logger.error("doExchange failed", e);
	  }
	  catch (SQLException e) {
		logger.error("doExchange failed", e);
	  }

At first blush, it may seem preferable to deal with these exceptions in a single catch block, as follows:

	  try {
		doExchange();
	  }
	  catch (Exception e) {
		logger.error("doExchange failed", e);
	  }

However, if doExchange() is modified to throw a new type of exception that should be handled in some different kind of way, the broad catch block will prevent the compiler from pointing out the situation. Further, the new catch block will now also handle exceptions derived from RuntimeException such as ClassCastException, and NullPointerException, which is not the programmer's intent.

Related Threats

Related Attacks

Related Vulnerabilities

Related Countermeasures

Categories