man3/gets.3

   1 '\" t
   2 .\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
   3 .\"
   4 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
   5 .\"
   6 .\" Modified Wed Jul 28 11:12:07 1993 by Rik Faith (faith@cs.unc.edu)
   7 .\" Modified Fri Sep  8 15:48:13 1995 by Andries Brouwer (aeb@cwi.nl)
   8 .\" Modified 2013-12-31, David Malcolm <dmalcolm@redhat.com>
   9 .\"     Split gets(3) into its own page; fgetc() et al. move to fgetc(3)
  10 .TH gets 3 (date) "Linux man-pages (unreleased)"
  11 .SH NAME
  12 gets \- get a string from standard input (DEPRECATED)
  13 .SH LIBRARY
  14 Standard C library
  15 .RI ( libc ", " \-lc )
  16 .SH SYNOPSIS
  17 .nf
  18 .B #include <stdio.h>
  19 .P
  20 .BI "[[deprecated]] char *gets(char *" "s" );
  21 .fi
  22 .SH DESCRIPTION
  23 .IR "Never use this function" .
  24 .P
  25 .BR gets ()
  26 reads a line from
  27 .I stdin
  28 into the buffer pointed to by
  29 .I s
  30 until either a terminating newline or
  31 .BR EOF ,
  32 which it replaces with a null byte (\[aq]\e0\[aq]).
  33 No check for buffer overrun is performed (see BUGS below).
  34 .SH RETURN VALUE
  35 .BR gets ()
  36 returns
  37 .I s
  38 on success, and NULL
  39 on error or when end of file occurs while no characters have been read.
  40 However, given the lack of buffer overrun checking, there can be no
  41 guarantees that the function will even return.
  42 .SH ATTRIBUTES
  43 For an explanation of the terms used in this section, see
  44 .BR attributes (7).
  45 .TS
  46 allbox;
  47 lbx lb lb
  48 l l l.
  49 Interface       Attribute       Value
  50 T{
  51 .na
  52 .nh
  53 .BR gets ()
  54 T}      Thread safety   MT-Safe
  55 .TE
  56 .SH STANDARDS
  57 POSIX.1-2008.
  58 .SH HISTORY
  59 C89, POSIX.1-2001.
  60 .P
  61 LSB deprecates
  62 .BR gets ().
  63 POSIX.1-2008 marks
  64 .BR gets ()
  65 obsolescent.
  66 ISO C11 removes the specification of
  67 .BR gets ()
  68 from the C language, and since glibc 2.16,
  69 glibc header files don't expose the function declaration if the
  70 .B _ISOC11_SOURCE
  71 feature test macro is defined.
  72 .SH BUGS
  73 Never use
  74 .BR gets ().
  75 Because it is impossible to tell without knowing the data in advance how many
  76 characters
  77 .BR gets ()
  78 will read, and because
  79 .BR gets ()
  80 will continue to store characters past the end of the buffer,
  81 it is extremely dangerous to use.
  82 It has been used to break computer security.
  83 Use
  84 .BR fgets ()
  85 instead.
  86 .P
  87 For more information, see CWE-242 (aka "Use of Inherently Dangerous
  88 Function") at
  89 http://cwe.mitre.org/data/definitions/242.html
  90 .SH SEE ALSO
  91 .BR read (2),
  92 .BR write (2),
  93 .BR ferror (3),
  94 .BR fgetc (3),
  95 .BR fgets (3),
  96 .BR fgetwc (3),
  97 .BR fgetws (3),
  98 .BR fopen (3),
  99 .BR fread (3),
 100 .BR fseek (3),
 101 .BR getline (3),
 102 .BR getwchar (3),
 103 .BR puts (3),
 104 .BR scanf (3),
 105 .BR ungetwc (3),
 106 .BR unlocked_stdio (3),
 107 .BR feature_test_macros (7)