Cleanup of crypto.c in wc-classic to prepare for certificate updates during runtime
authorArt Cancro <ajc@citadel.org>
Tue, 21 Dec 2021 18:45:33 +0000 (13:45 -0500)
committerArt Cancro <ajc@citadel.org>
Tue, 21 Dec 2021 18:45:33 +0000 (13:45 -0500)
webcit/crypto.c

index b1edb4a152ed74fcfa995f4cb931e490bf1e121a..0d0f080b0dfed63f0a17cf48c3ff9a7b1db720a6 100644 (file)
@@ -1,14 +1,12 @@
-/*
- * Copyright (c) 1996-2017 by the citadel.org team
- *
- * 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.
- */
+// Copyright (c) 1996-2021 by the citadel.org team
+//
+// 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
 #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 */
+#define SIGN_DAYS              3650                    // how long our self-signed certificate should live
 
-SSL_CTX *ssl_ctx;              /* SSL context */
+SSL_CTX *ssl_ctx;              // Global SSL context
 char *ssl_cipher_list = DEFAULT_SSL_CIPHER_LIST;
 
-pthread_key_t ThreadSSL;       /* Per-thread SSL context */
+pthread_key_t ThreadSSL;       // Per-thread SSL context
 
 void shutdown_ssl(void) {
        ERR_free_strings();
@@ -41,7 +39,7 @@ void generate_key(char *keyfilename) {
        unsigned long e = RSA_F4;
        FILE *fp;
 
-       if (access(keyfilename, R_OK) == 0) {
+       if (access(keyfilename, R_OK) == 0) {           // We already have a key -- don't generate a new one.
                return;
        }
 
@@ -64,13 +62,13 @@ void generate_key(char *keyfilename) {
        fp = fopen(keyfilename, "w");
        if (fp != NULL) {
                chmod(file_crpt_file_key, 0600);
-               if (PEM_write_RSAPrivateKey(fp, /* the file */
-                                       rsa,    /* the key */
-                                       NULL,   /* no enc */
-                                       NULL,   /* no passphr */
-                                       0,      /* no passphr */
-                                       NULL,   /* no callbk */
-                                       NULL    /* no callbk */
+               if (PEM_write_RSAPrivateKey(fp, // the file
+                                       rsa,    // the key
+                                       NULL,   // no enc
+                                       NULL,   // no passphrase
+                                       0,      // no passphrase
+                                       NULL,   // no callback
+                                       NULL    // no callback
                ) != 1) {
                        syslog(LOG_ERR, "crypto: cannot write key: %s", ERR_reason_error_string(ERR_get_error()));
                        unlink(keyfilename);
@@ -78,18 +76,15 @@ void generate_key(char *keyfilename) {
                fclose(fp);
        }
 
-    // 4. free
+       // Free the memory we used
 free_all:
-    RSA_free(rsa);
-    BN_free(bne);
+       RSA_free(rsa);
+       BN_free(bne);
 }
 
 
-/*
- * initialize ssl engine, load certs and initialize openssl internals
- */
-void init_ssl(void)
-{
+// initialize ssl engine, load certs and initialize openssl internals
+void init_ssl(void) {
        const SSL_METHOD *ssl_method;
        RSA *rsa=NULL;
        X509_REQ *req = NULL;
@@ -108,75 +103,69 @@ void init_ssl(void)
 #endif
 
        if (!RAND_status()) {
-               syslog(LOG_WARNING, "PRNG not adequately seeded, won't do SSL/TLS\n");
+               syslog(LOG_WARNING, "PRNG not adequately seeded, won't do SSL/TLS");
                return;
        }
 
-       /*
-        * Initialize SSL transport layer
-        */
+       // Initialize SSL transport layer
        SSL_library_init();
        SSL_load_error_strings();
        ssl_method = SSLv23_server_method();
        if (!(ssl_ctx = SSL_CTX_new(ssl_method))) {
-               syslog(LOG_WARNING, "SSL_CTX_new failed: %s\n", ERR_reason_error_string(ERR_get_error()));
+               syslog(LOG_WARNING, "SSL_CTX_new failed: %s", ERR_reason_error_string(ERR_get_error()));
                return;
        }
 
-       syslog(LOG_INFO, "Requesting cipher list: %s\n", ssl_cipher_list);
+       syslog(LOG_INFO, "Requesting cipher list: %s", ssl_cipher_list);
        if (!(SSL_CTX_set_cipher_list(ssl_ctx, ssl_cipher_list))) {
-               syslog(LOG_WARNING, "SSL_CTX_set_cipher_list failed: %s\n", ERR_reason_error_string(ERR_get_error()));
+               syslog(LOG_WARNING, "SSL_CTX_set_cipher_list failed: %s", 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. (FIXME: dirify. this is a setup job.)
-        * First, create the key/cert directory if it's not there already...
-        */
+       // Get our certificates in order.
+       // First, create the key/cert directory if it's not there already...
        mkdir(CTDL_CRYPTO_DIR, 0700);
 
-       /*
-        * Before attempting to generate keys/certificates, first try
-        * link to them from the Citadel server if it's on the same host.
-        * We ignore any error return because it either meant that there
-        * was nothing in Citadel to link from (in which case we just
-        * generate new files) or the target files already exist (which
-        * is not fatal either).
-        */
+       // Before attempting to generate keys/certificates, first try
+       // link to them from the Citadel server if it's on the same host.
+       // We ignore any error return because it either meant that there
+       // was nothing in Citadel to link from (in which case we just
+       // generate new files) or the target files already exist (which
+       // is not fatal either).
        if (!strcasecmp(ctdlhost, "uds")) {
                sprintf(buf, "%s/keys/citadel.key", ctdlport);
                rv = symlink(buf, CTDL_KEY_PATH);
-               if (!rv) syslog(LOG_DEBUG, "%s\n", strerror(errno));
+               if (!rv) {
+                       syslog(LOG_DEBUG, "%s", strerror(errno));
+               }
                sprintf(buf, "%s/keys/citadel.csr", ctdlport);
                rv = symlink(buf, CTDL_CSR_PATH);
-               if (!rv) syslog(LOG_DEBUG, "%s\n", strerror(errno));
+               if (!rv) {
+                       syslog(LOG_DEBUG, "%s", strerror(errno));
+               }
                sprintf(buf, "%s/keys/citadel.cer", ctdlport);
                rv = symlink(buf, CTDL_CER_PATH);
-               if (!rv) syslog(LOG_DEBUG, "%s\n", strerror(errno));
+               if (!rv) {
+                       syslog(LOG_DEBUG, "%s", strerror(errno));
+               }
        }
 
-       /*
-        * If we still don't have a private key, generate one.
-        */
+       // If we still don't have a private key, generate one.
        generate_key(CTDL_KEY_PATH);
 
-       /*
-        * 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 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_CER_PATH, R_OK) != 0) && (access(CTDL_CSR_PATH, R_OK) != 0) ) {
-               syslog(LOG_INFO, "Generating a certificate signing request.\n");
-
-               /*
-                * Read our key from the file.  No, we don't just keep this
-                * in memory from the above key-generation function, because
-                * there is the possibility that the key was already on disk
-                * and we didn't just generate it now.
-                */
+               syslog(LOG_INFO, "Generating a certificate signing request.");
+
+               // Read our key from the file.  No, we don't just keep this
+               // in memory from the above key-generation function, because
+               // there is the possibility that the key was already on disk
+               // and we didn't just generate it now.
                fp = fopen(CTDL_KEY_PATH, "r");
                if (fp) {
                        rsa = PEM_read_RSAPrivateKey(fp, NULL, NULL, NULL);
@@ -184,38 +173,22 @@ 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 */
+                                       // Set the public key
                                        X509_REQ_set_pubkey(req, pk);
                                        X509_REQ_set_version(req, 0L);
 
                                        name = X509_REQ_get_subject_name(req);
 
-                                       /* 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);
-                                       */
-
+                                       // Tell it who we are
                                        env = getenv("O");
-                                       if (env == NULL)
-                                               env = "Organization name",
+                                       if (env == NULL) {
+                                               env = "Organization name";
+                                       }
 
                                        X509_NAME_add_entry_by_txt(
                                                name, "O",
@@ -225,8 +198,9 @@ void init_ssl(void)
                                        );
 
                                        env = getenv("OU");
-                                       if (env == NULL)
+                                       if (env == NULL) {
                                                env = "Citadel server";
+                                       }
 
                                        X509_NAME_add_entry_by_txt(
                                                name, "OU",
@@ -248,12 +222,12 @@ void init_ssl(void)
                                
                                        X509_REQ_set_subject_name(req, name);
 
-                                       /* Sign the CSR */
+                                       // Sign the CSR
                                        if (!X509_REQ_sign(req, pk, EVP_md5())) {
-                                               syslog(LOG_WARNING, "X509_REQ_sign(): error\n");
+                                               syslog(LOG_WARNING, "X509_REQ_sign(): error");
                                        }
                                        else {
-                                               /* Write it to disk. */ 
+                                               // Write it to disk.
                                                fp = fopen(CTDL_CSR_PATH, "w");
                                                if (fp != NULL) {
                                                        chmod(CTDL_CSR_PATH, 0600);
@@ -261,7 +235,7 @@ void init_ssl(void)
                                                        fclose(fp);
                                                }
                                                else {
-                                                       syslog(LOG_WARNING, "Cannot write key: %s\n", CTDL_CSR_PATH);
+                                                       syslog(LOG_WARNING, "Cannot write key: %s", CTDL_CSR_PATH);
                                                        ShutDownWebcit();
                                                        exit(0);
                                                }
@@ -270,33 +244,26 @@ void init_ssl(void)
                                        X509_REQ_free(req);
                                }
                        }
-
                        RSA_free(rsa);
                }
-
                else {
-                       syslog(LOG_WARNING, "Unable to read private key.\n");
+                       syslog(LOG_WARNING, "Unable to read private key.");
                }
        }
 
-
-
-       /*
-        * Generate a self-signed certificate if we don't have one.
-        */
+       // Generate a self-signed certificate if we don't have one.
        if (access(CTDL_CER_PATH, R_OK) != 0) {
                syslog(LOG_INFO, "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.
-                */
+               // Same deal as before: always read the key from disk because
+               // it may or may not have just been generated.
                fp = fopen(CTDL_KEY_PATH, "r");
                if (fp) {
                        rsa = PEM_read_RSAPrivateKey(fp, NULL, NULL, NULL);
                        fclose(fp);
                }
 
-               /* This also holds true for the CSR. */
+               // This also holds true for the CSR.
                req = NULL;
                cer = NULL;
                pk = NULL;
@@ -324,12 +291,12 @@ void init_ssl(void)
                                        X509_set_pubkey(cer, req_pkey);
                                        EVP_PKEY_free(req_pkey);
                                        
-                                       /* Sign the cert */
+                                       // Sign the cert
                                        if (!X509_sign(cer, pk, EVP_md5())) {
-                                               syslog(LOG_WARNING, "X509_sign(): error\n");
+                                               syslog(LOG_WARNING, "X509_sign(): error");
                                        }
                                        else {
-                                               /* Write it to disk. */ 
+                                               // Write it to disk.
                                                fp = fopen(CTDL_CER_PATH, "w");
                                                if (fp != NULL) {
                                                        chmod(CTDL_CER_PATH, 0600);
@@ -337,7 +304,7 @@ void init_ssl(void)
                                                        fclose(fp);
                                                }
                                                else {
-                                                       syslog(LOG_WARNING, "Cannot write key: %s\n", CTDL_CER_PATH);
+                                                       syslog(LOG_WARNING, "Cannot write key: %s", CTDL_CER_PATH);
                                                        ShutDownWebcit();
                                                        exit(0);
                                                }
@@ -345,29 +312,24 @@ void init_ssl(void)
                                        X509_free(cer);
                                }
                        }
-
                        RSA_free(rsa);
                }
        }
 
-       /*
-        * Now try to bind to the key and certificate.
-        * Note that we use SSL_CTX_use_certificate_chain_file() which allows
-        * the certificate file to contain intermediate certificates.
-        */
+       // Now try to bind to the key and certificate.
+       // Note that we use SSL_CTX_use_certificate_chain_file() which allows
+       // the certificate file to contain intermediate certificates.
        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) ) {
-               syslog(LOG_WARNING, "crypto: cannot install certificate: %s\n", ERR_reason_error_string(ERR_get_error()));
+               syslog(LOG_WARNING, "crypto: cannot install certificate: %s", ERR_reason_error_string(ERR_get_error()));
        }
 }
 
 
-/*
- * 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;/*r; */
+       int retval, bits, alg_bits;
        SSL *newssl;
 
        pthread_setspecific(ThreadSSL, NULL);
@@ -376,31 +338,29 @@ int starttls(int sock) {
                return(1);
        }
        if (!(newssl = SSL_new(ssl_ctx))) {
-               syslog(LOG_WARNING, "SSL_new failed: %s\n", ERR_reason_error_string(ERR_get_error()));
+               syslog(LOG_WARNING, "SSL_new failed: %s", ERR_reason_error_string(ERR_get_error()));
                return(2);
        }
        if (!(SSL_set_fd(newssl, sock))) {
-               syslog(LOG_WARNING, "SSL_set_fd failed: %s\n", ERR_reason_error_string(ERR_get_error()));
+               syslog(LOG_WARNING, "SSL_set_fd failed: %s", ERR_reason_error_string(ERR_get_error()));
                SSL_free(newssl);
                return(3);
        }
        retval = SSL_accept(newssl);
        if (retval < 1) {
-               /*
-                * Can't notify the client of an error here; they will
-                * discover the problem at the SSL layer and should
-                * revert to unencrypted communications.
-                */
+               // Can't notify the client of an error here; they will
+               // discover the problem at the SSL layer and should
+               // 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(LOG_WARNING, "SSL_accept failed: errval=%ld, retval=%d %s\n", errval, retval, strerror(errval));
+                       syslog(LOG_WARNING, "SSL_accept failed: errval=%ld, retval=%d %s", errval, retval, strerror(errval));
                }
                else {
-                       syslog(LOG_WARNING, "SSL_accept failed: %s\n", ssl_error_reason);
+                       syslog(LOG_WARNING, "SSL_accept failed: %s", ssl_error_reason);
                }
                sleeeeeeeeeep(1);
                retval = SSL_accept(newssl);
@@ -412,66 +372,51 @@ int starttls(int sock) {
                errval = SSL_get_error(newssl, retval);
                ssl_error_reason = ERR_reason_error_string(ERR_get_error());
                if (ssl_error_reason == NULL) {
-                       syslog(LOG_WARNING, "SSL_accept failed: errval=%ld, retval=%d (%s)\n", errval, retval, strerror(errval));
+                       syslog(LOG_WARNING, "SSL_accept failed: errval=%ld, retval=%d (%s)", errval, retval, strerror(errval));
                }
                else {
-                       syslog(LOG_WARNING, "SSL_accept failed: %s\n", ssl_error_reason);
+                       syslog(LOG_WARNING, "SSL_accept failed: %s", ssl_error_reason);
                }
                SSL_free(newssl);
                newssl = NULL;
                return(4);
        }
        else {
-               syslog(LOG_INFO, "SSL_accept success\n");
+               syslog(LOG_INFO, "SSL_accept success");
        }
        /*r = */BIO_set_close(SSL_get_rbio(newssl), BIO_NOCLOSE);
        bits = SSL_CIPHER_get_bits(SSL_get_current_cipher(newssl), &alg_bits);
-       syslog(LOG_INFO, "SSL/TLS using %s on %s (%d of %d bits)\n",
+       syslog(LOG_INFO, "SSL/TLS using %s on %s (%d of %d bits)",
                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(LOG_INFO, "SSL started\n");
+       syslog(LOG_INFO, "SSL started");
        return(0);
 }
 
 
+// shuts down the TLS connection
+//
+// WARNING:  This may make your session vulnerable to a known plaintext
+// attack in the current implmentation.
+void endtls(void) {
 
-/*
- * 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;
+       if (THREADSSL == NULL) {
+               return;
+       }
 
-       syslog(LOG_INFO, "Ending SSL/TLS\n");
+       syslog(LOG_INFO, "Ending SSL/TLS");
        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(LOG_DEBUG, "Freeing CTX at %x\n", (int)ctx );
-        *              SSL_CTX_free(ctx);
-        *      }
-        */
-
+       SSL_get_SSL_CTX(THREADSSL);
        SSL_free(THREADSSL);
        pthread_setspecific(ThreadSSL, NULL);
 }
 
 
-/*
- * Send binary data to the client encrypted.
- */
-int client_write_ssl(const StrBuf *Buf)
-{
+// Send binary data to the client encrypted.
+int client_write_ssl(const StrBuf *Buf) {
        const char *buf;
        int retval;
        int nremain;
@@ -486,8 +431,7 @@ int client_write_ssl(const StrBuf *Buf)
        while (nremain > 0) {
                if (SSL_want_write(THREADSSL)) {
                        if ((SSL_read(THREADSSL, junk, 0)) < 1) {
-                               syslog(LOG_WARNING, "SSL_read in client_write: %s\n",
-                                               ERR_reason_error_string(ERR_get_error()));
+                               syslog(LOG_WARNING, "SSL_read in client_write: %s", ERR_reason_error_string(ERR_get_error()));
                        }
                }
                retval = SSL_write(THREADSSL, &buf[nbytes - nremain], nremain);
@@ -499,7 +443,7 @@ int client_write_ssl(const StrBuf *Buf)
                                sleeeeeeeeeep(1);
                                continue;
                        }
-                       syslog(LOG_WARNING, "SSL_write got error %ld, ret %d\n", errval, retval);
+                       syslog(LOG_WARNING, "SSL_write got error %ld, ret %d", errval, retval);
                        if (retval == -1) {
                                syslog(LOG_WARNING, "errno is %d\n", errno);
                        }
@@ -512,12 +456,9 @@ int client_write_ssl(const StrBuf *Buf)
 }
 
 
-/*
- * read data from the encrypted layer.
- */
-int client_read_sslbuffer(StrBuf *buf, int timeout)
-{
-       char sbuf[16384]; /* OpenSSL communicates in 16k blocks, so let's speak its native tongue. */
+// read data from the encrypted layer.
+int client_read_sslbuffer(StrBuf *buf, int timeout) {
+       char sbuf[16384];       // OpenSSL communicates in 16k blocks, so let's speak its native tongue.
        int rlen;
        char junk[1];
        SSL *pssl = THREADSSL;
@@ -527,7 +468,7 @@ int client_read_sslbuffer(StrBuf *buf, int timeout)
        while (1) {
                if (SSL_want_read(pssl)) {
                        if ((SSL_write(pssl, junk, 0)) < 1) {
-                               syslog(LOG_WARNING, "SSL_write in client_read\n");
+                               syslog(LOG_WARNING, "SSL_write in client_read");
                        }
                }
                rlen = SSL_read(pssl, sbuf, sizeof(sbuf));
@@ -539,7 +480,7 @@ int client_read_sslbuffer(StrBuf *buf, int timeout)
                                sleeeeeeeeeep(1);
                                continue;
                        }
-                       syslog(LOG_WARNING, "SSL_read got error %ld\n", errval);
+                       syslog(LOG_WARNING, "SSL_read got error %ld", errval);
                        endtls();
                        return (-1);
                }