man3/getpass.3

   1 .\" Copyright (c) 2000 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\"
   9 .\" The GNU General Public License's references to "object code"
  10 .\" and "executables" are to be interpreted as the output of any
  11 .\" document formatting or typesetting system, including
  12 .\" intermediate and printed output.
  13 .\"
  14 .\" This manual is distributed in the hope that it will be useful,
  15 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 .\" GNU General Public License for more details.
  18 .\"
  19 .\" You should have received a copy of the GNU General Public
  20 .\" License along with this manual; if not, see
  21 .\" <http://www.gnu.org/licenses/>.
  22 .\" %%%LICENSE_END
  23 .\"
  24 .TH GETPASS 3  2021-03-22 "Linux" "Linux Programmer's Manual"
  25 .SH NAME
  26 getpass \- get a password
  27 .SH SYNOPSIS
  28 .nf
  29 .B #include <unistd.h>
  30 .PP
  31 .BI "char *getpass(const char *" prompt );
  32 .fi
  33 .PP
  34 .RS -4
  35 Feature Test Macro Requirements for glibc (see
  36 .BR feature_test_macros (7)):
  37 .RE
  38 .PP
  39 .BR getpass ():
  40 .nf
  41     Since glibc 2.2.2:
  42         _XOPEN_SOURCE && ! (_POSIX_C_SOURCE >= 200112L)
  43             || /* Glibc since 2.19: */ _DEFAULT_SOURCE
  44             || /* Glibc <= 2.19: */ _BSD_SOURCE
  45     Before glibc 2.2.2:
  46         none
  47 .fi
  48 .SH DESCRIPTION
  49 This function is obsolete.
  50 Do not use it.
  51 If you want to read input without terminal echoing enabled,
  52 see the description of the
  53 .I ECHO
  54 flag in
  55 .BR termios (3).
  56 .PP
  57 The
  58 .BR getpass ()
  59 function opens
  60 .I /dev/tty
  61 (the controlling terminal of the process), outputs the string
  62 .IR prompt ,
  63 turns off echoing, reads one line (the "password"),
  64 restores the terminal state and closes
  65 .I /dev/tty
  66 again.
  67 .SH RETURN VALUE
  68 The function
  69 .BR getpass ()
  70 returns a pointer to a static buffer containing (the first
  71 .B PASS_MAX
  72 bytes of) the password without the trailing
  73 newline, terminated by a null byte (\(aq\e0\(aq).
  74 This buffer may be overwritten by a following call.
  75 On error, the terminal state is restored,
  76 .I errno
  77 is set to indicate the error, and NULL is returned.
  78 .SH ERRORS
  79 .TP
  80 .B ENXIO
  81 The process does not have a controlling terminal.
  82 .SH FILES
  83 .I /dev/tty
  84 .\" .SH HISTORY
  85 .\" A
  86 .\" .BR getpass ()
  87 .\" function appeared in Version 7 AT&T UNIX.
  88 .SH ATTRIBUTES
  89 For an explanation of the terms used in this section, see
  90 .BR attributes (7).
  91 .ad l
  92 .nh
  93 .TS
  94 allbox;
  95 lbx lb lb
  96 l l l.
  97 Interface       Attribute       Value
  98 T{
  99 .BR getpass ()
 100 T}      Thread safety   MT-Unsafe term
 101 .TE
 102 .hy
 103 .ad
 104 .sp 1
 105 .SH CONFORMING TO
 106 Present in SUSv2, but marked LEGACY.
 107 Removed in POSIX.1-2001.
 108 .SH NOTES
 109 .\" For libc4 and libc5, the prompt is not written to
 110 .\" .I /dev/tty
 111 .\" but to
 112 .\" .IR stderr .
 113 .\" Moreover, if
 114 .\" .I /dev/tty
 115 .\" cannot be opened, the password is read from
 116 .\" .IR stdin .
 117 .\" The static buffer has length 128 so that only the first 127
 118 .\" bytes of the password are returned.
 119 .\" While reading the password, signal generation
 120 .\" .RB ( SIGINT ,
 121 .\" .BR SIGQUIT ,
 122 .\" .BR SIGSTOP ,
 123 .\" .BR SIGTSTP )
 124 .\" is disabled and the corresponding characters
 125 .\" (usually control-C, control-\e, control-Z and control-Y)
 126 .\" are transmitted as part of the password.
 127 .\" Since libc 5.4.19 also line editing is disabled, so that also
 128 .\" backspace and the like will be seen as part of the password.
 129 .
 130 In the GNU C library implementation, if
 131 .I /dev/tty
 132 cannot be opened, the prompt is written to
 133 .I stderr
 134 and the password is read from
 135 .IR stdin .
 136 There is no limit on the length of the password.
 137 Line editing is not disabled.
 138 .PP
 139 According to SUSv2, the value of
 140 .B PASS_MAX
 141 must be defined in
 142 .I <limits.h>
 143 in case it is smaller than 8, and can in any case be obtained using
 144 .IR sysconf(_SC_PASS_MAX) .
 145 However, POSIX.2 withdraws the constants
 146 .B PASS_MAX
 147 and
 148 .BR _SC_PASS_MAX ,
 149 and the function
 150 .BR getpass ().
 151 .\" Libc4 and libc5 have never supported
 152 .\" .B PASS_MAX
 153 .\" or
 154 .\" .BR _SC_PASS_MAX .
 155 The glibc version accepts
 156 .B _SC_PASS_MAX
 157 and returns
 158 .B BUFSIZ
 159 (e.g., 8192).
 160 .SH BUGS
 161 The calling process should zero the password as soon as possible to avoid
 162 leaving the cleartext password visible in the process's address space.
 163 .SH SEE ALSO
 164 .BR crypt (3)