Page History

The C Standard, 7.21.5.3, paragraph 7 [ISO/IEC 9899:2011], places the following restrictions on update streams:

When a file is opened with update mode . . ., both input and output may be performed on the associated stream. However, output shall not be directly followed by input without an intervening call to the fflush function or to a file positioning function (fseek, fsetpos, or rewind), and input shall not be directly followed by output without an intervening call to a file positioning function, unless the input operation encounters end-of-file. Opening (or creating) a text file with update mode may instead open (or create) a binary stream in some implementations.

The following scenarios can result in undefined behavior. (See undefined behavior 151.)

•  Receiving

...

• input from a stream directly following an output to that stream without an intervening call to fflush(), fseek(), fsetpos(), or rewind()

...

• if the file is not at end-of-file
•  Outputting to a stream after receiving input from that stream without a call to fseek(), fsetpos(), or rewind() if the file is not at end-of-file

Consequently, a call to fseek(), fflush(), or fsetpos() is necessary between input and output to the same

...

stream. See ERR07-C.

...

Prefer functions that support error checking over equivalent functions that don't for more information on why fseek() is preferred over rewind().

Noncompliant Code Example

This noncompliant code example appends data to a file and then reads from the same file:

Non-Compliant Code Example

In this non-compliant code example, a device is opened for updating, data are sent to it, and then the response is read back.

/* some device used for both input and output */
#include <stdio.h>
 
enum { BUFFERSIZE = 32 };

extern void initialize_data(char *data, size_t size);
 
void func(const char *filename = "/dev/device2";

file_name) {
  char data[BUFFERSIZE];
  char append_data[BUFFERSIZE];
  FILE *file;

  file = fopen(filenamefile_name, "rba+");
  if (file == NULL) {
    /* handleHandle error */
  }
 
  initialize_data(append_data, BUFFERSIZE);

  if (fwrite(append_data, 1, BUFFERSIZE, file) != BUFFERSIZE) {
    /* Handle error * write to file stream */
/* read response from file stream */
fclose(file);
/
  }
  if (fread(data, 1, BUFFERSIZE, file) < BUFFERSIZE) {
    /* Handle there not being data */
  }

  if (fclose(file) == EOF) {
    /* Handle error */
  }
}

Because there is no intervening flush or positioning call between the calls to fread() and fwrite(), the behavior is undefinedHowever, the output buffer is not flushed before receiving input back from the stream, so the data may not have actually been sent, resulting in unexpected behavior.

Compliant Solution

In this compliant solution, fflushfseek() is called in between the output and input., eliminating the undefined behavior:

/* some device used for both input and output */
#include <stdio.h>
 
enum { BUFFERSIZE = 32 };
extern void initialize_data(char *data, size_t size);
 
void func(const char *filename = "/dev/device2";

file_name) {
  char data[BUFFERSIZE];
  char append_data[BUFFERSIZE];
  FILE *file;

  file = fopen(filenamefile_name, "rba+");
  if (file == NULL) {
    /* handleHandle error */
]

/* write to file stream */
fflush(file);
/* read response from file stream */
fclose(file);

This flush ensures that all data has been cleared from the buffer before continuing.

Risk Assessment

  }

  initialize_data(append_data, BUFFERSIZE);
  if (fwrite(append_data, BUFFERSIZE, 1, file) != BUFFERSIZE) {
    /* Handle error */
  }

  if (fseek(file, 0L, SEEK_SET) != 0) {
    /* Handle error */
  }

  if (fread(data, BUFFERSIZE, 1, file) != 0) {
    /* Handle there not being data */
  }

  if (fclose(file) == EOF) {
    /* Handle error */
  }
}

Risk Assessment

Alternately inputting and outputting from a stream without an intervening flush or positioning call is undefined behaviorFailing to flush the output buffer may result in data not being sent over the stream, causing unexpected program behavior and possibly a data integrity violation.

Automated Detection

Related Vulnerabilities

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

References

Related Guidelines

Key here (explains table format and definitions)

CERT-CWE Mapping Notes

Key here for mapping notes

CWE-664 and FIO39-C

CWE-664 = Union( FIO39-C, list) where list =

• Improper use of an object (besides alternating reading/writing a file stream without an intervening flush

This CWE is vague on what constitutes “improper control of a resource”. It could include any violation of an object’s method constraints (whether they are documented or not). Or it could be narrowly interpreted to mean object creation and object destruction (which are covered by other CWEs).

Bibliography

...

Image Added Image Added Image Added Wiki Markup\[[ISO/IEC 9899-1999|AA. C References#ISO/IEC 9899-1999]\] Section 7.9.15.3, "The {{fopen}} function"