First public contribution.
1 /* crypto/ui/ui_openssl.c -*- mode:C; c-file-style: "eay" -*- */
2 /* Written by Richard Levitte (richard@levitte.org) and others
3 * for the OpenSSL project 2001.
5 /* ====================================================================
6 * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * openssl-core@openssl.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
59 /* The lowest level part of this file was previously in crypto/des/read_pwd.c,
60 * Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
61 * All rights reserved.
63 * This package is an SSL implementation written
64 * by Eric Young (eay@cryptsoft.com).
65 * The implementation was written so as to conform with Netscapes SSL.
67 * This library is free for commercial and non-commercial use as long as
68 * the following conditions are aheared to. The following conditions
69 * apply to all code found in this distribution, be it the RC4, RSA,
70 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
71 * included with this distribution is covered by the same copyright terms
72 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
74 * Copyright remains Eric Young's, and as such any Copyright notices in
75 * the code are not to be removed.
76 * If this package is used in a product, Eric Young should be given attribution
77 * as the author of the parts of the library used.
78 * This can be in the form of a textual message at program startup or
79 * in documentation (online or textual) provided with the package.
81 * Redistribution and use in source and binary forms, with or without
82 * modification, are permitted provided that the following conditions
84 * 1. Redistributions of source code must retain the copyright
85 * notice, this list of conditions and the following disclaimer.
86 * 2. Redistributions in binary form must reproduce the above copyright
87 * notice, this list of conditions and the following disclaimer in the
88 * documentation and/or other materials provided with the distribution.
89 * 3. All advertising materials mentioning features or use of this software
90 * must display the following acknowledgement:
91 * "This product includes cryptographic software written by
92 * Eric Young (eay@cryptsoft.com)"
93 * The word 'cryptographic' can be left out if the rouines from the library
94 * being used are not cryptographic related :-).
95 * 4. If you include any Windows specific code (or a derivative thereof) from
96 * the apps directory (application code) you must include an acknowledgement:
97 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
99 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
100 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
101 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
102 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
103 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
104 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
105 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
106 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
107 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
108 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
111 * The licence and distribution terms for any publically available version or
112 * derivative of this code cannot be changed. i.e. this code cannot simply be
113 * copied and put under another distribution licence
114 * [including the GNU Public Licence.]
117 © Portions copyright (c) 2006 Nokia Corporation. All rights reserved.
121 #include <openssl/e_os2.h>
123 /* need for #define _POSIX_C_SOURCE arises whenever you pass -ansi to gcc
124 * [maybe others?], because it masks interfaces not discussed in standard,
125 * sigaction and fileno included. -pedantic would be more appropriate for
126 * the intended purposes, but we can't prevent users from adding -ansi.
129 #define _POSIX_C_SOURCE 1
130 #if (defined(SYMBIAN) && (defined(__WINSCW__) || defined(__WINS__)))
131 #undef _POSIX_C_SOURCE
141 #if !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS)
142 # ifdef OPENSSL_UNISTD
143 # include OPENSSL_UNISTD
147 /* If unistd.h defines _POSIX_VERSION, we conclude that we
148 * are on a POSIX system and have sigaction and termios. */
149 # if defined(_POSIX_VERSION) && !defined(SYMBIAN)
151 # if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
159 # undef OPENSSL_SYS_WIN16
165 /* 06-Apr-92 Luke Brennan Support for VMS */
167 #include "cryptlib.h"
169 #ifdef OPENSSL_SYS_VMS /* prototypes for sys$whatever */
170 # include <starlet.h>
172 # pragma message disable DOLLARID
177 #ifdef WIN_CONSOLE_BUG
178 # include <windows.h>
179 #ifndef OPENSSL_SYS_WINCE
185 /* There are 5 types of terminal interface supported,
186 * TERMIO, TERMIOS, VMS, MSDOS and SGTTY
189 #if defined(__sgi) && !defined(TERMIOS)
195 #if defined(linux) && !defined(TERMIO)
207 #if !defined(TERMIO) && !defined(TERMIOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && !defined(MAC_OS_GUSI_SOURCE)
213 #if defined(OPENSSL_SYS_VXWORKS)
219 #if defined(OPENSSL_SYS_NETWARE)
232 # include <termios.h>
233 # define TTY_STRUCT struct termios
234 # define TTY_FLAGS c_lflag
235 # define TTY_get(tty,data) tcgetattr(tty,data)
236 # define TTY_set(tty,data) tcsetattr(tty,TCSANOW,data)
241 # define TTY_STRUCT struct termio
242 # define TTY_FLAGS c_lflag
243 # define TTY_get(tty,data) ioctl(tty,TCGETA,data)
244 # define TTY_set(tty,data) ioctl(tty,TCSETA,data)
249 # define TTY_STRUCT struct sgttyb
250 # define TTY_FLAGS sg_flags
251 # define TTY_get(tty,data) ioctl(tty,TIOCGETP,data)
252 # define TTY_set(tty,data) ioctl(tty,TIOCSETP,data)
255 #if !defined(_LIBC) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && !defined(OPENSSL_SYS_SUNOS)
256 # include <sys/ioctl.h>
259 #ifdef OPENSSL_SYS_MSDOS
263 #ifdef OPENSSL_SYS_VMS
267 # include <descrip.h>
274 #if (defined(SYMBIAN) && (defined(__WINSCW__) || defined(__WINS__)))
275 #include "libcrypto_wsd_macros.h"
276 #include "libcrypto_wsd.h"
279 #ifdef OPENSSL_SYS_SUNOS
280 typedef int sig_atomic_t;
283 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(MAC_OS_GUSI_SOURCE) || defined(OPENSSL_SYS_NETWARE)
285 * This one needs work. As a matter of fact the code is unoperational
286 * and this is only a trick to get it compiled.
287 * <appro@fy.chalmers.se>
289 # define TTY_STRUCT int
293 # define NX509_SIG 32
297 /* Define globals. They are protected by a lock */
299 static struct sigaction savsig[NX509_SIG];
301 static void (*savsig[NX509_SIG])(int );
304 #ifdef OPENSSL_SYS_VMS
305 static struct IOSB iosb;
306 static $DESCRIPTOR(terminal,"TT");
307 static long tty_orig[3], tty_new[3]; /* XXX Is there any guarantee that this will always suffice for the actual structures? */
309 static unsigned short channel = 0;
312 #if !defined(OPENSSL_SYS_MSDOS) || defined(__DJGPP__)
313 static TTY_STRUCT tty_orig,tty_new;
318 static FILE *tty_in, *tty_out;
321 GET_STATIC_VAR_FROM_TLS(tty_in,ui_openssl,FILE *)
322 #define tty_in (*GET_WSD_VAR_NAME(tty_in,ui_openssl, s)())
324 GET_STATIC_VAR_FROM_TLS(tty_out,ui_openssl,FILE *)
325 #define tty_out (*GET_WSD_VAR_NAME(tty_out,ui_openssl, s)())
327 GET_STATIC_VAR_FROM_TLS(is_a_tty,ui_openssl,int)
328 #define is_a_tty (*GET_WSD_VAR_NAME(is_a_tty,ui_openssl, s)())
331 /* Declare static functions */
332 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
333 static void read_till_nl(FILE *);
334 static void recsig(int);
335 static void pushsig(void);
336 static void popsig(void);
338 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16)
339 static int noecho_fgets(char *buf, int size, FILE *tty);
341 static int read_string_inner(UI *ui, UI_STRING *uis, int echo, int strip_nl);
343 static int read_string(UI *ui, UI_STRING *uis);
344 static int write_string(UI *ui, UI_STRING *uis);
346 static int open_console(UI *ui);
347 static int echo_console(UI *ui);
348 static int noecho_console(UI *ui);
349 static int close_console(UI *ui);
352 static UI_METHOD ui_openssl =
354 "OpenSSL default user interface",
357 NULL, /* No flusher is needed for command lines */
363 GET_STATIC_VAR_FROM_TLS(ui_openssl,ui_openssl,UI_METHOD)
364 #define ui_openssl (*GET_WSD_VAR_NAME(ui_openssl,ui_openssl, s)())
365 const UI_METHOD temp_s_ui_openssl =
367 "OpenSSL default user interface",
370 NULL, /* No flusher is needed for command lines */
377 /* The method with all the built-in thingies */
378 EXPORT_C UI_METHOD *UI_OpenSSL(void)
383 /* The following function makes sure that info and error strings are printed
384 before any prompt. */
385 static int write_string(UI *ui, UI_STRING *uis)
387 switch (UI_get_string_type(uis))
391 fputs(UI_get0_output_string(uis), tty_out);
400 static int read_string(UI *ui, UI_STRING *uis)
404 switch (UI_get_string_type(uis))
407 fputs(UI_get0_output_string(uis), tty_out);
408 fputs(UI_get0_action_string(uis), tty_out);
410 return read_string_inner(ui, uis,
411 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO, 0);
413 fputs(UI_get0_output_string(uis), tty_out);
415 return read_string_inner(ui, uis,
416 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO, 1);
418 fprintf(tty_out,"Verifying - %s",
419 UI_get0_output_string(uis));
421 if ((ok = read_string_inner(ui, uis,
422 UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO, 1)) <= 0)
424 if (strcmp(UI_get0_result_string(uis),
425 UI_get0_test_string(uis)) != 0)
427 fprintf(tty_out,"Verify failure\n");
439 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
440 /* Internal functions to read a string without echoing */
441 static void read_till_nl(FILE *in)
448 } while (strchr(buf,'\n') == NULL);
451 static volatile sig_atomic_t intr_signal;
454 static int read_string_inner(UI *ui, UI_STRING *uis, int echo, int strip_nl)
459 int maxsize = BUFSIZ-1;
461 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
471 if (!echo && !noecho_console(ui))
476 #ifdef OPENSSL_SYS_MSDOS
479 noecho_fgets(result,maxsize,tty_in);
480 p=result; /* FIXME: noecho_fgets doesn't return errors */
483 p=fgets(result,maxsize,tty_in);
485 p=fgets(result,maxsize,tty_in);
489 if (feof(tty_in)) goto error;
490 if (ferror(tty_in)) goto error;
491 if ((p=(char *)strchr(result,'\n')) != NULL)
497 read_till_nl(tty_in);
498 if (UI_set_result(ui, uis, result) >= 0)
502 if (intr_signal == SIGINT)
504 if (!echo) fprintf(tty_out,"\n");
505 if (ps >= 2 && !echo && !echo_console(ui))
514 OPENSSL_cleanse(result,BUFSIZ);
519 /* Internal functions to open, handle and close a channel to the console. */
520 static int open_console(UI *ui)
522 CRYPTO_w_lock(CRYPTO_LOCK_UI);
525 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(OPENSSL_SYS_VXWORKS) || defined(OPENSSL_SYS_NETWARE)
529 # ifdef OPENSSL_SYS_MSDOS
530 # define DEV_TTY "con"
532 # define DEV_TTY "/dev/tty"
534 if ((tty_in=fopen(DEV_TTY,"r")) == NULL)
536 if ((tty_out=fopen(DEV_TTY,"w")) == NULL)
540 #if defined(TTY_get) && !defined(OPENSSL_SYS_VMS)
541 if (TTY_get(fileno(tty_in),&tty_orig) == -1)
549 /* Ariel Glenn ariel@columbia.edu reports that solaris
550 * can return EINVAL instead. This should be ok */
558 #ifdef OPENSSL_SYS_VMS
559 status = sys$assign(&terminal,&channel,0,0);
560 if (status != SS$_NORMAL)
562 status=sys$qiow(0,channel,IO$_SENSEMODE,&iosb,0,0,tty_orig,12,0,0,0,0);
563 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL))
569 static int noecho_console(UI *ui)
572 memcpy(&(tty_new),&(tty_orig),sizeof(tty_orig));
573 tty_new.TTY_FLAGS &= ~ECHO;
576 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
577 if (is_a_tty && (TTY_set(fileno(tty_in),&tty_new) == -1))
580 #ifdef OPENSSL_SYS_VMS
581 tty_new[0] = tty_orig[0];
582 tty_new[1] = tty_orig[1] | TT$M_NOECHO;
583 tty_new[2] = tty_orig[2];
584 status = sys$qiow(0,channel,IO$_SETMODE,&iosb,0,0,tty_new,12,0,0,0,0);
585 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL))
591 static int echo_console(UI *ui)
593 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
594 memcpy(&(tty_new),&(tty_orig),sizeof(tty_orig));
595 tty_new.TTY_FLAGS |= ECHO;
598 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
599 if (is_a_tty && (TTY_set(fileno(tty_in),&tty_new) == -1))
602 #ifdef OPENSSL_SYS_VMS
603 tty_new[0] = tty_orig[0];
604 tty_new[1] = tty_orig[1] & ~TT$M_NOECHO;
605 tty_new[2] = tty_orig[2];
606 status = sys$qiow(0,channel,IO$_SETMODE,&iosb,0,0,tty_new,12,0,0,0,0);
607 if ((status != SS$_NORMAL) || (iosb.iosb$w_value != SS$_NORMAL))
613 static int close_console(UI *ui)
615 if (tty_in != stdin) fclose(tty_in);
616 if (tty_out != stderr) fclose(tty_out);
617 #ifdef OPENSSL_SYS_VMS
618 status = sys$dassgn(channel);
620 CRYPTO_w_unlock(CRYPTO_LOCK_UI);
627 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
628 /* Internal functions to handle signals and act on them */
629 static void pushsig(void)
631 #ifndef OPENSSL_SYS_WIN32
637 memset(&sa,0,sizeof sa);
638 sa.sa_handler=recsig;
641 #ifdef OPENSSL_SYS_WIN32
642 savsig[SIGABRT]=signal(SIGABRT,recsig);
643 savsig[SIGFPE]=signal(SIGFPE,recsig);
644 savsig[SIGILL]=signal(SIGILL,recsig);
645 savsig[SIGINT]=signal(SIGINT,recsig);
646 savsig[SIGSEGV]=signal(SIGSEGV,recsig);
647 savsig[SIGTERM]=signal(SIGTERM,recsig);
649 for (i=1; i<NX509_SIG; i++)
660 if (i == SIGKILL) /* We can't make any action on that. */
664 sigaction(i,&sa,&savsig[i]);
666 savsig[i]=signal(i,recsig);
672 signal(SIGWINCH,SIG_DFL);
676 static void popsig(void)
678 #ifdef OPENSSL_SYS_WIN32
679 signal(SIGABRT,savsig[SIGABRT]);
680 signal(SIGFPE,savsig[SIGFPE]);
681 signal(SIGILL,savsig[SIGILL]);
682 signal(SIGINT,savsig[SIGINT]);
683 signal(SIGSEGV,savsig[SIGSEGV]);
684 signal(SIGTERM,savsig[SIGTERM]);
687 for (i=1; i<NX509_SIG; i++)
698 sigaction(i,&savsig[i],NULL);
706 static void recsig(int i)
713 /* Internal functions specific for Windows */
714 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
715 static int noecho_fgets(char *buf, int size, FILE *tty)
734 if (i == '\r') i='\n';
743 #ifdef WIN_CONSOLE_BUG
744 /* Win95 has several evil console bugs: one of these is that the
745 * last character read using getch() is passed to the next read: this is
746 * usually a CR so this can be trouble. No STDIO fix seems to work but
747 * flushing the console appears to do the trick.
751 inh = GetStdHandle(STD_INPUT_HANDLE);
752 FlushConsoleInputBuffer(inh);