STR36-C. Do not specify the dimension of a character array initialized with a string literal

The C standard allows an array variable to be declared both with a dimension index and with an initialization literal. The initialization literal also implies an array size, in the number of elements specified. For strings, the size specified by a string literal is the number of characters in the literal plus one for the terminating null character.

It is common for an array variable to be declared with both a string literal, and a size index which specifies the number of characters in the string literal. This is one too few characters to hold the string, since it does not account for the terminating null character. This has limited utility and the potential to cause vulnerabilities when a null-terminated byte string is assumed. Consequently, this practice is disallowed by this Secure Coding standard.

A better approach is to not specify the dimension of a string initialized with a string literal, as the compiler will automatically allocate sufficient space for the entire string literal, including the terminating null character.

Incidentally, initializing a character array using a string literal to fit exactly without a null byte is not allowed in C++.

Non-Compliant Code Example

This non-compliant code example initializes an array of characters using a string literal that defines one more character (counting the terminating '\0') than the array can hold.

char s[3] = "abc";

The size of the array s is three, although the size of the string literal is four. Any subsequent use of the array as a null-terminated byte string can result in a vulnerability, because s is not properly null-terminated.

Compliant Solution

This compliant solution does not specify the dimension of a character array in the array declaration. By omitting the size, the array will automatically be of appropriate length to store the full string literal.

char s[] = "abc";

This is the preferred approach, because the size of the array can always be derived even if the size of the string literal changes.

Exceptions

STR36-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:

char s[] = { 'a', 'b', 'c' }; /* NOT a string */

Again, if one is providing an initializer to an array, an explicit dimension is unnecessary, and, in fact, discouraged.

Also, one should make clear in comments or documentation if a character array is, in fact, not a null-terminated byte string.

Risk Assessment

Related Vulnerabilities

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

References

[[ISO/IEC 9899-1999]]
[[Seacord 05a]] Chapter 2, "Strings"
The Embedded C++ Programming Guide Lines. Version WP-GU-003. 6,Jan 1998 by the Embedded C++ Technical Committee A.8 Character array initialization

STR35-C. Do not copy data from an unbounded source to a fixed-length array      07. Characters and Strings (STR)       08. Memory Management (MEM)