Merge from vendor branch BZIP:
[dragonfly.git] / lib / libc / gen / readpassphrase.3
1 .\"     $OpenBSD: readpassphrase.3,v 1.7 2001/12/15 15:37:51 millert Exp $
2 .\"
3 .\" Copyright (c) 2000 Todd C. Miller <Todd.Miller@courtesan.com>
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. The name of the author may not be used to endorse or promote products
15 .\"    derived from this software without specific prior written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
18 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
19 .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
20 .\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
25 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
26 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD: src/lib/libc/gen/readpassphrase.3,v 1.4.2.3 2003/03/15 15:11:05 trhodes Exp $
29 .\" $DragonFly: src/lib/libc/gen/readpassphrase.3,v 1.3 2006/02/17 19:35:06 swildner Exp $
30 .\"
31 .Dd December 7, 2001
32 .Dt READPASSPHRASE 3
33 .Os
34 .Sh NAME
35 .Nm readpassphrase
36 .Nd get a passphrase from the user
37 .Sh SYNOPSIS
38 .In readpassphrase.h
39 .Ft "char *"
40 .Fn readpassphrase "const char *prompt" "char *buf" "size_t bufsiz" "int flags"
41 .Sh DESCRIPTION
42 The
43 .Fn readpassphrase
44 function displays a prompt to, and reads in a passphrase from,
45 .Pa /dev/tty .
46 If this file is inaccessible
47 and the
48 .Dv RPP_REQUIRE_TTY
49 flag is not set,
50 .Fn readpassphrase
51 displays the prompt on the standard error output and reads from the standard
52 input.
53 In this case it is generally not possible to turn off echo.
54 .Pp
55 Up to
56 .Fa bufsiz
57 \- 1 characters (one is for the
58 .Dv NUL )
59 are read into the provided buffer
60 .Fa buf .
61 Any additional
62 characters and the terminating newline (or return) character are discarded.
63 .Pp
64 The
65 .Fn readpassphrase
66 function
67 takes the following optional
68 .Fa flags :
69 .Pp
70 .Bl -tag -width ".Dv RPP_REQUIRE_TTY" -compact
71 .It Dv RPP_ECHO_OFF
72 turn off echo (default behavior)
73 .It Dv RPP_ECHO_ON
74 leave echo on
75 .It Dv RPP_REQUIRE_TTY
76 fail if there is no tty
77 .It Dv RPP_FORCELOWER
78 force input to lower case
79 .It Dv RPP_FORCEUPPER
80 force input to upper case
81 .It Dv RPP_SEVENBIT
82 strip the high bit from input
83 .El
84 .Pp
85 The calling process should zero the passphrase as soon as possible to
86 avoid leaving the cleartext passphrase visible in the process's address
87 space.
88 .Sh RETURN VALUES
89 Upon successful completion,
90 .Fn readpassphrase
91 returns a pointer to the null-terminated passphrase.
92 If an error is encountered, the terminal state is restored and
93 a
94 .Dv NULL
95 pointer is returned.
96 .Sh FILES
97 .Bl -tag -width ".Pa /dev/tty" -compact
98 .It Pa /dev/tty
99 .El
100 .Sh EXAMPLES
101 The following code fragment will read a passphrase from
102 .Pa /dev/tty
103 into the buffer
104 .Fa passbuf .
105 .Bd -literal -offset indent
106 char passbuf[1024];
107
108 \&...
109
110 if (readpassphrase("Response: ", passbuf, sizeof(passbuf),
111     RPP_REQUIRE_TTY) == NULL)
112         errx(1, "unable to read passphrase");
113
114 if (compare(transform(passbuf), epass) != 0)
115         errx(1, "bad passphrase");
116
117 \&...
118
119 memset(passbuf, 0, sizeof(passbuf));
120 .Ed
121 .Sh ERRORS
122 .Bl -tag -width Er
123 .It Bq Er EINTR
124 The
125 .Fn readpassphrase
126 function was interrupted by a signal.
127 .It Bq Er EINVAL
128 The
129 .Fa bufsiz
130 argument was zero.
131 .It Bq Er EIO
132 The process is a member of a background process attempting to read
133 from its controlling terminal, the process is ignoring or blocking
134 the
135 .Dv SIGTTIN
136 signal or the process group is orphaned.
137 .It Bq Er EMFILE
138 The process has already reached its limit for open file descriptors.
139 .It Bq Er ENFILE
140 The system file table is full.
141 .It Bq Er ENOTTY
142 There is no controlling terminal and the
143 .Dv RPP_REQUIRE_TTY
144 flag was specified.
145 .El
146 .Sh SIGNALS
147 The
148 .Fn readpassphrase
149 function
150 will catch the following signals:
151 .Pp
152 .Bl -tag -compact
153 .It Dv SIGINT
154 .It Dv SIGHUP
155 .It Dv SIGQUIT
156 .It Dv SIGTERM
157 .It Dv SIGTSTP
158 .It Dv SIGTTIN
159 .It Dv SIGTTOU
160 .El
161 .Pp
162 When one of the above signals is intercepted, terminal echo will
163 be restored if it had previously been turned off.
164 If a signal handler was installed for the signal when
165 .Fn readpassphrase
166 was called that handler is then executed.
167 If no handler was previously installed for the signal then the
168 default action is taken as per
169 .Xr sigaction 2 .
170 .Pp
171 The
172 .Dv SIGTSTP , SIGTTIN ,
173 and
174 .Dv SIGTTOU
175 signals (stop signal generated from keyboard or due to terminal I/O
176 from a background process) are treated specially.
177 When the process is resumed after it has been stopped,
178 .Fn readpassphrase
179 will reprint the prompt and the user may then enter a passphrase.
180 .Sh SEE ALSO
181 .Xr sigaction 2 ,
182 .Xr getpass 3
183 .Sh STANDARDS
184 The
185 .Fn readpassphrase
186 function is an
187 extension and should not be used if portability is desired.
188 .Sh HISTORY
189 The
190 .Fn readpassphrase
191 function first appeared in
192 .Ox 2.9 .