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>
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>
36 #include "serv_crypto.h"
37 #include "sysdep_decls.h"
40 #include "ctdl_module.h"
43 SSL_CTX *ssl_ctx; // SSL context for all sessions
46 // If a private key does not exist, generate one now.
47 void generate_key(char *keyfilename) {
52 unsigned long e = RSA_F4;
55 if (access(keyfilename, R_OK) == 0) { // Already have one.
59 syslog(LOG_INFO, "crypto: generating RSA key pair");
63 ret = BN_set_word(bne,e);
69 ret = RSA_generate_key_ex(rsa, bits, bne, NULL);
75 fp = fopen(keyfilename, "w");
77 chmod(keyfilename, 0600);
78 if (PEM_write_RSAPrivateKey(fp, // the file
81 NULL, // no passphrase
86 syslog(LOG_ERR, "crypto: cannot write key: %s", ERR_reason_error_string(ERR_get_error()));
92 // free the memory we used
99 // If a certificate does not exist, generate a self-signed one now.
100 void generate_certificate(char *keyfilename, char *certfilename) {
101 RSA *private_key = NULL;
102 EVP_PKEY *public_key = NULL;
103 X509_REQ *certificate_signing_request = NULL;
104 X509_NAME *name = NULL;
105 X509 *certificate = NULL;
108 if (access(certfilename, R_OK) == 0) { // already have one.
112 syslog(LOG_INFO, "crypto: generating a self-signed certificate");
114 // Read in our private key.
115 fp = fopen(keyfilename, "r");
117 private_key = PEM_read_RSAPrivateKey(fp, NULL, NULL, NULL);
122 syslog(LOG_ERR, "crypto: cannot read the private key");
126 // Create a public key from the private key
127 public_key = EVP_PKEY_new();
129 syslog(LOG_ERR, "crypto: cannot allocate public key");
130 RSA_free(private_key);
133 EVP_PKEY_assign_RSA(public_key, private_key);
135 // Create a certificate signing request
136 certificate_signing_request = X509_REQ_new();
137 if (!certificate_signing_request) {
138 syslog(LOG_ERR, "crypto: cannot allocate certificate signing request");
139 RSA_free(private_key);
140 EVP_PKEY_free(public_key);
144 // Assign the public key to the certificate signing request
145 X509_REQ_set_pubkey(certificate_signing_request, public_key);
146 X509_REQ_set_version(certificate_signing_request, 0L);
148 // Tell it who we are
149 name = X509_REQ_get_subject_name(certificate_signing_request);
150 X509_NAME_add_entry_by_txt(name, "C", MBSTRING_ASC, (unsigned const char *)"ZZ", -1, -1, 0);
151 X509_NAME_add_entry_by_txt(name, "ST", MBSTRING_ASC, (unsigned const char *)"The World", -1, -1, 0);
152 X509_NAME_add_entry_by_txt(name, "L", MBSTRING_ASC, (unsigned const char *)"My Location", -1, -1, 0);
153 X509_NAME_add_entry_by_txt(name, "O", MBSTRING_ASC, (unsigned const char *)"Generic certificate", -1, -1, 0);
154 X509_NAME_add_entry_by_txt(name, "OU", MBSTRING_ASC, (unsigned const char *)"Citadel server", -1, -1, 0);
155 X509_NAME_add_entry_by_txt(name, "CN", MBSTRING_ASC, (unsigned const char *)"*", -1, -1, 0);
156 X509_REQ_set_subject_name(certificate_signing_request, name);
159 if (!X509_REQ_sign(certificate_signing_request, public_key, EVP_md5())) {
160 syslog(LOG_ERR, "crypto: X509_REQ_sign(): error");
161 X509_REQ_free(certificate_signing_request);
162 RSA_free(private_key);
163 EVP_PKEY_free(public_key);
167 // Generate the self-signed certificate
168 certificate = X509_new();
170 syslog(LOG_ERR, "crypto: cannot allocate X.509 certificate");
171 X509_REQ_free(certificate_signing_request);
172 RSA_free(private_key);
173 EVP_PKEY_free(public_key);
177 ASN1_INTEGER_set(X509_get_serialNumber(certificate), 0);
178 X509_set_issuer_name(certificate, X509_REQ_get_subject_name(certificate_signing_request));
179 X509_set_subject_name(certificate, X509_REQ_get_subject_name(certificate_signing_request));
180 X509_gmtime_adj(X509_get_notBefore(certificate), 0);
181 X509_gmtime_adj(X509_get_notAfter(certificate), (long)60*60*24*SIGN_DAYS);
182 X509_set_pubkey(certificate, public_key);
183 X509_REQ_free(certificate_signing_request); // We're done with the CSR; free it
185 // Finally, sign the certificate with our private key.
186 if (!X509_sign(certificate, public_key, EVP_md5())) {
187 syslog(LOG_ERR, "crypto: X509_sign() error");
188 X509_free(certificate);
189 RSA_free(private_key);
190 EVP_PKEY_free(public_key);
194 // Write the certificate to disk
195 fp = fopen(certfilename, "w");
197 chmod(certfilename, 0600);
198 PEM_write_X509(fp, certificate);
202 syslog(LOG_ERR, "crypto: %s: %m", certfilename);
205 X509_free(certificate);
206 EVP_PKEY_free(public_key);
207 // RSA_free(private_key); // private_key is freed by EVP_PKEY_free() above
211 // Set the private key and certificate chain for the global SSL Context.
212 // This is called during initialization, and can be called again later if the certificate changes.
213 void bind_to_key_and_certificate(void) {
215 syslog(LOG_DEBUG, "crypto: using certificate chain %s", file_crpt_file_cer);
216 SSL_CTX_use_certificate_chain_file(ssl_ctx, file_crpt_file_cer);
218 syslog(LOG_DEBUG, "crypto: using private key %s", file_crpt_file_key);
219 SSL_CTX_use_PrivateKey_file(ssl_ctx, file_crpt_file_key, SSL_FILETYPE_PEM);
220 if ( !SSL_CTX_check_private_key(ssl_ctx) ) {
221 syslog(LOG_ERR, "crypto: cannot install certificate: %s", ERR_reason_error_string(ERR_get_error()));
226 // Check the modification time of the key and certificate files. Reload if either one changed.
227 void update_key_and_cert_if_needed(void) {
228 static time_t previous_mtime = 0;
230 struct stat certstat;
232 if (stat(file_crpt_file_key, &keystat) != 0) {
233 syslog(LOG_ERR, "%s: %s", file_crpt_file_key, strerror(errno));
236 if (stat(file_crpt_file_cer, &certstat) != 0) {
237 syslog(LOG_ERR, "%s: %s", file_crpt_file_cer, strerror(errno));
241 if ((keystat.st_mtime + certstat.st_mtime) != previous_mtime) {
242 bind_to_key_and_certificate();
243 previous_mtime = keystat.st_mtime + certstat.st_mtime;
248 // Initialize the SSL/TLS subsystem.
249 void init_ssl(void) {
250 SSL_library_init(); // Initialize SSL transport layer
251 SSL_load_error_strings();
252 if (!(ssl_ctx = SSL_CTX_new(SSLv23_server_method()))) {
253 syslog(LOG_ERR, "crypto: SSL_CTX_new failed: %s", ERR_reason_error_string(ERR_get_error()));
256 if (!(SSL_CTX_set_cipher_list(ssl_ctx, CIT_CIPHERS))) {
257 syslog(LOG_ERR, "crypto: No ciphers available");
258 SSL_CTX_free(ssl_ctx);
263 mkdir(ctdl_key_dir, 0700); // If the keys directory does not exist, create it
264 generate_key(file_crpt_file_key); // If a private key does not exist, create it
265 generate_certificate(file_crpt_file_key, file_crpt_file_cer); // If a certificate does not exist, create it
266 bind_to_key_and_certificate(); // Load key and cert from disk, and bind to them.
268 // Finally let the server know we're here
269 CtdlRegisterProtoHook(cmd_stls, "STLS", "Start SSL/TLS session");
270 CtdlRegisterProtoHook(cmd_gtls, "GTLS", "Get SSL/TLS session status");
271 CtdlRegisterSessionHook(endtls, EVT_STOP, PRIO_STOP + 10);
275 // client_write_ssl() Send binary data to the client encrypted.
276 void client_write_ssl(const char *buf, int nbytes) {
283 while (nremain > 0) {
284 if (SSL_want_write(CC->ssl)) {
285 if ((SSL_read(CC->ssl, junk, 0)) < 1) {
286 syslog(LOG_DEBUG, "crypto: SSL_read in client_write: %s", ERR_reason_error_string(ERR_get_error()));
290 SSL_write(CC->ssl, &buf[nbytes - nremain], nremain);
294 errval = SSL_get_error(CC->ssl, retval);
295 if (errval == SSL_ERROR_WANT_READ ||
296 errval == SSL_ERROR_WANT_WRITE) {
300 syslog(LOG_DEBUG, "crypto: SSL_write got error %ld, ret %d", errval, retval);
302 syslog(LOG_DEBUG, "crypto: errno is %d", errno);
305 client_write(&buf[nbytes - nremain], nremain);
313 // read data from the encrypted layer.
314 int client_read_sslbuffer(StrBuf *buf, int timeout) {
315 char sbuf[16384]; // OpenSSL communicates in 16k blocks, so let's speak its native tongue.
320 if (pssl == NULL) return(-1);
323 if (SSL_want_read(pssl)) {
324 if ((SSL_write(pssl, junk, 0)) < 1) {
325 syslog(LOG_DEBUG, "crypto: SSL_write in client_read");
328 rlen = SSL_read(pssl, sbuf, sizeof(sbuf));
332 errval = SSL_get_error(pssl, rlen);
333 if (errval == SSL_ERROR_WANT_READ || errval == SSL_ERROR_WANT_WRITE) {
337 syslog(LOG_DEBUG, "crypto: SSL_read got error %ld", errval);
341 StrBufAppendBufPlain(buf, sbuf, rlen, 0);
348 int client_readline_sslbuffer(StrBuf *Line, StrBuf *IOBuf, const char **Pos, int timeout) {
349 const char *pos = NULL;
352 int nSuccessLess = 0;
353 const char *pch = NULL;
355 if ((Line == NULL) || (Pos == NULL) || (IOBuf == NULL)) {
363 if ((StrLength(IOBuf) > 0) && (pos != NULL) && (pos < ChrPtr(IOBuf) + StrLength(IOBuf))) {
365 pch = strchr(pch, '\n');
368 StrBufAppendBufPlain(Line, pos, StrLength(IOBuf) - (pos - ChrPtr(IOBuf)), 0);
374 if ((pch > ChrPtr(IOBuf)) &&
375 (*(pch - 1) == '\r')) {
378 StrBufAppendBufPlain(Line, pos,
381 if (StrLength(IOBuf) <= (pch - ChrPtr(IOBuf) + 1)) {
387 return StrLength(Line);
392 while ((nSuccessLess < timeout) &&
396 rlen = client_read_sslbuffer(IOBuf, timeout);
401 pLF = strchr(ChrPtr(IOBuf), '\n');
408 if (len > 0 && (*(pLF - 1) == '\r') )
410 StrBufAppendBufPlain(Line, pos, len, 0);
411 if (pLF + 1 >= ChrPtr(IOBuf) + StrLength(IOBuf))
417 return StrLength(Line);
423 int client_read_sslblob(StrBuf *Target, long bytes, int timeout) {
428 baselen = StrLength(Target);
430 if (StrLength(CC->RecvBuf.Buf) > 0) {
435 if (CC->RecvBuf.ReadWritePointer == NULL) {
436 CC->RecvBuf.ReadWritePointer = ChrPtr(CC->RecvBuf.Buf);
438 pchs = ChrPtr(CC->RecvBuf.Buf);
439 TotalLen = StrLength(CC->RecvBuf.Buf);
440 RemainLen = TotalLen - (pchs - CC->RecvBuf.ReadWritePointer);
441 if (RemainLen > bytes) {
445 StrBufAppendBufPlain(Target, CC->RecvBuf.ReadWritePointer, RemainLen, 0);
446 CC->RecvBuf.ReadWritePointer += RemainLen;
448 if ((ChrPtr(CC->RecvBuf.Buf) + StrLength(CC->RecvBuf.Buf)) <= CC->RecvBuf.ReadWritePointer) {
449 CC->RecvBuf.ReadWritePointer = NULL;
450 FlushStrBuf(CC->RecvBuf.Buf);
454 if (StrLength(Target) >= bytes + baselen) {
458 CC->RecvBuf.ReadWritePointer = NULL;
460 while ((StrLength(Target) < bytes + baselen) && (retval >= 0)) {
461 retval = client_read_sslbuffer(CC->RecvBuf.Buf, timeout);
463 RemainRead = bytes - (StrLength (Target) - baselen);
464 if (RemainRead < StrLength(CC->RecvBuf.Buf)) {
465 StrBufAppendBufPlain(
467 ChrPtr(CC->RecvBuf.Buf),
469 CC->RecvBuf.ReadWritePointer = ChrPtr(CC->RecvBuf.Buf) + RemainRead;
472 StrBufAppendBuf(Target, CC->RecvBuf.Buf, 0); // todo: Buf > bytes?
473 FlushStrBuf(CC->RecvBuf.Buf);
476 FlushStrBuf(CC->RecvBuf.Buf);
485 // CtdlStartTLS() starts SSL/TLS encryption for the current session. It
486 // must be supplied with pre-generated strings for responses of "ok," "no
487 // support for TLS," and "error" so that we can use this in any protocol.
488 void CtdlStartTLS(char *ok_response, char *nosup_response, char *error_response) {
489 int retval, bits, alg_bits;
491 if (CC->redirect_ssl) {
492 syslog(LOG_ERR, "crypto: attempt to begin SSL on an already encrypted connection");
493 if (error_response != NULL) {
494 cprintf("%s", error_response);
500 syslog(LOG_ERR, "crypto: SSL failed: context has not been initialized");
501 if (nosup_response != NULL) {
502 cprintf("%s", nosup_response);
507 update_key_and_cert_if_needed(); // did someone update the key or cert? if so, re-bind them
509 if (!(CC->ssl = SSL_new(ssl_ctx))) {
510 syslog(LOG_ERR, "crypto: SSL_new failed: %s", ERR_reason_error_string(ERR_get_error()));
511 if (error_response != NULL) {
512 cprintf("%s", error_response);
516 if (!(SSL_set_fd(CC->ssl, CC->client_socket))) {
517 syslog(LOG_ERR, "crypto: SSL_set_fd failed: %s", ERR_reason_error_string(ERR_get_error()));
520 if (error_response != NULL) {
521 cprintf("%s", error_response);
525 if (ok_response != NULL) {
526 cprintf("%s", ok_response);
528 retval = SSL_accept(CC->ssl);
530 // Can't notify the client of an error here; they will
531 // discover the problem at the SSL layer and should
532 // revert to unencrypted communications.
534 char error_string[128];
536 errval = SSL_get_error(CC->ssl, retval);
537 syslog(LOG_ERR, "crypto: SSL_accept failed: retval=%d, errval=%ld, err=%s",
540 ERR_error_string(errval, error_string)
546 bits = SSL_CIPHER_get_bits(SSL_get_current_cipher(CC->ssl), &alg_bits);
547 syslog(LOG_INFO, "crypto: SSL/TLS using %s on %s (%d of %d bits)",
548 SSL_CIPHER_get_name(SSL_get_current_cipher(CC->ssl)),
549 SSL_CIPHER_get_version(SSL_get_current_cipher(CC->ssl)),
552 CC->redirect_ssl = 1;
556 // cmd_stls() starts SSL/TLS encryption for the current session
557 void cmd_stls(char *params) {
558 char ok_response[SIZ];
559 char nosup_response[SIZ];
560 char error_response[SIZ];
564 sprintf(ok_response, "%d Begin TLS negotiation now\n", CIT_OK);
565 sprintf(nosup_response, "%d TLS not supported here\n", ERROR + CMD_NOT_SUPPORTED);
566 sprintf(error_response, "%d TLS negotiation error\n", ERROR + INTERNAL_ERROR);
568 CtdlStartTLS(ok_response, nosup_response, error_response);
572 // cmd_gtls() returns status info about the TLS connection
573 void cmd_gtls(char *params) {
576 if (!CC->ssl || !CC->redirect_ssl) {
577 cprintf("%d Session is not encrypted.\n", ERROR);
581 SSL_CIPHER_get_bits(SSL_get_current_cipher(CC->ssl),
583 cprintf("%d %s|%s|%d|%d\n", CIT_OK,
584 SSL_CIPHER_get_version(SSL_get_current_cipher(CC->ssl)),
585 SSL_CIPHER_get_name(SSL_get_current_cipher(CC->ssl)),
590 // endtls() shuts down the TLS connection
592 // WARNING: This may make your session vulnerable to a known plaintext
593 // attack in the current implmentation.
596 CC->redirect_ssl = 0;
600 syslog(LOG_INFO, "crypto: ending SSL/TLS");
601 SSL_shutdown(CC->ssl);
604 CC->redirect_ssl = 0;
607 #endif // HAVE_OPENSSL