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 static const UI_METHOD *default_UI_meth = &ui_openssl;
207 void UI_set_default_method(const UI_METHOD *meth)
209 default_UI_meth = meth;
212 const UI_METHOD *UI_get_default_method(void)
214 return default_UI_meth;
217 /* The method with all the built-in thingies */
218 UI_METHOD *UI_OpenSSL(void)
224 * The following function makes sure that info and error strings are printed
227 static int write_string(UI *ui, UI_STRING *uis)
229 switch (UI_get_string_type(uis)) {
232 fputs(UI_get0_output_string(uis), tty_out);
241 static int read_string(UI *ui, UI_STRING *uis)
245 switch (UI_get_string_type(uis)) {
247 fputs(UI_get0_output_string(uis), tty_out);
248 fputs(UI_get0_action_string(uis), tty_out);
250 return read_string_inner(ui, uis,
251 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO,
254 fputs(UI_get0_output_string(uis), tty_out);
256 return read_string_inner(ui, uis,
257 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO,
260 fprintf(tty_out, "Verifying - %s", UI_get0_output_string(uis));
262 if ((ok = read_string_inner(ui, uis,
263 UI_get_input_flags(uis) &
264 UI_INPUT_FLAG_ECHO, 1)) <= 0)
266 if (strcmp(UI_get0_result_string(uis), UI_get0_test_string(uis)) != 0) {
267 fprintf(tty_out, "Verify failure\n");
278 #if !defined(OPENSSL_SYS_WINCE)
279 /* Internal functions to read a string without echoing */
280 static int read_till_nl(FILE *in)
286 if (!fgets(buf, SIZE, in))
288 } while (strchr(buf, '\n') == NULL);
292 static volatile sig_atomic_t intr_signal;
295 static int read_string_inner(UI *ui, UI_STRING *uis, int echo, int strip_nl)
300 int maxsize = BUFSIZ - 1;
301 #if !defined(OPENSSL_SYS_WINCE)
303 int echo_eol = !echo;
312 if (!echo && !noecho_console(ui))
320 # if defined(CP_UTF8)
321 if (GetEnvironmentVariableW(L"OPENSSL_WIN32_UTF8", NULL, 0) != 0) {
322 WCHAR wresult[BUFSIZ];
324 if (ReadConsoleW(GetStdHandle(STD_INPUT_HANDLE),
325 wresult, maxsize, &numread, NULL)) {
327 wresult[numread-2] == L'\r' &&
328 wresult[numread-1] == L'\n') {
329 wresult[numread-2] = L'\n';
332 wresult[numread] = '\0';
333 if (WideCharToMultiByte(CP_UTF8, 0, wresult, -1,
334 result, sizeof(result), NULL, 0) > 0)
337 OPENSSL_cleanse(wresult, sizeof(wresult));
341 if (ReadConsoleA(GetStdHandle(STD_INPUT_HANDLE),
342 result, maxsize, &numread, NULL)) {
344 result[numread-2] == '\r' && result[numread-1] == '\n') {
345 result[numread-2] = '\n';
348 result[numread] = '\0';
352 # elif defined(OPENSSL_SYS_MSDOS)
354 noecho_fgets(result, maxsize, tty_in);
355 p = result; /* FIXME: noecho_fgets doesn't return errors */
358 p = fgets(result, maxsize, tty_in);
365 if ((p = (char *)strchr(result, '\n')) != NULL) {
368 } else if (!read_till_nl(tty_in))
370 if (UI_set_result(ui, uis, result) >= 0)
374 if (intr_signal == SIGINT)
377 fprintf(tty_out, "\n");
378 if (ps >= 2 && !echo && !echo_console(ui))
387 OPENSSL_cleanse(result, BUFSIZ);
391 /* Internal functions to open, handle and close a channel to the console. */
392 static int open_console(UI *ui)
394 CRYPTO_THREAD_write_lock(ui->lock);
397 #if defined(OPENSSL_SYS_VXWORKS)
400 #elif defined(_WIN32) && !defined(_WIN32_WCE)
401 if ((tty_out = fopen("conout$", "w")) == NULL)
404 if (GetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), &tty_orig)) {
408 if ((tty_in = fopen("conin$", "r")) == NULL)
412 # ifdef OPENSSL_SYS_MSDOS
413 # define DEV_TTY "con"
415 # define DEV_TTY "/dev/tty"
417 if ((tty_in = fopen(DEV_TTY, "r")) == NULL)
419 if ((tty_out = fopen(DEV_TTY, "w")) == NULL)
423 #if defined(TTY_get) && !defined(OPENSSL_SYS_VMS)
424 if (TTY_get(fileno(tty_in), &tty_orig) == -1) {
432 * Ariel Glenn ariel@columbia.edu reports that solaris can return
433 * EINVAL instead. This should be ok
441 * MacOS X returns ENODEV (Operation not supported by device),
442 * which seems appropriate.
450 BIO_snprintf(tmp_num, sizeof(tmp_num) - 1, "%d", errno);
451 UIerr(UI_F_OPEN_CONSOLE, UI_R_UNKNOWN_TTYGET_ERRNO_VALUE);
452 ERR_add_error_data(2, "errno=", tmp_num);
458 #ifdef OPENSSL_SYS_VMS
459 status = sys$assign(&terminal, &channel, 0, 0);
461 /* if there isn't a TT device, something is very wrong */
462 if (status != SS$_NORMAL) {
465 BIO_snprintf(tmp_num, sizeof(tmp_num) - 1, "%%X%08X", status);
466 UIerr(UI_F_OPEN_CONSOLE, UI_R_SYSASSIGN_ERROR);
467 ERR_add_error_data(2, "status=", tmp_num);
471 status = sys$qiow(0, channel, IO$_SENSEMODE, &iosb, 0, 0, tty_orig, 12,
474 /* If IO$_SENSEMODE doesn't work, this is not a terminal device */
475 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL))
481 static int noecho_console(UI *ui)
484 memcpy(&(tty_new), &(tty_orig), sizeof(tty_orig));
485 tty_new.TTY_FLAGS &= ~ECHO;
488 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
489 if (is_a_tty && (TTY_set(fileno(tty_in), &tty_new) == -1))
492 #ifdef OPENSSL_SYS_VMS
494 tty_new[0] = tty_orig[0];
495 tty_new[1] = tty_orig[1] | TT$M_NOECHO;
496 tty_new[2] = tty_orig[2];
497 status = sys$qiow(0, channel, IO$_SETMODE, &iosb, 0, 0, tty_new, 12,
499 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL)) {
502 BIO_snprintf(tmp_num[0], sizeof(tmp_num[0]) - 1, "%%X%08X",
504 BIO_snprintf(tmp_num[1], sizeof(tmp_num[1]) - 1, "%%X%08X",
506 UIerr(UI_F_NOECHO_CONSOLE, UI_R_SYSQIOW_ERROR);
507 ERR_add_error_data(5, "status=", tmp_num[0],
508 ",", "iosb.iosb$w_value=", tmp_num[1]);
513 #if defined(_WIN32) && !defined(_WIN32_WCE)
516 tty_new &= ~ENABLE_ECHO_INPUT;
517 SetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), tty_new);
523 static int echo_console(UI *ui)
525 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
526 memcpy(&(tty_new), &(tty_orig), sizeof(tty_orig));
527 if (is_a_tty && (TTY_set(fileno(tty_in), &tty_new) == -1))
530 #ifdef OPENSSL_SYS_VMS
532 tty_new[0] = tty_orig[0];
533 tty_new[1] = tty_orig[1];
534 tty_new[2] = tty_orig[2];
535 status = sys$qiow(0, channel, IO$_SETMODE, &iosb, 0, 0, tty_new, 12,
537 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL)) {
540 BIO_snprintf(tmp_num[0], sizeof(tmp_num[0]) - 1, "%%X%08X",
542 BIO_snprintf(tmp_num[1], sizeof(tmp_num[1]) - 1, "%%X%08X",
544 UIerr(UI_F_ECHO_CONSOLE, UI_R_SYSQIOW_ERROR);
545 ERR_add_error_data(5, "status=", tmp_num[0],
546 ",", "iosb.iosb$w_value=", tmp_num[1]);
551 #if defined(_WIN32) && !defined(_WIN32_WCE)
554 SetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), tty_new);
560 static int close_console(UI *ui)
564 if (tty_out != stderr)
566 #ifdef OPENSSL_SYS_VMS
567 status = sys$dassgn(channel);
568 if (status != SS$_NORMAL) {
571 BIO_snprintf(tmp_num, sizeof(tmp_num) - 1, "%%X%08X", status);
572 UIerr(UI_F_CLOSE_CONSOLE, UI_R_SYSDASSGN_ERROR);
573 ERR_add_error_data(2, "status=", tmp_num);
577 CRYPTO_THREAD_unlock(ui->lock);
582 #if !defined(OPENSSL_SYS_WINCE)
583 /* Internal functions to handle signals and act on them */
584 static void pushsig(void)
586 # ifndef OPENSSL_SYS_WIN32
592 memset(&sa, 0, sizeof(sa));
593 sa.sa_handler = recsig;
596 # ifdef OPENSSL_SYS_WIN32
597 savsig[SIGABRT] = signal(SIGABRT, recsig);
598 savsig[SIGFPE] = signal(SIGFPE, recsig);
599 savsig[SIGILL] = signal(SIGILL, recsig);
600 savsig[SIGINT] = signal(SIGINT, recsig);
601 savsig[SIGSEGV] = signal(SIGSEGV, recsig);
602 savsig[SIGTERM] = signal(SIGTERM, recsig);
604 for (i = 1; i < NX509_SIG; i++) {
614 if (i == SIGKILL) /* We can't make any action on that. */
618 sigaction(i, &sa, &savsig[i]);
620 savsig[i] = signal(i, recsig);
626 signal(SIGWINCH, SIG_DFL);
630 static void popsig(void)
632 # ifdef OPENSSL_SYS_WIN32
633 signal(SIGABRT, savsig[SIGABRT]);
634 signal(SIGFPE, savsig[SIGFPE]);
635 signal(SIGILL, savsig[SIGILL]);
636 signal(SIGINT, savsig[SIGINT]);
637 signal(SIGSEGV, savsig[SIGSEGV]);
638 signal(SIGTERM, savsig[SIGTERM]);
641 for (i = 1; i < NX509_SIG; i++) {
651 sigaction(i, &savsig[i], NULL);
653 signal(i, savsig[i]);
659 static void recsig(int i)
665 /* Internal functions specific for Windows */
666 #if defined(OPENSSL_SYS_MSDOS) && !defined(_WIN32)
667 static int noecho_fgets(char *buf, int size, FILE *tty)
692 # ifdef WIN_CONSOLE_BUG
694 * Win95 has several evil console bugs: one of these is that the last
695 * character read using getch() is passed to the next read: this is
696 * usually a CR so this can be trouble. No STDIO fix seems to work but
697 * flushing the console appears to do the trick.
701 inh = GetStdHandle(STD_INPUT_HANDLE);
702 FlushConsoleInputBuffer(inh);
705 return (strlen(buf));