passphrase.c revision 302001
1/*-
2 * Copyright (c) 2014 Michihiro NAKAJIMA
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer
10 *    in this position and unchanged.
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 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26/*	$OpenBSD: readpassphrase.c,v 1.22 2010/01/13 10:20:54 dtucker Exp $	*/
27/*
28 * Copyright (c) 2000-2002, 2007 Todd C. Miller <Todd.Miller@courtesan.com>
29 *
30 * Permission to use, copy, modify, and distribute this software for any
31 * purpose with or without fee is hereby granted, provided that the above
32 * copyright notice and this permission notice appear in all copies.
33 *
34 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
35 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
36 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
37 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
38 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
39 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
40 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
41 *
42 * Sponsored in part by the Defense Advanced Research Projects
43 * Agency (DARPA) and Air Force Research Laboratory, Air Force
44 * Materiel Command, USAF, under agreement number F39502-99-1-0512.
45 */
46
47/* OPENBSD ORIGINAL: lib/libc/gen/readpassphrase.c */
48
49
50#include "lafe_platform.h"
51__FBSDID("$FreeBSD: stable/10/contrib/libarchive/libarchive_fe/passphrase.c 302001 2016-06-17 22:40:10Z mm $");
52
53#include <errno.h>
54#ifdef HAVE_STDLIB_H
55#include <stdlib.h>
56#endif
57#ifdef HAVE_UNISTD_H
58#include <unistd.h>
59#endif
60#ifdef HAVE_READPASSPHRASE_H
61#include <readpassphrase.h>
62#endif
63
64#include "err.h"
65#include "passphrase.h"
66
67#ifndef HAVE_READPASSPHRASE
68
69#define RPP_ECHO_OFF    0x00		/* Turn off echo (default). */
70#define RPP_ECHO_ON     0x01		/* Leave echo on. */
71#define RPP_REQUIRE_TTY 0x02		/* Fail if there is no tty. */
72#define RPP_FORCELOWER  0x04		/* Force input to lower case. */
73#define RPP_FORCEUPPER  0x08		/* Force input to upper case. */
74#define RPP_SEVENBIT    0x10		/* Strip the high bit from input. */
75#define RPP_STDIN       0x20		/* Read from stdin, not /dev/tty */
76
77
78#if defined(_WIN32) && !defined(__CYGWIN__)
79#include <windows.h>
80
81static char *
82readpassphrase(const char *prompt, char *buf, size_t bufsiz, int flags)
83{
84	HANDLE hStdin, hStdout;
85	DWORD mode, rbytes;
86	BOOL success;
87
88	(void)flags;
89
90	hStdin = GetStdHandle(STD_INPUT_HANDLE);
91	if (hStdin == INVALID_HANDLE_VALUE)
92		return (NULL);
93	hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
94	if (hStdout == INVALID_HANDLE_VALUE)
95		return (NULL);
96
97	success = GetConsoleMode(hStdin, &mode);
98	if (!success)
99		return (NULL);
100	mode &= ~ENABLE_ECHO_INPUT;
101	mode |= ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT;
102	success = SetConsoleMode(hStdin, mode);
103	if (!success)
104		return (NULL);
105
106	success = WriteFile(hStdout, prompt, (DWORD)strlen(prompt),
107		NULL, NULL);
108	if (!success)
109		return (NULL);
110	success = ReadFile(hStdin, buf, (DWORD)bufsiz - 1, &rbytes, NULL);
111	if (!success)
112		return (NULL);
113	WriteFile(hStdout, "\r\n", 2, NULL, NULL);
114	buf[rbytes] = '\0';
115	/* Remove trailing carriage return(s). */
116	if (rbytes > 2 && buf[rbytes - 2] == '\r' && buf[rbytes - 1] == '\n')
117		buf[rbytes - 2] = '\0';
118
119	return (buf);
120}
121
122#else /* _WIN32 && !__CYGWIN__ */
123
124#include <termios.h>
125#include <signal.h>
126#include <ctype.h>
127#include <fcntl.h>
128#ifdef HAVE_PATHS_H
129#include <paths.h>
130#endif
131#include <string.h>
132#include <unistd.h>
133
134#ifdef TCSASOFT
135# define _T_FLUSH	(TCSAFLUSH|TCSASOFT)
136#else
137# define _T_FLUSH	(TCSAFLUSH)
138#endif
139
140/* SunOS 4.x which lacks _POSIX_VDISABLE, but has VDISABLE */
141#if !defined(_POSIX_VDISABLE) && defined(VDISABLE)
142#  define _POSIX_VDISABLE       VDISABLE
143#endif
144
145static volatile sig_atomic_t *signo;
146
147static void
148handler(int s)
149{
150	signo[s] = 1;
151}
152
153static char *
154readpassphrase(const char *prompt, char *buf, size_t bufsiz, int flags)
155{
156	ssize_t nr;
157	int input, output, save_errno, i, need_restart;
158	char ch, *p, *end;
159	struct termios term, oterm;
160	struct sigaction sa, savealrm, saveint, savehup, savequit, saveterm;
161	struct sigaction savetstp, savettin, savettou, savepipe;
162
163	/* I suppose we could alloc on demand in this case (XXX). */
164	if (bufsiz == 0) {
165		errno = EINVAL;
166		return(NULL);
167	}
168
169	if (signo == NULL) {
170		signo = calloc(SIGRTMAX, sizeof(sig_atomic_t));
171	}
172
173restart:
174	for (i = 0; i < SIGRTMAX; i++)
175		signo[i] = 0;
176	nr = -1;
177	save_errno = 0;
178	need_restart = 0;
179	/*
180	 * Read and write to /dev/tty if available.  If not, read from
181	 * stdin and write to stderr unless a tty is required.
182	 */
183	if ((flags & RPP_STDIN) ||
184	    (input = output = open(_PATH_TTY, O_RDWR)) == -1) {
185		if (flags & RPP_REQUIRE_TTY) {
186			errno = ENOTTY;
187			return(NULL);
188		}
189		input = STDIN_FILENO;
190		output = STDERR_FILENO;
191	}
192
193	/*
194	 * Catch signals that would otherwise cause the user to end
195	 * up with echo turned off in the shell.  Don't worry about
196	 * things like SIGXCPU and SIGVTALRM for now.
197	 */
198	sigemptyset(&sa.sa_mask);
199	sa.sa_flags = 0;		/* don't restart system calls */
200	sa.sa_handler = handler;
201	(void)sigaction(SIGALRM, &sa, &savealrm);
202	(void)sigaction(SIGHUP, &sa, &savehup);
203	(void)sigaction(SIGINT, &sa, &saveint);
204	(void)sigaction(SIGPIPE, &sa, &savepipe);
205	(void)sigaction(SIGQUIT, &sa, &savequit);
206	(void)sigaction(SIGTERM, &sa, &saveterm);
207	(void)sigaction(SIGTSTP, &sa, &savetstp);
208	(void)sigaction(SIGTTIN, &sa, &savettin);
209	(void)sigaction(SIGTTOU, &sa, &savettou);
210
211	/* Turn off echo if possible. */
212	if (input != STDIN_FILENO && tcgetattr(input, &oterm) == 0) {
213		memcpy(&term, &oterm, sizeof(term));
214		if (!(flags & RPP_ECHO_ON))
215			term.c_lflag &= ~(ECHO | ECHONL);
216#ifdef VSTATUS
217		if (term.c_cc[VSTATUS] != _POSIX_VDISABLE)
218			term.c_cc[VSTATUS] = _POSIX_VDISABLE;
219#endif
220		(void)tcsetattr(input, _T_FLUSH, &term);
221	} else {
222		memset(&term, 0, sizeof(term));
223		term.c_lflag |= ECHO;
224		memset(&oterm, 0, sizeof(oterm));
225		oterm.c_lflag |= ECHO;
226	}
227
228	/* No I/O if we are already backgrounded. */
229	if (signo[SIGTTOU] != 1 && signo[SIGTTIN] != 1) {
230		if (!(flags & RPP_STDIN)) {
231			int r = write(output, prompt, strlen(prompt));
232			(void)r;
233		}
234		end = buf + bufsiz - 1;
235		p = buf;
236		while ((nr = read(input, &ch, 1)) == 1 && ch != '\n' && ch != '\r') {
237			if (p < end) {
238				if ((flags & RPP_SEVENBIT))
239					ch &= 0x7f;
240				if (isalpha(ch)) {
241					if ((flags & RPP_FORCELOWER))
242						ch = (char)tolower(ch);
243					if ((flags & RPP_FORCEUPPER))
244						ch = (char)toupper(ch);
245				}
246				*p++ = ch;
247			}
248		}
249		*p = '\0';
250		save_errno = errno;
251		if (!(term.c_lflag & ECHO)) {
252			int r = write(output, "\n", 1);
253			(void)r;
254		}
255	}
256
257	/* Restore old terminal settings and signals. */
258	if (memcmp(&term, &oterm, sizeof(term)) != 0) {
259		while (tcsetattr(input, _T_FLUSH, &oterm) == -1 &&
260		    errno == EINTR)
261			continue;
262	}
263	(void)sigaction(SIGALRM, &savealrm, NULL);
264	(void)sigaction(SIGHUP, &savehup, NULL);
265	(void)sigaction(SIGINT, &saveint, NULL);
266	(void)sigaction(SIGQUIT, &savequit, NULL);
267	(void)sigaction(SIGPIPE, &savepipe, NULL);
268	(void)sigaction(SIGTERM, &saveterm, NULL);
269	(void)sigaction(SIGTSTP, &savetstp, NULL);
270	(void)sigaction(SIGTTIN, &savettin, NULL);
271	(void)sigaction(SIGTTOU, &savettou, NULL);
272	if (input != STDIN_FILENO)
273		(void)close(input);
274
275	/*
276	 * If we were interrupted by a signal, resend it to ourselves
277	 * now that we have restored the signal handlers.
278	 */
279	for (i = 0; i < SIGRTMAX; i++) {
280		if (signo[i]) {
281			kill(getpid(), i);
282			switch (i) {
283			case SIGTSTP:
284			case SIGTTIN:
285			case SIGTTOU:
286				need_restart = 1;
287			}
288		}
289	}
290	if (need_restart)
291		goto restart;
292
293	if (save_errno)
294		errno = save_errno;
295	return(nr == -1 ? NULL : buf);
296}
297#endif /* _WIN32 && !__CYGWIN__ */
298#endif /* HAVE_READPASSPHRASE */
299
300char *
301lafe_readpassphrase(const char *prompt, char *buf, size_t bufsiz)
302{
303	char *p;
304
305	p = readpassphrase(prompt, buf, bufsiz, RPP_ECHO_OFF);
306	if (p == NULL) {
307		switch (errno) {
308		case EINTR:
309			break;
310		default:
311			lafe_errc(1, errno, "Couldn't read passphrase");
312			break;
313		}
314	}
315	return (p);
316}
317
318