removed a bunch of blank comment lines
[citadel.git] / webcit / crypto.c
index d55d8791aa9283202c842ba08b6bec61fa20f8ae..8792a341e0780c3515dcfe201e2ca41f32c8b444 100644 (file)
@@ -1,22 +1,31 @@
 /*
- * $Id$
+ * Copyright (c) 1996-2012 by the citadel.org team
  *
- * Provides HTTPS, when the OpenSSL library is available.
+ * This program is open source software.  You can redistribute it and/or
+ * modify it under the terms of the GNU General Public License, version 3.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  */
 
+#include "sysdep.h"
 #ifdef HAVE_OPENSSL
 
 #include "webcit.h"
 #include "webserver.h"
 
-#define        CTDL_CRYPTO_DIR         "./keys"
-#define CTDL_KEY_PATH          CTDL_CRYPTO_DIR "/citadel.key"
-#define CTDL_CSR_PATH          CTDL_CRYPTO_DIR "/citadel.csr"
-#define CTDL_CER_PATH          CTDL_CRYPTO_DIR "/citadel.cer"
-#define SIGN_DAYS              365
+/* where to find the keys */
+#define        CTDL_CRYPTO_DIR         ctdl_key_dir
+#define CTDL_KEY_PATH          file_crpt_file_key
+#define CTDL_CSR_PATH          file_crpt_file_csr
+#define CTDL_CER_PATH          file_crpt_file_cer
+#define SIGN_DAYS              3650                    /* how long our certificate should live */
 
 SSL_CTX *ssl_ctx;              /* SSL context */
 pthread_mutex_t **SSLCritters; /* Things needing locking */
+char *ssl_cipher_list = DEFAULT_SSL_CIPHER_LIST;
 
 pthread_key_t ThreadSSL;       /* Per-thread SSL context */
 
@@ -25,10 +34,25 @@ static unsigned long id_callback(void)
        return (unsigned long) pthread_self();
 }
 
+void shutdown_ssl(void)
+{
+       ERR_free_strings();
+
+       /* Openssl requires these while shutdown. 
+        * Didn't find a way to get out of this clean.
+        * int i, n = CRYPTO_num_locks();
+        * for (i = 0; i < n; i++)
+        *      free(SSLCritters[i]);
+        * free(SSLCritters);
+        */
+}
 
+/*
+ * initialize ssl engine, load certs and initialize openssl internals
+ */
 void init_ssl(void)
 {
-       SSL_METHOD *ssl_method;
+       const SSL_METHOD *ssl_method;
        RSA *rsa=NULL;
        X509_REQ *req = NULL;
        X509 *cer = NULL;
@@ -37,31 +61,33 @@ void init_ssl(void)
        X509_NAME *name = NULL;
        FILE *fp;
        char buf[SIZ];
+       int rv = 0;
 
-       if (!access("/var/run/egd-pool", F_OK))
+       if (!access("/var/run/egd-pool", F_OK)) {
                RAND_egd("/var/run/egd-pool");
+       }
 
        if (!RAND_status()) {
-               lprintf(3,
-                       "PRNG not adequately seeded, won't do SSL/TLS\n");
+               syslog(3, "PRNG not adequately seeded, won't do SSL/TLS\n");
                return;
        }
-       SSLCritters =
-           malloc(CRYPTO_num_locks() * sizeof(pthread_mutex_t *));
+       SSLCritters = malloc(CRYPTO_num_locks() * sizeof(pthread_mutex_t *));
        if (!SSLCritters) {
-               lprintf(1, "citserver: can't allocate memory!!\n");
+               syslog(1, "citserver: can't allocate memory!!\n");
                /* Nothing's been initialized, just die */
-               exit(1);
+               ShutDownWebcit();
+               exit(WC_EXIT_SSL);
        } else {
                int a;
 
                for (a = 0; a < CRYPTO_num_locks(); a++) {
                        SSLCritters[a] = malloc(sizeof(pthread_mutex_t));
                        if (!SSLCritters[a]) {
-                               lprintf(1,
+                               syslog(1,
                                        "citserver: can't allocate memory!!\n");
-                               /* Nothing's been initialized, just die */
-                               exit(1);
+                               /** Nothing's been initialized, just die */
+                               ShutDownWebcit();
+                               exit(WC_EXIT_SSL);
                        }
                        pthread_mutex_init(SSLCritters[a], NULL);
                }
@@ -74,15 +100,21 @@ void init_ssl(void)
        SSL_load_error_strings();
        ssl_method = SSLv23_server_method();
        if (!(ssl_ctx = SSL_CTX_new(ssl_method))) {
-               lprintf(3, "SSL_CTX_new failed: %s\n",
-                       ERR_reason_error_string(ERR_get_error()));
+               syslog(3, "SSL_CTX_new failed: %s\n", ERR_reason_error_string(ERR_get_error()));
+               return;
+       }
+
+       syslog(9, "Requesting cipher list: %s\n", ssl_cipher_list);
+       if (!(SSL_CTX_set_cipher_list(ssl_ctx, ssl_cipher_list))) {
+               syslog(3, "SSL_CTX_set_cipher_list failed: %s\n", ERR_reason_error_string(ERR_get_error()));
                return;
        }
 
        CRYPTO_set_locking_callback(ssl_lock);
        CRYPTO_set_id_callback(id_callback);
 
-       /* Get our certificates in order.
+       /*
+        * Get our certificates in order. (FIXME: dirify. this is a setup job.)
         * First, create the key/cert directory if it's not there already...
         */
        mkdir(CTDL_CRYPTO_DIR, 0700);
@@ -97,25 +129,28 @@ void init_ssl(void)
         */
        if (!strcasecmp(ctdlhost, "uds")) {
                sprintf(buf, "%s/keys/citadel.key", ctdlport);
-               symlink(buf, CTDL_KEY_PATH);
+               rv = symlink(buf, CTDL_KEY_PATH);
+               if (!rv) syslog(1, "%s\n", strerror(errno));
                sprintf(buf, "%s/keys/citadel.csr", ctdlport);
-               symlink(buf, CTDL_CSR_PATH);
+               rv = symlink(buf, CTDL_CSR_PATH);
+               if (!rv) syslog(1, "%s\n", strerror(errno));
                sprintf(buf, "%s/keys/citadel.cer", ctdlport);
-               symlink(buf, CTDL_CER_PATH);
+               rv = symlink(buf, CTDL_CER_PATH);
+               if (!rv) syslog(1, "%s\n", strerror(errno));
        }
 
        /*
         * If we still don't have a private key, generate one.
         */
        if (access(CTDL_KEY_PATH, R_OK) != 0) {
-               lprintf(5, "Generating RSA key pair.\n");
+               syslog(5, "Generating RSA key pair.\n");
                rsa = RSA_generate_key(1024,    /* modulus size */
                                        65537,  /* exponent */
                                        NULL,   /* no callback */
-                                       NULL);  /* no callback */
+                                       NULL    /* no callback */
+               );
                if (rsa == NULL) {
-                       lprintf(3, "Key generation failed: %s\n",
-                               ERR_reason_error_string(ERR_get_error()));
+                       syslog(3, "Key generation failed: %s\n", ERR_reason_error_string(ERR_get_error()));
                }
                if (rsa != NULL) {
                        fp = fopen(CTDL_KEY_PATH, "w");
@@ -129,21 +164,28 @@ void init_ssl(void)
                                                        NULL,   /* no callbk */
                                                        NULL    /* no callbk */
                                ) != 1) {
-                                       lprintf(3, "Cannot write key: %s\n",
-                                               ERR_reason_error_string(ERR_get_error()));
+                                       syslog(3, "Cannot write key: %s\n",
+                                               ERR_reason_error_string(ERR_get_error()));
                                        unlink(CTDL_KEY_PATH);
                                }
                                fclose(fp);
                        }
+                       else {
+                               syslog(3, "Cannot write key: %s\n", CTDL_KEY_PATH);
+                               ShutDownWebcit();
+                               exit(0);
+                       }
                        RSA_free(rsa);
                }
        }
 
        /*
-        * Generate a CSR if we don't have one.
+        * If there is no certificate file on disk, we will be generating a self-signed certificate
+        * in the next step.  Therefore, if we have neither a CSR nor a certificate, generate
+        * the CSR in this step so that the next step may commence.
         */
-       if (access(CTDL_CSR_PATH, R_OK) != 0) {
-               lprintf(5, "Generating a certificate signing request.\n");
+       if ( (access(CTDL_CER_PATH, R_OK) != 0) && (access(CTDL_CSR_PATH, R_OK) != 0) ) {
+               syslog(5, "Generating a certificate signing request.\n");
 
                /*
                 * Read our key from the file.  No, we don't just keep this
@@ -159,11 +201,11 @@ void init_ssl(void)
 
                if (rsa) {
 
-                       /* Create a public key from the private key */
+                       /** Create a public key from the private key */
                        if (pk=EVP_PKEY_new(), pk != NULL) {
                                EVP_PKEY_assign_RSA(pk, rsa);
                                if (req = X509_REQ_new(), req != NULL) {
-
+                                       const char *env;
                                        /* Set the public key */
                                        X509_REQ_set_pubkey(req, pk);
                                        X509_REQ_set_version(req, 0L);
@@ -173,30 +215,58 @@ void init_ssl(void)
                                        /* Tell it who we are */
 
                                        /*
+                                        * We used to add these fields to the subject, but
+                                        * now we don't.  Someone doing this for real isn't
+                                        * going to use the webcit-generated CSR anyway.
+                                        *
                                        X509_NAME_add_entry_by_txt(name, "C",
                                                MBSTRING_ASC, "US", -1, -1, 0);
-
+                                       *
                                        X509_NAME_add_entry_by_txt(name, "ST",
                                                MBSTRING_ASC, "New York", -1, -1, 0);
-
+                                       *
                                        X509_NAME_add_entry_by_txt(name, "L",
                                                MBSTRING_ASC, "Mount Kisco", -1, -1, 0);
                                        */
 
-                                       X509_NAME_add_entry_by_txt(name, "O",
-                                               MBSTRING_ASC, "FIXME.FIXME.org", -1, -1, 0);
-
-                                       X509_NAME_add_entry_by_txt(name, "OU",
-                                               MBSTRING_ASC, "Citadel server", -1, -1, 0);
-
-                                       X509_NAME_add_entry_by_txt(name, "CN",
-                                               MBSTRING_ASC, "FIXME.FIXME.org", -1, -1, 0);
+                                       env = getenv("O");
+                                       if (env == NULL)
+                                               env = "Organization name",
+
+                                       X509_NAME_add_entry_by_txt(
+                                               name, "O",
+                                               MBSTRING_ASC, 
+                                               (unsigned char*)env, 
+                                               -1, -1, 0
+                                       );
+
+                                       env = getenv("OU");
+                                       if (env == NULL)
+                                               env = "Citadel server";
+
+                                       X509_NAME_add_entry_by_txt(
+                                               name, "OU",
+                                               MBSTRING_ASC, 
+                                               (unsigned char*)env, 
+                                               -1, -1, 0
+                                       );
+
+                                       env = getenv("CN");
+                                       if (env == NULL)
+                                               env = "*";
+
+                                       X509_NAME_add_entry_by_txt(
+                                               name, "CN",
+                                               MBSTRING_ASC, 
+                                               (unsigned char*)env,
+                                               -1, -1, 0
+                                       );
                                
                                        X509_REQ_set_subject_name(req, name);
 
                                        /* Sign the CSR */
                                        if (!X509_REQ_sign(req, pk, EVP_md5())) {
-                                               lprintf(3, "X509_REQ_sign(): error\n");
+                                               syslog(3, "X509_REQ_sign(): error\n");
                                        }
                                        else {
                                                /* Write it to disk. */ 
@@ -206,6 +276,11 @@ void init_ssl(void)
                                                        PEM_write_X509_REQ(fp, req);
                                                        fclose(fp);
                                                }
+                                               else {
+                                                       syslog(3, "Cannot write key: %s\n", CTDL_CSR_PATH);
+                                                       ShutDownWebcit();
+                                                       exit(0);
+                                               }
                                        }
 
                                        X509_REQ_free(req);
@@ -216,7 +291,7 @@ void init_ssl(void)
                }
 
                else {
-                       lprintf(3, "Unable to read private key.\n");
+                       syslog(3, "Unable to read private key.\n");
                }
        }
 
@@ -226,7 +301,7 @@ void init_ssl(void)
         * Generate a self-signed certificate if we don't have one.
         */
        if (access(CTDL_CER_PATH, R_OK) != 0) {
-               lprintf(5, "Generating a self-signed certificate.\n");
+               syslog(5, "Generating a self-signed certificate.\n");
 
                /* Same deal as before: always read the key from disk because
                 * it may or may not have just been generated.
@@ -267,7 +342,7 @@ void init_ssl(void)
                                        
                                        /* Sign the cert */
                                        if (!X509_sign(cer, pk, EVP_md5())) {
-                                               lprintf(3, "X509_sign(): error\n");
+                                               syslog(3, "X509_sign(): error\n");
                                        }
                                        else {
                                                /* Write it to disk. */ 
@@ -277,6 +352,11 @@ void init_ssl(void)
                                                        PEM_write_X509(fp, cer);
                                                        fclose(fp);
                                                }
+                                               else {
+                                                       syslog(3, "Cannot write key: %s\n", CTDL_CER_PATH);
+                                                       ShutDownWebcit();
+                                                       exit(0);
+                                               }
                                        }
                                        X509_free(cer);
                                }
@@ -294,7 +374,7 @@ void init_ssl(void)
        SSL_CTX_use_certificate_chain_file(ssl_ctx, CTDL_CER_PATH);
        SSL_CTX_use_PrivateKey_file(ssl_ctx, CTDL_KEY_PATH, SSL_FILETYPE_PEM);
        if ( !SSL_CTX_check_private_key(ssl_ctx) ) {
-               lprintf(3, "Cannot install certificate: %s\n",
+               syslog(3, "Cannot install certificate: %s\n",
                                ERR_reason_error_string(ERR_get_error()));
        }
        
@@ -302,10 +382,10 @@ void init_ssl(void)
 
 
 /*
- * starttls() starts SSL/TLS encryption for the current session.
+ * starts SSL/TLS encryption for the current session.
  */
 int starttls(int sock) {
-       int retval, bits, alg_bits;
+       int retval, bits, alg_bits;/*r; */
        SSL *newssl;
 
        pthread_setspecific(ThreadSSL, NULL);
@@ -314,13 +394,11 @@ int starttls(int sock) {
                return(1);
        }
        if (!(newssl = SSL_new(ssl_ctx))) {
-               lprintf(3, "SSL_new failed: %s\n",
-                               ERR_reason_error_string(ERR_get_error()));
+               syslog(3, "SSL_new failed: %s\n", ERR_reason_error_string(ERR_get_error()));
                return(2);
        }
        if (!(SSL_set_fd(newssl, sock))) {
-               lprintf(3, "SSL_set_fd failed: %s\n",
-                       ERR_reason_error_string(ERR_get_error()));
+               syslog(3, "SSL_set_fd failed: %s\n", ERR_reason_error_string(ERR_get_error()));
                SSL_free(newssl);
                return(3);
        }
@@ -332,74 +410,114 @@ int starttls(int sock) {
                 * revert to unencrypted communications.
                 */
                long errval;
+               const char *ssl_error_reason = NULL;
+
+               errval = SSL_get_error(newssl, retval);
+               ssl_error_reason = ERR_reason_error_string(ERR_get_error());
+               if (ssl_error_reason == NULL) {
+                       syslog(3, "SSL_accept failed: errval=%ld, retval=%d %s\n", errval, retval, strerror(errval));
+               }
+               else {
+                       syslog(3, "SSL_accept failed: %s\n", ssl_error_reason);
+               }
+               sleeeeeeeeeep(1);
+               retval = SSL_accept(newssl);
+       }
+       if (retval < 1) {
+               long errval;
+               const char *ssl_error_reason = NULL;
 
                errval = SSL_get_error(newssl, retval);
-               lprintf(3, "SSL_accept failed: %s\n",
-                       ERR_reason_error_string(ERR_get_error()));
+               ssl_error_reason = ERR_reason_error_string(ERR_get_error());
+               if (ssl_error_reason == NULL) {
+                       syslog(3, "SSL_accept failed: errval=%ld, retval=%d (%s)\n", errval, retval, strerror(errval));
+               }
+               else {
+                       syslog(3, "SSL_accept failed: %s\n", ssl_error_reason);
+               }
                SSL_free(newssl);
                newssl = NULL;
                return(4);
        }
-       BIO_set_close(newssl->rbio, BIO_NOCLOSE);
-       bits =
-           SSL_CIPHER_get_bits(SSL_get_current_cipher(newssl),
-                               &alg_bits);
-       lprintf(5, "SSL/TLS using %s on %s (%d of %d bits)\n",
+       else {
+               syslog(15, "SSL_accept success\n");
+       }
+       /*r = */BIO_set_close(newssl->rbio, BIO_NOCLOSE);
+       bits = SSL_CIPHER_get_bits(SSL_get_current_cipher(newssl), &alg_bits);
+       syslog(15, "SSL/TLS using %s on %s (%d of %d bits)\n",
                SSL_CIPHER_get_name(SSL_get_current_cipher(newssl)),
                SSL_CIPHER_get_version(SSL_get_current_cipher(newssl)),
                bits, alg_bits);
 
        pthread_setspecific(ThreadSSL, newssl);
+       syslog(15, "SSL started\n");
        return(0);
 }
 
 
 
 /*
- * endtls() shuts down the TLS connection
+ * shuts down the TLS connection
  *
  * WARNING:  This may make your session vulnerable to a known plaintext
  * attack in the current implmentation.
  */
 void endtls(void)
 {
+       /*SSL_CTX *ctx;*/
+
        if (THREADSSL == NULL) return;
 
-       lprintf(5, "Ending SSL/TLS\n");
+       syslog(15, "Ending SSL/TLS\n");
        SSL_shutdown(THREADSSL);
+       /*ctx = */SSL_get_SSL_CTX(THREADSSL);
+
+       /* I don't think this is needed, and it crashes the server anyway
+        *
+        *      if (ctx != NULL) {
+        *              syslog(9, "Freeing CTX at %x\n", (int)ctx );
+        *              SSL_CTX_free(ctx);
+        *      }
+        */
+
        SSL_free(THREADSSL);
        pthread_setspecific(ThreadSSL, NULL);
 }
 
 
 /*
- * ssl_lock() callback for OpenSSL mutex locks
+ * callback for OpenSSL mutex locks
  */
 void ssl_lock(int mode, int n, const char *file, int line)
 {
-       if (mode & CRYPTO_LOCK)
+       if (mode & CRYPTO_LOCK) {
                pthread_mutex_lock(SSLCritters[n]);
-       else
+       }
+       else {
                pthread_mutex_unlock(SSLCritters[n]);
+       }
 }
 
 /*
- * client_write_ssl() Send binary data to the client encrypted.
+ * Send binary data to the client encrypted.
  */
-void client_write_ssl(char *buf, int nbytes)
+void client_write_ssl(const StrBuf *Buf)
 {
+       const char *buf;
        int retval;
        int nremain;
+       long nbytes;
        char junk[1];
 
        if (THREADSSL == NULL) return;
 
-       nremain = nbytes;
+       nbytes = nremain = StrLength(Buf);
+       buf = ChrPtr(Buf);
 
        while (nremain > 0) {
                if (SSL_want_write(THREADSSL)) {
                        if ((SSL_read(THREADSSL, junk, 0)) < 1) {
-                               lprintf(9, "SSL_read in client_write: %s\n",
+                               syslog(9, "SSL_read in client_write: %s\n",
                                                ERR_reason_error_string(ERR_get_error()));
                        }
                }
@@ -408,14 +526,13 @@ void client_write_ssl(char *buf, int nbytes)
                        long errval;
 
                        errval = SSL_get_error(THREADSSL, retval);
-                       if (errval == SSL_ERROR_WANT_READ ||
-                           errval == SSL_ERROR_WANT_WRITE) {
-                               sleep(1);
+                       if (errval == SSL_ERROR_WANT_READ || errval == SSL_ERROR_WANT_WRITE) {
+                               sleeeeeeeeeep(1);
                                continue;
                        }
-                       lprintf(9, "SSL_write got error %ld, ret %d\n", errval, retval);
+                       syslog(9, "SSL_write got error %ld, ret %d\n", errval, retval);
                        if (retval == -1) {
-                               lprintf(9, "errno is %d\n", errno);
+                               syslog(9, "errno is %d\n", errno);
                        }
                        endtls();
                        return;
@@ -426,64 +543,40 @@ void client_write_ssl(char *buf, int nbytes)
 
 
 /*
- * client_read_ssl() - read data from the encrypted layer.
+ * read data from the encrypted layer.
  */
-int client_read_ssl(char *buf, int bytes, int timeout)
+int client_read_sslbuffer(StrBuf *buf, int timeout)
 {
-#if 0
-       fd_set rfds;
-       struct timeval tv;
-       int retval;
-       int s;
-#endif
-       int len, rlen;
+       char sbuf[16384]; /* OpenSSL communicates in 16k blocks, so let's speak its native tongue. */
+       int rlen;
        char junk[1];
+       SSL *pssl = THREADSSL;
 
-       if (THREADSSL == NULL) return(0);
+       if (pssl == NULL) return(-1);
 
-       len = 0;
-       while (len < bytes) {
-#if 0
-               /*
-                * This code is disabled because we don't need it when
-                * using blocking reads (which we are). -IO
-                */
-               FD_ZERO(&rfds);
-               s = BIO_get_fd(THREADSSL->rbio, NULL);
-               FD_SET(s, &rfds);
-               tv.tv_sec = timeout;
-               tv.tv_usec = 0;
-
-               retval = select(s + 1, &rfds, NULL, NULL, &tv);
-
-               if (FD_ISSET(s, &rfds) == 0) {
-                       return (0);
-               }
-
-#endif
-               if (SSL_want_read(THREADSSL)) {
-                       if ((SSL_write(THREADSSL, junk, 0)) < 1) {
-                               lprintf(9, "SSL_write in client_read: %s\n", ERR_reason_error_string(ERR_get_error()));
+       while (1) {
+               if (SSL_want_read(pssl)) {
+                       if ((SSL_write(pssl, junk, 0)) < 1) {
+                               syslog(9, "SSL_write in client_read\n");
                        }
                }
-               rlen = SSL_read(THREADSSL, &buf[len], bytes - len);
+               rlen = SSL_read(pssl, sbuf, sizeof(sbuf));
                if (rlen < 1) {
                        long errval;
 
-                       errval = SSL_get_error(THREADSSL, rlen);
-                       if (errval == SSL_ERROR_WANT_READ ||
-                           errval == SSL_ERROR_WANT_WRITE) {
-                               sleep(1);
+                       errval = SSL_get_error(pssl, rlen);
+                       if (errval == SSL_ERROR_WANT_READ || errval == SSL_ERROR_WANT_WRITE) {
+                               sleeeeeeeeeep(1);
                                continue;
                        }
-                       lprintf(9, "SSL_read got error %ld\n", errval);
+                       syslog(9, "SSL_read got error %ld\n", errval);
                        endtls();
-                       return (0);
+                       return (-1);
                }
-               len += rlen;
+               StrBufAppendBufPlain(buf, sbuf, rlen, 0);
+               return rlen;
        }
-       return (1);
+       return (0);
 }
 
-
 #endif                         /* HAVE_OPENSSL */