1 // Copyright (c) 1996-2021 by the citadel.org team
3 // This program is open source software. You can redistribute it and/or
4 // modify it under the terms of the GNU General Public License, version 3.
6 // This program is distributed in the hope that it will be useful,
7 // but WITHOUT ANY WARRANTY; without even the implied warranty of
8 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 // GNU General Public License for more details.
15 #include "webserver.h"
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;
23 pthread_key_t ThreadSSL; // Per-thread SSL context
25 void shutdown_ssl(void) {
30 // Set the private key and certificate chain for the global SSL Context.
31 // This is called during initialization, and can be called again later if the certificate changes.
32 void bind_to_key_and_certificate(void) {
33 if (IsEmptyStr(key_file)) {
34 snprintf(key_file, sizeof key_file, "%s/keys/citadel.key", ctdl_dir);
36 if (IsEmptyStr(cert_file)) {
37 snprintf(cert_file, sizeof key_file, "%s/keys/citadel.cer", ctdl_dir);
40 syslog(LOG_DEBUG, "crypto: [re]installing key \"%s\" and certificate \"%s\"", key_file, cert_file);
42 SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_file);
43 SSL_CTX_use_PrivateKey_file(ssl_ctx, key_file, SSL_FILETYPE_PEM);
45 if ( !SSL_CTX_check_private_key(ssl_ctx) ) {
46 syslog(LOG_WARNING, "crypto: cannot install certificate: %s", ERR_reason_error_string(ERR_get_error()));
51 // initialize ssl engine, load certs and initialize openssl internals
54 #ifndef OPENSSL_NO_EGD
55 if (!access("/var/run/egd-pool", F_OK)) {
56 RAND_egd("/var/run/egd-pool");
61 syslog(LOG_WARNING, "PRNG not adequately seeded, won't do SSL/TLS");
65 // Initialize SSL transport layer
67 SSL_load_error_strings();
68 if (!(ssl_ctx = SSL_CTX_new(SSLv23_server_method()))) {
69 syslog(LOG_WARNING, "SSL_CTX_new failed: %s", ERR_reason_error_string(ERR_get_error()));
73 syslog(LOG_INFO, "Requesting cipher list: %s", ssl_cipher_list);
74 if (!(SSL_CTX_set_cipher_list(ssl_ctx, ssl_cipher_list))) {
75 syslog(LOG_WARNING, "SSL_CTX_set_cipher_list failed: %s", ERR_reason_error_string(ERR_get_error()));
80 // Now try to bind to the key and certificate.
81 bind_to_key_and_certificate();
85 // Check the modification time of the key and certificate -- reload if either one changed
86 void update_key_and_cert_if_needed(void) {
87 static time_t previous_mtime = 0;
91 if (stat(key_file, &keystat) != 0) {
92 syslog(LOG_ERR, "%s: %s", key_file, strerror(errno));
95 if (stat(cert_file, &certstat) != 0) {
96 syslog(LOG_ERR, "%s: %s", cert_file, strerror(errno));
100 if ((keystat.st_mtime + certstat.st_mtime) != previous_mtime) {
101 bind_to_key_and_certificate();
102 previous_mtime = keystat.st_mtime + certstat.st_mtime;
107 // starts SSL/TLS encryption for the current session.
108 int starttls(int sock) {
110 int retval, bits, alg_bits;
112 // Check the modification time of the key and certificate -- reload if they changed
113 update_key_and_cert_if_needed();
115 // SSL is a thread-specific thing, I think.
116 pthread_setspecific(ThreadSSL, NULL);
121 if (!(newssl = SSL_new(ssl_ctx))) {
122 syslog(LOG_WARNING, "SSL_new failed: %s", ERR_reason_error_string(ERR_get_error()));
125 if (!(SSL_set_fd(newssl, sock))) {
126 syslog(LOG_WARNING, "SSL_set_fd failed: %s", ERR_reason_error_string(ERR_get_error()));
130 retval = SSL_accept(newssl);
132 // Can't notify the client of an error here; they will
133 // discover the problem at the SSL layer and should
134 // revert to unencrypted communications.
136 const char *ssl_error_reason = NULL;
138 errval = SSL_get_error(newssl, retval);
139 ssl_error_reason = ERR_reason_error_string(ERR_get_error());
140 if (ssl_error_reason == NULL) {
141 syslog(LOG_WARNING, "first SSL_accept failed: errval=%ld, retval=%d %s", errval, retval, strerror(errval));
144 syslog(LOG_WARNING, "first SSL_accept failed: %s", ssl_error_reason);
147 // retval = SSL_accept(newssl);
151 // const char *ssl_error_reason = NULL;
153 // errval = SSL_get_error(newssl, retval);
154 // ssl_error_reason = ERR_reason_error_string(ERR_get_error());
155 // if (ssl_error_reason == NULL) {
156 // syslog(LOG_WARNING, "second SSL_accept failed: errval=%ld, retval=%d (%s)", errval, retval, strerror(errval));
159 // syslog(LOG_WARNING, "second SSL_accept failed: %s", ssl_error_reason);
166 syslog(LOG_INFO, "SSL_accept success");
168 /*r = */BIO_set_close(SSL_get_rbio(newssl), BIO_NOCLOSE);
169 bits = SSL_CIPHER_get_bits(SSL_get_current_cipher(newssl), &alg_bits);
170 syslog(LOG_INFO, "SSL/TLS using %s on %s (%d of %d bits)",
171 SSL_CIPHER_get_name(SSL_get_current_cipher(newssl)),
172 SSL_CIPHER_get_version(SSL_get_current_cipher(newssl)),
175 pthread_setspecific(ThreadSSL, newssl);
176 syslog(LOG_INFO, "SSL started");
181 // shuts down the TLS connection
183 // WARNING: This may make your session vulnerable to a known plaintext
184 // attack in the current implmentation.
187 if (THREADSSL == NULL) {
191 syslog(LOG_INFO, "Ending SSL/TLS");
192 SSL_shutdown(THREADSSL);
193 SSL_get_SSL_CTX(THREADSSL);
195 pthread_setspecific(ThreadSSL, NULL);
199 // Send binary data to the client encrypted.
200 int client_write_ssl(const StrBuf *Buf) {
207 if (THREADSSL == NULL) return -1;
209 nbytes = nremain = StrLength(Buf);
212 while (nremain > 0) {
213 if (SSL_want_write(THREADSSL)) {
214 if ((SSL_read(THREADSSL, junk, 0)) < 1) {
215 syslog(LOG_WARNING, "SSL_read in client_write: %s", ERR_reason_error_string(ERR_get_error()));
218 retval = SSL_write(THREADSSL, &buf[nbytes - nremain], nremain);
222 errval = SSL_get_error(THREADSSL, retval);
223 if (errval == SSL_ERROR_WANT_READ || errval == SSL_ERROR_WANT_WRITE) {
227 syslog(LOG_WARNING, "SSL_write: %s", ERR_reason_error_string(ERR_get_error()));
229 syslog(LOG_WARNING, "errno is %d\n", errno);
240 // read data from the encrypted layer.
241 int client_read_sslbuffer(StrBuf *buf, int timeout) {
242 char sbuf[16384]; // OpenSSL communicates in 16k blocks, so let's speak its native tongue.
245 SSL *pssl = THREADSSL;
247 if (pssl == NULL) return(-1);
250 if (SSL_want_read(pssl)) {
251 if ((SSL_write(pssl, junk, 0)) < 1) {
252 syslog(LOG_WARNING, "SSL_write in client_read");
255 rlen = SSL_read(pssl, sbuf, sizeof(sbuf));
259 errval = SSL_get_error(pssl, rlen);
260 if (errval == SSL_ERROR_WANT_READ || errval == SSL_ERROR_WANT_WRITE) {
264 syslog(LOG_WARNING, "SSL_read in client_read: %s", ERR_reason_error_string(ERR_get_error()));
268 StrBufAppendBufPlain(buf, sbuf, rlen, 0);
274 #endif /* HAVE_OPENSSL */