Enhance the user interface with better support for dialog box
[openssl.git] / crypto / ui / ui_openssl.c
index 821b1d5..7c988aa 100644 (file)
@@ -1,6 +1,6 @@
 /* crypto/ui/ui_openssl.c -*- mode:C; c-file-style: "eay" -*- */
-/* Written by Richard Levitte (levitte@stacken.kth.se) for the OpenSSL
- * project 2000.
+/* Written by Richard Levitte (levitte@stacken.kth.se) and others
+ * for the OpenSSL project 2000/2001.
  */
 /* ====================================================================
  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
  *
  */
 
-#if !defined(MSDOS) && !defined(VMS) && !defined(WIN32)
-#include <openssl/opensslconf.h>
-#ifdef OPENSSL_UNISTD
-# include OPENSSL_UNISTD
-#else
-# include <unistd.h>
-#endif
+/* The lowest level part of this file was previously in crypto/des/read_pwd.c,
+ * Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
+ * All rights reserved.
+ *
+ * This package is an SSL implementation written
+ * by Eric Young (eay@cryptsoft.com).
+ * The implementation was written so as to conform with Netscapes SSL.
+ * 
+ * This library is free for commercial and non-commercial use as long as
+ * the following conditions are aheared to.  The following conditions
+ * apply to all code found in this distribution, be it the RC4, RSA,
+ * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
+ * included with this distribution is covered by the same copyright terms
+ * except that the holder is Tim Hudson (tjh@cryptsoft.com).
+ * 
+ * Copyright remains Eric Young's, and as such any Copyright notices in
+ * the code are not to be removed.
+ * If this package is used in a product, Eric Young should be given attribution
+ * as the author of the parts of the library used.
+ * This can be in the form of a textual message at program startup or
+ * in documentation (online or textual) provided with the package.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *    "This product includes cryptographic software written by
+ *     Eric Young (eay@cryptsoft.com)"
+ *    The word 'cryptographic' can be left out if the rouines from the library
+ *    being used are not cryptographic related :-).
+ * 4. If you include any Windows specific code (or a derivative thereof) from 
+ *    the apps directory (application code) you must include an acknowledgement:
+ *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
+ * 
+ * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * 
+ * The licence and distribution terms for any publically available version or
+ * derivative of this code cannot be changed.  i.e. this code cannot simply be
+ * copied and put under another distribution licence
+ * [including the GNU Public Licence.]
+ */
+
+
+#include <openssl/e_os2.h>
+
+#if !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS)
+# ifdef OPENSSL_UNISTD
+#  include OPENSSL_UNISTD
+# else
+#  include <unistd.h>
+# endif
 /* If unistd.h defines _POSIX_VERSION, we conclude that we
  * are on a POSIX system and have sigaction and termios. */
-#if defined(_POSIX_VERSION)
+# if defined(_POSIX_VERSION)
 
-# define SIGACTION
-# if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
-# define TERMIOS
-# endif
+#  define SIGACTION
+#  if !defined(TERMIOS) && !defined(TERMIO) && !defined(SGTTY)
+#   define TERMIOS
+#  endif
 
-#endif
+# endif
 #endif
 
-/* #define SIGACTION */ /* Define this if you have sigaction() */
-
 #ifdef WIN16TTY
-#undef WIN16
-#undef _WINDOWS
-#include <graph.h>
+# undef OPENSSL_SYS_WIN16
+# undef WIN16
+# undef _WINDOWS
+# include <graph.h>
 #endif
 
 /* 06-Apr-92 Luke Brennan    Support for VMS */
 #include <setjmp.h>
 #include <errno.h>
 
-#ifdef VMS                     /* prototypes for sys$whatever */
-#include <starlet.h>
-#ifdef __DECC
-#pragma message disable DOLLARID
-#endif
+#ifdef OPENSSL_SYS_VMS         /* prototypes for sys$whatever */
+# include <starlet.h>
+# ifdef __DECC
+#  pragma message disable DOLLARID
+# endif
 #endif
 
 #ifdef WIN_CONSOLE_BUG
-#include <windows.h>
-#include <wincon.h>
+# include <windows.h>
+# include <wincon.h>
 #endif
 
 
  */
 
 #if defined(__sgi) && !defined(TERMIOS)
-#define TERMIOS
-#undef  TERMIO
-#undef  SGTTY
+# define TERMIOS
+# undef  TERMIO
+# undef  SGTTY
 #endif
 
 #if defined(linux) && !defined(TERMIO)
-#undef  TERMIOS
-#define TERMIO
-#undef  SGTTY
+# undef  TERMIOS
+# define TERMIO
+# undef  SGTTY
 #endif
 
 #ifdef _LIBC
-#undef  TERMIOS
-#define TERMIO
-#undef  SGTTY
+# undef  TERMIOS
+# define TERMIO
+# undef  SGTTY
 #endif
 
-#if !defined(TERMIO) && !defined(TERMIOS) && !defined(VMS) && !defined(MSDOS) && !defined(MAC_OS_pre_X) && !defined(MAC_OS_GUSI_SOURCE)
-#undef  TERMIOS
-#undef  TERMIO
-#define SGTTY
+#if !defined(TERMIO) && !defined(TERMIOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && !defined(MAC_OS_GUSI_SOURCE)
+# undef  TERMIOS
+# undef  TERMIO
+# define SGTTY
 #endif
 
 #ifdef TERMIOS
-#include <termios.h>
-#define TTY_STRUCT             struct termios
-#define TTY_FLAGS              c_lflag
-#define        TTY_get(tty,data)       tcgetattr(tty,data)
-#define TTY_set(tty,data)      tcsetattr(tty,TCSANOW,data)
+# include <termios.h>
+# define TTY_STRUCT            struct termios
+# define TTY_FLAGS             c_lflag
+# define TTY_get(tty,data)     tcgetattr(tty,data)
+# define TTY_set(tty,data)     tcsetattr(tty,TCSANOW,data)
 #endif
 
 #ifdef TERMIO
-#include <termio.h>
-#define TTY_STRUCT             struct termio
-#define TTY_FLAGS              c_lflag
-#define TTY_get(tty,data)      ioctl(tty,TCGETA,data)
-#define TTY_set(tty,data)      ioctl(tty,TCSETA,data)
+# include <termio.h>
+# define TTY_STRUCT            struct termio
+# define TTY_FLAGS             c_lflag
+# define TTY_get(tty,data)     ioctl(tty,TCGETA,data)
+# define TTY_set(tty,data)     ioctl(tty,TCSETA,data)
 #endif
 
 #ifdef SGTTY
-#include <sgtty.h>
-#define TTY_STRUCT             struct sgttyb
-#define TTY_FLAGS              sg_flags
-#define TTY_get(tty,data)      ioctl(tty,TIOCGETP,data)
-#define TTY_set(tty,data)      ioctl(tty,TIOCSETP,data)
+# include <sgtty.h>
+# define TTY_STRUCT            struct sgttyb
+# define TTY_FLAGS             sg_flags
+# define TTY_get(tty,data)     ioctl(tty,TIOCGETP,data)
+# define TTY_set(tty,data)     ioctl(tty,TIOCSETP,data)
 #endif
 
-#if !defined(_LIBC) && !defined(MSDOS) && !defined(VMS) && !defined(MAC_OS_pre_X)
-#include <sys/ioctl.h>
+#if !defined(_LIBC) && !defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_VMS) && !defined(OPENSSL_SYS_MACINTOSH_CLASSIC)
+# include <sys/ioctl.h>
 #endif
 
-#ifdef MSDOS
-#include <conio.h>
-#define fgets(a,b,c) noecho_fgets(a,b,c)
+#ifdef OPENSSL_SYS_MSDOS
+# include <conio.h>
 #endif
 
-#ifdef VMS
-#include <ssdef.h>
-#include <iodef.h>
-#include <ttdef.h>
-#include <descrip.h>
+#ifdef OPENSSL_SYS_VMS
+# include <ssdef.h>
+# include <iodef.h>
+# include <ttdef.h>
+# include <descrip.h>
 struct IOSB {
        short iosb$w_value;
        short iosb$w_count;
@@ -178,17 +236,17 @@ struct IOSB {
        };
 #endif
 
-#if defined(MAC_OS_pre_X) || defined(MAC_OS_GUSI_SOURCE)
+#if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) || defined(MAC_OS_GUSI_SOURCE)
 /*
  * This one needs work. As a matter of fact the code is unoperational
  * and this is only a trick to get it compiled.
  *                                     <appro@fy.chalmers.se>
  */
-#define TTY_STRUCT int
+# define TTY_STRUCT int
 #endif
 
 #ifndef NX509_SIG
-#define NX509_SIG 32
+# define NX509_SIG 32
 #endif
 
 
@@ -200,18 +258,18 @@ static void (*savsig[NX509_SIG])(int );
 #endif
 static jmp_buf save;
 
-#ifdef VMS
+#ifdef OPENSSL_SYS_VMS
 static struct IOSB iosb;
 static $DESCRIPTOR(terminal,"TT");
-static long tty_orig[3], tty_new[3];
+static long tty_orig[3], tty_new[3]; /* XXX   Is there any guarantee that this will always suffice for the actual structures? */
 static long status;
 static unsigned short channel = 0;
 #else
-#ifndef MSDOS
+#ifndef OPENSSL_SYS_MSDOS
 static TTY_STRUCT tty_orig,tty_new;
 #endif
 #endif
-static FILE *tty;
+static FILE *tty_in, *tty_out;
 static int is_a_tty;
 
 /* Declare static functions */
@@ -219,12 +277,13 @@ static void read_till_nl(FILE *);
 static void recsig(int);
 static void pushsig(void);
 static void popsig(void);
-#if defined(MSDOS) && !defined(WIN16)
+#if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16)
 static int noecho_fgets(char *buf, int size, FILE *tty);
 #endif
 static int read_string_inner(UI *ui, UI_STRING *uis, int echo);
 
 static int read_string(UI *ui, UI_STRING *uis);
+static int write_string(UI *ui, UI_STRING *uis);
 
 static int open_console(UI *ui);
 static int echo_console(UI *ui);
@@ -235,9 +294,11 @@ static UI_METHOD ui_openssl =
        {
        "OpenSSL default user interface",
        open_console,
+       write_string,
+       NULL,                   /* No flusher is needed for command lines */
        read_string,
-       NULL,                   /* The reader function writes as well */
        close_console,
+       NULL
        };
 
 /* The method with all the built-in thingies */
@@ -246,49 +307,50 @@ UI_METHOD *UI_OpenSSL(void)
        return &ui_openssl;
        }
 
-static int read_string(UI *ui, UI_STRING *uis)
+/* The following function makes sure that info and error strings are printed
+   before any prompt. */
+static int write_string(UI *ui, UI_STRING *uis)
        {
        switch (UI_get_string_type(uis))
                {
-       case UI_VERIFY_NOECHO:
-               fprintf(tty,"Verifying - %s",
-                       UI_get0_output_string(uis));
-               fflush(tty);
-               if (read_string_inner(ui, uis, 0) == 0)
-                       return 0;
-               if (strcmp(UI_get0_result_string(uis),
-                       UI_get0_test_string(uis)) != 0)
-                       {
-                       fprintf(tty,"Verify failure\n");
-                       fflush(tty);
-                       return 0;
-                       }
+       case UIT_VERIFY:
+       case UIT_PROMPT:
                break;
-       case UI_VERIFY_ECHO:
-               fprintf(tty,"Verifying - %s",
+       default:
+               fputs(UI_get0_output_string(uis), tty_out);
+               fflush(tty_out);
+               break;
+               }
+       return 1;
+       }
+
+static int read_string(UI *ui, UI_STRING *uis)
+       {
+       int ok = 0;
+
+       switch (UI_get_string_type(uis))
+               {
+       case UIT_PROMPT:
+               fputs(UI_get0_output_string(uis), tty_out);
+               fflush(tty_out);
+               return read_string_inner(ui, uis,
+                       UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO);
+       case UIT_VERIFY:
+               fprintf(tty_out,"Verifying - %s",
                        UI_get0_output_string(uis));
-               fflush(tty);
-               if (read_string_inner(ui, uis, 1) == 0)
-                       return 0;
+               fflush(tty_out);
+               if ((ok = read_string_inner(ui, uis,
+                       UI_get_input_flags(uis) & UI_INPUT_FLAG_ECHO)) <= 0)
+                       return ok;
                if (strcmp(UI_get0_result_string(uis),
                        UI_get0_test_string(uis)) != 0)
                        {
-                       fprintf(tty,"Verify failure\n");
-                       fflush(tty);
+                       fprintf(tty_out,"Verify failure\n");
+                       fflush(tty_out);
                        return 0;
                        }
                break;
-       case UI_STRING_NOECHO:
-               fputs(UI_get0_output_string(uis), tty);
-               fflush(tty);
-               return read_string_inner(ui, uis, 0);
-       case UI_STRING_ECHO:
-               fputs(UI_get0_output_string(uis), tty);
-               fflush(tty);
-               return read_string_inner(ui, uis, 1);
        default:
-               fputs(UI_get0_output_string(uis), tty);
-               fflush(tty);
                break;
                }
        return 1;
@@ -313,10 +375,10 @@ static int read_string_inner(UI *ui, UI_STRING *uis, int echo)
        char *result = OPENSSL_malloc(BUFSIZ);
        int maxsize = BUFSIZ-1;
 
-#ifndef WIN16
-       if (setjmp(save))
+#ifndef OPENSSL_SYS_WIN16
+       if ((ok = setjmp(save)))
                {
-               ok=0;
+               if (ok == 1) ok=0;
                goto error;
                }
        ok=0;
@@ -333,18 +395,26 @@ static int read_string_inner(UI *ui, UI_STRING *uis, int echo)
                char *p;
 
                result[0]='\0';
-               fgets(result,maxsize,tty);
-               if (feof(tty)) goto error;
-               if (ferror(tty)) goto error;
+#ifdef OPENSSL_SYS_MSDOS
+               if (!echo)
+                       noecho_fgets(result,maxsize,tty_in);
+               else
+                       fgets(result,maxsize,tty_in);
+#else
+               fgets(result,maxsize,tty_in);
+#endif
+               if (feof(tty_in)) goto error;
+               if (ferror(tty_in)) goto error;
                if ((p=(char *)strchr(result,'\n')) != NULL)
                        *p='\0';
-               else    read_till_nl(tty);
+               else
+                       read_till_nl(tty_in);
                if (UI_set_result(uis, result) >= 0)
                        ok=1;
                }
 
 error:
-       if (!echo) fprintf(tty,"\n");
+       if (!echo) fprintf(tty_out,"\n");
        if (ps >= 2 && !echo)
                echo_console(ui);
 
@@ -366,18 +436,23 @@ static int open_console(UI *ui)
        CRYPTO_w_lock(CRYPTO_LOCK_UI);
        is_a_tty = 1;
 
-#ifdef MSDOS
-       if ((tty=fopen("con","w+")) == NULL)
-               tty=stdin;
-#elif defined(MAC_OS_pre_X)
-       tty=stdin;
+#if defined(OPENSSL_SYS_MACINTOSH_CLASSIC)
+       tty_in=stdin;
+       tty_out=stderr;
 #else
-       if ((tty=fopen("/dev/tty","w+")) == NULL)
-               tty=stdin;
+#  ifdef OPENSSL_SYS_MSDOS
+#    define DEV_TTY "con"
+#  else
+#    define DEV_TTY "/dev/tty"
+#  endif
+       if ((tty_in=fopen(DEV_TTY,"r")) == NULL)
+               tty_in=stdin;
+       if ((tty_out=fopen(DEV_TTY,"w")) == NULL)
+               tty_out=stderr;
 #endif
 
 #if defined(TTY_get) && !defined(VMS)
-       if (TTY_get(fileno(tty),&tty_orig) == -1)
+       if (TTY_get(fileno(tty_in),&tty_orig) == -1)
                {
 #ifdef ENOTTY
                if (errno == ENOTTY)
@@ -394,7 +469,7 @@ static int open_console(UI *ui)
                        return 0;
                }
 #endif
-#ifdef VMS
+#ifdef OPENSSL_SYS_VMS
        status = sys$assign(&terminal,&channel,0,0);
        if (status != SS$_NORMAL)
                return 0;
@@ -412,11 +487,11 @@ static int noecho_console(UI *ui)
        tty_new.TTY_FLAGS &= ~ECHO;
 #endif
 
-#if defined(TTY_set) && !defined(VMS)
-       if (is_a_tty && (TTY_set(fileno(tty),&tty_new) == -1))
+#if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
+       if (is_a_tty && (TTY_set(fileno(tty_in),&tty_new) == -1))
                return 0;
 #endif
-#ifdef VMS
+#ifdef OPENSSL_SYS_VMS
        tty_new[0] = tty_orig[0];
        tty_new[1] = tty_orig[1] | TT$M_NOECHO;
        tty_new[2] = tty_orig[2];
@@ -429,16 +504,16 @@ static int noecho_console(UI *ui)
 
 static int echo_console(UI *ui)
        {
-#if defined(TTY_set) && !defined(VMS)
+#if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
        memcpy(&(tty_new),&(tty_orig),sizeof(tty_orig));
        tty_new.TTY_FLAGS |= ECHO;
 #endif
 
-#if defined(TTY_set) && !defined(VMS)
-       if (is_a_tty && (TTY_set(fileno(tty),&tty_new) == -1))
+#if defined(TTY_set) && !defined(OPENSSL_SYS_VMS)
+       if (is_a_tty && (TTY_set(fileno(tty_in),&tty_new) == -1))
                return 0;
 #endif
-#ifdef VMS
+#ifdef OPENSSL_SYS_VMS
        tty_new[0] = tty_orig[0];
        tty_new[1] = tty_orig[1] & ~TT$M_NOECHO;
        tty_new[2] = tty_orig[2];
@@ -451,8 +526,9 @@ static int echo_console(UI *ui)
 
 static int close_console(UI *ui)
        {
-       if (stdin != tty) fclose(tty);
-#ifdef VMS
+       if (tty_in != stderr) fclose(tty_in);
+       if (tty_out != stderr) fclose(tty_out);
+#ifdef OPENSSL_SYS_VMS
        status = sys$dassgn(channel);
 #endif
        CRYPTO_w_unlock(CRYPTO_LOCK_UI);
@@ -522,15 +598,20 @@ static void popsig(void)
 
 static void recsig(int i)
        {
+       switch(i)
+               {
+       case SIGINT:
+               longjmp(save,-1);
+               break;
+       default:
+               break;
+               }
        longjmp(save,1);
-#ifdef LINT
-       i=i;
-#endif
        }
 
 
 /* Internal functions specific for Windows */
-#if defined(MSDOS) && !defined(WIN16)
+#if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN16)
 static int noecho_fgets(char *buf, int size, FILE *tty)
        {
        int i;