Page History

Wiki MarkupSection Subclause 7.1921.7.11 of C99 defines {{ungetc()}} as follows: \[10 of the C Standard [ISO/IEC 9899:1999|AA. C References#ISO/IEC 9899-1999]\]2011] defines ungetc() as follows:

The ungetc function pushes the character specified by c (converted to an unsigned char) back onto the input stream pointed to by stream. Pushed-back characters will be returned by subsequent reads on that stream in the reverse order of their pushing. A successful intervening call (with the stream pointed to by stream) to a file positioning function (fseek, fsetpos, or rewind) discards any pushed-back characters for the stream. The external storage corresponding to the stream is unchanged.

One character of pushback is guaranteed.

Consequently, multiple calls to ungetc() on the same stream must be separated by a call to a read function or a file-positioning function (which will discard any data pushed by ungetc()).

Likewise, for ungetwc() C99 , C guarantees only guarantees one wide character of pushback (section subclause 7.2429.3.10). Consequently, multiple calls to ungetwc() on the same stream must be separated by a call to a read function or a file-positioning function (which will discard any data pushed by ungetwc()).

...

Noncompliant Code Example

In this non-compliant noncompliant code example, more than one character is pushed back on the stream referenced by fp.:

FILE *fp;
char *file_name;

/* initializeInitialize file_name */

fp = fopen(file_name, "rb");
if (fp == NULL) {
  /* handleHandle Errorerror */
}

/* readRead data */

if (ungetc('\n', fp) == EOF) {
  /* handleHandle error */
}
if (ungetc('\r', fp) == EOF) {
  /* handleHandle error */
}

/* continue onContinue */

Compliant Solution

If more than one character needs to be pushed by ungetc(), then fgetpos() and fsetpos() should be used before and after reading the data instead of pushing it back with ungetc(). Note that this solution can applies only be used if the input is seekable.

FILE *fp;
fpos_t pos;
char *file_name;

/* initializeInitialize file_name */

fp = fopen(file_name, "rb");
if (fp == NULL) {
  /* handleHandle Errorerror */
}

/* readRead data */

if (fgetpos(fp, &pos)) {
  /* handleHandle Errorerror */
}

/* readRead the data that will be "pushed back" */

if (fsetpos(fp, &pos)) {
  /* handleHandle Errorerror */
}

/* Continue on */

Remember to always call fgetpos() before fsetpos(). (see See FIO44-C. Only use values for fsetpos() that are returned from fgetpos().).

Risk Assessment

If used improperly, ungetc() and ungetwc() can cause data to be truncated or lost.

Automated Detection

...

...

...

Related Vulnerabilities

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

Reference

...

Bibliography

...

...

...

...

...

Image Added Image Added Image Added {{ungetc}} function"FIO12-A. Prefer setvbuf() to setbuf()      09. Input Output (FIO)       FIO14-A. Understand the difference between text mode and binary mode with file streams