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.]
118 #include <openssl/e_os2.h>
120 /* need for #define _POSIX_C_SOURCE arises whenever you pass -ansi to gcc
121 * [maybe others?], because it masks interfaces not discussed in standard,
122 * sigaction and fileno included. -pedantic would be more appropriate for
123 * the intended purposes, but we can't prevent users from adding -ansi.
125 #define _POSIX_C_SOURCE 1
131 #if !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS)
132 # ifdef OPENSSL_UNISTD
133 # include OPENSSL_UNISTD
137 /* If unistd.h defines _POSIX_VERSION, we conclude that we
138 * are on a POSIX system and have sigaction and termios. */
139 # if defined(_POSIX_VERSION)
142 # if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
150 # undef OPENSSL_SYS_WIN16
156 /* 06-Apr-92 Luke Brennan Support for VMS */
158 #include "cryptlib.h"
160 #ifdef OPENSSL_SYS_VMS /* prototypes for sys$whatever */
161 # include <starlet.h>
163 # pragma message disable DOLLARID
167 #ifdef WIN_CONSOLE_BUG
168 # include <windows.h>
169 #ifndef OPENSSL_SYS_WINCE
175 /* There are 5 types of terminal interface supported,
176 * TERMIO, TERMIOS, VMS, MSDOS and SGTTY
179 #if defined(__sgi) && !defined(TERMIOS)
185 #if defined(linux) && !defined(TERMIO)
197 #if !defined(TERMIO) && !defined(TERMIOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && !defined(MAC_OS_GUSI_SOURCE)
203 #if defined(OPENSSL_SYS_VXWORKS)
209 #if defined(OPENSSL_SYS_NETWARE)
216 # include <termios.h>
217 # define TTY_STRUCT struct termios
218 # define TTY_FLAGS c_lflag
219 # define TTY_get(tty,data) tcgetattr(tty,data)
220 # define TTY_set(tty,data) tcsetattr(tty,TCSANOW,data)
225 # define TTY_STRUCT struct termio
226 # define TTY_FLAGS c_lflag
227 # define TTY_get(tty,data) ioctl(tty,TCGETA,data)
228 # define TTY_set(tty,data) ioctl(tty,TCSETA,data)
233 # define TTY_STRUCT struct sgttyb
234 # define TTY_FLAGS sg_flags
235 # define TTY_get(tty,data) ioctl(tty,TIOCGETP,data)
236 # define TTY_set(tty,data) ioctl(tty,TIOCSETP,data)
239 #if !defined(_LIBC) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && !defined(OPENSSL_SYS_SUNOS)
240 # include <sys/ioctl.h>
243 #ifdef OPENSSL_SYS_MSDOS
247 #ifdef OPENSSL_SYS_VMS
251 # include <descrip.h>
259 #ifdef OPENSSL_SYS_SUNOS
260 typedef int sig_atomic_t;
263 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(MAC_OS_GUSI_SOURCE) || defined(OPENSSL_SYS_NETWARE)
265 * This one needs work. As a matter of fact the code is unoperational
266 * and this is only a trick to get it compiled.
267 * <appro@fy.chalmers.se>
269 # define TTY_STRUCT int
273 # define NX509_SIG 32
277 /* Define globals. They are protected by a lock */
279 static struct sigaction savsig
[NX509_SIG
];
281 static void (*savsig
[NX509_SIG
])(int );
284 #ifdef OPENSSL_SYS_VMS
285 static struct IOSB iosb
;
286 static $
DESCRIPTOR(terminal
,"TT");
287 static long tty_orig
[3], tty_new
[3]; /* XXX Is there any guarantee that this will always suffice for the actual structures? */
289 static unsigned short channel
= 0;
291 #if !defined(OPENSSL_SYS_MSDOS) || defined(__DJGPP__)
292 static TTY_STRUCT tty_orig
,tty_new
;
295 static FILE *tty_in
, *tty_out
;
298 /* Declare static functions */
299 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
300 static void read_till_nl(FILE *);
301 static void recsig(int);
302 static void pushsig(void);
303 static void popsig(void);
305 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16)
306 static int noecho_fgets(char *buf
, int size
, FILE *tty
);
308 static int read_string_inner(UI
*ui
, UI_STRING
*uis
, int echo
, int strip_nl
);
310 static int read_string(UI
*ui
, UI_STRING
*uis
);
311 static int write_string(UI
*ui
, UI_STRING
*uis
);
313 static int open_console(UI
*ui
);
314 static int echo_console(UI
*ui
);
315 static int noecho_console(UI
*ui
);
316 static int close_console(UI
*ui
);
318 static UI_METHOD ui_openssl
=
320 "OpenSSL default user interface",
323 NULL
, /* No flusher is needed for command lines */
329 /* The method with all the built-in thingies */
330 UI_METHOD
*UI_OpenSSL(void)
335 /* The following function makes sure that info and error strings are printed
336 before any prompt. */
337 static int write_string(UI
*ui
, UI_STRING
*uis
)
339 switch (UI_get_string_type(uis
))
343 fputs(UI_get0_output_string(uis
), tty_out
);
352 static int read_string(UI
*ui
, UI_STRING
*uis
)
356 switch (UI_get_string_type(uis
))
359 fputs(UI_get0_output_string(uis
), tty_out
);
360 fputs(UI_get0_action_string(uis
), tty_out
);
362 return read_string_inner(ui
, uis
,
363 UI_get_input_flags(uis
) & UI_INPUT_FLAG_ECHO
, 0);
365 fputs(UI_get0_output_string(uis
), tty_out
);
367 return read_string_inner(ui
, uis
,
368 UI_get_input_flags(uis
) & UI_INPUT_FLAG_ECHO
, 1);
370 fprintf(tty_out
,"Verifying - %s",
371 UI_get0_output_string(uis
));
373 if ((ok
= read_string_inner(ui
, uis
,
374 UI_get_input_flags(uis
) & UI_INPUT_FLAG_ECHO
, 1)) <= 0)
376 if (strcmp(UI_get0_result_string(uis
),
377 UI_get0_test_string(uis
)) != 0)
379 fprintf(tty_out
,"Verify failure\n");
391 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
392 /* Internal functions to read a string without echoing */
393 static void read_till_nl(FILE *in
)
400 } while (strchr(buf
,'\n') == NULL
);
403 static volatile sig_atomic_t intr_signal
;
406 static int read_string_inner(UI
*ui
, UI_STRING
*uis
, int echo
, int strip_nl
)
411 int maxsize
= BUFSIZ
-1;
412 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
422 if (!echo
&& !noecho_console(ui
))
427 #ifdef OPENSSL_SYS_MSDOS
430 noecho_fgets(result
,maxsize
,tty_in
);
431 p
=result
; /* FIXME: noecho_fgets doesn't return errors */
434 p
=fgets(result
,maxsize
,tty_in
);
436 p
=fgets(result
,maxsize
,tty_in
);
440 if (feof(tty_in
)) goto error
;
441 if (ferror(tty_in
)) goto error
;
442 if ((p
=(char *)strchr(result
,'\n')) != NULL
)
448 read_till_nl(tty_in
);
449 if (UI_set_result(ui
, uis
, result
) >= 0)
453 if (intr_signal
== SIGINT
)
455 if (!echo
) fprintf(tty_out
,"\n");
456 if (ps
>= 2 && !echo
&& !echo_console(ui
))
465 OPENSSL_cleanse(result
,BUFSIZ
);
470 /* Internal functions to open, handle and close a channel to the console. */
471 static int open_console(UI
*ui
)
473 CRYPTO_w_lock(CRYPTO_LOCK_UI
);
476 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(OPENSSL_SYS_VXWORKS) || defined(OPENSSL_SYS_NETWARE)
480 # ifdef OPENSSL_SYS_MSDOS
481 # define DEV_TTY "con"
483 # define DEV_TTY "/dev/tty"
485 if ((tty_in
=fopen(DEV_TTY
,"r")) == NULL
)
487 if ((tty_out
=fopen(DEV_TTY
,"w")) == NULL
)
491 #if defined(TTY_get) && !defined(OPENSSL_SYS_VMS)
492 if (TTY_get(fileno(tty_in
),&tty_orig
) == -1)
500 /* Ariel Glenn ariel@columbia.edu reports that solaris
501 * can return EINVAL instead. This should be ok */
509 #ifdef OPENSSL_SYS_VMS
510 status
= sys$
assign(&terminal
,&channel
,0,0);
511 if (status
!= SS$_NORMAL
)
513 status
=sys$
qiow(0,channel
,IO$_SENSEMODE
,&iosb
,0,0,tty_orig
,12,0,0,0,0);
514 if ((status
!= SS$_NORMAL
) || (iosb
.iosb$w_value
!= SS$_NORMAL
))
520 static int noecho_console(UI
*ui
)
523 memcpy(&(tty_new
),&(tty_orig
),sizeof(tty_orig
));
524 tty_new
.TTY_FLAGS
&= ~ECHO
;
527 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
528 if (is_a_tty
&& (TTY_set(fileno(tty_in
),&tty_new
) == -1))
531 #ifdef OPENSSL_SYS_VMS
532 tty_new
[0] = tty_orig
[0];
533 tty_new
[1] = tty_orig
[1] | TT$M_NOECHO
;
534 tty_new
[2] = tty_orig
[2];
535 status
= sys$
qiow(0,channel
,IO$_SETMODE
,&iosb
,0,0,tty_new
,12,0,0,0,0);
536 if ((status
!= SS$_NORMAL
) || (iosb
.iosb$w_value
!= SS$_NORMAL
))
542 static int echo_console(UI
*ui
)
544 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
545 memcpy(&(tty_new
),&(tty_orig
),sizeof(tty_orig
));
546 tty_new
.TTY_FLAGS
|= ECHO
;
549 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
550 if (is_a_tty
&& (TTY_set(fileno(tty_in
),&tty_new
) == -1))
553 #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,0,0,0,0);
558 if ((status
!= SS$_NORMAL
) || (iosb
.iosb$w_value
!= SS$_NORMAL
))
564 static int close_console(UI
*ui
)
566 if (tty_in
!= stdin
) fclose(tty_in
);
567 if (tty_out
!= stderr
) fclose(tty_out
);
568 #ifdef OPENSSL_SYS_VMS
569 status
= sys$
dassgn(channel
);
571 CRYPTO_w_unlock(CRYPTO_LOCK_UI
);
577 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
578 /* Internal functions to handle signals and act on them */
579 static void pushsig(void)
581 #ifndef OPENSSL_SYS_WIN32
587 memset(&sa
,0,sizeof sa
);
588 sa
.sa_handler
=recsig
;
591 #ifdef OPENSSL_SYS_WIN32
592 savsig
[SIGABRT
]=signal(SIGABRT
,recsig
);
593 savsig
[SIGFPE
]=signal(SIGFPE
,recsig
);
594 savsig
[SIGILL
]=signal(SIGILL
,recsig
);
595 savsig
[SIGINT
]=signal(SIGINT
,recsig
);
596 savsig
[SIGSEGV
]=signal(SIGSEGV
,recsig
);
597 savsig
[SIGTERM
]=signal(SIGTERM
,recsig
);
599 for (i
=1; i
<NX509_SIG
; i
++)
610 if (i
== SIGKILL
) /* We can't make any action on that. */
614 sigaction(i
,&sa
,&savsig
[i
]);
616 savsig
[i
]=signal(i
,recsig
);
622 signal(SIGWINCH
,SIG_DFL
);
626 static void popsig(void)
628 #ifdef OPENSSL_SYS_WIN32
629 signal(SIGABRT
,savsig
[SIGABRT
]);
630 signal(SIGFPE
,savsig
[SIGFPE
]);
631 signal(SIGILL
,savsig
[SIGILL
]);
632 signal(SIGINT
,savsig
[SIGINT
]);
633 signal(SIGSEGV
,savsig
[SIGSEGV
]);
634 signal(SIGTERM
,savsig
[SIGTERM
]);
637 for (i
=1; i
<NX509_SIG
; i
++)
648 sigaction(i
,&savsig
[i
],NULL
);
656 static void recsig(int i
)
662 /* Internal functions specific for Windows */
663 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
664 static int noecho_fgets(char *buf
, int size
, FILE *tty
)
680 #elif defined(_WIN32)
685 if (i
== '\r') i
='\n';
693 #ifdef WIN_CONSOLE_BUG
694 /* Win95 has several evil console bugs: one of these is that the
695 * last 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
);