passphrase.c revision 302425
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 302425 2016-07-08 10:06:02Z 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 <assert.h> 125#include <ctype.h> 126#include <fcntl.h> 127#ifdef HAVE_PATHS_H 128#include <paths.h> 129#endif 130#include <signal.h> 131#include <string.h> 132#include <termios.h> 133#include <unistd.h> 134 135#ifndef _PATH_TTY 136#define _PATH_TTY "/dev/tty" 137#endif 138 139#ifdef TCSASOFT 140# define _T_FLUSH (TCSAFLUSH|TCSASOFT) 141#else 142# define _T_FLUSH (TCSAFLUSH) 143#endif 144 145/* SunOS 4.x which lacks _POSIX_VDISABLE, but has VDISABLE */ 146#if !defined(_POSIX_VDISABLE) && defined(VDISABLE) 147# define _POSIX_VDISABLE VDISABLE 148#endif 149 150#define M(a,b) (a > b ? a : b) 151#define MAX_SIGNO M(M(M(SIGALRM, SIGHUP), \ 152 M(SIGINT, SIGPIPE)), \ 153 M(M(SIGQUIT, SIGTERM), \ 154 M(M(SIGTSTP, SIGTTIN), SIGTTOU))) 155 156static volatile sig_atomic_t signo[MAX_SIGNO + 1]; 157 158static void 159handler(int s) 160{ 161 assert(s <= MAX_SIGNO); 162 signo[s] = 1; 163} 164 165static char * 166readpassphrase(const char *prompt, char *buf, size_t bufsiz, int flags) 167{ 168 ssize_t nr; 169 int input, output, save_errno, i, need_restart; 170 char ch, *p, *end; 171 struct termios term, oterm; 172 struct sigaction sa, savealrm, saveint, savehup, savequit, saveterm; 173 struct sigaction savetstp, savettin, savettou, savepipe; 174 175 /* I suppose we could alloc on demand in this case (XXX). */ 176 if (bufsiz == 0) { 177 errno = EINVAL; 178 return(NULL); 179 } 180 181restart: 182 for (i = 0; i <= MAX_SIGNO; i++) 183 signo[i] = 0; 184 nr = -1; 185 save_errno = 0; 186 need_restart = 0; 187 /* 188 * Read and write to /dev/tty if available. If not, read from 189 * stdin and write to stderr unless a tty is required. 190 */ 191 if ((flags & RPP_STDIN) || 192 (input = output = open(_PATH_TTY, O_RDWR)) == -1) { 193 if (flags & RPP_REQUIRE_TTY) { 194 errno = ENOTTY; 195 return(NULL); 196 } 197 input = STDIN_FILENO; 198 output = STDERR_FILENO; 199 } 200 201 /* 202 * Catch signals that would otherwise cause the user to end 203 * up with echo turned off in the shell. Don't worry about 204 * things like SIGXCPU and SIGVTALRM for now. 205 */ 206 sigemptyset(&sa.sa_mask); 207 sa.sa_flags = 0; /* don't restart system calls */ 208 sa.sa_handler = handler; 209 /* Keep this list in sync with MAX_SIGNO! */ 210 (void)sigaction(SIGALRM, &sa, &savealrm); 211 (void)sigaction(SIGHUP, &sa, &savehup); 212 (void)sigaction(SIGINT, &sa, &saveint); 213 (void)sigaction(SIGPIPE, &sa, &savepipe); 214 (void)sigaction(SIGQUIT, &sa, &savequit); 215 (void)sigaction(SIGTERM, &sa, &saveterm); 216 (void)sigaction(SIGTSTP, &sa, &savetstp); 217 (void)sigaction(SIGTTIN, &sa, &savettin); 218 (void)sigaction(SIGTTOU, &sa, &savettou); 219 220 /* Turn off echo if possible. */ 221 if (input != STDIN_FILENO && tcgetattr(input, &oterm) == 0) { 222 memcpy(&term, &oterm, sizeof(term)); 223 if (!(flags & RPP_ECHO_ON)) 224 term.c_lflag &= ~(ECHO | ECHONL); 225#ifdef VSTATUS 226 if (term.c_cc[VSTATUS] != _POSIX_VDISABLE) 227 term.c_cc[VSTATUS] = _POSIX_VDISABLE; 228#endif 229 (void)tcsetattr(input, _T_FLUSH, &term); 230 } else { 231 memset(&term, 0, sizeof(term)); 232 term.c_lflag |= ECHO; 233 memset(&oterm, 0, sizeof(oterm)); 234 oterm.c_lflag |= ECHO; 235 } 236 237 /* No I/O if we are already backgrounded. */ 238 if (signo[SIGTTOU] != 1 && signo[SIGTTIN] != 1) { 239 if (!(flags & RPP_STDIN)) { 240 int r = write(output, prompt, strlen(prompt)); 241 (void)r; 242 } 243 end = buf + bufsiz - 1; 244 p = buf; 245 while ((nr = read(input, &ch, 1)) == 1 && ch != '\n' && ch != '\r') { 246 if (p < end) { 247 if ((flags & RPP_SEVENBIT)) 248 ch &= 0x7f; 249 if (isalpha((unsigned char)ch)) { 250 if ((flags & RPP_FORCELOWER)) 251 ch = (char)tolower((unsigned char)ch); 252 if ((flags & RPP_FORCEUPPER)) 253 ch = (char)toupper((unsigned char)ch); 254 } 255 *p++ = ch; 256 } 257 } 258 *p = '\0'; 259 save_errno = errno; 260 if (!(term.c_lflag & ECHO)) { 261 int r = write(output, "\n", 1); 262 (void)r; 263 } 264 } 265 266 /* Restore old terminal settings and signals. */ 267 if (memcmp(&term, &oterm, sizeof(term)) != 0) { 268 while (tcsetattr(input, _T_FLUSH, &oterm) == -1 && 269 errno == EINTR) 270 continue; 271 } 272 (void)sigaction(SIGALRM, &savealrm, NULL); 273 (void)sigaction(SIGHUP, &savehup, NULL); 274 (void)sigaction(SIGINT, &saveint, NULL); 275 (void)sigaction(SIGQUIT, &savequit, NULL); 276 (void)sigaction(SIGPIPE, &savepipe, NULL); 277 (void)sigaction(SIGTERM, &saveterm, NULL); 278 (void)sigaction(SIGTSTP, &savetstp, NULL); 279 (void)sigaction(SIGTTIN, &savettin, NULL); 280 (void)sigaction(SIGTTOU, &savettou, NULL); 281 if (input != STDIN_FILENO) 282 (void)close(input); 283 284 /* 285 * If we were interrupted by a signal, resend it to ourselves 286 * now that we have restored the signal handlers. 287 */ 288 for (i = 0; i <= MAX_SIGNO; i++) { 289 if (signo[i]) { 290 kill(getpid(), i); 291 switch (i) { 292 case SIGTSTP: 293 case SIGTTIN: 294 case SIGTTOU: 295 need_restart = 1; 296 } 297 } 298 } 299 if (need_restart) 300 goto restart; 301 302 if (save_errno) 303 errno = save_errno; 304 return(nr == -1 ? NULL : buf); 305} 306#endif /* _WIN32 && !__CYGWIN__ */ 307#endif /* HAVE_READPASSPHRASE */ 308 309char * 310lafe_readpassphrase(const char *prompt, char *buf, size_t bufsiz) 311{ 312 char *p; 313 314 p = readpassphrase(prompt, buf, bufsiz, RPP_ECHO_OFF); 315 if (p == NULL) { 316 switch (errno) { 317 case EINTR: 318 break; 319 default: 320 lafe_errc(1, errno, "Couldn't read passphrase"); 321 break; 322 } 323 } 324 return (p); 325} 326 327