contrib/libarchive/libarchive_fe/passphrase.c

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