Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Software vulnerabilities can result when a programmer fails to consider all possible data states.

Noncompliant Code Example (

...

if Chain)

This noncompliant code example fails to test for conditions where a is neither b nor c. This behavior may be correct in this case, but failure to account for all the values of a can result in logic errors if a unexpectedly assumes a different value.

Code Block
bgColor#FFCCCC
langc
if (a == b) {
  /* ... */
}
else if (a == c) {
  /* ... */
}

Compliant Solution (

...

if Chain)

This compliant solution explicitly checks for the unexpected condition and handles it appropriately:

Code Block
bgColor#ccccff
langc
if (a == b) {
  /* ... */
}
else if (a == c) {
  /* ... */
}
else {
  /* Handle error condition */
}

Noncompliant Code Example (

...

switch)

The following noncompliant code example fails to consider all possible cases. Failure to account for all valid values of type Color will result in a logic error. Because valid values of an enumerated type include all those of its underlying integer type, unless enumeration constants have been provided for all those values, the default label is appropriate and necessary.

...

Microsoft Visual C++ .NET with /W4 does not warn when assigning an integer value to an enum type or when the switch statement does not contain all possible values of the enumeration.

Compliant Solution (

...

switch)

The following compliant solution takes care to provide the default label to handle all valid values of type Color:

...

Note that adding a default case to a switch statement, even when all possible switch labels are specified, is an exception (MSC07-EX1) to MSC07-C. Detect and remove dead code.

...

Originally, the consensus among those writing best practices was simply that each switch statement should have a default label. Eventually, emerging compilers and static analysis tools could verify that a switch on an enum type contained a case label for each enumeration value, but only if no default label existed. This led to a shift toward purposely leaving out the default label to allow static analysis. However, the resulting code was then vulnerable to enum variables being assigned int values outside the set of enum values.

These two practices have now been merged. A switch on an enum type should now contain a case label for each enum value but should also contain a default label for safety. This practice does not add difficulty to static analysis.

Existing implementations are in transition, with some not yet analyzing switch statements with default labels. Developers must take extra care to check their own switch statements until the new practice becomes universal.

...

This noncompliant code example shows incomplete logic when converting dates. The code appeared in the Zune 30 media player, causing many players to lock up on December 30, 2008, at midnight PST. This noncompliant code example comes from the ConvertDays function in the real-time clock (RTC) routines for the MC13783 PMIC RTC. This noncompliant code sample It takes the number of days since January 1, 1980, and computes the correct year and number of days since January 1 of the correct year.

...

The following proposed rewrite is provided by at http://winjade.net/2009/01/lesson-on-infinite-loops. The loop is guaranteed to exit, because days decreases for each iteration of the loop, unless the while condition fails and the loop terminates.

...

Failing to account for all possibilities within a logic statement can lead to a corrupted running state, potentially resulting in unintentional information disclosure or abnormal termination.

Recommendation

Severity

Likelihood

Remediation Cost

Priority

Level

MSC01-C

mediumMedium

probableProbable

mediumMedium

P8

L2

Automated Detection

Tool

Version

Checker

Description

Compass/ROSE

  

Can detect some violations of this recommendation. In particular, it flags switch statements that do not have a default clause. ROSE should detect "fake switches" as well (that is, a chain of if statements each checking the value of the same variable). These if statements should always end in an else clause, or they should mathematically cover every possibility. For instance, consider the following:

  if (x > 0) {
	  /* ... */
  } else if (x < 0) {
    /* ... */
  } else if (x == 0) {
    /* ... */
  }
GCC
Include Page
GCC_V
GCC_V
 

Can detect some violations of this recommendation when the -Wswitch and -Wswitch-default flags are used

 Klocwork 
Include Page
Klocwork_V
Klocwork_V
 LA_UNUSED 

LDRA tool suite

Include Page
LDRA_V
LDRA_V

12 S

Fully implemented
PRQA QA-C
Include Page
PRQA_V
PRQA_V

0597
1460
1470
1472
2002
2004

Fully implemented

Related Vulnerabilities

Search for vulnerabilities resulting from the violation of this rule on the CERT website.

...

CERT C++ Secure Coding StandardMSC01-CPP. Strive for logical completeness
ISO/IEC TS 17961 (Draft)Use of an implied default in a switch statement [swtchdflt]
ISO/IEC TR 24772Switch Statements and Static Analysis [CLL]

...