Page History

Never call any call a formatted I/O function with a format string containing user input.

An attacker who can fully or partially control the contents of a format string can crash a vulnerable process, view the contents of the stack, view memory content, or write to an arbitrary memory location and consequently execute arbitrary code with the permissions of the vulnerable process \[[Seacord 05a|AA. Bibliography#Seacord 05]\].

Formatted a tainted value .  An attacker who can fully or partially control the contents of a format string can crash a vulnerable process, view the contents of the stack, view memory content, or write to an arbitrary memory location. Consequently, the attacker can execute arbitrary code with the permissions of the vulnerable process [Seacord 2013b]. Formatted output functions are particularly dangerous because many programmers are unaware of their capabilities (for . For example, they can formatted output functions can be used to write an integer value to a specified address using the %n conversion specifier).

Noncompliant Code Example

Wiki MarkupThis noncompliant code example shows the {{The incorrect_password()}} function, which is called during identification and authentication if the specified user is not found, or the password is incorrect, to display an error message. The function accepts the name of the user as a null-terminated byte string referenced by {{user}}. This is an excellent example of data that originates from an untrusted, unauthenticated user. The function constructs an error message which is then output to {{stderr}} using the C99 standard {{fprintf()}} function \[[ISO/IEC 9899:1999|AA. Bibliography#ISO/IEC 9899-1999]\] function in this noncompliant code example is called during identification and authentication to display an error message if the specified user is not found or the password is incorrect. The function accepts the name of the user as a string referenced by user. This is an exemplar of untrusted data that originates from an unauthenticated user. The function constructs an error message that is then output to stderr using the C Standard fprintf() function.

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
 
void incorrect_password(const char *user) {
  int ret;
  /* userUser names are restricted to 256 charactersor orfewer lesscharacters */
  static const char msg_format[] = "%s cannot be authenticated.\n";
  size_t len = strlen(user) + sizeof(msg_format);
  char *msg = (char *)malloc(len);
  if (msg == NULL) {
    /* Handle error */
  }
  ret = snprintf(msg, len, msg_format, user);
  if (ret < 0) { 
    /* Handle error */ 
 ;
 } else if (ret >= len) { 
    /* Handle truncated output */ 
 ;
 }
  fprintf(stderr, msg);
  free(msg);
}

The incorrect_password() function calculates the size of the message, allocates dynamic storage, and then constructs the message in the allocated memory using the snprintf() function. The addition operations are not checked for integer overflow because the length of the string referenced by user is known to be have a length of 256 or less. Because the %s characters are replaced by the string referenced by user in the call to snprintf(), one less byte is required to store the resulting string and terminating NULL-byte character. This is a common idiom for displaying the same message needs 1 byte less than is allocated. The snprintf() function is commonly used for messages that are displayed in multiple locations or when the message is messages that are difficult to build. The However, the resulting code contains a format-string vulnerability, however, because the msg includes untrusted user input and is passed as the format-string argument in the call to fprintf().

...

This compliant solution fixes the problem by replacing the fprintf() call with a call to fputs(), which does not treat msg like a format string, but outputs it to stderr as is.outputs msg directly to stderr without evaluating its contents:

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
 
void incorrect_password(const char *user) {
  int ret;
  /* userUser names are restricted to 256 charactersor orfewer lesscharacters */
  static const char msg_format[] = "%s cannot be authenticated.\n";
  size_t len = strlen(user) + sizeof(msg_format);
  char *msg = (char *)malloc(len);
  if (msg == NULL) {
    /* Handle error */
  }
  ret = snprintf(msg, len, msg_format, user);
  if (ret < 0) { 
    /* Handle error */ 
 ;
 } else if (ret >= len) { 
    /* Handle truncated output */ 
  ;}

  if (fputs(msg, stderr) == EOF) {
    /* Handle error */;
  }
  free(msg);
}

Compliant Solution (fprintf())

This simpler compliant solution passes the untrusted user input as one of the variadic arguments to fprintf() and not as part of the format string, eliminating the possibility of a format-string vulnerability.:

#include <stdio.h>
 
void incorrect_password(const char *user) {
  static const char msg_format[] = "%s cannot be authenticated.\n";
  fprintf(stderr, msg_format, user);
}

Noncompliant Code Example (POSIX)

...

This noncompliant code example is exactly the same as the first noncompliant code example but uses the POSIX function {{syslog()}} \[[Open Group 04|AA. Bibliography#Open Group 04]\] instead of the {{fprintf()}} function, which is also susceptible to format-string is similar to the first noncompliant code example but uses the POSIX function syslog() [IEEE Std 1003.1:2013] instead of the fprintf() function. The syslog() function is also susceptible to format-string vulnerabilities.

Code Block
bgColor #FFCCCC lang c
#include <stdio.h> #include <stdlib.h> #include <string.h> #include <syslog.h>   void incorrect_password(const char *user) { int ret; /* userUser names are restricted to 256 charactersor orfewer lesscharacters */ static const char msg_format[] = "%s cannot be authenticated.\n"; size_t len = strlen(user) + sizeof(msg_format); char *msg = (char *)malloc(len); if (msg !== NULL) { /* Handle error */ } ret = snprintf(msg, len, msg_format, user); if (ret < 0) {  /* Handle error */  ; } else if (ret >= len) {  /* Handle truncated output */  ; } syslog(LOG_INFO, msg); free(msg); }

...

This compliant solution passes the untrusted user input as one of the variadic arguments to syslog() instead of including it in the format string.:

Code Block
bgColor #ccccff lang c
#include <syslog.h>   void incorrect_password(const char *user) { static const char msg_format[] = "%s cannot be authenticated.\n"; syslog(LOG_INFO, msg_format, user); }

...

Failing to exclude user input from format specifiers may allow an attacker to crash a vulnerable process, view the contents of the stack, view memory content, or write to an arbitrary memory location , and consequently execute arbitrary code with the permissions of the vulnerable process.

Rule	Severity	Likelihood	Detectable

Remediation Cost

Repairable	Priority	Level
FIO30-C

high

High

Likely

likely

Yes

medium

No

P18

L1

Automated Detection

Related Vulnerabilities

Two Two recent examples of format-string vulnerabilities resulting from a violation of this rule include include Ettercap and  and Samba.

In Ettercap v.NG-0.7.2, the the ncurses user  user interface suffers from a format-string defect. The The curses_msg() function in  function in ec_curses.c calls  calls wdg_scroll_print(), which takes a format string and its parameters and passes it to to vw_printw(). The The curses_msg() function  function uses one of its parameters as the format string. This input can include user data, allowing for a format-string vulnerability.

The Samba AFS ACL mapping VFS plug-in fails to properly properly sanitize user user-controlled file names that are used in a format specifier supplied to to snprintf(). This This security flaw becomes  becomes exploitable when a user can write to a share that uses Samba's s afsacl.so library  library for setting Windows NT access control lists on files residing on an AFS file system.

Automated Detection

Fortify SCA Version 5.0 can detect violations of this rule.

Splint Version 3.1.1 can detect violations of this rule.

GCC Compiler Version 4.4.0 can detect violations of this rule when the -Wformat-security flag is used.

Compass/ROSE can detect violations of this rule.

Klocwork can detect violations of this rule with the SV.FMTSTR.GENERIC and SV.TAINTED.FMTSTR checkers.  See Klocwork Cross Reference

...

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

Other Languages

...

Related Guidelines

Key here (explains table format and definitions)

...

...

...

...

...

...

...

Bibliography

...

Image Added Image Added Image Added

Bibliography

\[[ISO/IEC 9899:1999|AA. Bibliography#ISO/IEC 9899-1999]\] Section 7.19.6, "Formatted input/output functions"
\[[ISO/IEC PDTR 24772|AA. Bibliography#ISO/IEC PDTR 24772]\] "RST Injection"
\[[MITRE 07|AA. Bibliography#MITRE 07]\] [CWE ID 134|http://cwe.mitre.org/data/definitions/134.html], "Uncontrolled Format String"
\[[Open Group 04|AA. Bibliography#Open Group 04]\] [{{syslog()}}|http://www.opengroup.org/onlinepubs/009695399/toc.htm]
\[[Seacord 05|AA. Bibliography#Seacord 05]\] Chapter 6, "Formatted Output"
\[[Viega 05|AA. Bibliography#Viega 05]\] Section 5.2.23, "Format string problem"

FIO00-C. Take care when creating format strings      09. Input Output (FIO)      FIO31-C. Do not open a file that is already open