Page History

A TOCTOU (time-of-check, time-of-use) race condition occurs is possible when a program performs two or more accesses on a filename or pathconcurrent processes are operating on a shared file system [Seacord 2013b]. Typically, the first access is a check to verify some attribute of the file, followed by a call to use the file. An attacker can alter the file between the two accesses, causing the check to succeed but the use to fail. Worse, the use can operate on a different file than the checkor replace the file with a symbolic or hard link to a different file. These TOCTOU conditions can be exploited when a program performs two or more file operations on the same file name or path name.

A program that performs a two or more file operation operations on a filename single file name or path twice name creates a race window between the two file operations. This race window comes from the assumption that the filename or path refers file name or path name refers to the same resource both times. If an attacker can modify the file, remove it, or replace it with a different file, then this assumption will not hold.

Noncompliant Code Example

...

If an existing file is opened for writing with the w mode argument, the file's previous contents (if any) are destroyed. This noncompliant code example tries to prevent an existing file from being overwritten by first trying to open opening it for reading before opening it for writing. An attacker can exploit the race window between the two calls to fopen() to overwrite an existing file.

Code Block

bgColor	#ffcccc
lang	c

#include <stdio.h>

void open_some_file(const char *file) {
  FILE *f = fopen(file, "r");
  if (NULL != f) {
    /* File exists, handle error */
  } else {
    if (fclose(f) != 0) {
      /* Handle error */
    }
    f = fopen(file, "w");
    if (NULL == f) {
      /* Handle error */
    }
 
    /* Write to file */
    if (fclose(f) !== 0EOF) {
      /* Handle error */
    }
  }
}

Compliant Solution

...

This compliant solution uses only one instance of invokes fopen(), at a single location and uses the x mode of fopen(), which was added in C11. This mode causes fopen() to fail if the file exists. This check and subsequent open is performed without creating a race window. Note that the The x mode provides exclusive access to the file only if the host environment provides this support.

Code Block

bgColor	#ccccff
lang	c

#include <stdio.h>

void open_some_file(const char *file) {
  FILE *f = fopen(file, "wx");
  if (NULL == f) {
    /* Handle error */
  }
  /* Write to file */
  if (fclose(f) !== 0EOF) {
    /* Handle error */
  }
}

Compliant Solution (POSIX

...

)

This compliant solution uses the O_CREAT and O_EXCL flags of POSIX's open() function. These flags cause open() to fail if the file exists.

Code Block

bgColor	#ccccff
lang	c

#include <stdio.h>
#include <unistd.h>
#include <fcntl.h>

void open_some_file(const char *file) {
  int fd = open(file, O_CREAT | O_EXCL | O_WRONLY);
  if (-1 != fd) {
    FILE *f = fdopen(fd, "w");
    if (NULL != f) {

      /* Write to file */

       ifif (fclose(f) !== 0EOF) {
        /* Handle error */
      }
    }
    if (close(fd) != 0) {
      /* Handle error */
    }
  }
}

Noncompliant Code Example (POSIX read)

This noncompliant code example attempts to ensure that an open will succeed by first calling the POSIX access() function, which returns zero if the file exists and can be accessed using the specified permissions. An attacker can exploit the race window between the access and the open to cause fopen() to fail in spite of the check.

Code Block

bgColor	#ffcccc
lang	c

#include <stdio.h>
#include <unistd.h> 

void open_some_file(const char *file) {
 else {
      if (access(file, R_OKclose(fd) == 0) {
    FILE *f = fopen(file, "rb");
    if (NULL == f) {
      /* Handle error */
    }
    /* Read file */
    if (fclose(f) != 0) {
 -1) {
        /* Handle error */
    }
  }
}

Compliant Solution (read)

This compliant solution dispenses with an access() call and merely relies on fopen() to verify the file.

Code Block

bgColor	#ccccff
lang	c

#include <stdio.h>

void open_some_file(const char *file) {
  FILE *f = fopen(file, "rb");
  if (NULL == f) {
    /* Handle error */
  }
  /* Read file */
  if (fclose(f) != 0) {
    /* Handle error */
   }
}

Exceptions

FIO45-EX1: Accessing a filename or path multiple times is permitted if it is requested specifically by a user. A program that accepts commands from a user to read or write to a specific filename or path does not violate this standard. Example programs would include file managers or text editors.FIO45-EX2: Accessing a path C-EX2: Accessing a file name or path name multiple times is permitted if the path can not be modified by an attacker. This could occur, for example, if the path refers to file referenced resides in a secure directory. (for For more information, see FIO15-C. Ensure that file operations are performed in a secure directory.).

FIO45-C-EX3: Repeatedly opening and closing a file in append mode (in order to add data) is permitted as an exception to this rule. Many servers will open a log file for appending, write log messages, and immediately close the file. The server does not care if this log file changes, and many systems archive old log files and create a new empty log file periodically.FIO45-EX4: Accessing a path Accessing a file name or path name multiple times is permitted if the program is able to can verify that every operation indeed operates on the same file.

This POSIX code example demonstrates how to verify that two accesses are indeed verifies that each subsequent file access operates on the same file in POSIX. In POSIX, every file can be uniquely identified by using its device and i-node attributes. This code example checks that a filename file name refers to a regular file (instead of and not a directory, symbolic link, etc). This is done using or other special file) by invoking lstat(); the . This call also retrieves its device and i-node. The file is subsequently opened. Finally, the program verifies that the file that was opened is the same one (matching device and i-nodes) as the file that was confirmed as a regular file.

An attacker can still exploit this code if they have the ability to delete the benign file and create the malicious file within the race window between lstat() and open(). It is possible that the OS kernel will reuse the same device and i-node for both files. This can be mitigated by making sure that the attacker lacks the permissions to delete the benign file.

Code Block

bgColor	#ccccff
lang	c

#include <sys/stat.h>
#include <fcntl.h>

int open_regular_file(char *filename, int flags) {
  struct stat lstat_info;
  struct stat fstat_info;
  int f;
 
  if (lstat(filename, &lstat_info) == -1) {
    /* File does not exist, handle error */
  }
 
  if (!S_ISREG(lstat_info.st_mode)) {
    /* File is not a regular file, handle error */
  }
 
  if ((f = open(filename, flags)) == -1) {
    /* File has disappeared, handle error */
  }
 
  if (fstat(f, &fstat_info) == -1) {
    /* Handle error */
  }
 
  if (lstat_info.st_ino != fstat_info.st_ino  ||
      lstat_info.st_dev != fstat_info.st_dev) {
    /* Open file is not the expected regular file, handle error */
  }
 
  /* f is the expected regular open file */
  return f;
}