Page History

Some functions return a pointer to an object that cannot be modified without causing undefined behavior. These functions include the standard getenv(), setlocale(), localeconv(), asctime(), and strerror() functions.. In such cases, the function call results must be treated as being const-qualified.

The C Standard, 7.24.4.6, paragraph 4 C11, Section 7.22.4.6  [ISO/IEC 9899:20112024], defines getenv() as follows:

The getenv function returns a pointer to a string associated with the matched list member. The string pointed to shall not be modified by the program, but may be overwritten by a subsequent call to the getenv function. If the specified name cannot be found, a null pointer is returned.

Consequently, if If the string returned by getenv() must be altered, a local copy should be created. Altering the string returned by getenv() results in is undefined behavior. (See also undefined behavior 184 of Annex J of C11.)

Similarly, C11, Section subclause 7.11.1.1 1, paragraph 8 [ISO/IEC 9899:20112024], defines setlocale and localeconv () as follows:

The pointer to string returned by the setlocale function is such that a subsequent call with that string value and its associated category will restore that part of the program'€™s locale. The string pointed to shall not be modified by the program, but may be overwritten by a subsequent call to the setlocale function.

 And subclause 7.11.2.1, paragraph 8 [ISO/IEC 9899:2024], defines localeconv() as follows:

The localeconv function returns a pointer to the filled-in object. The structure pointed to by the return value shall not be modified by the program, but may be overwritten by a subsequent call to the localeconv function. In addition, calls to the setlocale function with categories LC_ALL, LC_MONETARY, or LC_NUMERIC may overwrite the contents of the structure.

Altering the string returned by setlocale() or the structure returned by localeconv() results in are undefined behaviorbehaviors. (See also undefined behaviors 120 and 121 of Annex J.) Furthermore, the C standard imposes Standard imposes no requirements on the contents of the string by setlocale(). Consequently, a program should make no assumptions can be made as to the string's internal contents or structure.

Finally, C11, Section subclause 7.2426.6.2 3, paragraph 4 [ISO/IEC 9899:20112024], states

The The strerror function returns a pointer to the string, the contents of which are locale-specific. The array pointed to shall not be modified by the program, but may be overwritten by . The behavior is undefined if the returned value is used after a subsequent call to the strerror functionthe strerror function, or after the thread which called the function to obtain the returned value has exited.

Altering the string returned by strerror() results in is undefined behavior. (See also undefined behavior 184 of Annex J.)

Noncompliant Code Example (getenv())

This noncompliant code example modifies the string returned by getenv() by replacing all double quote quotation marks (") characters with underscores .(_):

#include <stdlib.h>
 
void trstr(char *c_str, char orig, char rep) {
  while (*c_str != '\0') {
    if (*c_str == orig) {
      *c_str = rep;
    }
    str++c_str;
  }
}

/* ... */

void func(void) {
  char *env = getenv("TEST_ENV");
  if (env == NULL) {
    /* Handle error */
  }

  trstr(env,'"', '_');


/* ... */
}

Compliant Solution (getenv()) (

...

Environment Not Modified)

If the programmer does not intend to For the case where the intent of the noncompliant code example is to use the modified value of the environment variable locally and not modify the environment, this compliant solution makes demonstrates how to modify a local copy of that string value and then modifies it.the return value:

#include <stdlib.h>
#include <string.h>
 
void trstr(char *c_str, char orig, char rep) {
  while (*c_str != '\0') {
    if (*c_str == orig) {
      *c_str = rep;
    }
    ++c_str;
  }
}
 
void func(void) {
  const char *env;
  char *copy_of_env;

  env = getenv("TEST_ENV");
  if (env == NULL) {
    /* Handle error */
  }

  copy_of_env = (char *)malloc(strlen(env) + 1);
  if (copy_of_env == NULL) {
    /* Handle error */
  }

  strcpy(copy_of_env, env);
  trstr(copy_of_env,'\"', '_');
  /* ... */
  free(copy_of_env);
}

Compliant Solution (getenv()) (Modifying the Environment in POSIX)

For the case where the If the programmer's intent is to modify the environment, this compliant solution, which saves the altered string back into the environment by using the POSIX setenv() and strdup() functions., can be used:

#include <stdlib.h>
#include <string.h>
 
void trstr(char *c_str, char orig, char rep) {
  while (*c_str != '\0') {
    if (*c_str == orig) {
      *c_str = rep;
    }
    ++c_str;
  }
}
 
void func(void) {
  const char *env;
  char *copy_of_env;

  env = getenv("TEST_ENV");
  if (env == NULL) {
    /* Handle error */
  }

  copy_of_env = strdup(env);
  if (copy_of_env == NULL) {
    /* Handle error */
  }

  trstr(copy_of_env,'\"', '_');

  if (setenv("TEST_ENV", copy_of_env, 1) != 0) {
    /* Handle error */
  }
  /* ... */
  free(copy_of_env);
}

Noncompliant Code Example (localeconv())

In this noncompliant example, the object returned by localeconv() is directly modified:

#include <locale.h>
 
void f2(void) {
  struct lconv *conv = localeconv();
 
  if ('\0' == conv->decimal_point[0]) {
    conv->decimal_point = ".";
  }
}

Risk Assessment

Compliant Solution (localeconv()) (Copy)

This compliant solution modifies a copy of the object returned by localeconv():

#include <locale.h>
#include <stdlib.h>
#include <string.h>
 
void f2(void) {
  const struct lconv *conv = localeconv();
  if (conv == NULL) {
     /* Handle error */
  }
  
  struct lconv *copy_of_conv = (struct lconv *)malloc(
    sizeof(struct lconv));
  if (copy_of_conv == NULL) {
    /* Handle error */
  }
 
  memcpy(copy_of_conv, conv, sizeof(struct lconv));
 
  if ('\0' == copy_of_conv->decimal_point[0]) {
    copy_of_conv->decimal_point = ".";  
  }
  /* ... */
  free(copy_of_conv);
}

Risk Assessment

Modifying the Depending on the implementation, modifying the object pointed to by the return value of these functions causes of getenv(), setlocale(), localeconv(), asctime(), or strerror() is undefined behavior. Even if the modification succeeds, the modified object can be overwritten by a subsequent call to the getenv(), setlocale(), localeconv(), or strerror() functionssame function.

Automated Detection

Related Vulnerabilities

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

Related Guidelines

CERT C++ Secure Coding Standard: ENV30-CPP. Do not modify the string returned by getenv()

Key here (explains table format and definitions)

Bibliography

...

...

...

...

...

...

...

...

...

...

...

...

...

ISO/IEC TR 17961 (Draft) Modifying the string returned by getenv, localeconv, setlocale, and strerror [libmod]

Bibliography

...

...

Image Modified Image Modified Image Modified