5 * \defgroup https Provides HTTPS, when the OpenSSL library is available.
6 * \ingroup WebcitHttpServer
14 #include "webserver.h"
16 /** where to find the keys */
17 #define CTDL_CRYPTO_DIR "./keys"
18 #define CTDL_KEY_PATH CTDL_CRYPTO_DIR "/citadel.key" /**< the key */
19 #define CTDL_CSR_PATH CTDL_CRYPTO_DIR "/citadel.csr" /**< the csr file */
20 #define CTDL_CER_PATH CTDL_CRYPTO_DIR "/citadel.cer" /**< the cer file */
21 #define SIGN_DAYS 365 /**< how long our certificate should live */
23 SSL_CTX *ssl_ctx; /**< SSL context */
24 pthread_mutex_t **SSLCritters; /**< Things needing locking */
26 pthread_key_t ThreadSSL; /**< Per-thread SSL context */
30 * \return thread id???
32 static unsigned long id_callback(void)
34 return (unsigned long) pthread_self();
38 * \brief initialize ssl engine
39 * load certs and initialize openssl internals
43 SSL_METHOD *ssl_method;
48 EVP_PKEY *req_pkey = NULL;
49 X509_NAME *name = NULL;
53 if (!access("/var/run/egd-pool", F_OK))
54 RAND_egd("/var/run/egd-pool");
58 "PRNG not adequately seeded, won't do SSL/TLS\n");
62 malloc(CRYPTO_num_locks() * sizeof(pthread_mutex_t *));
64 lprintf(1, "citserver: can't allocate memory!!\n");
65 /* Nothing's been initialized, just die */
70 for (a = 0; a < CRYPTO_num_locks(); a++) {
71 SSLCritters[a] = malloc(sizeof(pthread_mutex_t));
72 if (!SSLCritters[a]) {
74 "citserver: can't allocate memory!!\n");
75 /** Nothing's been initialized, just die */
78 pthread_mutex_init(SSLCritters[a], NULL);
83 * Initialize SSL transport layer
86 SSL_load_error_strings();
87 ssl_method = SSLv23_server_method();
88 if (!(ssl_ctx = SSL_CTX_new(ssl_method))) {
89 lprintf(3, "SSL_CTX_new failed: %s\n",
90 ERR_reason_error_string(ERR_get_error()));
94 CRYPTO_set_locking_callback(ssl_lock);
95 CRYPTO_set_id_callback(id_callback);
98 * Get our certificates in order. \todo dirify. this is a setup job.
99 * First, create the key/cert directory if it's not there already...
101 mkdir(CTDL_CRYPTO_DIR, 0700);
104 * Before attempting to generate keys/certificates, first try
105 * link to them from the Citadel server if it's on the same host.
106 * We ignore any error return because it either meant that there
107 * was nothing in Citadel to link from (in which case we just
108 * generate new files) or the target files already exist (which
109 * is not fatal either). \todo dirify
111 if (!strcasecmp(ctdlhost, "uds")) {
112 sprintf(buf, "%s/keys/citadel.key", ctdlport);
113 symlink(buf, CTDL_KEY_PATH);
114 sprintf(buf, "%s/keys/citadel.csr", ctdlport);
115 symlink(buf, CTDL_CSR_PATH);
116 sprintf(buf, "%s/keys/citadel.cer", ctdlport);
117 symlink(buf, CTDL_CER_PATH);
121 * If we still don't have a private key, generate one.
123 if (access(CTDL_KEY_PATH, R_OK) != 0) {
124 lprintf(5, "Generating RSA key pair.\n");
125 rsa = RSA_generate_key(1024, /**< modulus size */
126 65537, /**< exponent */
127 NULL, /**< no callback */
128 NULL); /**< no callback */
130 lprintf(3, "Key generation failed: %s\n",
131 ERR_reason_error_string(ERR_get_error()));
134 fp = fopen(CTDL_KEY_PATH, "w");
136 chmod(CTDL_KEY_PATH, 0600);
137 if (PEM_write_RSAPrivateKey(fp, /**< the file */
140 NULL, /**< no passphr */
141 0, /**< no passphr */
142 NULL, /**< no callbk */
143 NULL /**< no callbk */
145 lprintf(3, "Cannot write key: %s\n",
146 ERR_reason_error_string(ERR_get_error()));
147 unlink(CTDL_KEY_PATH);
156 * Generate a CSR if we don't have one.
158 if (access(CTDL_CSR_PATH, R_OK) != 0) {
159 lprintf(5, "Generating a certificate signing request.\n");
162 * Read our key from the file. No, we don't just keep this
163 * in memory from the above key-generation function, because
164 * there is the possibility that the key was already on disk
165 * and we didn't just generate it now.
167 fp = fopen(CTDL_KEY_PATH, "r");
169 rsa = PEM_read_RSAPrivateKey(fp, NULL, NULL, NULL);
175 /** Create a public key from the private key */
176 if (pk=EVP_PKEY_new(), pk != NULL) {
177 EVP_PKEY_assign_RSA(pk, rsa);
178 if (req = X509_REQ_new(), req != NULL) {
180 /** Set the public key */
181 X509_REQ_set_pubkey(req, pk);
182 X509_REQ_set_version(req, 0L);
184 name = X509_REQ_get_subject_name(req);
186 /** Tell it who we are */
189 X509_NAME_add_entry_by_txt(name, "C",
190 MBSTRING_ASC, "US", -1, -1, 0);
192 X509_NAME_add_entry_by_txt(name, "ST",
193 MBSTRING_ASC, "New York", -1, -1, 0);
195 X509_NAME_add_entry_by_txt(name, "L",
196 MBSTRING_ASC, "Mount Kisco", -1, -1, 0);
199 X509_NAME_add_entry_by_txt(name, "O",
200 MBSTRING_ASC, "FIXME.FIXME.org", -1, -1, 0);
202 X509_NAME_add_entry_by_txt(name, "OU",
203 MBSTRING_ASC, "Citadel server", -1, -1, 0);
205 X509_NAME_add_entry_by_txt(name, "CN",
206 MBSTRING_ASC, "FIXME.FIXME.org", -1, -1, 0);
208 X509_REQ_set_subject_name(req, name);
211 if (!X509_REQ_sign(req, pk, EVP_md5())) {
212 lprintf(3, "X509_REQ_sign(): error\n");
215 /** Write it to disk. */
216 fp = fopen(CTDL_CSR_PATH, "w");
218 chmod(CTDL_CSR_PATH, 0600);
219 PEM_write_X509_REQ(fp, req);
232 lprintf(3, "Unable to read private key.\n");
239 * Generate a self-signed certificate if we don't have one.
241 if (access(CTDL_CER_PATH, R_OK) != 0) {
242 lprintf(5, "Generating a self-signed certificate.\n");
244 /** Same deal as before: always read the key from disk because
245 * it may or may not have just been generated.
247 fp = fopen(CTDL_KEY_PATH, "r");
249 rsa = PEM_read_RSAPrivateKey(fp, NULL, NULL, NULL);
253 /** This also holds true for the CSR. */
258 if (pk=EVP_PKEY_new(), pk != NULL) {
259 EVP_PKEY_assign_RSA(pk, rsa);
262 fp = fopen(CTDL_CSR_PATH, "r");
264 req = PEM_read_X509_REQ(fp, NULL, NULL, NULL);
269 if (cer = X509_new(), cer != NULL) {
271 ASN1_INTEGER_set(X509_get_serialNumber(cer), 0);
272 X509_set_issuer_name(cer, req->req_info->subject);
273 X509_set_subject_name(cer, req->req_info->subject);
274 X509_gmtime_adj(X509_get_notBefore(cer), 0);
275 X509_gmtime_adj(X509_get_notAfter(cer),(long)60*60*24*SIGN_DAYS);
277 req_pkey = X509_REQ_get_pubkey(req);
278 X509_set_pubkey(cer, req_pkey);
279 EVP_PKEY_free(req_pkey);
282 if (!X509_sign(cer, pk, EVP_md5())) {
283 lprintf(3, "X509_sign(): error\n");
286 /** Write it to disk. */
287 fp = fopen(CTDL_CER_PATH, "w");
289 chmod(CTDL_CER_PATH, 0600);
290 PEM_write_X509(fp, cer);
303 * Now try to bind to the key and certificate.
304 * Note that we use SSL_CTX_use_certificate_chain_file() which allows
305 * the certificate file to contain intermediate certificates.
307 SSL_CTX_use_certificate_chain_file(ssl_ctx, CTDL_CER_PATH);
308 SSL_CTX_use_PrivateKey_file(ssl_ctx, CTDL_KEY_PATH, SSL_FILETYPE_PEM);
309 if ( !SSL_CTX_check_private_key(ssl_ctx) ) {
310 lprintf(3, "Cannot install certificate: %s\n",
311 ERR_reason_error_string(ERR_get_error()));
318 * \brief starts SSL/TLS encryption for the current session.
319 * \param sock the socket connection
320 * \return Zero if the SSL/TLS handshake succeeded, non-zero otherwise.
322 int starttls(int sock) {
323 int retval, bits, alg_bits;
326 pthread_setspecific(ThreadSSL, NULL);
331 if (!(newssl = SSL_new(ssl_ctx))) {
332 lprintf(3, "SSL_new failed: %s\n",
333 ERR_reason_error_string(ERR_get_error()));
336 if (!(SSL_set_fd(newssl, sock))) {
337 lprintf(3, "SSL_set_fd failed: %s\n",
338 ERR_reason_error_string(ERR_get_error()));
342 retval = SSL_accept(newssl);
345 * Can't notify the client of an error here; they will
346 * discover the problem at the SSL layer and should
347 * revert to unencrypted communications.
351 errval = SSL_get_error(newssl, retval);
352 lprintf(3, "SSL_accept failed: %s\n",
353 ERR_reason_error_string(ERR_get_error()));
358 BIO_set_close(newssl->rbio, BIO_NOCLOSE);
360 SSL_CIPHER_get_bits(SSL_get_current_cipher(newssl),
362 lprintf(5, "SSL/TLS using %s on %s (%d of %d bits)\n",
363 SSL_CIPHER_get_name(SSL_get_current_cipher(newssl)),
364 SSL_CIPHER_get_version(SSL_get_current_cipher(newssl)),
367 pthread_setspecific(ThreadSSL, newssl);
374 * \brief shuts down the TLS connection
376 * WARNING: This may make your session vulnerable to a known plaintext
377 * attack in the current implmentation.
383 if (THREADSSL == NULL) return;
385 lprintf(5, "Ending SSL/TLS\n");
386 SSL_shutdown(THREADSSL);
387 ctx = SSL_get_SSL_CTX(THREADSSL);
392 pthread_setspecific(ThreadSSL, NULL);
397 * \brief callback for OpenSSL mutex locks
398 * \param mode which mode??????
399 * \param n how many???
400 * \param file which filename ???
401 * \param line what line????
403 void ssl_lock(int mode, int n, const char *file, int line)
405 if (mode & CRYPTO_LOCK)
406 pthread_mutex_lock(SSLCritters[n]);
408 pthread_mutex_unlock(SSLCritters[n]);
412 * \brief Send binary data to the client encrypted.
413 * \param buf chars to send to the client
414 * \param nbytes how many chars
416 void client_write_ssl(char *buf, int nbytes)
422 if (THREADSSL == NULL) return;
426 while (nremain > 0) {
427 if (SSL_want_write(THREADSSL)) {
428 if ((SSL_read(THREADSSL, junk, 0)) < 1) {
429 lprintf(9, "SSL_read in client_write: %s\n",
430 ERR_reason_error_string(ERR_get_error()));
433 retval = SSL_write(THREADSSL, &buf[nbytes - nremain], nremain);
437 errval = SSL_get_error(THREADSSL, retval);
438 if (errval == SSL_ERROR_WANT_READ ||
439 errval == SSL_ERROR_WANT_WRITE) {
443 lprintf(9, "SSL_write got error %ld, ret %d\n", errval, retval);
445 lprintf(9, "errno is %d\n", errno);
456 * \brief read data from the encrypted layer.
457 * \param buf charbuffer to read to
458 * \param bytes how many
459 * \param timeout how long should we wait?
462 int client_read_ssl(char *buf, int bytes, int timeout)
473 if (THREADSSL == NULL) return(0);
476 while (len < bytes) {
479 * This code is disabled because we don't need it when
480 * using blocking reads (which we are). -IO
483 s = BIO_get_fd(THREADSSL->rbio, NULL);
488 retval = select(s + 1, &rfds, NULL, NULL, &tv);
490 if (FD_ISSET(s, &rfds) == 0) {
495 if (SSL_want_read(THREADSSL)) {
496 if ((SSL_write(THREADSSL, junk, 0)) < 1) {
497 lprintf(9, "SSL_write in client_read: %s\n", ERR_reason_error_string(ERR_get_error()));
500 rlen = SSL_read(THREADSSL, &buf[len], bytes - len);
504 errval = SSL_get_error(THREADSSL, rlen);
505 if (errval == SSL_ERROR_WANT_READ ||
506 errval == SSL_ERROR_WANT_WRITE) {
510 lprintf(9, "SSL_read got error %ld\n", errval);
520 #endif /* HAVE_OPENSSL */