webcit-ng/tls.c

   1 // Functions in this module handle SSL encryption when WebCit is running
   2 // as an HTTPS server.
   3 //
   4 // Copyright (c) 1996-2022 by the citadel.org team
   5 //
   6 // This program is open source software.  It runs great on the
   7 // Linux operating system (and probably elsewhere).  You can use,
   8 // copy, and run it under the terms of the GNU General Public
   9 // License version 3.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 #include "webcit.h"
  17
  18 SSL_CTX *ssl_ctx;               // global SSL context
  19 char key_file[PATH_MAX] = "";
  20 char cert_file[PATH_MAX] = "";
  21 char *ssl_cipher_list = DEFAULT_SSL_CIPHER_LIST;
  22
  23
  24 // Set the private key and certificate chain for the global SSL Context.
  25 // This is called during initialization, and can be called again later if the certificate changes.
  26 void bind_to_key_and_certificate(void) {
  27         if (IsEmptyStr(key_file)) {
  28                 snprintf(key_file, sizeof key_file, "%s/keys/citadel.key", ctdl_dir);
  29         }
  30         if (IsEmptyStr(cert_file)) {
  31                 snprintf(cert_file, sizeof key_file, "%s/keys/citadel.cer", ctdl_dir);
  32         }
  33
  34         syslog(LOG_DEBUG, "crypto: [re]installing key \"%s\" and certificate \"%s\"", key_file, cert_file);
  35
  36         SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_file);
  37         SSL_CTX_use_PrivateKey_file(ssl_ctx, key_file, SSL_FILETYPE_PEM);
  38
  39         if ( !SSL_CTX_check_private_key(ssl_ctx) ) {
  40                 syslog(LOG_WARNING, "crypto: cannot install certificate: %s", ERR_reason_error_string(ERR_get_error()));
  41         }
  42 }
  43
  44
  45 // Initialize ssl engine, load certs and initialize openssl internals
  46 void init_ssl(void) {
  47         const SSL_METHOD *ssl_method;
  48         RSA *rsa = NULL;
  49         X509_REQ *req = NULL;
  50         X509 *cer = NULL;
  51         EVP_PKEY *pk = NULL;
  52         EVP_PKEY *req_pkey = NULL;
  53         X509_NAME *name = NULL;
  54         FILE *fp;
  55         char buf[SIZ];
  56         int rv = 0;
  57
  58         // Initialize SSL transport layer
  59         SSL_library_init();
  60         SSL_load_error_strings();
  61         ssl_method = SSLv23_server_method();
  62         if (!(ssl_ctx = SSL_CTX_new(ssl_method))) {
  63                 syslog(LOG_WARNING, "SSL_CTX_new failed: %s", ERR_reason_error_string(ERR_get_error()));
  64                 return;
  65         }
  66
  67         syslog(LOG_INFO, "Requesting cipher list: %s", ssl_cipher_list);
  68         if (!(SSL_CTX_set_cipher_list(ssl_ctx, ssl_cipher_list))) {
  69                 syslog(LOG_WARNING, "SSL_CTX_set_cipher_list failed: %s", ERR_reason_error_string(ERR_get_error()));
  70                 return;
  71         }
  72
  73         // Now try to bind to the key and certificate.
  74         bind_to_key_and_certificate();
  75 }
  76
  77
  78 // Check the modification time of the key and certificate -- reload if they changed
  79 void update_key_and_cert_if_needed(void) {
  80         static time_t previous_mtime = 0;
  81         struct stat keystat;
  82         struct stat certstat;
  83
  84         if (stat(key_file, &keystat) != 0) {
  85                 syslog(LOG_ERR, "%s: %s", key_file, strerror(errno));
  86                 return;
  87         }
  88         if (stat(cert_file, &certstat) != 0) {
  89                 syslog(LOG_ERR, "%s: %s", cert_file, strerror(errno));
  90                 return;
  91         }
  92
  93         if ((keystat.st_mtime + certstat.st_mtime) != previous_mtime) {
  94                 bind_to_key_and_certificate();
  95                 previous_mtime = keystat.st_mtime + certstat.st_mtime;
  96         }
  97 }
  98
  99
 100 // starts SSL/TLS encryption for the current session.
 101 void starttls(struct client_handle *ch) {
 102         int retval, bits, alg_bits;
 103
 104         if (!ssl_ctx) {
 105                 return;
 106         }
 107
 108         // Check the modification time of the key and certificate -- reload if they changed
 109         update_key_and_cert_if_needed();
 110
 111         if (!(ch->ssl_handle = SSL_new(ssl_ctx))) {
 112                 syslog(LOG_WARNING, "SSL_new failed: %s", ERR_reason_error_string(ERR_get_error()));
 113                 return;
 114         }
 115         if (!(SSL_set_fd(ch->ssl_handle, ch->sock))) {
 116                 syslog(LOG_WARNING, "SSL_set_fd failed: %s", ERR_reason_error_string(ERR_get_error()));
 117                 SSL_free(ch->ssl_handle);
 118                 return;
 119         }
 120         retval = SSL_accept(ch->ssl_handle);
 121         if (retval < 1) {
 122                 syslog(LOG_WARNING, "SSL_accept failed: %s", ERR_reason_error_string(ERR_get_error()));
 123         }
 124         else {
 125                 syslog(LOG_INFO, "SSL_accept success");
 126         }
 127         bits = SSL_CIPHER_get_bits(SSL_get_current_cipher(ch->ssl_handle), &alg_bits);
 128         syslog(LOG_INFO, "SSL/TLS using %s on %s (%d of %d bits)",
 129                SSL_CIPHER_get_name(SSL_get_current_cipher(ch->ssl_handle)),
 130                SSL_CIPHER_get_version(SSL_get_current_cipher(ch->ssl_handle)), bits, alg_bits);
 131         syslog(LOG_INFO, "SSL started");
 132 }
 133
 134
 135 // shuts down the TLS connection
 136 void endtls(struct client_handle *ch) {
 137         syslog(LOG_INFO, "Ending SSL/TLS");
 138         if (ch->ssl_handle != NULL) {
 139                 SSL_shutdown(ch->ssl_handle);
 140                 SSL_get_SSL_CTX(ch->ssl_handle);
 141                 SSL_free(ch->ssl_handle);
 142         }
 143         ch->ssl_handle = NULL;
 144 }
 145
 146
 147 // Send binary data to the client encrypted.
 148 int client_write_ssl(struct client_handle *ch, char *buf, int nbytes) {
 149         int retval;
 150         int nremain;
 151         char junk[1];
 152
 153         if (ch->ssl_handle == NULL)
 154                 return (-1);
 155
 156         nremain = nbytes;
 157         while (nremain > 0) {
 158                 if (SSL_want_write(ch->ssl_handle)) {
 159                         if ((SSL_read(ch->ssl_handle, junk, 0)) < 1) {
 160                                 syslog(LOG_WARNING, "SSL_read in client_write: %s", ERR_reason_error_string(ERR_get_error()));
 161                         }
 162                 }
 163                 retval = SSL_write(ch->ssl_handle, &buf[nbytes - nremain], nremain);
 164                 if (retval < 1) {
 165                         long errval;
 166
 167                         errval = SSL_get_error(ch->ssl_handle, retval);
 168                         if (errval == SSL_ERROR_WANT_READ || errval == SSL_ERROR_WANT_WRITE) {
 169                                 sleep(1);
 170                                 continue;
 171                         }
 172                         syslog(LOG_WARNING, "SSL_write: %s", ERR_reason_error_string(ERR_get_error()));
 173                         if (retval == -1) {
 174                                 syslog(LOG_WARNING, "errno is %d", errno);
 175                                 endtls(ch);
 176                         }
 177                         return -1;
 178                 }
 179                 nremain -= retval;
 180         }
 181         return 0;
 182 }
 183
 184
 185 // read data from the encrypted layer
 186 int client_read_ssl(struct client_handle *ch, char *buf, int nbytes) {
 187         int bytes_read = 0;
 188         int rlen = 0;
 189         char junk[1];
 190
 191         if (ch->ssl_handle == NULL)
 192                 return (-1);
 193
 194         while (bytes_read < nbytes) {
 195                 if (SSL_want_read(ch->ssl_handle)) {
 196                         if ((SSL_write(ch->ssl_handle, junk, 0)) < 1) {
 197                                 syslog(LOG_WARNING, "SSL_write in client_read");
 198                         }
 199                 }
 200                 rlen = SSL_read(ch->ssl_handle, &buf[bytes_read], nbytes - bytes_read);
 201                 if (rlen < 1) {
 202                         long errval;
 203                         errval = SSL_get_error(ch->ssl_handle, rlen);
 204                         if (errval == SSL_ERROR_WANT_READ || errval == SSL_ERROR_WANT_WRITE) {
 205                                 sleep(1);
 206                                 continue;
 207                         }
 208                         syslog(LOG_WARNING, "SSL_read error %ld", errval);
 209                         endtls(ch);
 210                         return (-1);
 211                 }
 212                 bytes_read += rlen;
 213         }
 214         return (bytes_read);
 215 }