1 /* crypto/ui/ui_openssl.c */
3 * Written by Richard Levitte (richard@levitte.org) and others for the
4 * OpenSSL project 2001.
6 /* ====================================================================
7 * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * openssl-core@openssl.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
61 * The lowest level part of this file was previously in crypto/des/read_pwd.c,
62 * Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
63 * All rights reserved.
65 * This package is an SSL implementation written
66 * by Eric Young (eay@cryptsoft.com).
67 * The implementation was written so as to conform with Netscapes SSL.
69 * This library is free for commercial and non-commercial use as long as
70 * the following conditions are aheared to. The following conditions
71 * apply to all code found in this distribution, be it the RC4, RSA,
72 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
73 * included with this distribution is covered by the same copyright terms
74 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
76 * Copyright remains Eric Young's, and as such any Copyright notices in
77 * the code are not to be removed.
78 * If this package is used in a product, Eric Young should be given attribution
79 * as the author of the parts of the library used.
80 * This can be in the form of a textual message at program startup or
81 * in documentation (online or textual) provided with the package.
83 * Redistribution and use in source and binary forms, with or without
84 * modification, are permitted provided that the following conditions
86 * 1. Redistributions of source code must retain the copyright
87 * notice, this list of conditions and the following disclaimer.
88 * 2. Redistributions in binary form must reproduce the above copyright
89 * notice, this list of conditions and the following disclaimer in the
90 * documentation and/or other materials provided with the distribution.
91 * 3. All advertising materials mentioning features or use of this software
92 * must display the following acknowledgement:
93 * "This product includes cryptographic software written by
94 * Eric Young (eay@cryptsoft.com)"
95 * The word 'cryptographic' can be left out if the rouines from the library
96 * being used are not cryptographic related :-).
97 * 4. If you include any Windows specific code (or a derivative thereof) from
98 * the apps directory (application code) you must include an acknowledgement:
99 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
101 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
102 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
103 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
104 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
105 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
106 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
107 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
108 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
109 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
110 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
113 * The licence and distribution terms for any publically available version or
114 * derivative of this code cannot be changed. i.e. this code cannot simply be
115 * copied and put under another distribution licence
116 * [including the GNU Public Licence.]
119 #include <openssl/e_os2.h>
122 * need for #define _POSIX_C_SOURCE arises whenever you pass -ansi to gcc
123 * [maybe others?], because it masks interfaces not discussed in standard,
124 * sigaction and fileno included. -pedantic would be more appropriate for the
125 * intended purposes, but we can't prevent users from adding -ansi.
127 #if defined(OPENSSL_SYSNAME_VXWORKS)
128 # include <sys/types.h>
131 #if !defined(_POSIX_C_SOURCE) && defined(OPENSSL_SYS_VMS)
132 # ifndef _POSIX_C_SOURCE
133 # define _POSIX_C_SOURCE 2
141 #if !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS)
142 # ifdef OPENSSL_UNISTD
143 # include OPENSSL_UNISTD
148 * If unistd.h defines _POSIX_VERSION, we conclude that we are on a POSIX
149 * system and have sigaction and termios.
151 # if defined(_POSIX_VERSION)
154 # if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
162 # undef OPENSSL_SYS_WIN16
168 /* 06-Apr-92 Luke Brennan Support for VMS */
170 #include "cryptlib.h"
172 #ifdef OPENSSL_SYS_VMS /* prototypes for sys$whatever */
173 # include <starlet.h>
175 # pragma message disable DOLLARID
179 #ifdef WIN_CONSOLE_BUG
180 # include <windows.h>
181 # ifndef OPENSSL_SYS_WINCE
187 * There are 5 types of terminal interface supported, TERMIO, TERMIOS, VMS,
190 * If someone defines one of the macros TERMIO, TERMIOS or SGTTY, it will
191 * remain respected. Otherwise, we default to TERMIOS except for a few
192 * systems that require something different.
194 * Note: we do not use SGTTY unless it's defined by the configuration. We
195 * may eventually opt to remove it's use entirely.
198 #if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
205 * We know that VMS, MSDOS, VXWORKS, NETWARE use entirely other mechanisms.
206 * MAC_OS_GUSI_SOURCE should probably go away, but that needs to be confirmed.
208 # elif !defined(OPENSSL_SYS_VMS) \
209 && !defined(OPENSSL_SYS_MSDOS) \
210 && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) \
211 && !defined(MAC_OS_GUSI_SOURCE) \
212 && !defined(OPENSSL_SYS_VXWORKS) \
213 && !defined(OPENSSL_SYS_NETWARE)
222 # include <termios.h>
223 # define TTY_STRUCT struct termios
224 # define TTY_FLAGS c_lflag
225 # define TTY_get(tty,data) tcgetattr(tty,data)
226 # define TTY_set(tty,data) tcsetattr(tty,TCSANOW,data)
231 # define TTY_STRUCT struct termio
232 # define TTY_FLAGS c_lflag
233 # define TTY_get(tty,data) ioctl(tty,TCGETA,data)
234 # define TTY_set(tty,data) ioctl(tty,TCSETA,data)
239 # define TTY_STRUCT struct sgttyb
240 # define TTY_FLAGS sg_flags
241 # define TTY_get(tty,data) ioctl(tty,TIOCGETP,data)
242 # define TTY_set(tty,data) ioctl(tty,TIOCSETP,data)
245 #if !defined(_LIBC) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && !defined(OPENSSL_SYS_SUNOS)
246 # include <sys/ioctl.h>
249 #ifdef OPENSSL_SYS_MSDOS
253 #ifdef OPENSSL_SYS_VMS
257 # include <descrip.h>
265 #ifdef OPENSSL_SYS_SUNOS
266 typedef int sig_atomic_t;
269 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(MAC_OS_GUSI_SOURCE) || defined(OPENSSL_SYS_NETWARE)
271 * This one needs work. As a matter of fact the code is unoperational
272 * and this is only a trick to get it compiled.
273 * <appro@fy.chalmers.se>
275 # define TTY_STRUCT int
279 # define NX509_SIG 32
282 /* Define globals. They are protected by a lock */
284 static struct sigaction savsig[NX509_SIG];
286 static void (*savsig[NX509_SIG]) (int);
289 #ifdef OPENSSL_SYS_VMS
290 static struct IOSB iosb;
291 static $DESCRIPTOR(terminal, "TT");
292 static long tty_orig[3], tty_new[3]; /* XXX Is there any guarantee that this
293 * will always suffice for the actual
296 static unsigned short channel = 0;
298 # if !defined(OPENSSL_SYS_MSDOS) || defined(__DJGPP__)
299 static TTY_STRUCT tty_orig, tty_new;
302 static FILE *tty_in, *tty_out;
305 /* Declare static functions */
306 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
307 static int read_till_nl(FILE *);
308 static void recsig(int);
309 static void pushsig(void);
310 static void popsig(void);
312 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16)
313 static int noecho_fgets(char *buf, int size, FILE *tty);
315 static int read_string_inner(UI *ui, UI_STRING *uis, int echo, int strip_nl);
317 static int read_string(UI *ui, UI_STRING *uis);
318 static int write_string(UI *ui, UI_STRING *uis);
320 static int open_console(UI *ui);
321 static int echo_console(UI *ui);
322 static int noecho_console(UI *ui);
323 static int close_console(UI *ui);
325 static UI_METHOD ui_openssl = {
326 "OpenSSL default user interface",
329 NULL, /* No flusher is needed for command lines */
335 /* The method with all the built-in thingies */
336 UI_METHOD *UI_OpenSSL(void)
342 * The following function makes sure that info and error strings are printed
345 static int write_string(UI *ui, UI_STRING *uis)
347 switch (UI_get_string_type(uis)) {
350 fputs(UI_get0_output_string(uis), tty_out);
359 static int read_string(UI *ui, UI_STRING *uis)
363 switch (UI_get_string_type(uis)) {
365 fputs(UI_get0_output_string(uis), tty_out);
366 fputs(UI_get0_action_string(uis), tty_out);
368 return read_string_inner(ui, uis,
369 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO,
372 fputs(UI_get0_output_string(uis), tty_out);
374 return read_string_inner(ui, uis,
375 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO,
378 fprintf(tty_out, "Verifying - %s", UI_get0_output_string(uis));
380 if ((ok = read_string_inner(ui, uis,
381 UI_get_input_flags(uis) &
382 UI_INPUT_FLAG_ECHO, 1)) <= 0)
384 if (strcmp(UI_get0_result_string(uis), UI_get0_test_string(uis)) != 0) {
385 fprintf(tty_out, "Verify failure\n");
396 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
397 /* Internal functions to read a string without echoing */
398 static int read_till_nl(FILE *in)
404 if (!fgets(buf, SIZE, in))
406 } while (strchr(buf, '\n') == NULL);
410 static volatile sig_atomic_t intr_signal;
413 static int read_string_inner(UI *ui, UI_STRING *uis, int echo, int strip_nl)
418 int maxsize = BUFSIZ - 1;
419 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
429 if (!echo && !noecho_console(ui))
434 # ifdef OPENSSL_SYS_MSDOS
436 noecho_fgets(result, maxsize, tty_in);
437 p = result; /* FIXME: noecho_fgets doesn't return errors */
439 p = fgets(result, maxsize, tty_in);
441 p = fgets(result, maxsize, tty_in);
449 if ((p = (char *)strchr(result, '\n')) != NULL) {
452 } else if (!read_till_nl(tty_in))
454 if (UI_set_result(ui, uis, result) >= 0)
458 if (intr_signal == SIGINT)
461 fprintf(tty_out, "\n");
462 if (ps >= 2 && !echo && !echo_console(ui))
471 OPENSSL_cleanse(result, BUFSIZ);
475 /* Internal functions to open, handle and close a channel to the console. */
476 static int open_console(UI *ui)
478 CRYPTO_w_lock(CRYPTO_LOCK_UI);
481 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(OPENSSL_SYS_VXWORKS) || defined(OPENSSL_SYS_NETWARE) || defined(OPENSSL_SYS_BEOS)
485 # ifdef OPENSSL_SYS_MSDOS
486 # define DEV_TTY "con"
488 # define DEV_TTY "/dev/tty"
490 if ((tty_in = fopen(DEV_TTY, "r")) == NULL)
492 if ((tty_out = fopen(DEV_TTY, "w")) == NULL)
496 #if defined(TTY_get) && !defined(OPENSSL_SYS_VMS)
497 if (TTY_get(fileno(tty_in), &tty_orig) == -1) {
505 * Ariel Glenn ariel@columbia.edu reports that solaris can return
506 * EINVAL instead. This should be ok
514 * MacOS X returns ENODEV (Operation not supported by device),
515 * which seems appropriate.
524 #ifdef OPENSSL_SYS_VMS
525 status = sys$assign(&terminal, &channel, 0, 0);
527 /* if there isn't a TT device, something is very wrong */
528 if (status != SS$_NORMAL)
531 status = sys$qiow(0, channel, IO$_SENSEMODE, &iosb, 0, 0, tty_orig, 12,
534 /* If IO$_SENSEMODE doesn't work, this is not a terminal device */
535 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL))
541 static int noecho_console(UI *ui)
544 memcpy(&(tty_new), &(tty_orig), sizeof(tty_orig));
545 tty_new.TTY_FLAGS &= ~ECHO;
548 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
549 if (is_a_tty && (TTY_set(fileno(tty_in), &tty_new) == -1))
552 #ifdef OPENSSL_SYS_VMS
554 tty_new[0] = tty_orig[0];
555 tty_new[1] = tty_orig[1] | TT$M_NOECHO;
556 tty_new[2] = tty_orig[2];
557 status = sys$qiow(0, channel, IO$_SETMODE, &iosb, 0, 0, tty_new, 12,
559 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL))
566 static int echo_console(UI *ui)
568 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
569 memcpy(&(tty_new), &(tty_orig), sizeof(tty_orig));
570 tty_new.TTY_FLAGS |= ECHO;
573 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
574 if (is_a_tty && (TTY_set(fileno(tty_in), &tty_new) == -1))
577 #ifdef OPENSSL_SYS_VMS
579 tty_new[0] = tty_orig[0];
580 tty_new[1] = tty_orig[1] & ~TT$M_NOECHO;
581 tty_new[2] = tty_orig[2];
582 status = sys$qiow(0, channel, IO$_SETMODE, &iosb, 0, 0, tty_new, 12,
584 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL))
591 static int close_console(UI *ui)
595 if (tty_out != stderr)
597 #ifdef OPENSSL_SYS_VMS
598 status = sys$dassgn(channel);
599 if (status != SS$_NORMAL)
602 CRYPTO_w_unlock(CRYPTO_LOCK_UI);
607 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
608 /* Internal functions to handle signals and act on them */
609 static void pushsig(void)
611 # ifndef OPENSSL_SYS_WIN32
617 memset(&sa, 0, sizeof sa);
618 sa.sa_handler = recsig;
621 # ifdef OPENSSL_SYS_WIN32
622 savsig[SIGABRT] = signal(SIGABRT, recsig);
623 savsig[SIGFPE] = signal(SIGFPE, recsig);
624 savsig[SIGILL] = signal(SIGILL, recsig);
625 savsig[SIGINT] = signal(SIGINT, recsig);
626 savsig[SIGSEGV] = signal(SIGSEGV, recsig);
627 savsig[SIGTERM] = signal(SIGTERM, recsig);
629 for (i = 1; i < NX509_SIG; i++) {
639 if (i == SIGKILL) /* We can't make any action on that. */
643 sigaction(i, &sa, &savsig[i]);
645 savsig[i] = signal(i, recsig);
651 signal(SIGWINCH, SIG_DFL);
655 static void popsig(void)
657 # ifdef OPENSSL_SYS_WIN32
658 signal(SIGABRT, savsig[SIGABRT]);
659 signal(SIGFPE, savsig[SIGFPE]);
660 signal(SIGILL, savsig[SIGILL]);
661 signal(SIGINT, savsig[SIGINT]);
662 signal(SIGSEGV, savsig[SIGSEGV]);
663 signal(SIGTERM, savsig[SIGTERM]);
666 for (i = 1; i < NX509_SIG; i++) {
676 sigaction(i, &savsig[i], NULL);
678 signal(i, savsig[i]);
684 static void recsig(int i)
690 /* Internal functions specific for Windows */
691 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
692 static int noecho_fgets(char *buf, int size, FILE *tty)
706 # elif defined(_WIN32)
719 # ifdef WIN_CONSOLE_BUG
721 * Win95 has several evil console bugs: one of these is that the last
722 * character read using getch() is passed to the next read: this is
723 * usually a CR so this can be trouble. No STDIO fix seems to work but
724 * flushing the console appears to do the trick.
728 inh = GetStdHandle(STD_INPUT_HANDLE);
729 FlushConsoleInputBuffer(inh);
732 return (strlen(buf));