1 // Copyright (c) 1987-2022 by the citadel.org team
3 // This program is open source software; you can redistribute it and/or modify
4 // 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.
14 #include <sys/types.h>
15 #include "../../sysdep.h"
18 #include <openssl/ssl.h>
19 #include <openssl/err.h>
20 #include <openssl/rand.h>
29 #ifdef HAVE_SYS_SELECT_H
30 #include <sys/select.h>
34 #include <libcitadel.h>
35 #include "../../server.h"
36 #include "serv_crypto.h"
37 #include "../../sysdep_decls.h"
38 #include "../../citadel_defs.h"
39 #include "../../config.h"
40 #include "../../ctdl_module.h"
44 SSL_CTX *ssl_ctx = NULL; // This SSL context is used for all sessions.
45 char *ssl_cipher_list = CIT_CIPHERS;
47 // If a private key does not exist, generate one now.
48 void generate_key(char *keyfilename) {
53 unsigned long e = RSA_F4;
56 if (access(keyfilename, R_OK) == 0) { // Already have one.
57 syslog(LOG_INFO, "crypto: %s exists and is readable", keyfilename);
61 syslog(LOG_INFO, "crypto: generating RSA key pair");
65 ret = BN_set_word(bne,e);
71 ret = RSA_generate_key_ex(rsa, bits, bne, NULL);
77 fp = fopen(keyfilename, "w");
79 chmod(keyfilename, 0600);
80 if (PEM_write_RSAPrivateKey(fp, // the file
83 NULL, // no passphrase
88 syslog(LOG_ERR, "crypto: cannot write key: %s", ERR_reason_error_string(ERR_get_error()));
94 // free the memory we used
101 // If a certificate does not exist, generate a self-signed one now.
102 void generate_certificate(char *keyfilename, char *certfilename) {
103 RSA *private_key = NULL;
104 EVP_PKEY *public_key = NULL;
105 X509_REQ *certificate_signing_request = NULL;
106 X509_NAME *name = NULL;
107 X509 *certificate = NULL;
110 if (access(certfilename, R_OK) == 0) { // already have one.
111 syslog(LOG_INFO, "crypto: %s exists and is readable", certfilename);
115 syslog(LOG_INFO, "crypto: generating a self-signed certificate");
117 // Read in our private key.
118 fp = fopen(keyfilename, "r");
120 private_key = PEM_read_RSAPrivateKey(fp, NULL, NULL, NULL);
125 syslog(LOG_ERR, "crypto: cannot read the private key");
129 // Create a public key from the private key
130 public_key = EVP_PKEY_new();
132 syslog(LOG_ERR, "crypto: cannot allocate public key");
133 RSA_free(private_key);
136 EVP_PKEY_assign_RSA(public_key, private_key);
138 // Create a certificate signing request
139 certificate_signing_request = X509_REQ_new();
140 if (!certificate_signing_request) {
141 syslog(LOG_ERR, "crypto: cannot allocate certificate signing request");
142 RSA_free(private_key);
143 EVP_PKEY_free(public_key);
147 // Assign the public key to the certificate signing request
148 X509_REQ_set_pubkey(certificate_signing_request, public_key);
149 X509_REQ_set_version(certificate_signing_request, 0L);
151 // Tell it who we are
152 name = X509_REQ_get_subject_name(certificate_signing_request);
153 X509_NAME_add_entry_by_txt(name, "C", MBSTRING_ASC, (unsigned const char *)"ZZ", -1, -1, 0);
154 X509_NAME_add_entry_by_txt(name, "ST", MBSTRING_ASC, (unsigned const char *)"The World", -1, -1, 0);
155 X509_NAME_add_entry_by_txt(name, "L", MBSTRING_ASC, (unsigned const char *)"My Location", -1, -1, 0);
156 X509_NAME_add_entry_by_txt(name, "O", MBSTRING_ASC, (unsigned const char *)"Generic certificate", -1, -1, 0);
157 X509_NAME_add_entry_by_txt(name, "OU", MBSTRING_ASC, (unsigned const char *)"Citadel server", -1, -1, 0);
158 X509_NAME_add_entry_by_txt(name, "CN", MBSTRING_ASC, (unsigned const char *)"*", -1, -1, 0);
159 X509_REQ_set_subject_name(certificate_signing_request, name);
162 //if (!X509_REQ_sign(certificate_signing_request, public_key, EVP_md5())) {
163 if (!X509_REQ_sign(certificate_signing_request, public_key, EVP_md5()) , 0) {
164 syslog(LOG_ERR, "crypto: X509_REQ_sign(): error");
165 X509_REQ_free(certificate_signing_request);
166 RSA_free(private_key);
167 EVP_PKEY_free(public_key);
171 // Generate the self-signed certificate
172 certificate = X509_new();
174 syslog(LOG_ERR, "crypto: cannot allocate X.509 certificate");
175 X509_REQ_free(certificate_signing_request);
176 RSA_free(private_key);
177 EVP_PKEY_free(public_key);
181 ASN1_INTEGER_set(X509_get_serialNumber(certificate), 0);
182 X509_set_issuer_name(certificate, X509_REQ_get_subject_name(certificate_signing_request));
183 X509_set_subject_name(certificate, X509_REQ_get_subject_name(certificate_signing_request));
184 X509_gmtime_adj(X509_get_notBefore(certificate), 0);
185 X509_gmtime_adj(X509_get_notAfter(certificate), (long)60*60*24*SIGN_DAYS);
186 X509_set_pubkey(certificate, public_key);
187 X509_REQ_free(certificate_signing_request); // We're done with the CSR; free it
189 // Finally, sign the certificate with our private key.
190 if (!X509_sign(certificate, public_key, EVP_md5())) {
191 syslog(LOG_ERR, "crypto: X509_sign() error");
192 X509_free(certificate);
193 RSA_free(private_key);
194 EVP_PKEY_free(public_key);
198 // Write the certificate to disk
199 fp = fopen(certfilename, "w");
201 chmod(certfilename, 0600);
202 PEM_write_X509(fp, certificate);
206 syslog(LOG_ERR, "crypto: %s: %m", certfilename);
209 X509_free(certificate);
210 EVP_PKEY_free(public_key);
211 // do not RSA_free(private_key); because it was freed by EVP_PKEY_free() above
215 // Set the private key and certificate chain for the global SSL Context.
216 // This is called during initialization, and can be called again later if the certificate changes.
217 void bind_to_key_and_certificate(void) {
219 SSL_CTX *old_ctx = NULL;
220 SSL_CTX *new_ctx = NULL;
222 const SSL_METHOD *method = SSLv23_server_method();
224 syslog(LOG_ERR, "crypto: SSLv23_server_method() failed: %s", ERR_reason_error_string(ERR_get_error()));
228 new_ctx = SSL_CTX_new(method);
230 syslog(LOG_ERR, "crypto: SSL_CTX_new failed: %s", ERR_reason_error_string(ERR_get_error()));
234 if (!(SSL_CTX_set_cipher_list(new_ctx, ssl_cipher_list))) {
235 syslog(LOG_ERR, "crypto: SSL_CTX_set_cipher_list failed: %s", ERR_reason_error_string(ERR_get_error()));
239 syslog(LOG_DEBUG, "crypto: using certificate chain %s", file_crpt_file_cer);
240 if (!SSL_CTX_use_certificate_chain_file(new_ctx, file_crpt_file_cer)) {
241 syslog(LOG_ERR, "crypto: SSL_CTX_use_certificate_chain_file failed: %s", ERR_reason_error_string(ERR_get_error()));
245 syslog(LOG_DEBUG, "crypto: using private key %s", file_crpt_file_key);
246 if (!SSL_CTX_use_PrivateKey_file(new_ctx, file_crpt_file_key, SSL_FILETYPE_PEM)) {
247 syslog(LOG_ERR, "crypto: SSL_CTX_use_PrivateKey_file failed: %s", ERR_reason_error_string(ERR_get_error()));
252 ssl_ctx = new_ctx; // All future binds will use the new certificate
254 if (old_ctx != NULL) {
255 sleep(1); // Hopefully wait until all in-progress binds to the old certificate have completed
256 SSL_CTX_free(old_ctx);
261 // Check the modification time of the key and certificate files. Reload if either one changed.
262 void update_key_and_cert_if_needed(void) {
263 static time_t previous_mtime = 0;
265 struct stat certstat;
267 if (stat(file_crpt_file_key, &keystat) != 0) {
268 syslog(LOG_ERR, "%s: %s", file_crpt_file_key, strerror(errno));
271 if (stat(file_crpt_file_cer, &certstat) != 0) {
272 syslog(LOG_ERR, "%s: %s", file_crpt_file_cer, strerror(errno));
276 if ((keystat.st_mtime + certstat.st_mtime) != previous_mtime) {
277 begin_critical_section(S_OPENSSL);
278 bind_to_key_and_certificate();
279 end_critical_section(S_OPENSSL);
280 previous_mtime = keystat.st_mtime + certstat.st_mtime;
285 // Initialize the TLS subsystem.
286 void init_ssl(void) {
288 // Initialize the OpenSSL library
290 SSL_load_error_strings();
292 // Load (or generate) a key and certificate
293 mkdir(ctdl_key_dir, 0700); // If the keys directory does not exist, create it
294 generate_key(file_crpt_file_key); // If a private key does not exist, create it
295 generate_certificate(file_crpt_file_key, file_crpt_file_cer); // If a certificate does not exist, create it
296 bind_to_key_and_certificate(); // Load key and cert from disk, and bind to them.
298 // Register some Citadel protocol commands for dealing with encrypted sessions
299 CtdlRegisterProtoHook(cmd_stls, "STLS", "Start TLS session");
300 CtdlRegisterProtoHook(cmd_gtls, "GTLS", "Get TLS session status");
301 CtdlRegisterSessionHook(endtls, EVT_STOP, PRIO_STOP + 10);
305 // client_write_ssl() Send binary data to the client encrypted.
306 void client_write_ssl(const char *buf, int nbytes) {
313 while (nremain > 0) {
314 if (SSL_want_write(CC->ssl)) {
315 if ((SSL_read(CC->ssl, junk, 0)) < 1) {
316 syslog(LOG_DEBUG, "crypto: SSL_read in client_write: %s", ERR_reason_error_string(ERR_get_error()));
320 SSL_write(CC->ssl, &buf[nbytes - nremain], nremain);
324 errval = SSL_get_error(CC->ssl, retval);
325 if (errval == SSL_ERROR_WANT_READ || errval == SSL_ERROR_WANT_WRITE) {
329 syslog(LOG_DEBUG, "crypto: SSL_write got error %ld, ret %d", errval, retval);
331 syslog(LOG_DEBUG, "crypto: errno is %d", errno);
334 client_write(&buf[nbytes - nremain], nremain);
342 // read data from the encrypted layer.
343 int client_read_sslbuffer(StrBuf *buf, int timeout) {
344 char sbuf[16384]; // OpenSSL communicates in 16k blocks, so let's speak its native tongue.
349 if (pssl == NULL) return(-1);
352 if (SSL_want_read(pssl)) {
353 if ((SSL_write(pssl, junk, 0)) < 1) {
354 syslog(LOG_DEBUG, "crypto: SSL_write in client_read");
357 rlen = SSL_read(pssl, sbuf, sizeof(sbuf));
361 errval = SSL_get_error(pssl, rlen);
362 if (errval == SSL_ERROR_WANT_READ || errval == SSL_ERROR_WANT_WRITE) {
366 syslog(LOG_DEBUG, "crypto: SSL_read got error %ld", errval);
370 StrBufAppendBufPlain(buf, sbuf, rlen, 0);
377 int client_readline_sslbuffer(StrBuf *Line, StrBuf *IOBuf, const char **Pos, int timeout) {
378 const char *pos = NULL;
381 int nSuccessLess = 0;
382 const char *pch = NULL;
384 if ((Line == NULL) || (Pos == NULL) || (IOBuf == NULL)) {
392 if ((StrLength(IOBuf) > 0) && (pos != NULL) && (pos < ChrPtr(IOBuf) + StrLength(IOBuf))) {
394 pch = strchr(pch, '\n');
397 StrBufAppendBufPlain(Line, pos, StrLength(IOBuf) - (pos - ChrPtr(IOBuf)), 0);
403 if ((pch > ChrPtr(IOBuf)) && (*(pch - 1) == '\r')) {
406 StrBufAppendBufPlain(Line, pos, (pch - pos - n), 0);
408 if (StrLength(IOBuf) <= (pch - ChrPtr(IOBuf) + 1)) {
415 return StrLength(Line);
420 while ((nSuccessLess < timeout) && (pLF == NULL) && (CC->ssl != NULL)) {
422 rlen = client_read_sslbuffer(IOBuf, timeout);
427 pLF = strchr(ChrPtr(IOBuf), '\n');
434 if (len > 0 && (*(pLF - 1) == '\r') )
436 StrBufAppendBufPlain(Line, pos, len, 0);
437 if (pLF + 1 >= ChrPtr(IOBuf) + StrLength(IOBuf)) {
443 return StrLength(Line);
449 int client_read_sslblob(StrBuf *Target, long bytes, int timeout) {
454 baselen = StrLength(Target);
456 if (StrLength(CC->RecvBuf.Buf) > 0) {
461 if (CC->RecvBuf.ReadWritePointer == NULL) {
462 CC->RecvBuf.ReadWritePointer = ChrPtr(CC->RecvBuf.Buf);
464 pchs = ChrPtr(CC->RecvBuf.Buf);
465 TotalLen = StrLength(CC->RecvBuf.Buf);
466 RemainLen = TotalLen - (pchs - CC->RecvBuf.ReadWritePointer);
467 if (RemainLen > bytes) {
471 StrBufAppendBufPlain(Target, CC->RecvBuf.ReadWritePointer, RemainLen, 0);
472 CC->RecvBuf.ReadWritePointer += RemainLen;
474 if ((ChrPtr(CC->RecvBuf.Buf) + StrLength(CC->RecvBuf.Buf)) <= CC->RecvBuf.ReadWritePointer) {
475 CC->RecvBuf.ReadWritePointer = NULL;
476 FlushStrBuf(CC->RecvBuf.Buf);
480 if (StrLength(Target) >= bytes + baselen) {
484 CC->RecvBuf.ReadWritePointer = NULL;
486 while ((StrLength(Target) < bytes + baselen) && (retval >= 0)) {
487 retval = client_read_sslbuffer(CC->RecvBuf.Buf, timeout);
489 RemainRead = bytes - (StrLength (Target) - baselen);
490 if (RemainRead < StrLength(CC->RecvBuf.Buf)) {
491 StrBufAppendBufPlain(
493 ChrPtr(CC->RecvBuf.Buf),
495 CC->RecvBuf.ReadWritePointer = ChrPtr(CC->RecvBuf.Buf) + RemainRead;
498 StrBufAppendBuf(Target, CC->RecvBuf.Buf, 0);
499 FlushStrBuf(CC->RecvBuf.Buf);
502 FlushStrBuf(CC->RecvBuf.Buf);
511 // CtdlStartTLS() starts TLS encryption for the current session. It
512 // must be supplied with pre-generated strings for responses of "ok," "no
513 // support for TLS," and "error" so that we can use this in any protocol.
514 void CtdlStartTLS(char *ok_response, char *nosup_response, char *error_response) {
515 int retval, bits, alg_bits;
517 if (CC->redirect_ssl) {
518 syslog(LOG_ERR, "crypto: attempt to begin SSL on an already encrypted connection");
519 if (error_response != NULL) {
520 cprintf("%s", error_response);
526 syslog(LOG_ERR, "crypto: SSL failed: ../../context.has not been initialized");
527 if (nosup_response != NULL) {
528 cprintf("%s", nosup_response);
533 update_key_and_cert_if_needed(); // did someone update the key or cert? if so, re-bind them
535 if (!(CC->ssl = SSL_new(ssl_ctx))) {
536 syslog(LOG_ERR, "crypto: SSL_new failed: %s", ERR_reason_error_string(ERR_get_error()));
537 if (error_response != NULL) {
538 cprintf("%s", error_response);
542 if (!(SSL_set_fd(CC->ssl, CC->client_socket))) {
543 syslog(LOG_ERR, "crypto: SSL_set_fd failed: %s", ERR_reason_error_string(ERR_get_error()));
546 if (error_response != NULL) {
547 cprintf("%s", error_response);
551 if (ok_response != NULL) {
552 cprintf("%s", ok_response);
554 retval = SSL_accept(CC->ssl);
556 // Can't notify the client of an error here; they will
557 // discover the problem at the SSL layer and should
558 // revert to unencrypted communications.
559 syslog(LOG_ERR, "crypto: SSL_accept failed: %s", ERR_reason_error_string(ERR_get_error()));
564 bits = SSL_CIPHER_get_bits(SSL_get_current_cipher(CC->ssl), &alg_bits);
565 syslog(LOG_INFO, "crypto: TLS using %s on %s (%d of %d bits)",
566 SSL_CIPHER_get_name(SSL_get_current_cipher(CC->ssl)),
567 SSL_CIPHER_get_version(SSL_get_current_cipher(CC->ssl)),
570 CC->redirect_ssl = 1;
574 // cmd_stls() starts TLS encryption for the current session
575 void cmd_stls(char *params) {
576 char ok_response[SIZ];
577 char nosup_response[SIZ];
578 char error_response[SIZ];
582 sprintf(ok_response, "%d Begin TLS negotiation now\n", CIT_OK);
583 sprintf(nosup_response, "%d TLS not supported here\n", ERROR + CMD_NOT_SUPPORTED);
584 sprintf(error_response, "%d TLS negotiation error\n", ERROR + INTERNAL_ERROR);
586 CtdlStartTLS(ok_response, nosup_response, error_response);
590 // cmd_gtls() returns status info about the TLS connection
591 void cmd_gtls(char *params) {
594 if (!CC->ssl || !CC->redirect_ssl) {
595 cprintf("%d Session is not encrypted.\n", ERROR);
598 bits = SSL_CIPHER_get_bits(SSL_get_current_cipher(CC->ssl), &alg_bits);
599 cprintf("%d %s|%s|%d|%d\n", CIT_OK,
600 SSL_CIPHER_get_version(SSL_get_current_cipher(CC->ssl)),
601 SSL_CIPHER_get_name(SSL_get_current_cipher(CC->ssl)),
606 // endtls() shuts down the TLS connection
609 CC->redirect_ssl = 0;
613 syslog(LOG_INFO, "crypto: ending TLS on this session");
614 SSL_shutdown(CC->ssl);
617 CC->redirect_ssl = 0;
620 #endif // HAVE_OPENSSL