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 #if defined(OPENSSL_SYSNAME_VXWORKS)
126 #include <sys/types.h>
129 #if !defined(_POSIX_C_SOURCE) && defined(OPENSSL_SYS_VMS)
130 #ifndef _POSIX_C_SOURCE
131 #define _POSIX_C_SOURCE 2
139 #if !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS)
140 # ifdef OPENSSL_UNISTD
141 # include OPENSSL_UNISTD
145 /* If unistd.h defines _POSIX_VERSION, we conclude that we
146 * are on a POSIX system and have sigaction and termios. */
147 # if defined(_POSIX_VERSION)
150 # if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
158 # undef OPENSSL_SYS_WIN16
164 /* 06-Apr-92 Luke Brennan Support for VMS */
166 #include "cryptlib.h"
168 #ifdef OPENSSL_SYS_VMS /* prototypes for sys$whatever */
169 # include <starlet.h>
171 # pragma message disable DOLLARID
175 #ifdef WIN_CONSOLE_BUG
176 # include <windows.h>
177 #ifndef OPENSSL_SYS_WINCE
183 /* There are 5 types of terminal interface supported,
184 * TERMIO, TERMIOS, VMS, MSDOS and SGTTY
187 #if defined(__sgi) && !defined(TERMIOS)
193 #if defined(linux) && !defined(TERMIO)
205 #if !defined(TERMIO) && !defined(TERMIOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && !defined(MAC_OS_GUSI_SOURCE)
211 #if defined(OPENSSL_SYS_VXWORKS)
217 #if defined(OPENSSL_SYS_NETWARE)
224 # include <termios.h>
225 # define TTY_STRUCT struct termios
226 # define TTY_FLAGS c_lflag
227 # define TTY_get(tty,data) tcgetattr(tty,data)
228 # define TTY_set(tty,data) tcsetattr(tty,TCSANOW,data)
233 # define TTY_STRUCT struct termio
234 # define TTY_FLAGS c_lflag
235 # define TTY_get(tty,data) ioctl(tty,TCGETA,data)
236 # define TTY_set(tty,data) ioctl(tty,TCSETA,data)
241 # define TTY_STRUCT struct sgttyb
242 # define TTY_FLAGS sg_flags
243 # define TTY_get(tty,data) ioctl(tty,TIOCGETP,data)
244 # define TTY_set(tty,data) ioctl(tty,TIOCSETP,data)
247 #if !defined(_LIBC) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && !defined(OPENSSL_SYS_SUNOS)
248 # include <sys/ioctl.h>
251 #ifdef OPENSSL_SYS_MSDOS
255 #ifdef OPENSSL_SYS_VMS
259 # include <descrip.h>
267 #ifdef OPENSSL_SYS_SUNOS
268 typedef int sig_atomic_t;
271 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(MAC_OS_GUSI_SOURCE) || defined(OPENSSL_SYS_NETWARE)
273 * This one needs work. As a matter of fact the code is unoperational
274 * and this is only a trick to get it compiled.
275 * <appro@fy.chalmers.se>
277 # define TTY_STRUCT int
281 # define NX509_SIG 32
285 /* Define globals. They are protected by a lock */
287 static struct sigaction savsig
[NX509_SIG
];
289 static void (*savsig
[NX509_SIG
])(int );
292 #ifdef OPENSSL_SYS_VMS
293 static struct IOSB iosb
;
294 static $
DESCRIPTOR(terminal
,"TT");
295 static long tty_orig
[3], tty_new
[3]; /* XXX Is there any guarantee that this will always suffice for the actual structures? */
297 static unsigned short channel
= 0;
299 #if !defined(OPENSSL_SYS_MSDOS) || defined(__DJGPP__)
300 static TTY_STRUCT tty_orig
,tty_new
;
303 static FILE *tty_in
, *tty_out
;
306 /* Declare static functions */
307 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
308 static int read_till_nl(FILE *);
309 static void recsig(int);
310 static void pushsig(void);
311 static void popsig(void);
313 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16)
314 static int noecho_fgets(char *buf
, int size
, FILE *tty
);
316 static int read_string_inner(UI
*ui
, UI_STRING
*uis
, int echo
, int strip_nl
);
318 static int read_string(UI
*ui
, UI_STRING
*uis
);
319 static int write_string(UI
*ui
, UI_STRING
*uis
);
321 static int open_console(UI
*ui
);
322 static int echo_console(UI
*ui
);
323 static int noecho_console(UI
*ui
);
324 static int close_console(UI
*ui
);
326 static UI_METHOD ui_openssl
=
328 "OpenSSL default user interface",
331 NULL
, /* No flusher is needed for command lines */
337 /* The method with all the built-in thingies */
338 UI_METHOD
*UI_OpenSSL(void)
343 /* The following function makes sure that info and error strings are printed
344 before any prompt. */
345 static int write_string(UI
*ui
, UI_STRING
*uis
)
347 switch (UI_get_string_type(uis
))
351 fputs(UI_get0_output_string(uis
), tty_out
);
360 static int read_string(UI
*ui
, UI_STRING
*uis
)
364 switch (UI_get_string_type(uis
))
367 fputs(UI_get0_output_string(uis
), tty_out
);
368 fputs(UI_get0_action_string(uis
), tty_out
);
370 return read_string_inner(ui
, uis
,
371 UI_get_input_flags(uis
) & UI_INPUT_FLAG_ECHO
, 0);
373 fputs(UI_get0_output_string(uis
), tty_out
);
375 return read_string_inner(ui
, uis
,
376 UI_get_input_flags(uis
) & UI_INPUT_FLAG_ECHO
, 1);
378 fprintf(tty_out
,"Verifying - %s",
379 UI_get0_output_string(uis
));
381 if ((ok
= read_string_inner(ui
, uis
,
382 UI_get_input_flags(uis
) & UI_INPUT_FLAG_ECHO
, 1)) <= 0)
384 if (strcmp(UI_get0_result_string(uis
),
385 UI_get0_test_string(uis
)) != 0)
387 fprintf(tty_out
,"Verify failure\n");
399 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
400 /* Internal functions to read a string without echoing */
401 static int read_till_nl(FILE *in
)
407 if (!fgets(buf
,SIZE
,in
))
409 } while (strchr(buf
,'\n') == NULL
);
413 static volatile sig_atomic_t intr_signal
;
416 static int read_string_inner(UI
*ui
, UI_STRING
*uis
, int echo
, int strip_nl
)
421 int maxsize
= BUFSIZ
-1;
422 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
432 if (!echo
&& !noecho_console(ui
))
437 #ifdef OPENSSL_SYS_MSDOS
440 noecho_fgets(result
,maxsize
,tty_in
);
441 p
=result
; /* FIXME: noecho_fgets doesn't return errors */
444 p
=fgets(result
,maxsize
,tty_in
);
446 p
=fgets(result
,maxsize
,tty_in
);
450 if (feof(tty_in
)) goto error
;
451 if (ferror(tty_in
)) goto error
;
452 if ((p
=(char *)strchr(result
,'\n')) != NULL
)
458 if (!read_till_nl(tty_in
))
460 if (UI_set_result(ui
, uis
, result
) >= 0)
464 if (intr_signal
== SIGINT
)
466 if (!echo
) fprintf(tty_out
,"\n");
467 if (ps
>= 2 && !echo
&& !echo_console(ui
))
476 OPENSSL_cleanse(result
,BUFSIZ
);
481 /* Internal functions to open, handle and close a channel to the console. */
482 static int open_console(UI
*ui
)
484 CRYPTO_w_lock(CRYPTO_LOCK_UI
);
487 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(OPENSSL_SYS_VXWORKS) || defined(OPENSSL_SYS_NETWARE) || defined(OPENSSL_SYS_BEOS)
491 # ifdef OPENSSL_SYS_MSDOS
492 # define DEV_TTY "con"
494 # define DEV_TTY "/dev/tty"
496 if ((tty_in
=fopen(DEV_TTY
,"r")) == NULL
)
498 if ((tty_out
=fopen(DEV_TTY
,"w")) == NULL
)
502 #if defined(TTY_get) && !defined(OPENSSL_SYS_VMS)
503 if (TTY_get(fileno(tty_in
),&tty_orig
) == -1)
511 /* Ariel Glenn ariel@columbia.edu reports that solaris
512 * can return EINVAL instead. This should be ok */
520 #ifdef OPENSSL_SYS_VMS
521 status
= sys$
assign(&terminal
,&channel
,0,0);
522 if (status
!= SS$_NORMAL
)
524 status
=sys$
qiow(0,channel
,IO$_SENSEMODE
,&iosb
,0,0,tty_orig
,12,0,0,0,0);
525 if ((status
!= SS$_NORMAL
) || (iosb
.iosb$w_value
!= SS$_NORMAL
))
531 static int noecho_console(UI
*ui
)
534 memcpy(&(tty_new
),&(tty_orig
),sizeof(tty_orig
));
535 tty_new
.TTY_FLAGS
&= ~ECHO
;
538 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
539 if (is_a_tty
&& (TTY_set(fileno(tty_in
),&tty_new
) == -1))
542 #ifdef OPENSSL_SYS_VMS
543 tty_new
[0] = tty_orig
[0];
544 tty_new
[1] = tty_orig
[1] | TT$M_NOECHO
;
545 tty_new
[2] = tty_orig
[2];
546 status
= sys$
qiow(0,channel
,IO$_SETMODE
,&iosb
,0,0,tty_new
,12,0,0,0,0);
547 if ((status
!= SS$_NORMAL
) || (iosb
.iosb$w_value
!= SS$_NORMAL
))
553 static int echo_console(UI
*ui
)
555 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
556 memcpy(&(tty_new
),&(tty_orig
),sizeof(tty_orig
));
557 tty_new
.TTY_FLAGS
|= ECHO
;
560 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
561 if (is_a_tty
&& (TTY_set(fileno(tty_in
),&tty_new
) == -1))
564 #ifdef OPENSSL_SYS_VMS
565 tty_new
[0] = tty_orig
[0];
566 tty_new
[1] = tty_orig
[1] & ~TT$M_NOECHO
;
567 tty_new
[2] = tty_orig
[2];
568 status
= sys$
qiow(0,channel
,IO$_SETMODE
,&iosb
,0,0,tty_new
,12,0,0,0,0);
569 if ((status
!= SS$_NORMAL
) || (iosb
.iosb$w_value
!= SS$_NORMAL
))
575 static int close_console(UI
*ui
)
577 if (tty_in
!= stdin
) fclose(tty_in
);
578 if (tty_out
!= stderr
) fclose(tty_out
);
579 #ifdef OPENSSL_SYS_VMS
580 status
= sys$
dassgn(channel
);
582 CRYPTO_w_unlock(CRYPTO_LOCK_UI
);
588 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
589 /* Internal functions to handle signals and act on them */
590 static void pushsig(void)
592 #ifndef OPENSSL_SYS_WIN32
598 memset(&sa
,0,sizeof sa
);
599 sa
.sa_handler
=recsig
;
602 #ifdef OPENSSL_SYS_WIN32
603 savsig
[SIGABRT
]=signal(SIGABRT
,recsig
);
604 savsig
[SIGFPE
]=signal(SIGFPE
,recsig
);
605 savsig
[SIGILL
]=signal(SIGILL
,recsig
);
606 savsig
[SIGINT
]=signal(SIGINT
,recsig
);
607 savsig
[SIGSEGV
]=signal(SIGSEGV
,recsig
);
608 savsig
[SIGTERM
]=signal(SIGTERM
,recsig
);
610 for (i
=1; i
<NX509_SIG
; i
++)
621 if (i
== SIGKILL
) /* We can't make any action on that. */
625 sigaction(i
,&sa
,&savsig
[i
]);
627 savsig
[i
]=signal(i
,recsig
);
633 signal(SIGWINCH
,SIG_DFL
);
637 static void popsig(void)
639 #ifdef OPENSSL_SYS_WIN32
640 signal(SIGABRT
,savsig
[SIGABRT
]);
641 signal(SIGFPE
,savsig
[SIGFPE
]);
642 signal(SIGILL
,savsig
[SIGILL
]);
643 signal(SIGINT
,savsig
[SIGINT
]);
644 signal(SIGSEGV
,savsig
[SIGSEGV
]);
645 signal(SIGTERM
,savsig
[SIGTERM
]);
648 for (i
=1; i
<NX509_SIG
; i
++)
659 sigaction(i
,&savsig
[i
],NULL
);
667 static void recsig(int i
)
673 /* Internal functions specific for Windows */
674 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
675 static int noecho_fgets(char *buf
, int size
, FILE *tty
)
691 #elif defined(_WIN32)
696 if (i
== '\r') i
='\n';
704 #ifdef WIN_CONSOLE_BUG
705 /* Win95 has several evil console bugs: one of these is that the
706 * last character read using getch() is passed to the next read: this is
707 * usually a CR so this can be trouble. No STDIO fix seems to work but
708 * flushing the console appears to do the trick.
712 inh
= GetStdHandle(STD_INPUT_HANDLE
);
713 FlushConsoleInputBuffer(inh
);