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 #if !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS)
121 # ifdef OPENSSL_UNISTD
122 # include OPENSSL_UNISTD
126 /* If unistd.h defines _POSIX_VERSION, we conclude that we
127 * are on a POSIX system and have sigaction and termios. */
128 # if defined(_POSIX_VERSION)
131 # if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
139 # undef OPENSSL_SYS_WIN16
145 /* 06-Apr-92 Luke Brennan Support for VMS */
147 #include "cryptlib.h"
153 #ifdef OPENSSL_SYS_VMS /* prototypes for sys$whatever */
154 # include <starlet.h>
156 # pragma message disable DOLLARID
160 #ifdef WIN_CONSOLE_BUG
161 # include <windows.h>
162 #ifndef OPENSSL_SYS_WINCE
168 /* There are 5 types of terminal interface supported,
169 * TERMIO, TERMIOS, VMS, MSDOS and SGTTY
172 #if defined(__sgi) && !defined(TERMIOS)
178 #if defined(linux) && !defined(TERMIO)
190 #if !defined(TERMIO) && !defined(TERMIOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && !defined(MAC_OS_GUSI_SOURCE)
196 #if defined(OPENSSL_SYS_VXWORKS)
203 # include <termios.h>
204 # define TTY_STRUCT struct termios
205 # define TTY_FLAGS c_lflag
206 # define TTY_get(tty,data) tcgetattr(tty,data)
207 # define TTY_set(tty,data) tcsetattr(tty,TCSANOW,data)
212 # define TTY_STRUCT struct termio
213 # define TTY_FLAGS c_lflag
214 # define TTY_get(tty,data) ioctl(tty,TCGETA,data)
215 # define TTY_set(tty,data) ioctl(tty,TCSETA,data)
220 # define TTY_STRUCT struct sgttyb
221 # define TTY_FLAGS sg_flags
222 # define TTY_get(tty,data) ioctl(tty,TIOCGETP,data)
223 # define TTY_set(tty,data) ioctl(tty,TIOCSETP,data)
226 #if !defined(_LIBC) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && !defined(OPENSSL_SYS_SUNOS)
227 # include <sys/ioctl.h>
230 #ifdef OPENSSL_SYS_MSDOS
234 #ifdef OPENSSL_SYS_VMS
238 # include <descrip.h>
246 #ifdef OPENSSL_SYS_SUNOS
247 typedef int sig_atomic_t;
250 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(MAC_OS_GUSI_SOURCE)
252 * This one needs work. As a matter of fact the code is unoperational
253 * and this is only a trick to get it compiled.
254 * <appro@fy.chalmers.se>
256 # define TTY_STRUCT int
260 # define NX509_SIG 32
264 /* Define globals. They are protected by a lock */
266 static struct sigaction savsig
[NX509_SIG
];
268 static void (*savsig
[NX509_SIG
])(int );
271 #ifdef OPENSSL_SYS_VMS
272 static struct IOSB iosb
;
273 static $
DESCRIPTOR(terminal
,"TT");
274 static long tty_orig
[3], tty_new
[3]; /* XXX Is there any guarantee that this will always suffice for the actual structures? */
276 static unsigned short channel
= 0;
278 #if !defined(OPENSSL_SYS_MSDOS) || defined(__DJGPP__)
279 static TTY_STRUCT tty_orig
,tty_new
;
282 static FILE *tty_in
, *tty_out
;
285 /* Declare static functions */
286 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
287 static void read_till_nl(FILE *);
288 static void recsig(int);
289 static void pushsig(void);
290 static void popsig(void);
292 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16)
293 static int noecho_fgets(char *buf
, int size
, FILE *tty
);
295 static int read_string_inner(UI
*ui
, UI_STRING
*uis
, int echo
, int strip_nl
);
297 static int read_string(UI
*ui
, UI_STRING
*uis
);
298 static int write_string(UI
*ui
, UI_STRING
*uis
);
300 static int open_console(UI
*ui
);
301 static int echo_console(UI
*ui
);
302 static int noecho_console(UI
*ui
);
303 static int close_console(UI
*ui
);
305 static UI_METHOD ui_openssl
=
307 "OpenSSL default user interface",
310 NULL
, /* No flusher is needed for command lines */
316 /* The method with all the built-in thingies */
317 UI_METHOD
*UI_OpenSSL(void)
322 /* The following function makes sure that info and error strings are printed
323 before any prompt. */
324 static int write_string(UI
*ui
, UI_STRING
*uis
)
326 switch (UI_get_string_type(uis
))
330 fputs(UI_get0_output_string(uis
), tty_out
);
339 static int read_string(UI
*ui
, UI_STRING
*uis
)
343 switch (UI_get_string_type(uis
))
346 fputs(UI_get0_output_string(uis
), tty_out
);
347 fputs(UI_get0_action_string(uis
), tty_out
);
349 return read_string_inner(ui
, uis
,
350 UI_get_input_flags(uis
) & UI_INPUT_FLAG_ECHO
, 0);
352 fputs(UI_get0_output_string(uis
), tty_out
);
354 return read_string_inner(ui
, uis
,
355 UI_get_input_flags(uis
) & UI_INPUT_FLAG_ECHO
, 1);
357 fprintf(tty_out
,"Verifying - %s",
358 UI_get0_output_string(uis
));
360 if ((ok
= read_string_inner(ui
, uis
,
361 UI_get_input_flags(uis
) & UI_INPUT_FLAG_ECHO
, 1)) <= 0)
363 if (strcmp(UI_get0_result_string(uis
),
364 UI_get0_test_string(uis
)) != 0)
366 fprintf(tty_out
,"Verify failure\n");
378 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
379 /* Internal functions to read a string without echoing */
380 static void read_till_nl(FILE *in
)
387 } while (strchr(buf
,'\n') == NULL
);
390 static volatile sig_atomic_t intr_signal
;
393 static int read_string_inner(UI
*ui
, UI_STRING
*uis
, int echo
, int strip_nl
)
398 int maxsize
= BUFSIZ
-1;
399 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
409 if (!echo
&& !noecho_console(ui
))
414 #ifdef OPENSSL_SYS_MSDOS
417 noecho_fgets(result
,maxsize
,tty_in
);
418 p
=result
; /* FIXME: noecho_fgets doesn't return errors */
421 p
=fgets(result
,maxsize
,tty_in
);
423 p
=fgets(result
,maxsize
,tty_in
);
427 if (feof(tty_in
)) goto error
;
428 if (ferror(tty_in
)) goto error
;
429 if ((p
=(char *)strchr(result
,'\n')) != NULL
)
435 read_till_nl(tty_in
);
436 if (UI_set_result(ui
, uis
, result
) >= 0)
440 if (intr_signal
== SIGINT
)
442 if (!echo
) fprintf(tty_out
,"\n");
443 if (ps
>= 2 && !echo
&& !echo_console(ui
))
452 OPENSSL_cleanse(result
,BUFSIZ
);
457 /* Internal functions to open, handle and close a channel to the console. */
458 static int open_console(UI
*ui
)
460 CRYPTO_w_lock(CRYPTO_LOCK_UI
);
463 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(OPENSSL_SYS_VXWORKS)
467 # ifdef OPENSSL_SYS_MSDOS
468 # define DEV_TTY "con"
470 # define DEV_TTY "/dev/tty"
472 if ((tty_in
=fopen(DEV_TTY
,"r")) == NULL
)
474 if ((tty_out
=fopen(DEV_TTY
,"w")) == NULL
)
478 #if defined(TTY_get) && !defined(OPENSSL_SYS_VMS)
479 if (TTY_get(fileno(tty_in
),&tty_orig
) == -1)
487 /* Ariel Glenn ariel@columbia.edu reports that solaris
488 * can return EINVAL instead. This should be ok */
496 #ifdef OPENSSL_SYS_VMS
497 status
= sys$
assign(&terminal
,&channel
,0,0);
498 if (status
!= SS$_NORMAL
)
500 status
=sys$
qiow(0,channel
,IO$_SENSEMODE
,&iosb
,0,0,tty_orig
,12,0,0,0,0);
501 if ((status
!= SS$_NORMAL
) || (iosb
.iosb$w_value
!= SS$_NORMAL
))
507 static int noecho_console(UI
*ui
)
510 memcpy(&(tty_new
),&(tty_orig
),sizeof(tty_orig
));
511 tty_new
.TTY_FLAGS
&= ~ECHO
;
514 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
515 if (is_a_tty
&& (TTY_set(fileno(tty_in
),&tty_new
) == -1))
518 #ifdef OPENSSL_SYS_VMS
519 tty_new
[0] = tty_orig
[0];
520 tty_new
[1] = tty_orig
[1] | TT$M_NOECHO
;
521 tty_new
[2] = tty_orig
[2];
522 status
= sys$
qiow(0,channel
,IO$_SETMODE
,&iosb
,0,0,tty_new
,12,0,0,0,0);
523 if ((status
!= SS$_NORMAL
) || (iosb
.iosb$w_value
!= SS$_NORMAL
))
529 static int echo_console(UI
*ui
)
531 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
532 memcpy(&(tty_new
),&(tty_orig
),sizeof(tty_orig
));
533 tty_new
.TTY_FLAGS
|= ECHO
;
536 #if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
537 if (is_a_tty
&& (TTY_set(fileno(tty_in
),&tty_new
) == -1))
540 #ifdef OPENSSL_SYS_VMS
541 tty_new
[0] = tty_orig
[0];
542 tty_new
[1] = tty_orig
[1] & ~TT$M_NOECHO
;
543 tty_new
[2] = tty_orig
[2];
544 status
= sys$
qiow(0,channel
,IO$_SETMODE
,&iosb
,0,0,tty_new
,12,0,0,0,0);
545 if ((status
!= SS$_NORMAL
) || (iosb
.iosb$w_value
!= SS$_NORMAL
))
551 static int close_console(UI
*ui
)
553 if (tty_in
!= stdin
) fclose(tty_in
);
554 if (tty_out
!= stderr
) fclose(tty_out
);
555 #ifdef OPENSSL_SYS_VMS
556 status
= sys$
dassgn(channel
);
558 CRYPTO_w_unlock(CRYPTO_LOCK_UI
);
564 #if !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
565 /* Internal functions to handle signals and act on them */
566 static void pushsig(void)
572 memset(&sa
,0,sizeof sa
);
573 sa
.sa_handler
=recsig
;
576 for (i
=1; i
<NX509_SIG
; i
++)
587 if (i
== SIGKILL
) /* We can't make any action on that. */
591 sigaction(i
,&sa
,&savsig
[i
]);
593 savsig
[i
]=signal(i
,recsig
);
598 signal(SIGWINCH
,SIG_DFL
);
602 static void popsig(void)
606 for (i
=1; i
<NX509_SIG
; i
++)
617 sigaction(i
,&savsig
[i
],NULL
);
624 static void recsig(int i
)
630 /* Internal functions specific for Windows */
631 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16) && !defined(OPENSSL_SYS_WINCE)
632 static int noecho_fgets(char *buf
, int size
, FILE *tty
)
651 if (i
== '\r') i
='\n';
659 #ifdef WIN_CONSOLE_BUG
660 /* Win95 has several evil console bugs: one of these is that the
661 * last character read using getch() is passed to the next read: this is
662 * usually a CR so this can be trouble. No STDIO fix seems to work but
663 * flushing the console appears to do the trick.
667 inh
= GetStdHandle(STD_INPUT_HANDLE
);
668 FlushConsoleInputBuffer(inh
);