Division and modulo operations are susceptible to divide-by-zero errors.
The C Standard identifies two conditions the following condition under which division and modulo remainder operations result in undefined behavior (UB):
UB | Description |
The value of the second operand of the |
Ensure that division and remainder operations do not result in divide-by-zero errors.
Division
The result of the /
operator is the quotient from the division of the first arithmetic operand by the second arithmetic operand. Division operations are susceptible to divide-by-zero errors. Overflow can also occur during two's complement signed integer division when the dividend is equal to the minimum (most negative) value for the signed integer type and the divisor is equal to −1.
(See INT32-C. Ensure that operations on signed integers do not result in overflow.)
Noncompliant Code Example
This noncompliant code example can result in prevents signed integer overflow in compliance with INT32-C. Ensure that operations on signed integers do not result in overflow but fails to prevent a divide-by-zero error during the division of the signed operands operands s_a
and and s_b
. :It can also result in a signed integer overflow error on twos-complement platforms. The x86-32 architecture, for example, requires that both conditions result in a fault, which can easily result in a denial-of-service attack.
Code Block | ||||
---|---|---|---|---|
| ||||
#include <limits.h> void func(signed long s_a, signed long s_b) { signed long result; if ((s_a == LONG_MIN) && (s_b == -1)) { /* Handle error */ } else { result = s_a / s_b; } /* ... */ } |
Compliant Solution
This compliant solution tests the suspect division operation to guarantee there is no possibility of divide-by-zero errors or signed overflow:
Code Block | ||||
---|---|---|---|---|
| ||||
#include <limits.h>
void func(signed long s_a, signed long s_b) {
signed long result;
if ((s_b == 0) || ((s_a == LONG_MIN) && (s_b == -1))) {
/* Handle error */
} else {
result = s_a / s_b;
}
/* ... */
} |
...
Remainder
The modulo remainder operator provides the remainder when two operands of integer type are divided.
Noncompliant Code Example
This noncompliant code example can result in example prevents signed integer overflow in compliance with INT32-C. Ensure that operations on signed integers do not result in overflow but fails to prevent a divide-by-zero error during the modulo remainder operation on the signed operands s_a
and s_b
. Furthermore, many hardware platforms implement modulo as part of the division operator, which can overflow. Overflow can occur during a modulo operation when the dividend is equal to the minimum (negative) value for the signed integer type and the divisor is equal to −1. This occurs even though the result of such a modulo operation is mathematically 0.:
Code Block | ||||
---|---|---|---|---|
| ||||
void func(signed long s_a, signed long s_b) {
signed long result = s_a % s_b;
/* ... */
} |
Implementation Details
On x86 platforms, the modulo operator for signed integers is implemented by the idiv
instruction code, along with the divide operator. Because LONG_MIN / -1
overflows, this code will throw a floating-point exception on LONG_MIN % -1
.
On Microsoft Visual Studio 2013, taking the modulo of LONG_MIN
by −1
results in abnormal termination on x86 and x64. On GCC/Linux, taking the modulo of LONG_MIN
by −1
produces a floating-point exception. However, on GCC 4.2.4 and newer, with optimization enabled, taking the modulo of LONG_MIN
by −1
yields the value 0
.
Compliant Solution (Overflow Prevention)
This compliant solution tests the modulo operand to guarantee there is no possibility of a divide-by-zero error or an (internal) overflow error:
Code Block | ||||
---|---|---|---|---|
| ||||
#include <limits.h> void func(signed long s_a, signed long s_b) { signed long result; if ((s_b == 0 ) || ((s_a == LONG_MIN) && (s_b == -1))) { /* Handle error */ } else { result = s_a % s_b; } /* ... */ } |
Compliant Solution
...
This compliant solution is based on the fact that both the division and modulo operators truncate toward 0, as specified in subclause 6.5.5, footnote 105, of the C Standard [ISO/IEC 9899:2011], which guarantees that
Code Block |
---|
i % j
|
and
Code Block |
---|
i % -j
|
are always equivalent.
However, the minimum signed value modulo −1
results in undefined behavior because the minimum signed value divided by -1
is not representable.tests the remainder operand to guarantee there is no possibility of a divide-by-zero error or an overflow error:
Code Block | ||||
---|---|---|---|---|
| ||||
#include <limits.h> void func(signed long s_a, signed long s_b) { signed long result; if ((s_b == 0 ) || ((s_a == LONG_MIN) && (s_b == -1))) { /* Handle error */ } else { if ((s_b < 0) && (s_b != LONG_MIN)) { s_b = -s_b; } result = s_a % s_b; } /* ... */ } |
Risk Assessment
A divide-by-zero error can result in abnormal program termination and denial of service.
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
INT33-C | Low | Likely | Medium | P6 | L2 |
Automated Detection
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
Astrée |
| int-division-by-zero int-modulo-by-zero | Fully checked | ||||||
Axivion Bauhaus Suite |
| CertC-INT33 | |||||||
CodeSonar |
| LANG.ARITH.DIVZERO LANG.ARITH.FDIVZERO | Division by zero Float Division By Zero | ||||||
Compass/ROSE |
Can detect some violations of this rule |
(In particular, it ensures that all operations involving division or modulo are preceded by a check ensuring that the second operand is nonzero.) |
Coverity |
| DIVIDE_BY_ZERO | Fully implemented |
Cppcheck |
| zerodiv zerodivcond | Context sensitive analysis of division by zero | ||||||
Cppcheck Premium |
| zerodiv premium-cert-int33-c | Context sensitive analysis of division by zero Not detected for division by struct member / array element / pointer data that is 0 Detected when there is unsafe division by variable before/after test if variable is zero | ||||||
Helix QAC |
| C2830 C++2830 DF2831, DF2832, DF2833 | |||||||
Klocwork |
| DBZ.CONST |
LDRA tool suite |
| 43 D, 127 D |
, 248 S, 629 S, 80 X | Partially implemented |
2830 (C)
2831 (D)
2832 (A)
2833 (S)
2834 (P)
Parasoft C/C++test |
| CERT_C-INT33-a | Avoid division by zero | ||||||
Parasoft Insure++ | Runtime analysis | ||||||||
Polyspace Bug Finder |
| Checks for:
Rule fully covered. | |||||||
SonarQube C/C++ Plugin |
| S3518 | |||||||
PVS-Studio |
| V609 | |||||||
TrustInSoft Analyzer |
| division_by_zero | Exhaustively verified (see one compliant and one non-compliant example). |
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
Related Guidelines
Key here (explains table format and definitions)
Taxonomy | Taxonomy item | Relationship |
---|---|---|
CERT C |
INT32-C. Ensure that operations on signed integers do not result in overflow |
Prior to 2018-01-12: CERT: Unspecified Relationship | |
CERT Oracle Secure Coding Standard for Java | NUM02-J. Ensure that division and |
remainder operations do not result in divide-by-zero errors | Prior to 2018-01-12: CERT: Unspecified Relationship |
ISO/IEC TS 17961 | Integer division errors [diverr] |
Prior to 2018-01-12: CERT: Unspecified Relationship | ||
CWE 2.11 | CWE-369, Divide By Zero | 2017-07-07: CERT: Exact |
CERT-CWE Mapping Notes
Key here for mapping notes
CWE-682 and INT33-C
CWE-682 = Union( INT33-C, list) where list =
- Incorrect calculations that do not involve division by zero
Bibliography
[ |
Seacord 2013b] | Chapter 5, "Integer Security" |
[Warren 2002] | Chapter 2, "Basics" |
...
...