Implement STARTTLS for certain protocols, currently only supporting SMTP.
[openssl.git] / apps / s_client.c
index c9b52e6a99ce651738f1c3a4eb9843fa0aa0e71a..15a63cc9e6a8029daa9048a817fa8fe48afe7b08 100644 (file)
  * copied and put under another distribution licence
  * [including the GNU Public Licence.]
  */
+/* ====================================================================
+ * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
+ *
+ * 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 above 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 acknowledgment:
+ *    "This product includes software developed by the OpenSSL Project
+ *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
+ *
+ * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+ *    endorse or promote products derived from this software without
+ *    prior written permission. For written permission, please contact
+ *    openssl-core@openssl.org.
+ *
+ * 5. Products derived from this software may not be called "OpenSSL"
+ *    nor may "OpenSSL" appear in their names without prior written
+ *    permission of the OpenSSL Project.
+ *
+ * 6. Redistributions of any form whatsoever must retain the following
+ *    acknowledgment:
+ *    "This product includes software developed by the OpenSSL Project
+ *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+ * EXPRESSED 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 OpenSSL PROJECT OR
+ * ITS 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.
+ * ====================================================================
+ *
+ * This product includes cryptographic software written by Eric Young
+ * (eay@cryptsoft.com).  This product includes software written by Tim
+ * Hudson (tjh@cryptsoft.com).
+ *
+ */
 
 #include <assert.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
-#ifdef NO_STDIO
+#include <openssl/e_os2.h>
+#ifdef OPENSSL_NO_STDIO
 #define APPS_WIN16
 #endif
 
    recursive header file inclusion, resulting in the compiler complaining
    that u_int isn't defined, but only if _POSIX_C_SOURCE is defined, which
    is needed to have fileno() declared correctly...  So let's define u_int */
-#if defined(VMS) && defined(__DECC) && !defined(__U_INT)
+#if defined(OPENSSL_SYS_VMS_DECC) && !defined(__U_INT)
 #define __U_INT
 typedef unsigned int u_int;
 #endif
@@ -79,14 +133,15 @@ typedef unsigned int u_int;
 #include <openssl/ssl.h>
 #include <openssl/err.h>
 #include <openssl/pem.h>
+#include <openssl/rand.h>
 #include "s_apps.h"
 
-#ifdef WINDOWS
+#ifdef OPENSSL_SYS_WINDOWS
 #include <conio.h>
 #endif
 
 
-#if (defined(VMS) && __VMS_VER < 70000000)
+#if (defined(OPENSSL_SYS_VMS) && __VMS_VER < 70000000)
 /* FIONBIO used as a switch to enable ioctl, and that isn't in VMS < 7.0 */
 #undef FIONBIO
 #endif
@@ -111,12 +166,14 @@ static int c_nbio=0;
 #endif
 static int c_Pause=0;
 static int c_debug=0;
+static int c_msg=0;
 static int c_showcerts=0;
 
 static void sc_usage(void);
 static void print_stuff(BIO *berr,SSL *con,int full);
 static BIO *bio_c_out=NULL;
 static int c_quiet=0;
+static int c_ign_eof=0;
 
 static void sc_usage(void)
        {
@@ -136,6 +193,7 @@ static void sc_usage(void)
        BIO_printf(bio_err," -pause        - sleep(1) after each read(2) and write(2) system call\n");
        BIO_printf(bio_err," -showcerts    - show all certificates in the chain\n");
        BIO_printf(bio_err," -debug        - extra output\n");
+       BIO_printf(bio_err," -msg          - Show protocol messages\n");
        BIO_printf(bio_err," -nbio_test    - more ssl protocol testing\n");
        BIO_printf(bio_err," -state        - print the 'ssl' states\n");
 #ifdef FIONBIO
@@ -143,22 +201,33 @@ static void sc_usage(void)
 #endif
        BIO_printf(bio_err," -crlf         - convert LF from terminal into CRLF\n");
        BIO_printf(bio_err," -quiet        - no s_client output\n");
+       BIO_printf(bio_err," -ign_eof      - ignore input eof (default when -quiet)\n");
        BIO_printf(bio_err," -ssl2         - just use SSLv2\n");
        BIO_printf(bio_err," -ssl3         - just use SSLv3\n");
        BIO_printf(bio_err," -tls1         - just use TLSv1\n");
        BIO_printf(bio_err," -no_tls1/-no_ssl3/-no_ssl2 - turn off that protocol\n");
        BIO_printf(bio_err," -bugs         - Switch on all SSL implementation bug workarounds\n");
-       BIO_printf(bio_err," -cipher       - prefered cipher to use, use the 'openssl ciphers'\n");
+       BIO_printf(bio_err," -serverpref   - Use server's cipher preferences (only SSLv2)\n");
+       BIO_printf(bio_err," -cipher       - preferred cipher to use, use the 'openssl ciphers'\n");
        BIO_printf(bio_err,"                 command to see what is available\n");
+       BIO_printf(bio_err," -starttls prot - use the STARTTLS command before starting TLS\n");
+       BIO_printf(bio_err,"                 for those protocols that support it, where\n");
+       BIO_printf(bio_err,"                 'prot' defines which one to assume.  Currently,\n");
+       BIO_printf(bio_err,"                 only \"smtp\" is supported.\n");
+       BIO_printf(bio_err," -engine id    - Initialise and use the specified engine\n");
+       BIO_printf(bio_err," -rand file%cfile%c...\n", LIST_SEPARATOR_CHAR, LIST_SEPARATOR_CHAR);
 
        }
 
+int MAIN(int, char **);
+
 int MAIN(int argc, char **argv)
        {
        int off=0;
        SSL *con=NULL,*con2=NULL;
+       X509_STORE *store = NULL;
        int s,k,width,state=0;
-       char *cbuf=NULL,*sbuf=NULL;
+       char *cbuf=NULL,*sbuf=NULL,*mbuf=NULL;
        int cbuf_len,cbuf_off;
        int sbuf_len,sbuf_off;
        fd_set readfds,writefds;
@@ -172,32 +241,39 @@ int MAIN(int argc, char **argv)
        int write_tty,read_tty,write_ssl,read_ssl,tty_on,ssl_pending;
        SSL_CTX *ctx=NULL;
        int ret=1,in_init=1,i,nbio_test=0;
-       int prexit = 0;
+       int smtp_starttls = 0;
+       int prexit = 0, vflags = 0;
        SSL_METHOD *meth=NULL;
        BIO *sbio;
-#ifdef WINDOWS
+       char *inrand=NULL;
+       char *engine_id=NULL;
+       ENGINE *e=NULL;
+#ifdef OPENSSL_SYS_WINDOWS
        struct timeval tv;
 #endif
 
-#if !defined(NO_SSL2) && !defined(NO_SSL3)
+#if !defined(OPENSSL_NO_SSL2) && !defined(OPENSSL_NO_SSL3)
        meth=SSLv23_client_method();
-#elif !defined(NO_SSL3)
+#elif !defined(OPENSSL_NO_SSL3)
        meth=SSLv3_client_method();
-#elif !defined(NO_SSL2)
+#elif !defined(OPENSSL_NO_SSL2)
        meth=SSLv2_client_method();
 #endif
 
        apps_startup();
        c_Pause=0;
        c_quiet=0;
+       c_ign_eof=0;
        c_debug=0;
+       c_msg=0;
        c_showcerts=0;
 
        if (bio_err == NULL)
                bio_err=BIO_new_fp(stderr,BIO_NOCLOSE);
 
-       if (    ((cbuf=Malloc(BUFSIZZ)) == NULL) ||
-               ((sbuf=Malloc(BUFSIZZ)) == NULL))
+       if (    ((cbuf=OPENSSL_malloc(BUFSIZZ)) == NULL) ||
+               ((sbuf=OPENSSL_malloc(BUFSIZZ)) == NULL) ||
+               ((mbuf=OPENSSL_malloc(BUFSIZZ)) == NULL))
                {
                BIO_printf(bio_err,"out of memory\n");
                goto end;
@@ -242,31 +318,42 @@ int MAIN(int argc, char **argv)
                        if (--argc < 1) goto bad;
                        cert_file= *(++argv);
                        }
+               else if (strcmp(*argv,"-crl_check") == 0)
+                       vflags |= X509_V_FLAG_CRL_CHECK;
+               else if (strcmp(*argv,"-crl_check_all") == 0)
+                       vflags |= X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL;
                else if (strcmp(*argv,"-prexit") == 0)
                        prexit=1;
                else if (strcmp(*argv,"-crlf") == 0)
                        crlf=1;
                else if (strcmp(*argv,"-quiet") == 0)
+                       {
                        c_quiet=1;
+                       c_ign_eof=1;
+                       }
+               else if (strcmp(*argv,"-ign_eof") == 0)
+                       c_ign_eof=1;
                else if (strcmp(*argv,"-pause") == 0)
                        c_Pause=1;
                else if (strcmp(*argv,"-debug") == 0)
                        c_debug=1;
+               else if (strcmp(*argv,"-msg") == 0)
+                       c_msg=1;
                else if (strcmp(*argv,"-showcerts") == 0)
                        c_showcerts=1;
                else if (strcmp(*argv,"-nbio_test") == 0)
                        nbio_test=1;
                else if (strcmp(*argv,"-state") == 0)
                        state=1;
-#ifndef NO_SSL2
+#ifndef OPENSSL_NO_SSL2
                else if (strcmp(*argv,"-ssl2") == 0)
                        meth=SSLv2_client_method();
 #endif
-#ifndef NO_SSL3
+#ifndef OPENSSL_NO_SSL3
                else if (strcmp(*argv,"-ssl3") == 0)
                        meth=SSLv3_client_method();
 #endif
-#ifndef NO_TLS1
+#ifndef OPENSSL_NO_TLS1
                else if (strcmp(*argv,"-tls1") == 0)
                        meth=TLSv1_client_method();
 #endif
@@ -297,6 +384,8 @@ int MAIN(int argc, char **argv)
                        off|=SSL_OP_NO_SSLv3;
                else if (strcmp(*argv,"-no_ssl2") == 0)
                        off|=SSL_OP_NO_SSLv2;
+               else if (strcmp(*argv,"-serverpref") == 0)
+                       off|=SSL_OP_CIPHER_SERVER_PREFERENCE;
                else if (strcmp(*argv,"-cipher") == 0)
                        {
                        if (--argc < 1) goto bad;
@@ -306,6 +395,25 @@ int MAIN(int argc, char **argv)
                else if (strcmp(*argv,"-nbio") == 0)
                        { c_nbio=1; }
 #endif
+               else if (strcmp(*argv,"-starttls") == 0)
+                       {
+                       if (--argc < 1) goto bad;
+                       ++argv;
+                       if (strcmp(*argv,"smtp") == 0)
+                               smtp_starttls = 1;
+                       else
+                               goto bad;
+                       }
+               else if (strcmp(*argv,"-engine") == 0)
+                       {
+                       if (--argc < 1) goto bad;
+                       engine_id = *(++argv);
+                       }
+               else if (strcmp(*argv,"-rand") == 0)
+                       {
+                       if (--argc < 1) goto bad;
+                       inrand= *(++argv);
+                       }
                else
                        {
                        BIO_printf(bio_err,"unknown option %s\n",*argv);
@@ -322,11 +430,18 @@ bad:
                goto end;
                }
 
-       app_RAND_load_file(NULL, bio_err, 0);
+       if (!app_RAND_load_file(NULL, bio_err, 1) && inrand == NULL
+               && !RAND_status())
+               {
+               BIO_printf(bio_err,"warning, not much extra random data, consider using the -rand option\n");
+               }
+       if (inrand != NULL)
+               BIO_printf(bio_err,"%ld semi-random bytes loaded\n",
+                       app_RAND_load_files(inrand));
 
        if (bio_c_out == NULL)
                {
-               if (c_quiet)
+               if (c_quiet && !c_debug && !c_msg)
                        {
                        bio_c_out=BIO_new(BIO_s_null());
                        }
@@ -337,8 +452,11 @@ bad:
                        }
                }
 
-       SSLeay_add_ssl_algorithms();
+       OpenSSL_add_ssl_algorithms();
        SSL_load_error_strings();
+
+        e = setup_engine(bio_err, engine_id, 1);
+
        ctx=SSL_CTX_new(meth);
        if (ctx == NULL)
                {
@@ -354,7 +472,7 @@ bad:
        if (state) SSL_CTX_set_info_callback(ctx,apps_ssl_info_callback);
        if (cipher != NULL)
                if(!SSL_CTX_set_cipher_list(ctx,cipher)) {
-               BIO_printf(bio_err,"error seting cipher list\n");
+               BIO_printf(bio_err,"error setting cipher list\n");
                ERR_print_errors(bio_err);
                goto end;
        }
@@ -370,13 +488,21 @@ bad:
        if ((!SSL_CTX_load_verify_locations(ctx,CAfile,CApath)) ||
                (!SSL_CTX_set_default_verify_paths(ctx)))
                {
-               /* BIO_printf(bio_err,"error seting default verify locations\n"); */
+               /* BIO_printf(bio_err,"error setting default verify locations\n"); */
                ERR_print_errors(bio_err);
                /* goto end; */
                }
 
+       store = SSL_CTX_get_cert_store(ctx);
+       X509_STORE_set_flags(store, vflags);
 
-       con=(SSL *)SSL_new(ctx);
+       con=SSL_new(ctx);
+#ifndef OPENSSL_NO_KRB5
+       if (con  &&  (con->kssl_ctx = kssl_ctx_new()) != NULL)
+                {
+                kssl_ctx_setstring(con->kssl_ctx, KSSL_SERVER, host);
+               }
+#endif /* OPENSSL_NO_KRB5  */
 /*     SSL_set_cipher_list(con,"RC4-MD5"); */
 
 re_start:
@@ -418,6 +544,11 @@ re_start:
                BIO_set_callback(sbio,bio_dump_cb);
                BIO_set_callback_arg(sbio,bio_c_out);
                }
+       if (c_msg)
+               {
+               SSL_set_msg_callback(con, msg_cb);
+               SSL_set_msg_callback_arg(con, bio_c_out);
+               }
 
        SSL_set_bio(con,sbio,sbio);
        SSL_set_connect_state(con);
@@ -436,6 +567,14 @@ re_start:
        sbuf_len=0;
        sbuf_off=0;
 
+       /* This is an ugly hack that does a lot of assumptions */
+       if (smtp_starttls)
+               {
+               BIO_read(sbio,mbuf,BUFSIZZ);
+               BIO_printf(sbio,"STARTTLS\r\n");
+               BIO_read(sbio,sbuf,BUFSIZZ);
+               }
+
        for (;;)
                {
                FD_ZERO(&readfds);
@@ -455,6 +594,13 @@ re_start:
                                print_stuff(bio_c_out,con,full_log);
                                if (full_log > 0) full_log--;
 
+                               if (smtp_starttls)
+                                       {
+                                       BIO_printf(bio_err,"%s",mbuf);
+                                       /* We don't need to know any more */
+                                       smtp_starttls = 0;
+                                       }
+
                                if (reconnect)
                                        {
                                        reconnect--;
@@ -471,7 +617,7 @@ re_start:
 
                if (!ssl_pending)
                        {
-#ifndef WINDOWS
+#ifndef OPENSSL_SYS_WINDOWS
                        if (tty_on)
                                {
                                if (read_tty)  FD_SET(fileno(stdin),&readfds);
@@ -498,7 +644,7 @@ re_start:
                         * will choke the compiler: if you do have a cast then
                         * you can either go for (int *) or (void *).
                         */
-#ifdef WINDOWS
+#ifdef OPENSSL_SYS_WINDOWS
                        /* Under Windows we make the assumption that we can
                         * always write to the tty: therefore if we need to
                         * write to the tty we just fall through. Otherwise
@@ -506,13 +652,14 @@ re_start:
                         * are any keypresses. Note: this is a hack, in a proper
                         * Windows application we wouldn't do this.
                         */
+                       i=0;
                        if(!write_tty) {
                                if(read_tty) {
                                        tv.tv_sec = 1;
                                        tv.tv_usec = 0;
                                        i=select(width,(void *)&readfds,(void *)&writefds,
                                                 NULL,&tv);
-                                       if(!i && (!_kbhit() || !read_tty) ) continue;
+                                       if(!i && (!((_kbhit()) || (WAIT_OBJECT_0 == WaitForSingleObject(GetStdHandle(STD_INPUT_HANDLE), 0))) || !read_tty) ) continue;
                                } else  i=select(width,(void *)&readfds,(void *)&writefds,
                                         NULL,NULL);
                        }
@@ -596,7 +743,7 @@ re_start:
                                goto shut;
                                }
                        }
-#ifdef WINDOWS
+#ifdef OPENSSL_SYS_WINDOWS
                /* Assume Windows can always write */
                else if (!ssl_pending && write_tty)
 #else
@@ -677,8 +824,8 @@ printf("read=%d pending=%d peek=%d\n",k,SSL_pending(con),SSL_peek(con,zbuf,10240
                                }
                        }
 
-#ifdef WINDOWS
-               else if (_kbhit())
+#ifdef OPENSSL_SYS_WINDOWS
+               else if ((_kbhit()) || (WAIT_OBJECT_0 == WaitForSingleObject(GetStdHandle(STD_INPUT_HANDLE), 0)))
 #else
                else if (FD_ISSET(fileno(stdin),&readfds))
 #endif
@@ -708,13 +855,13 @@ printf("read=%d pending=%d peek=%d\n",k,SSL_pending(con),SSL_peek(con,zbuf,10240
                        else
                                i=read(fileno(stdin),cbuf,BUFSIZZ);
 
-                       if ((!c_quiet) && ((i <= 0) || (cbuf[0] == 'Q')))
+                       if ((!c_ign_eof) && ((i <= 0) || (cbuf[0] == 'Q')))
                                {
                                BIO_printf(bio_err,"DONE\n");
                                goto shut;
                                }
 
-                       if ((!c_quiet) && (cbuf[0] == 'R'))
+                       if ((!c_ign_eof) && (cbuf[0] == 'R'))
                                {
                                BIO_printf(bio_err,"RENEGOTIATING\n");
                                SSL_renegotiate(con);
@@ -742,13 +889,15 @@ end:
        if (con != NULL) SSL_free(con);
        if (con2 != NULL) SSL_free(con2);
        if (ctx != NULL) SSL_CTX_free(ctx);
-       if (cbuf != NULL) { memset(cbuf,0,BUFSIZZ); Free(cbuf); }
-       if (sbuf != NULL) { memset(sbuf,0,BUFSIZZ); Free(sbuf); }
+       if (cbuf != NULL) { memset(cbuf,0,BUFSIZZ); OPENSSL_free(cbuf); }
+       if (sbuf != NULL) { memset(sbuf,0,BUFSIZZ); OPENSSL_free(sbuf); }
+       if (mbuf != NULL) { memset(mbuf,0,BUFSIZZ); OPENSSL_free(mbuf); }
        if (bio_c_out != NULL)
                {
                BIO_free(bio_c_out);
                bio_c_out=NULL;
                }
+       apps_shutdown();
        EXIT(ret);
        }
 
@@ -870,5 +1019,7 @@ static void print_stuff(BIO *bio, SSL *s, int full)
        BIO_printf(bio,"---\n");
        if (peer != NULL)
                X509_free(peer);
+       /* flush, or debugging output gets mixed with http response */
+       BIO_flush(bio);
        }