2 * Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
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
10 #include <openssl/e_os2.h>
11 #include <openssl/err.h>
14 * need for #define _POSIX_C_SOURCE arises whenever you pass -ansi to gcc
15 * [maybe others?], because it masks interfaces not discussed in standard,
16 * sigaction and fileno included. -pedantic would be more appropriate for the
17 * intended purposes, but we can't prevent users from adding -ansi.
19 #if defined(OPENSSL_SYS_VXWORKS)
20 # include <sys/types.h>
23 #if !defined(_POSIX_C_SOURCE) && defined(OPENSSL_SYS_VMS)
24 # ifndef _POSIX_C_SOURCE
25 # define _POSIX_C_SOURCE 2
33 #if !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS)
34 # ifdef OPENSSL_UNISTD
35 # include OPENSSL_UNISTD
40 * If unistd.h defines _POSIX_VERSION, we conclude that we are on a POSIX
41 * system and have sigaction and termios.
43 # if defined(_POSIX_VERSION)
46 # if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
53 /* 06-Apr-92 Luke Brennan Support for VMS */
55 #include "internal/cryptlib.h"
57 #ifdef OPENSSL_SYS_VMS /* prototypes for sys$whatever */
60 # pragma message disable DOLLARID
64 #ifdef WIN_CONSOLE_BUG
66 # ifndef OPENSSL_SYS_WINCE
72 * There are 6 types of terminal interface supported, TERMIO, TERMIOS, VMS,
73 * MSDOS, WIN32 Console and SGTTY.
75 * If someone defines one of the macros TERMIO, TERMIOS or SGTTY, it will
76 * remain respected. Otherwise, we default to TERMIOS except for a few
77 * systems that require something different.
79 * Note: we do not use SGTTY unless it's defined by the configuration. We
80 * may eventually opt to remove it's use entirely.
83 #if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
90 * We know that VMS, MSDOS, VXWORKS, use entirely other mechanisms.
92 # elif !defined(OPENSSL_SYS_VMS) \
93 && !defined(OPENSSL_SYS_MSDOS) \
94 && !defined(OPENSSL_SYS_VXWORKS)
103 # include <termios.h>
104 # define TTY_STRUCT struct termios
105 # define TTY_FLAGS c_lflag
106 # define TTY_get(tty,data) tcgetattr(tty,data)
107 # define TTY_set(tty,data) tcsetattr(tty,TCSANOW,data)
112 # define TTY_STRUCT struct termio
113 # define TTY_FLAGS c_lflag
114 # define TTY_get(tty,data) ioctl(tty,TCGETA,data)
115 # define TTY_set(tty,data) ioctl(tty,TCSETA,data)
120 # define TTY_STRUCT struct sgttyb
121 # define TTY_FLAGS sg_flags
122 # define TTY_get(tty,data) ioctl(tty,TIOCGETP,data)
123 # define TTY_set(tty,data) ioctl(tty,TIOCSETP,data)
126 #if !defined(_LIBC) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS)
127 # include <sys/ioctl.h>
130 #ifdef OPENSSL_SYS_MSDOS
134 #ifdef OPENSSL_SYS_VMS
138 # include <descrip.h>
147 # define NX509_SIG 32
150 /* Define globals. They are protected by a lock */
152 static struct sigaction savsig[NX509_SIG];
154 static void (*savsig[NX509_SIG]) (int);
157 #ifdef OPENSSL_SYS_VMS
158 static struct IOSB iosb;
159 static $DESCRIPTOR(terminal, "TT");
160 static long tty_orig[3], tty_new[3]; /* XXX Is there any guarantee that this
161 * will always suffice for the actual
164 static unsigned short channel = 0;
165 #elif defined(_WIN32) && !defined(_WIN32_WCE)
166 static DWORD tty_orig, tty_new;
168 # if !defined(OPENSSL_SYS_MSDOS) || defined(__DJGPP__)
169 static TTY_STRUCT tty_orig, tty_new;
172 static FILE *tty_in, *tty_out;
175 /* Declare static functions */
176 #if !defined(OPENSSL_SYS_WINCE)
177 static int read_till_nl(FILE *);
178 static void recsig(int);
179 static void pushsig(void);
180 static void popsig(void);
182 #if defined(OPENSSL_SYS_MSDOS) && !defined(_WIN32)
183 static int noecho_fgets(char *buf, int size, FILE *tty);
185 static int read_string_inner(UI *ui, UI_STRING *uis, int echo, int strip_nl);
187 static int read_string(UI *ui, UI_STRING *uis);
188 static int write_string(UI *ui, UI_STRING *uis);
190 static int open_console(UI *ui);
191 static int echo_console(UI *ui);
192 static int noecho_console(UI *ui);
193 static int close_console(UI *ui);
195 static UI_METHOD ui_openssl = {
196 "OpenSSL default user interface",
199 NULL, /* No flusher is needed for command lines */
205 /* The method with all the built-in thingies */
206 UI_METHOD *UI_OpenSSL(void)
212 * The following function makes sure that info and error strings are printed
215 static int write_string(UI *ui, UI_STRING *uis)
217 switch (UI_get_string_type(uis)) {
220 fputs(UI_get0_output_string(uis), tty_out);
232 static int read_string(UI *ui, UI_STRING *uis)
236 switch (UI_get_string_type(uis)) {
238 fputs(UI_get0_output_string(uis), tty_out);
239 fputs(UI_get0_action_string(uis), tty_out);
241 return read_string_inner(ui, uis,
242 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO,
245 fputs(UI_get0_output_string(uis), tty_out);
247 return read_string_inner(ui, uis,
248 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO,
251 fprintf(tty_out, "Verifying - %s", UI_get0_output_string(uis));
253 if ((ok = read_string_inner(ui, uis,
254 UI_get_input_flags(uis) &
255 UI_INPUT_FLAG_ECHO, 1)) <= 0)
257 if (strcmp(UI_get0_result_string(uis), UI_get0_test_string(uis)) != 0) {
258 fprintf(tty_out, "Verify failure\n");
271 #if !defined(OPENSSL_SYS_WINCE)
272 /* Internal functions to read a string without echoing */
273 static int read_till_nl(FILE *in)
279 if (!fgets(buf, SIZE, in))
281 } while (strchr(buf, '\n') == NULL);
285 static volatile sig_atomic_t intr_signal;
288 static int read_string_inner(UI *ui, UI_STRING *uis, int echo, int strip_nl)
293 int maxsize = BUFSIZ - 1;
294 #if !defined(OPENSSL_SYS_WINCE)
296 int echo_eol = !echo;
305 if (!echo && !noecho_console(ui))
313 # if defined(CP_UTF8)
314 if (GetEnvironmentVariableW(L"OPENSSL_WIN32_UTF8", NULL, 0) != 0) {
315 WCHAR wresult[BUFSIZ];
317 if (ReadConsoleW(GetStdHandle(STD_INPUT_HANDLE),
318 wresult, maxsize, &numread, NULL)) {
320 wresult[numread-2] == L'\r' &&
321 wresult[numread-1] == L'\n') {
322 wresult[numread-2] = L'\n';
325 wresult[numread] = '\0';
326 if (WideCharToMultiByte(CP_UTF8, 0, wresult, -1,
327 result, sizeof(result), NULL, 0) > 0)
330 OPENSSL_cleanse(wresult, sizeof(wresult));
334 if (ReadConsoleA(GetStdHandle(STD_INPUT_HANDLE),
335 result, maxsize, &numread, NULL)) {
337 result[numread-2] == '\r' && result[numread-1] == '\n') {
338 result[numread-2] = '\n';
341 result[numread] = '\0';
345 # elif defined(OPENSSL_SYS_MSDOS)
347 noecho_fgets(result, maxsize, tty_in);
348 p = result; /* FIXME: noecho_fgets doesn't return errors */
351 p = fgets(result, maxsize, tty_in);
358 if ((p = (char *)strchr(result, '\n')) != NULL) {
361 } else if (!read_till_nl(tty_in))
363 if (UI_set_result(ui, uis, result) >= 0)
367 if (intr_signal == SIGINT)
370 fprintf(tty_out, "\n");
371 if (ps >= 2 && !echo && !echo_console(ui))
380 OPENSSL_cleanse(result, BUFSIZ);
384 /* Internal functions to open, handle and close a channel to the console. */
385 static int open_console(UI *ui)
387 CRYPTO_THREAD_write_lock(ui->lock);
390 #if defined(OPENSSL_SYS_VXWORKS)
393 #elif defined(_WIN32) && !defined(_WIN32_WCE)
394 if ((tty_out = fopen("conout$", "w")) == NULL)
397 if (GetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), &tty_orig)) {
401 if ((tty_in = fopen("conin$", "r")) == NULL)
405 # ifdef OPENSSL_SYS_MSDOS
406 # define DEV_TTY "con"
408 # define DEV_TTY "/dev/tty"
410 if ((tty_in = fopen(DEV_TTY, "r")) == NULL)
412 if ((tty_out = fopen(DEV_TTY, "w")) == NULL)
416 #if defined(TTY_get) && !defined(OPENSSL_SYS_VMS)
417 if (TTY_get(fileno(tty_in), &tty_orig) == -1) {
425 * Ariel Glenn ariel@columbia.edu reports that solaris can return
426 * EINVAL instead. This should be ok
434 * MacOS X returns ENODEV (Operation not supported by device),
435 * which seems appropriate.
443 BIO_snprintf(tmp_num, sizeof(tmp_num) - 1, "%d", errno);
444 UIerr(UI_F_OPEN_CONSOLE, UI_R_UNKNOWN_TTYGET_ERRNO_VALUE);
445 ERR_add_error_data(2, "errno=", tmp_num);
451 #ifdef OPENSSL_SYS_VMS
452 status = sys$assign(&terminal, &channel, 0, 0);
454 /* if there isn't a TT device, something is very wrong */
455 if (status != SS$_NORMAL) {
458 BIO_snprintf(tmp_num, sizeof(tmp_num) - 1, "%%X%08X", status);
459 UIerr(UI_F_OPEN_CONSOLE, UI_R_SYSASSIGN_ERROR);
460 ERR_add_error_data(2, "status=", tmp_num);
464 status = sys$qiow(0, channel, IO$_SENSEMODE, &iosb, 0, 0, tty_orig, 12,
467 /* If IO$_SENSEMODE doesn't work, this is not a terminal device */
468 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL))
474 static int noecho_console(UI *ui)
477 memcpy(&(tty_new), &(tty_orig), sizeof(tty_orig));
478 tty_new.TTY_FLAGS &= ~ECHO;
481 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
482 if (is_a_tty && (TTY_set(fileno(tty_in), &tty_new) == -1))
485 #ifdef OPENSSL_SYS_VMS
487 tty_new[0] = tty_orig[0];
488 tty_new[1] = tty_orig[1] | TT$M_NOECHO;
489 tty_new[2] = tty_orig[2];
490 status = sys$qiow(0, channel, IO$_SETMODE, &iosb, 0, 0, tty_new, 12,
492 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL)) {
495 BIO_snprintf(tmp_num[0], sizeof(tmp_num[0]) - 1, "%%X%08X",
497 BIO_snprintf(tmp_num[1], sizeof(tmp_num[1]) - 1, "%%X%08X",
499 UIerr(UI_F_NOECHO_CONSOLE, UI_R_SYSQIOW_ERROR);
500 ERR_add_error_data(5, "status=", tmp_num[0],
501 ",", "iosb.iosb$w_value=", tmp_num[1]);
506 #if defined(_WIN32) && !defined(_WIN32_WCE)
509 tty_new &= ~ENABLE_ECHO_INPUT;
510 SetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), tty_new);
516 static int echo_console(UI *ui)
518 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
519 memcpy(&(tty_new), &(tty_orig), sizeof(tty_orig));
520 tty_new.TTY_FLAGS |= ECHO;
523 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
524 if (is_a_tty && (TTY_set(fileno(tty_in), &tty_new) == -1))
527 #ifdef OPENSSL_SYS_VMS
529 tty_new[0] = tty_orig[0];
530 tty_new[1] = tty_orig[1] & ~TT$M_NOECHO;
531 tty_new[2] = tty_orig[2];
532 status = sys$qiow(0, channel, IO$_SETMODE, &iosb, 0, 0, tty_new, 12,
534 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL)) {
537 BIO_snprintf(tmp_num[0], sizeof(tmp_num[0]) - 1, "%%X%08X",
539 BIO_snprintf(tmp_num[1], sizeof(tmp_num[1]) - 1, "%%X%08X",
541 UIerr(UI_F_ECHO_CONSOLE, UI_R_SYSQIOW_ERROR);
542 ERR_add_error_data(5, "status=", tmp_num[0],
543 ",", "iosb.iosb$w_value=", tmp_num[1]);
548 #if defined(_WIN32) && !defined(_WIN32_WCE)
551 tty_new |= ENABLE_ECHO_INPUT;
552 SetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), tty_new);
558 static int close_console(UI *ui)
562 if (tty_out != stderr)
564 #ifdef OPENSSL_SYS_VMS
565 status = sys$dassgn(channel);
566 if (status != SS$_NORMAL) {
569 BIO_snprintf(tmp_num, sizeof(tmp_num) - 1, "%%X%08X", status);
570 UIerr(UI_F_CLOSE_CONSOLE, UI_R_SYSDASSGN_ERROR);
571 ERR_add_error_data(2, "status=", tmp_num);
575 CRYPTO_THREAD_unlock(ui->lock);
580 #if !defined(OPENSSL_SYS_WINCE)
581 /* Internal functions to handle signals and act on them */
582 static void pushsig(void)
584 # ifndef OPENSSL_SYS_WIN32
590 memset(&sa, 0, sizeof(sa));
591 sa.sa_handler = recsig;
594 # ifdef OPENSSL_SYS_WIN32
595 savsig[SIGABRT] = signal(SIGABRT, recsig);
596 savsig[SIGFPE] = signal(SIGFPE, recsig);
597 savsig[SIGILL] = signal(SIGILL, recsig);
598 savsig[SIGINT] = signal(SIGINT, recsig);
599 savsig[SIGSEGV] = signal(SIGSEGV, recsig);
600 savsig[SIGTERM] = signal(SIGTERM, recsig);
602 for (i = 1; i < NX509_SIG; i++) {
612 if (i == SIGKILL) /* We can't make any action on that. */
616 sigaction(i, &sa, &savsig[i]);
618 savsig[i] = signal(i, recsig);
624 signal(SIGWINCH, SIG_DFL);
628 static void popsig(void)
630 # ifdef OPENSSL_SYS_WIN32
631 signal(SIGABRT, savsig[SIGABRT]);
632 signal(SIGFPE, savsig[SIGFPE]);
633 signal(SIGILL, savsig[SIGILL]);
634 signal(SIGINT, savsig[SIGINT]);
635 signal(SIGSEGV, savsig[SIGSEGV]);
636 signal(SIGTERM, savsig[SIGTERM]);
639 for (i = 1; i < NX509_SIG; i++) {
649 sigaction(i, &savsig[i], NULL);
651 signal(i, savsig[i]);
657 static void recsig(int i)
663 /* Internal functions specific for Windows */
664 #if defined(OPENSSL_SYS_MSDOS) && !defined(_WIN32)
665 static int noecho_fgets(char *buf, int size, FILE *tty)
690 # ifdef WIN_CONSOLE_BUG
692 * Win95 has several evil console bugs: one of these is that the last
693 * character read using getch() is passed to the next read: this is
694 * usually a CR so this can be trouble. No STDIO fix seems to work but
695 * flushing the console appears to do the trick.
699 inh = GetStdHandle(STD_INPUT_HANDLE);
700 FlushConsoleInputBuffer(inh);
703 return (strlen(buf));