Versions Compared

Key

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

An object has a storage duration that determines its lifetime. There are three storage durations: static, automatic, and allocated.

According to C99 C11, Section 6.2.4, para. 2 [ISO/IEC 9899:19992011],

The lifetime of an object is the portion of program execution during which storage is guaranteed to be reserved for it. An object exists, has a constant address, and retains its last-stored value throughout its lifetime. If an object is referred to outside of its lifetime, the behavior is undefined. The value of a pointer becomes indeterminate when the object it points to reaches the end of its lifetime.

Attempting to access an object outside of its lifetime can result in undefined behavior and lead to an exploitable vulnerability. (See also undefined behavior 8 9  of Appendix J.)

Noncompliant Code Example (Static Variables)

...

Code Block
bgColor#FFCCCC
langc

const char *p;
void dont_do_this(void) {
    const char str[] = "This will change";
    p = str; /* dangerous */
    /* ... */
}

void innocuous(void) {
    const char str[] = "Surprise, surprise";
}
/* ... */
dont_do_this();
innocuous();
/* p might be pointing to "Surprise, surprise" */

...

Code Block
bgColor#ccccff
langc

void this_is_OK(void) {
    const char str[] = "Everything OK";
    const char *p = str;
    /* ... */
}
/* p is inaccessible outside the scope of string str */

...

Code Block
bgColor#ccccff
langc

const char *p;
void is_this_OK(void) {
    const char str[] = "Everything OK?";
    p = str;
    /* ... */
    p = NULL;
}

...

Code Block
bgColor#FFCCCC
langc

char *init_array(void) {
   char array[10];
   /* Initialize array */
   return array;
}

Some compilers generate a warning when a pointer to an automatic variable is returned from a function, as in this example. Compile your code at high warning levels and resolve any warnings. (See recommendation MSC00-C. Compile cleanly at high warning levels.)

...

Code Block
bgColor#ccccff
langc

void init_array(char array[]) {
   /* Initialize array */
   return;
}

int main(int argc, char *argv[]) {
   char array[10];
   init_array(array);
   /* ... */
   return 0;
}

...

In this noncompliant code sample, the function squirrel_away() stores a pointer to local stack variable local into a location pointed to by function parameter ptr_param. Since it an can be assumed that the pointer variable to which ptr_param points remains alive upon squirrel_away()'s return, it is illegal for local to go out of scope.

Code Block
bgColor#FFcccc
langc

void squirrel_away(char **ptr_param) {
   char local[10];
   /* Initialize array */
   *ptr_param = local;
}

void rodent() {
  char *ptr;
  squirrel_away(&ptr);
  /* ptr is live but invalid here */
}

...

section Implemented sectioncan sectionsectioncan sectionfinds

Tool

Version

Checker

Description

Section

LDRA tool suite

Include Page
LDRA_V
LDRA_V
Section

42 D
71 S

Fully implemented.

Fortify SCA

Section

V. 7.6.0

 
Section

Can detect violations when an array is declared in a function and then a pointer to that array is returned

.

Splint
Include Page
Splint_V
Splint_V
  
Compass/ROSE  
Section

Can detect violations of this rule. It automatically detects returning pointers to local variables. Detecting more general cases, such as examples where static pointers are set to local variables which then go out of scope would be difficult.

Coverity Prevent

Include Page
Coverity_V
Coverity_V
Section

RETURN_LOCAL

Section

Finds many instances where a function will return a pointer to a local stack variable. Coverity Prevent cannot discover all violations of this rule, so further verification is necessary.

Section

Klocwork

Include Page
Klocwork_V
Klocwork_V
Section

LOCRET.*

 

Related Vulnerabilities

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

...

CERT C++ Secure Coding Standard: DCL30-CPP. Declare objects with appropriate storage durations

ISO/IEC 9899:19992011 Section 6.2.4, "Storage durations of objects," and Section 7.2022.3, "Memory management functions"

ISO/IEC TR 17961 (Draft) Escaping of the address of an automatic object [addrescape]

ISO/IEC PDTR 24772 "DCM Dangling references to stack frames"

...