...
A better approach is to not specify the bound of a string initialized with a string literal because the compiler will automatically allocate sufficient space for the entire string literal, including the terminating null character. This rule is a specific exception to ARR02-C. Explicitly specify array bounds, even if implicitly defined by an initializer.
Noncompliant Code Example
This noncompliant code example initializes an array of characters using a string literal that defines one character more (counting the terminating '\0'
) than the array can hold:
...
The size of the array s
is 3, although the size of the string literal is 4. Any subsequent use of the array as a null-terminated byte string can result in a vulnerability, because s
is not properly null-terminated. (See STR32-C. Null-terminate byte strings as requiredDo not pass a non-null-terminated character sequence to a library function that expects a string.)
Implementation Details
This code compiles with no warning with Visual Studio 2013 and GCC 4.8.1. It produces a three-character array with no terminating null character, as specified by the standard.
Compliant Solution
This compliant solution does not specify the bound of a character array in the array declaration. If the array bound is omitted, the compiler allocates sufficient storage to store the entire string literal, including the terminating null character.
...
This approach is preferred because the size of the array can always be derived even if the size of the string literal changes.
Exceptions
STR36STR11-C-EX1: If the intention is to create a character array and not a null-terminated byte string, initializing to fit exactly without a null byte is allowed but not recommended. The preferred approach to create an array containing just the three characters 'a'
, 'b'
, and 'c'
, for example, is to declare each character literal as a separate element as follows:
...
Also, you should make clear in comments or documentation if a character array is, in fact, not a null-terminated byte string.
STR36STR11-C-EX1EX2: If the character array must be larger than the string literal it is initialized with, you may explicitly specify an array bounds. This is particularly important if the array's contents might change during program execution.
Code Block | ||||
---|---|---|---|---|
| ||||
#include <string.h> void func(void) { char s[10] = "abc"; strcpy(&s[3], "def"); } |
Risk Assessment
Recommendation | Severity | Likelihood | Remediation Cost | Priority | Level |
---|
STR11-C |
Low | Probable | Low |
P6 |
L2 |
Automated Detection
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
Astrée |
| Supported: Astrée can detect subsequent code defects that this rule aims to prevent. | |||||||
Axivion Bauhaus Suite |
| CertC-STR11 | |||||||
Compass/ROSE |
| CC2.STR36 | Fully implemented | |||||||
Helix QAC |
| C1312 | |||||||
LDRA tool suite |
| 404 S | Partially implemented |
Parasoft C/C++test |
| CERT_C-STR11-a | Do not specify the bound of a character array initialized with a string literal | ||||||
PC-lint Plus |
| 784 | Partially supported | ||||||
Polyspace Bug Finder |
| Checks for missing null in string array (rec. partially covered) |
Splint |
|
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
Related Guidelines
CERT C Secure Coding Standard | ARR02-C. Explicitly specify array bounds, even if implicitly defined by an initializer STR32-C. |
Do not pass a non-null-terminated character sequence to a library function that expects a string |
SEI |
CERT C++ |
Coding Standard |
VOID STR08-CPP. Do not specify the bound of a character array initialized with a string literal | |
ISO/IEC TR 24772:2013 | String Termination [CJM] |
Bibliography
[ECTC 1998] | Section A.8, "Character Array Initialization" |
[ISO/IEC 9899:2011] | Subclause 6.7.9, "Initialization" |
[Seacord 2013] | Chapter 2, "Strings" |
...
...