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 // Initialize SSL transport layer
56 SSL_load_error_strings();
57 if (!(ssl_ctx = SSL_CTX_new(SSLv23_server_method()))) {
58 syslog(LOG_WARNING, "SSL_CTX_new failed: %s", ERR_reason_error_string(ERR_get_error()));
62 syslog(LOG_INFO, "Requesting cipher list: %s", ssl_cipher_list);
63 if (!(SSL_CTX_set_cipher_list(ssl_ctx, ssl_cipher_list))) {
64 syslog(LOG_WARNING, "SSL_CTX_set_cipher_list failed: %s", ERR_reason_error_string(ERR_get_error()));
69 // Now try to bind to the key and certificate.
70 bind_to_key_and_certificate();
74 // Check the modification time of the key and certificate -- reload if either one changed
75 void update_key_and_cert_if_needed(void) {
76 static time_t previous_mtime = 0;
80 if (stat(key_file, &keystat) != 0) {
81 syslog(LOG_ERR, "%s: %s", key_file, strerror(errno));
84 if (stat(cert_file, &certstat) != 0) {
85 syslog(LOG_ERR, "%s: %s", cert_file, strerror(errno));
89 if ((keystat.st_mtime + certstat.st_mtime) != previous_mtime) {
90 bind_to_key_and_certificate();
91 previous_mtime = keystat.st_mtime + certstat.st_mtime;
96 // starts SSL/TLS encryption for the current session.
97 int starttls(int sock) {
99 int retval, bits, alg_bits;
101 // Check the modification time of the key and certificate -- reload if they changed
102 update_key_and_cert_if_needed();
104 // SSL is a thread-specific thing, I think.
105 pthread_setspecific(ThreadSSL, NULL);
110 if (!(newssl = SSL_new(ssl_ctx))) {
111 syslog(LOG_WARNING, "SSL_new failed: %s", ERR_reason_error_string(ERR_get_error()));
114 if (!(SSL_set_fd(newssl, sock))) {
115 syslog(LOG_WARNING, "SSL_set_fd failed: %s", ERR_reason_error_string(ERR_get_error()));
119 retval = SSL_accept(newssl);
121 // Can't notify the client of an error here; they will
122 // discover the problem at the SSL layer and should
123 // revert to unencrypted communications.
125 const char *ssl_error_reason = NULL;
127 errval = SSL_get_error(newssl, retval);
128 ssl_error_reason = ERR_reason_error_string(ERR_get_error());
129 if (ssl_error_reason == NULL) {
130 syslog(LOG_WARNING, "first SSL_accept failed: errval=%ld, retval=%d %s", errval, retval, strerror(errval));
133 syslog(LOG_WARNING, "first SSL_accept failed: %s", ssl_error_reason);
136 // retval = SSL_accept(newssl);
140 // const char *ssl_error_reason = NULL;
142 // errval = SSL_get_error(newssl, retval);
143 // ssl_error_reason = ERR_reason_error_string(ERR_get_error());
144 // if (ssl_error_reason == NULL) {
145 // syslog(LOG_WARNING, "second SSL_accept failed: errval=%ld, retval=%d (%s)", errval, retval, strerror(errval));
148 // syslog(LOG_WARNING, "second SSL_accept failed: %s", ssl_error_reason);
155 syslog(LOG_INFO, "SSL_accept success");
157 /*r = */BIO_set_close(SSL_get_rbio(newssl), BIO_NOCLOSE);
158 bits = SSL_CIPHER_get_bits(SSL_get_current_cipher(newssl), &alg_bits);
159 syslog(LOG_INFO, "SSL/TLS using %s on %s (%d of %d bits)",
160 SSL_CIPHER_get_name(SSL_get_current_cipher(newssl)),
161 SSL_CIPHER_get_version(SSL_get_current_cipher(newssl)),
164 pthread_setspecific(ThreadSSL, newssl);
165 syslog(LOG_INFO, "SSL started");
170 // shuts down the TLS connection
172 // WARNING: This may make your session vulnerable to a known plaintext
173 // attack in the current implmentation.
176 if (THREADSSL == NULL) {
180 syslog(LOG_INFO, "Ending SSL/TLS");
181 SSL_shutdown(THREADSSL);
182 SSL_get_SSL_CTX(THREADSSL);
184 pthread_setspecific(ThreadSSL, NULL);
188 // Send binary data to the client encrypted.
189 int client_write_ssl(const StrBuf *Buf) {
196 if (THREADSSL == NULL) return -1;
198 nbytes = nremain = StrLength(Buf);
201 while (nremain > 0) {
202 if (SSL_want_write(THREADSSL)) {
203 if ((SSL_read(THREADSSL, junk, 0)) < 1) {
204 syslog(LOG_WARNING, "SSL_read in client_write: %s", ERR_reason_error_string(ERR_get_error()));
207 retval = SSL_write(THREADSSL, &buf[nbytes - nremain], nremain);
211 errval = SSL_get_error(THREADSSL, retval);
212 if (errval == SSL_ERROR_WANT_READ || errval == SSL_ERROR_WANT_WRITE) {
216 syslog(LOG_WARNING, "SSL_write: %s", ERR_reason_error_string(ERR_get_error()));
218 syslog(LOG_WARNING, "errno is %d\n", errno);
229 // read data from the encrypted layer.
230 int client_read_sslbuffer(StrBuf *buf, int timeout) {
231 char sbuf[16384]; // OpenSSL communicates in 16k blocks, so let's speak its native tongue.
234 SSL *pssl = THREADSSL;
236 if (pssl == NULL) return(-1);
239 if (SSL_want_read(pssl)) {
240 if ((SSL_write(pssl, junk, 0)) < 1) {
241 syslog(LOG_WARNING, "SSL_write in client_read");
244 rlen = SSL_read(pssl, sbuf, sizeof(sbuf));
248 errval = SSL_get_error(pssl, rlen);
249 if (errval == SSL_ERROR_WANT_READ || errval == SSL_ERROR_WANT_WRITE) {
253 syslog(LOG_WARNING, "SSL_read in client_read: %s", ERR_reason_error_string(ERR_get_error()));
257 StrBufAppendBufPlain(buf, sbuf, rlen, 0);
263 #endif /* HAVE_OPENSSL */