Versions Compared

Key

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

...

These functions truncate strings that exceed the specified limits. Additionally, some functions, such as strncpy(), do not guarantee that the resulting string character sequence is 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.)

Unintentional truncation results in a loss of data and in some cases leads to software vulnerabilities.

Noncompliant Code Example

The standard functions strncpy() and strncat() copy a specified number of characters n from a source string to a destination array. In the case of strncpy(), if there is no null character in the first n characters of the source array, the result will not be null-terminated and any remaining characters are truncated.

Code Block
bgColor#FFcccc
langc
char *string_data;
char a[16];
/* ... */
strncpy(a, string_data, sizeof(a));

Compliant Solution (Adequate Space)

Either the strcpy() or strncpy() function can be used to copy a string and a null character to a destination buffer, provided there is enough space. The programmer must be careful to ensure that the destination buffer is large enough to hold the string to be copied and the null byte to prevent errors, such as data truncation and buffer overflow.

...

This solution requires that string_data is null-terminated; that is, a null byte can be found within the bounds of the referenced character array. Otherwise, strlen() will stray into other objects before finding a null byte.

Compliant Solution

...

(strcpy_s(), C11 Annex K)

The strcpy_s() function defined in Extensions to the C Library—Part I C11 Annex K  [ISO/IEC TR 24731-1:2007], which provides 9899:2011] provides additional safeguards, including accepting the size of the destination buffer as an additional argument. (See STR07-C. Use the bounds-checking interfaces for remediation of existing string manipulation code.) Also, strnlen_s() accepts a maximum-length argument for strings that may not be null-terminated.

...

If a runtime-constraint error is detected by either the call to either strnlen_s() or strcpy_s(), the currently registered runtime-constraint handler is invoked. See ERR03-C. Use runtime-constraint handlers when calling the bounds-checking interfaces for more information on using runtime-constraint handlers with TR 24731-1 C11 Annex K functions.

Exceptions

STR03-C-EX1: The intent of the programmer is to intentionally purposely truncate the null-terminated byte string.

Risk Assessment

Truncating strings can lead to a loss of data.

Recommendation

Severity

Likelihood

Remediation Cost

Priority

Level

STR03-C

medium

Medium

probable

Probable

medium

Medium

P8

L2

Automated Detection

Tool

Version

Checker

Description

CodeSonar
Include Page
CodeSonar_V
CodeSonar_V
MISC.MEM.NTERMNo Space For Null Terminator
Compass/ROSE

 

 



Could detect violations in the following manner: all calls to strncpy() and the other functions should be followed by an assignment of a terminating character to null-terminate the string

.

Fortify SCA
GCC
5
8.
0

 

Can detect violations of this rule with CERT C Rule Pack
1-Wstringop-truncationDetects string truncation by strncat and strncpy.
Klocwork
Include Page
Klocwork_V
Klocwork_V

NNTS.MIGHT

 

NNTS.MUST


LDRA tool suite
Include Page
LDRA_V
LDRA_V

115 S, 44 S

Fully implemented.

Partially implemented

Parasoft C/C++test
Include Page
Parasoft_V
Parasoft_V

CERT_C-STR03-a

Avoid overflow due to reading a not zero terminated string

Polyspace Bug Finder

Include Page
Polyspace Bug Finder_V
Polyspace Bug Finder_V

CERT C: Rec. STR03-C

Checks for invalid use of standard library string routine (rec. partially supported)

Related Vulnerabilities

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

Related Guidelines

SEI CERT C++
Secure
Coding StandardVOID STR03-CPP. Do not inadvertently truncate a null-terminated character array
ISO/IEC TR
24731-1:2007 ISO/IEC TR 24772
24772:2013String
termination
Termination [CJM]
MITRE CWECWE-170, Improper null termination
CWE-464, Addition of data structure sentinel

Bibliography

[Seacord
2005a
2013]Chapter 2, "Strings"

...


...

Image Modified Image Modified Image Modified