crypto/ui/ui_openssl.c: let new-line through after query in Windows path.
[openssl.git] / crypto / ui / ui_openssl.c
1 /*
2  * Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <openssl/e_os2.h>
11
12 /*
13  * need for #define _POSIX_C_SOURCE arises whenever you pass -ansi to gcc
14  * [maybe others?], because it masks interfaces not discussed in standard,
15  * sigaction and fileno included. -pedantic would be more appropriate for the
16  * intended purposes, but we can't prevent users from adding -ansi.
17  */
18 #if defined(OPENSSL_SYS_VXWORKS)
19 # include <sys/types.h>
20 #endif
21
22 #if !defined(_POSIX_C_SOURCE) && defined(OPENSSL_SYS_VMS)
23 # ifndef _POSIX_C_SOURCE
24 #  define _POSIX_C_SOURCE 2
25 # endif
26 #endif
27 #include <signal.h>
28 #include <stdio.h>
29 #include <string.h>
30 #include <errno.h>
31
32 #if !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS)
33 # ifdef OPENSSL_UNISTD
34 #  include OPENSSL_UNISTD
35 # else
36 #  include <unistd.h>
37 # endif
38 /*
39  * If unistd.h defines _POSIX_VERSION, we conclude that we are on a POSIX
40  * system and have sigaction and termios.
41  */
42 # if defined(_POSIX_VERSION)
43
44 #  define SIGACTION
45 #  if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
46 #   define TERMIOS
47 #  endif
48
49 # endif
50 #endif
51
52 /* 06-Apr-92 Luke Brennan    Support for VMS */
53 #include "ui_locl.h"
54 #include "internal/cryptlib.h"
55
56 #ifdef OPENSSL_SYS_VMS          /* prototypes for sys$whatever */
57 # include <starlet.h>
58 # ifdef __DECC
59 #  pragma message disable DOLLARID
60 # endif
61 #endif
62
63 #ifdef WIN_CONSOLE_BUG
64 # include <windows.h>
65 # ifndef OPENSSL_SYS_WINCE
66 #  include <wincon.h>
67 # endif
68 #endif
69
70 /*
71  * There are 6 types of terminal interface supported, TERMIO, TERMIOS, VMS,
72  * MSDOS, WIN32 Console and SGTTY.
73  *
74  * If someone defines one of the macros TERMIO, TERMIOS or SGTTY, it will
75  * remain respected.  Otherwise, we default to TERMIOS except for a few
76  * systems that require something different.
77  *
78  * Note: we do not use SGTTY unless it's defined by the configuration.  We
79  * may eventually opt to remove it's use entirely.
80  */
81
82 #if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
83
84 # if defined(_LIBC)
85 #  undef  TERMIOS
86 #  define TERMIO
87 #  undef  SGTTY
88 /*
89  * We know that VMS, MSDOS, VXWORKS, use entirely other mechanisms.
90  */
91 # elif !defined(OPENSSL_SYS_VMS) \
92         && !defined(OPENSSL_SYS_MSDOS) \
93         && !defined(OPENSSL_SYS_VXWORKS)
94 #  define TERMIOS
95 #  undef  TERMIO
96 #  undef  SGTTY
97 # endif
98
99 #endif
100
101 #ifdef TERMIOS
102 # include <termios.h>
103 # define TTY_STRUCT             struct termios
104 # define TTY_FLAGS              c_lflag
105 # define TTY_get(tty,data)      tcgetattr(tty,data)
106 # define TTY_set(tty,data)      tcsetattr(tty,TCSANOW,data)
107 #endif
108
109 #ifdef TERMIO
110 # include <termio.h>
111 # define TTY_STRUCT             struct termio
112 # define TTY_FLAGS              c_lflag
113 # define TTY_get(tty,data)      ioctl(tty,TCGETA,data)
114 # define TTY_set(tty,data)      ioctl(tty,TCSETA,data)
115 #endif
116
117 #ifdef SGTTY
118 # include <sgtty.h>
119 # define TTY_STRUCT             struct sgttyb
120 # define TTY_FLAGS              sg_flags
121 # define TTY_get(tty,data)      ioctl(tty,TIOCGETP,data)
122 # define TTY_set(tty,data)      ioctl(tty,TIOCSETP,data)
123 #endif
124
125 #if !defined(_LIBC) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS)
126 # include <sys/ioctl.h>
127 #endif
128
129 #ifdef OPENSSL_SYS_MSDOS
130 # include <conio.h>
131 #endif
132
133 #ifdef OPENSSL_SYS_VMS
134 # include <ssdef.h>
135 # include <iodef.h>
136 # include <ttdef.h>
137 # include <descrip.h>
138 struct IOSB {
139     short iosb$w_value;
140     short iosb$w_count;
141     long iosb$l_info;
142 };
143 #endif
144
145 #ifndef NX509_SIG
146 # define NX509_SIG 32
147 #endif
148
149 /* Define globals.  They are protected by a lock */
150 #ifdef SIGACTION
151 static struct sigaction savsig[NX509_SIG];
152 #else
153 static void (*savsig[NX509_SIG]) (int);
154 #endif
155
156 #ifdef OPENSSL_SYS_VMS
157 static struct IOSB iosb;
158 static $DESCRIPTOR(terminal, "TT");
159 static long tty_orig[3], tty_new[3]; /* XXX Is there any guarantee that this
160                                       * will always suffice for the actual
161                                       * structures? */
162 static long status;
163 static unsigned short channel = 0;
164 #elif defined(_WIN32) && !defined(_WIN32_WCE)
165 static DWORD tty_orig, tty_new;
166 #else
167 # if !defined(OPENSSL_SYS_MSDOS) || defined(__DJGPP__)
168 static TTY_STRUCT tty_orig, tty_new;
169 # endif
170 #endif
171 static FILE *tty_in, *tty_out;
172 static int is_a_tty;
173
174 /* Declare static functions */
175 #if !defined(OPENSSL_SYS_WINCE)
176 static int read_till_nl(FILE *);
177 static void recsig(int);
178 static void pushsig(void);
179 static void popsig(void);
180 #endif
181 #if defined(OPENSSL_SYS_MSDOS) && !defined(_WIN32)
182 static int noecho_fgets(char *buf, int size, FILE *tty);
183 #endif
184 static int read_string_inner(UI *ui, UI_STRING *uis, int echo, int strip_nl);
185
186 static int read_string(UI *ui, UI_STRING *uis);
187 static int write_string(UI *ui, UI_STRING *uis);
188
189 static int open_console(UI *ui);
190 static int echo_console(UI *ui);
191 static int noecho_console(UI *ui);
192 static int close_console(UI *ui);
193
194 static UI_METHOD ui_openssl = {
195     "OpenSSL default user interface",
196     open_console,
197     write_string,
198     NULL,                       /* No flusher is needed for command lines */
199     read_string,
200     close_console,
201     NULL
202 };
203
204 /* The method with all the built-in thingies */
205 UI_METHOD *UI_OpenSSL(void)
206 {
207     return &ui_openssl;
208 }
209
210 /*
211  * The following function makes sure that info and error strings are printed
212  * before any prompt.
213  */
214 static int write_string(UI *ui, UI_STRING *uis)
215 {
216     switch (UI_get_string_type(uis)) {
217     case UIT_ERROR:
218     case UIT_INFO:
219         fputs(UI_get0_output_string(uis), tty_out);
220         fflush(tty_out);
221         break;
222     default:
223         break;
224     }
225     return 1;
226 }
227
228 static int read_string(UI *ui, UI_STRING *uis)
229 {
230     int ok = 0;
231
232     switch (UI_get_string_type(uis)) {
233     case UIT_BOOLEAN:
234         fputs(UI_get0_output_string(uis), tty_out);
235         fputs(UI_get0_action_string(uis), tty_out);
236         fflush(tty_out);
237         return read_string_inner(ui, uis,
238                                  UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO,
239                                  0);
240     case UIT_PROMPT:
241         fputs(UI_get0_output_string(uis), tty_out);
242         fflush(tty_out);
243         return read_string_inner(ui, uis,
244                                  UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO,
245                                  1);
246     case UIT_VERIFY:
247         fprintf(tty_out, "Verifying - %s", UI_get0_output_string(uis));
248         fflush(tty_out);
249         if ((ok = read_string_inner(ui, uis,
250                                     UI_get_input_flags(uis) &
251                                     UI_INPUT_FLAG_ECHO, 1)) <= 0)
252             return ok;
253         if (strcmp(UI_get0_result_string(uis), UI_get0_test_string(uis)) != 0) {
254             fprintf(tty_out, "Verify failure\n");
255             fflush(tty_out);
256             return 0;
257         }
258         break;
259     default:
260         break;
261     }
262     return 1;
263 }
264
265 #if !defined(OPENSSL_SYS_WINCE)
266 /* Internal functions to read a string without echoing */
267 static int read_till_nl(FILE *in)
268 {
269 # define SIZE 4
270     char buf[SIZE + 1];
271
272     do {
273         if (!fgets(buf, SIZE, in))
274             return 0;
275     } while (strchr(buf, '\n') == NULL);
276     return 1;
277 }
278
279 static volatile sig_atomic_t intr_signal;
280 #endif
281
282 static int read_string_inner(UI *ui, UI_STRING *uis, int echo, int strip_nl)
283 {
284     static int ps;
285     int ok;
286     char result[BUFSIZ];
287     int maxsize = BUFSIZ - 1;
288 #if !defined(OPENSSL_SYS_WINCE)
289     char *p = NULL;
290     int echo_eol = !echo;
291
292     intr_signal = 0;
293     ok = 0;
294     ps = 0;
295
296     pushsig();
297     ps = 1;
298
299     if (!echo && !noecho_console(ui))
300         goto error;
301     ps = 2;
302
303     result[0] = '\0';
304 # if defined(_WIN32)
305     if (is_a_tty) {
306         DWORD numread;
307 #  if defined(CP_UTF8)
308         WCHAR wresult[BUFSIZ];
309
310         if (ReadConsoleW(GetStdHandle(STD_INPUT_HANDLE),
311                          wresult, maxsize, &numread, NULL)) {
312             if (numread >= 2 &&
313                 wresult[numread-2] == L'\r' && wresult[numread-1] == L'\n') {
314                 wresult[numread-2] = L'\n';
315                 numread--;
316             }
317             wresult[numread] = '\0';
318             if (WideCharToMultiByte(CP_UTF8, 0, wresult, -1,
319                                     result, sizeof(result), NULL, 0) > 0)
320                 p = result;
321
322             OPENSSL_cleanse(wresult, sizeof(wresult));
323         }
324 #  else
325         if (ReadConsoleA(GetStdHandle(STD_INPUT_HANDLE),
326                          result, maxsize, &numread, NULL)) {
327             if (numread >= 2 &&
328                 result[numread-2] == '\r' && result[numread-1] == '\n') {
329                 result[numread-2] = '\n';
330                 numread--;
331             }
332             result[numread] = '\0';
333             p = result;
334         }
335 #  endif
336     } else
337 # elif defined(OPENSSL_SYS_MSDOS)
338     if (!echo) {
339         noecho_fgets(result, maxsize, tty_in);
340         p = result;             /* FIXME: noecho_fgets doesn't return errors */
341     } else
342 # endif
343     p = fgets(result, maxsize, tty_in);
344     if (!p)
345         goto error;
346     if (feof(tty_in))
347         goto error;
348     if (ferror(tty_in))
349         goto error;
350     if ((p = (char *)strchr(result, '\n')) != NULL) {
351         if (strip_nl)
352             *p = '\0';
353     } else if (!read_till_nl(tty_in))
354         goto error;
355     if (UI_set_result(ui, uis, result) >= 0)
356         ok = 1;
357
358  error:
359     if (intr_signal == SIGINT)
360         ok = -1;
361     if (echo_eol)
362         fprintf(tty_out, "\n");
363     if (ps >= 2 && !echo && !echo_console(ui))
364         ok = 0;
365
366     if (ps >= 1)
367         popsig();
368 #else
369     ok = 1;
370 #endif
371
372     OPENSSL_cleanse(result, BUFSIZ);
373     return ok;
374 }
375
376 /* Internal functions to open, handle and close a channel to the console.  */
377 static int open_console(UI *ui)
378 {
379     CRYPTO_THREAD_write_lock(ui->lock);
380     is_a_tty = 1;
381
382 #if defined(OPENSSL_SYS_VXWORKS)
383     tty_in = stdin;
384     tty_out = stderr;
385 #elif defined(_WIN32) && !defined(_WIN32_WCE)
386     if ((tty_out = fopen("conout$", "w")) == NULL)
387         tty_out = stderr;
388
389     if (GetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), &tty_orig)) {
390         tty_in = stdin;
391     } else {
392         is_a_tty = 0;
393         if ((tty_in = fopen("conin$", "r")) == NULL)
394             tty_in = stdin;
395     }
396 #else
397 # ifdef OPENSSL_SYS_MSDOS
398 #  define DEV_TTY "con"
399 # else
400 #  define DEV_TTY "/dev/tty"
401 # endif
402     if ((tty_in = fopen(DEV_TTY, "r")) == NULL)
403         tty_in = stdin;
404     if ((tty_out = fopen(DEV_TTY, "w")) == NULL)
405         tty_out = stderr;
406 #endif
407
408 #if defined(TTY_get) && !defined(OPENSSL_SYS_VMS)
409     if (TTY_get(fileno(tty_in), &tty_orig) == -1) {
410 # ifdef ENOTTY
411         if (errno == ENOTTY)
412             is_a_tty = 0;
413         else
414 # endif
415 # ifdef EINVAL
416             /*
417              * Ariel Glenn ariel@columbia.edu reports that solaris can return
418              * EINVAL instead.  This should be ok
419              */
420         if (errno == EINVAL)
421             is_a_tty = 0;
422         else
423 # endif
424             return 0;
425     }
426 #endif
427 #ifdef OPENSSL_SYS_VMS
428     status = sys$assign(&terminal, &channel, 0, 0);
429     if (status != SS$_NORMAL)
430         return 0;
431     status =
432         sys$qiow(0, channel, IO$_SENSEMODE, &iosb, 0, 0, tty_orig, 12, 0, 0,
433                  0, 0);
434     if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL))
435         return 0;
436 #endif
437     return 1;
438 }
439
440 static int noecho_console(UI *ui)
441 {
442 #ifdef TTY_FLAGS
443     memcpy(&(tty_new), &(tty_orig), sizeof(tty_orig));
444     tty_new.TTY_FLAGS &= ~ECHO;
445 #endif
446
447 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
448     if (is_a_tty && (TTY_set(fileno(tty_in), &tty_new) == -1))
449         return 0;
450 #endif
451 #ifdef OPENSSL_SYS_VMS
452     tty_new[0] = tty_orig[0];
453     tty_new[1] = tty_orig[1] | TT$M_NOECHO;
454     tty_new[2] = tty_orig[2];
455     status =
456         sys$qiow(0, channel, IO$_SETMODE, &iosb, 0, 0, tty_new, 12, 0, 0, 0,
457                  0);
458     if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL))
459         return 0;
460 #endif
461 #if defined(_WIN32) && !defined(_WIN32_WCE)
462     if (is_a_tty) {
463         tty_new = tty_orig;
464         tty_new &= ~ENABLE_ECHO_INPUT;
465         SetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), tty_new);
466     }
467 #endif
468     return 1;
469 }
470
471 static int echo_console(UI *ui)
472 {
473 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
474     memcpy(&(tty_new), &(tty_orig), sizeof(tty_orig));
475     tty_new.TTY_FLAGS |= ECHO;
476 #endif
477
478 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
479     if (is_a_tty && (TTY_set(fileno(tty_in), &tty_new) == -1))
480         return 0;
481 #endif
482 #ifdef OPENSSL_SYS_VMS
483     tty_new[0] = tty_orig[0];
484     tty_new[1] = tty_orig[1] & ~TT$M_NOECHO;
485     tty_new[2] = tty_orig[2];
486     status =
487         sys$qiow(0, channel, IO$_SETMODE, &iosb, 0, 0, tty_new, 12, 0, 0, 0,
488                  0);
489     if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL))
490         return 0;
491 #endif
492 #if defined(_WIN32) && !defined(_WIN32_WCE)
493     if (is_a_tty) {
494         tty_new = tty_orig;
495         tty_new |= ENABLE_ECHO_INPUT;
496         SetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), tty_new);
497     }
498 #endif
499     return 1;
500 }
501
502 static int close_console(UI *ui)
503 {
504     if (tty_in != stdin)
505         fclose(tty_in);
506     if (tty_out != stderr)
507         fclose(tty_out);
508 #ifdef OPENSSL_SYS_VMS
509     status = sys$dassgn(channel);
510 #endif
511     CRYPTO_THREAD_unlock(ui->lock);
512
513     return 1;
514 }
515
516 #if !defined(OPENSSL_SYS_WINCE)
517 /* Internal functions to handle signals and act on them */
518 static void pushsig(void)
519 {
520 # ifndef OPENSSL_SYS_WIN32
521     int i;
522 # endif
523 # ifdef SIGACTION
524     struct sigaction sa;
525
526     memset(&sa, 0, sizeof(sa));
527     sa.sa_handler = recsig;
528 # endif
529
530 # ifdef OPENSSL_SYS_WIN32
531     savsig[SIGABRT] = signal(SIGABRT, recsig);
532     savsig[SIGFPE] = signal(SIGFPE, recsig);
533     savsig[SIGILL] = signal(SIGILL, recsig);
534     savsig[SIGINT] = signal(SIGINT, recsig);
535     savsig[SIGSEGV] = signal(SIGSEGV, recsig);
536     savsig[SIGTERM] = signal(SIGTERM, recsig);
537 # else
538     for (i = 1; i < NX509_SIG; i++) {
539 #  ifdef SIGUSR1
540         if (i == SIGUSR1)
541             continue;
542 #  endif
543 #  ifdef SIGUSR2
544         if (i == SIGUSR2)
545             continue;
546 #  endif
547 #  ifdef SIGKILL
548         if (i == SIGKILL)       /* We can't make any action on that. */
549             continue;
550 #  endif
551 #  ifdef SIGACTION
552         sigaction(i, &sa, &savsig[i]);
553 #  else
554         savsig[i] = signal(i, recsig);
555 #  endif
556     }
557 # endif
558
559 # ifdef SIGWINCH
560     signal(SIGWINCH, SIG_DFL);
561 # endif
562 }
563
564 static void popsig(void)
565 {
566 # ifdef OPENSSL_SYS_WIN32
567     signal(SIGABRT, savsig[SIGABRT]);
568     signal(SIGFPE, savsig[SIGFPE]);
569     signal(SIGILL, savsig[SIGILL]);
570     signal(SIGINT, savsig[SIGINT]);
571     signal(SIGSEGV, savsig[SIGSEGV]);
572     signal(SIGTERM, savsig[SIGTERM]);
573 # else
574     int i;
575     for (i = 1; i < NX509_SIG; i++) {
576 #  ifdef SIGUSR1
577         if (i == SIGUSR1)
578             continue;
579 #  endif
580 #  ifdef SIGUSR2
581         if (i == SIGUSR2)
582             continue;
583 #  endif
584 #  ifdef SIGACTION
585         sigaction(i, &savsig[i], NULL);
586 #  else
587         signal(i, savsig[i]);
588 #  endif
589     }
590 # endif
591 }
592
593 static void recsig(int i)
594 {
595     intr_signal = i;
596 }
597 #endif
598
599 /* Internal functions specific for Windows */
600 #if defined(OPENSSL_SYS_MSDOS) && !defined(_WIN32)
601 static int noecho_fgets(char *buf, int size, FILE *tty)
602 {
603     int i;
604     char *p;
605
606     p = buf;
607     for (;;) {
608         if (size == 0) {
609             *p = '\0';
610             break;
611         }
612         size--;
613 # if defined(_WIN32)
614         i = _getch();
615 # else
616         i = getch();
617 # endif
618         if (i == '\r')
619             i = '\n';
620         *(p++) = i;
621         if (i == '\n') {
622             *p = '\0';
623             break;
624         }
625     }
626 # ifdef WIN_CONSOLE_BUG
627     /*
628      * Win95 has several evil console bugs: one of these is that the last
629      * character read using getch() is passed to the next read: this is
630      * usually a CR so this can be trouble. No STDIO fix seems to work but
631      * flushing the console appears to do the trick.
632      */
633     {
634         HANDLE inh;
635         inh = GetStdHandle(STD_INPUT_HANDLE);
636         FlushConsoleInputBuffer(inh);
637     }
638 # endif
639     return (strlen(buf));
640 }
641 #endif