tls.c
No OneTemporary
Actions

Authored By

Unknown

Size

18 KB

Referenced Files

None

Subscribers

None

tls.c
View Options

	/* tls.c - STARTTLS helper functions for imapd
	* Tim Martin
	* 9/21/99
	*
	* Based upon Lutz Jaenicke's TLS patches for postfix

	* Copyright (c) 1999-2000 Carnegie Mellon University. All rights reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	*
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in
	* the documentation and/or other materials provided with the
	* distribution.
	*
	* 3. The name "Carnegie Mellon University" must not be used to
	* endorse or promote products derived from this software without
	* prior written permission. For permission or any other legal
	* details, please contact
	* Office of Technology Transfer
	* Carnegie Mellon University
	* 5000 Forbes Avenue
	* Pittsburgh, PA 15213-3890
	* (412) 268-4387, fax: (412) 268-7395
	* tech-transfer@andrew.cmu.edu
	*
	* 4. Redistributions of any form whatsoever must retain the following
	* acknowledgment:
	* "This product includes software developed by Computing Services
	* at Carnegie Mellon University (http://www.cmu.edu/computing/)."
	*
	* CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
	* THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
	* AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
	* FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
	* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
	* AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
	* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

	* NAME
	* tls
	* SUMMARY
	* interface to openssl routines
	* SYNOPSIS
	* #include <tls.h>
	*
	* DESCRIPTION
	* This module is the interface between Cyrus Imapd and the OpenSSL library.
	* As of now only one filedescriptor can be handled, so only one
	* TLS channel can be open at a time. This can be accpted, as smtpd
	* and smtp are seperate services run by seperate programs.
	*
	* tls_init_serverengine() is called once when smtpd is started
	* in order to initialize as much of the TLS stuff as possible.
	* The certificate handling is also decided during the setup phase,
	* so that a peer specific handling is not possible.
	*
	* tls_start_servertls() activates the TLS feature for the
	* filedescriptor selected with tls_setfd() before. We expect
	* that all buffers are flushed and the TLS handshake can begin
	* immediately.
	*
	* tls_stop_servertls() sends the "close notify" alert via
	* SSL_shutdown() to the peer and resets all connection specific
	* TLS data. As RFC2487 does not specify a seperate shutdown, it
	* is supposed that the underlying TCP connection is shut down
	* immediately afterwards, so we don't care about additional data
	* coming through the channel.
	*
	* Once the TLS connection is initiated, information about the TLS
	* state is available:
	* tls_protocol holds the protocol name (SSLv2, SSLv3, TLSv1),
	* tls_cipher_name the cipher name (e.g. RC4/MD5),
	* tls_cipher_usebits the number of bits actually used (e.g. 40),
	* tls_cipher_algbits the number of bits the algorithm is based on
	* (e.g. 128).
	* The last two values may be different when talking to a crippled
	* - ahem - export controled peer (e.g. 40/128).
	*
	* If the peer offered a certifcate _and_ the certificate could be
	* verified successfully, part of the certificate data are available as:
	* tls_peer_subject X509v3-oneline with the DN of the peer
	* pfixlts_peer_CN extracted CommonName of the peer
	* tls_peer_issuer X509v3-oneline with the DN of the issuer
	* pfixlts_peer_CN extracted CommonName of the issuer
	* tls_peer_fingerprint fingerprint of the certificate
	*
	*/

	#include <config.h>

	#ifdef HAVE_SSL

	/* System library. */

	#include <sys/types.h>
	#include <unistd.h>
	#include <stdio.h>
	#include <string.h>
	#include <syslog.h>

	/* OpenSSL library. */

	#include <openssl/lhash.h>
	#include <openssl/bn.h>
	#include <openssl/err.h>
	#include <openssl/pem.h>
	#include <openssl/x509.h>
	#include <openssl/ssl.h>

	/* Application-specific. */

	#include "tls.h"

	/* We must keep some of the info available */
	static const char hexcodes[] = "0123456789ABCDEF";

	static int verify_depth;
	static int verify_error = X509_V_OK;
	static int do_dump = 0;
	static SSL_CTX *ctx = NULL;
	SSL *tls_conn = NULL;

	#define CCERT_BUFSIZ 256
	static char peer_subject[CCERT_BUFSIZ];
	static char peer_issuer[CCERT_BUFSIZ];
	static char peer_CN[CCERT_BUFSIZ];
	static char issuer_CN[CCERT_BUFSIZ];
	static unsigned char md[EVP_MAX_MD_SIZE];
	static char fingerprint[EVP_MAX_MD_SIZE * 3];

	int tls_serverengine = 0;
	int tls_serveractive = 0; /* available or not */
	char *tls_peer_subject = NULL;
	char *tls_peer_issuer = NULL;
	char *tls_peer_fingerprint = NULL;

	int tls_clientactive = 0; /* available or not */
	char *tls_peer_CN = NULL;
	char *tls_issuer_CN = NULL;

	int var_imapd_tls_loglevel = 0;

	/* taken from OpenSSL apps/s_cb.c
	* tim - this seems to just be giving logging messages
	*/

	static void apps_ssl_info_callback(SSL * s, int where, int ret)
	{
	char *str;
	int w;

	if (var_imapd_tls_loglevel==0) return;

	w = where & ~SSL_ST_MASK;

	if (w & SSL_ST_CONNECT)
	str = "SSL_connect";
	else if (w & SSL_ST_ACCEPT)
	str = "SSL_accept";
	else
	str = "undefined";

	if (where & SSL_CB_LOOP) {
	if (tls_serverengine && (var_imapd_tls_loglevel >= 2))
	syslog(LOG_DEBUG, "%s:%s", str, SSL_state_string_long(s));
	} else if (where & SSL_CB_ALERT) {
	str = (where & SSL_CB_READ) ? "read" : "write";
	if ((tls_serverengine && (var_imapd_tls_loglevel >= 2)) \|\|
	((ret & 0xff) != SSL3_AD_CLOSE_NOTIFY))
	syslog(LOG_DEBUG, "SSL3 alert %s:%s:%s", str,
	SSL_alert_type_string_long(ret),
	SSL_alert_desc_string_long(ret));
	} else if (where & SSL_CB_EXIT) {
	if (ret == 0)
	syslog(LOG_DEBUG, "%s:failed in %s",
	str, SSL_state_string_long(s));
	else if (ret < 0) {
	syslog(LOG_DEBUG, "%s:error in %s",
	str, SSL_state_string_long(s));
	}
	}
	}

	/* taken from OpenSSL apps/s_cb.c */

	static RSA tmp_rsa_cb(SSL s, int export, int keylength)
	{
	static RSA *rsa_tmp = NULL;

	if (rsa_tmp == NULL) {
	rsa_tmp = RSA_generate_key(keylength, RSA_F4, NULL, NULL);
	}
	return (rsa_tmp);
	}

	/* taken from OpenSSL apps/s_cb.c */

	static int verify_callback(int ok, X509_STORE_CTX * ctx)
	{
	char buf[256];
	X509 *err_cert;
	int err;
	int depth;

	syslog(LOG_ERR,"Doing a peer verify");

	err_cert = X509_STORE_CTX_get_current_cert(ctx);
	err = X509_STORE_CTX_get_error(ctx);
	depth = X509_STORE_CTX_get_error_depth(ctx);

	X509_NAME_oneline(X509_get_subject_name(err_cert), buf, 256);
	if ((tls_serveractive) && (var_imapd_tls_loglevel >= 1))
	syslog(LOG_DEBUG, "Peer cert verify depth=%d %s", depth, buf);
	if (ok==0)
	{
	syslog(LOG_ERR, "verify error:num=%d:%s", err,
	X509_verify_cert_error_string(err));

	if (verify_depth >= depth) {
	ok = 0;
	verify_error = X509_V_OK;
	} else {
	ok = 0;
	verify_error = X509_V_ERR_CERT_CHAIN_TOO_LONG;
	}
	}
	switch (ctx->error) {
	case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
	X509_NAME_oneline(X509_get_issuer_name(ctx->current_cert), buf, 256);
	syslog(LOG_NOTICE, "issuer= %s", buf);
	break;
	case X509_V_ERR_CERT_NOT_YET_VALID:
	case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
	syslog(LOG_NOTICE, "cert not yet valid");
	break;
	case X509_V_ERR_CERT_HAS_EXPIRED:
	case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
	syslog(LOG_NOTICE, "cert has expired");
	break;
	}
	if ((tls_serveractive) && (var_imapd_tls_loglevel >= 1))
	syslog(LOG_DEBUG, "verify return:%d", ok);

	return (ok);
	}


	/*
	* taken from OpenSSL crypto/bio/b_dump.c, modified to save a lot of strcpy
	* and strcat by Matti Aarnio.
	*/

	#define TRUNCATE
	#define DUMP_WIDTH 16

	static int tls_dump(const char *s, int len)
	{
	int ret = 0;
	char buf[160 + 1];
	char *ss;
	int i;
	int j;
	int rows;
	int trunc;
	unsigned char ch;

	trunc = 0;


	#ifdef TRUNCATE
	for (; (len > 0) && ((s[len - 1] == ' ') \|\| (s[len - 1] == '\0')); len--)
	trunc++;
	#endif

	rows = (len / DUMP_WIDTH);
	if ((rows * DUMP_WIDTH) < len)
	rows++;

	for (i = 0; i < rows; i++) {
	buf[0] = '\0'; /* start with empty string */
	ss = buf;

	sprintf(ss, "%04x ", i * DUMP_WIDTH);
	ss += strlen(ss);
	for (j = 0; j < DUMP_WIDTH; j++) {
	if (((i * DUMP_WIDTH) + j) >= len) {
	strcpy(ss, " ");
	} else {
	ch = ((unsigned char) ((char ) (s) + i * DUMP_WIDTH + j))
	& 0xff;
	sprintf(ss, "%02x%c", ch, j == 7 ? '\|' : ' ');
	ss += 3;
	}
	}
	ss += strlen(ss);
	*ss+= ' ';
	for (j = 0; j < DUMP_WIDTH; j++) {
	if (((i * DUMP_WIDTH) + j) >= len)
	break;
	ch = ((unsigned char) ((char ) (s) + i * DUMP_WIDTH + j)) & 0xff;
	*ss+= (((ch >= ' ') && (ch <= '~')) ? ch : '.');
	if (j == 7) *ss+= ' ';
	}
	*ss = 0;
	/*
	* if this is the last call then update the ddt_dump thing so that
	* we will move the selection point in the debug window
	*/
	if (var_imapd_tls_loglevel>0)
	printf("%s", buf);
	ret += strlen(buf);
	}
	#ifdef TRUNCATE
	if (trunc > 0) {
	sprintf(buf, "%04x - <SPACES/NULS>\n", len+ trunc);
	if (var_imapd_tls_loglevel>0)
	printf("%s", buf);
	ret += strlen(buf);
	}
	#endif
	return (ret);
	}

	/*
	* Set up the cert things on the server side. We do need both the
	* private key (in key_file) and the cert (in cert_file).
	* Both files may be identical.
	*
	* This function is taken from OpenSSL apps/s_cb.c
	*/

	static int set_cert_stuff(SSL_CTX * ctx, char cert_file, char key_file)
	{
	if (cert_file != NULL) {
	if (SSL_CTX_use_certificate_file(ctx, cert_file,
	SSL_FILETYPE_PEM) <= 0) {
	syslog(LOG_ERR, "unable to get certificate from '%s'", cert_file);
	return (0);
	}
	if (key_file == NULL)
	key_file = cert_file;
	if (SSL_CTX_use_PrivateKey_file(ctx, key_file,
	SSL_FILETYPE_PEM) <= 0) {
	syslog(LOG_ERR, "unable to get private key from '%s'", key_file);
	return (0);
	}
	/* Now we know that a key and cert have been set against
	* the SSL context */
	if (!SSL_CTX_check_private_key(ctx)) {
	syslog(LOG_ERR, "Private key does not match the certificate public key");
	return (0);
	}
	}
	return (1);
	}



	/*
	* This is the setup routine for the SSL server. As smtpd might be called
	* more than once, we only want to do the initialization one time.
	*
	* The skeleton of this function is taken from OpenSSL apps/s_server.c.

	* returns -1 on error
	*/

	int tls_init_serverengine(int verifydepth,
	int askcert,
	int requirecert,
	char *var_imapd_tls_CAfile,
	char *var_imapd_tls_CApath,
	char *var_imapd_tls_cert_file,
	char *var_imapd_tls_key_file)
	{
	int off = 0;
	int verify_flags = SSL_VERIFY_NONE;
	char *CApath;
	char *CAfile;
	char *s_cert_file;
	char *s_key_file;

	if (tls_serverengine)
	return (0); /* already running */

	if (var_imapd_tls_loglevel >= 2)
	syslog(LOG_DEBUG, "starting TLS engine");

	SSL_load_error_strings();
	SSLeay_add_ssl_algorithms();

	ctx = SSL_CTX_new(SSLv23_server_method());
	if (ctx == NULL) {
	return (-1);
	};

	off \|= SSL_OP_ALL; /* Work around all known bugs */
	SSL_CTX_set_options(ctx, off);
	SSL_CTX_set_info_callback(ctx, apps_ssl_info_callback);
	SSL_CTX_sess_set_cache_size(ctx, 128);

	if (strlen(var_imapd_tls_CAfile) == 0)
	CAfile = NULL;
	else
	CAfile = var_imapd_tls_CAfile;
	if (strlen(var_imapd_tls_CApath) == 0)
	CApath = NULL;
	else
	CApath = var_imapd_tls_CApath;

	if ((!SSL_CTX_load_verify_locations(ctx, CAfile, CApath)) \|\|
	(!SSL_CTX_set_default_verify_paths(ctx))) {
	/* just a warning since this is only necessary for client auth */
	syslog(LOG_NOTICE,"TLS engine: cannot load CA data");
	}
	if (strlen(var_imapd_tls_cert_file) == 0)
	s_cert_file = NULL;
	else
	s_cert_file = var_imapd_tls_cert_file;
	if (strlen(var_imapd_tls_key_file) == 0)
	s_key_file = NULL;
	else
	s_key_file = var_imapd_tls_key_file;

	if (!set_cert_stuff(ctx, s_cert_file, s_key_file)) {
	syslog(LOG_ERR,"TLS engine: cannot load cert/key data");
	return (-1);
	}
	SSL_CTX_set_tmp_rsa_callback(ctx, tmp_rsa_cb);

	verify_depth = verifydepth;
	if (askcert!=0)
	verify_flags \|= SSL_VERIFY_PEER \| SSL_VERIFY_CLIENT_ONCE;
	if (requirecert)
	verify_flags \|= SSL_VERIFY_PEER \| SSL_VERIFY_FAIL_IF_NO_PEER_CERT
	\| SSL_VERIFY_CLIENT_ONCE;
	SSL_CTX_set_verify(ctx, verify_flags, verify_callback);

	SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(CAfile));

	tls_serverengine = 1;
	return (0);
	}


	/* taken from OpenSSL apps/s_cb.c */

	static long bio_dump_cb(BIO * bio, int cmd, const char *argp, int argi,
	long argl, long ret)
	{
	if (!do_dump)
	return (ret);

	if (cmd == (BIO_CB_READ \| BIO_CB_RETURN)) {
	printf("read from %08X [%08lX] (%d bytes => %ld (0x%X))", (unsigned int) bio, (long unsigned int) argp,
	argi, ret, (unsigned int) ret);
	tls_dump(argp, (int) ret);
	return (ret);
	} else if (cmd == (BIO_CB_WRITE \| BIO_CB_RETURN)) {
	printf("write to %08X [%08lX] (%d bytes => %ld (0x%X))", (unsigned int) bio, (long unsigned int)argp,
	argi, ret, (unsigned int) ret);
	tls_dump(argp, (int) ret);
	}
	return (ret);
	}




	/*
	* This is the actual startup routine for the connection. We expect
	* that the buffers are flushed and the "220 Ready to start TLS" was
	* send to the client, so that we can immediately can start the TLS
	* handshake process.
	*
	* layerbits and authid are filled in on sucess. authid is only
	* filled in if the client authenticated
	*
	*/
	int tls_start_servertls(int readfd, int writefd, int layerbits, char *authid)
	{
	int sts;
	int j;
	unsigned int n;
	SSL_SESSION *session;
	SSL_CIPHER *cipher;
	X509 *peer;
	const char *tls_protocol = NULL;
	const char *tls_cipher_name = NULL;
	int tls_cipher_usebits = 0;
	int tls_cipher_algbits = 0;

	if (!tls_serverengine)
	{
	/* should never happen */
	syslog(LOG_ERR, "tls_engine not running");
	return (-1);
	}
	if (var_imapd_tls_loglevel >= 1)
	syslog(LOG_DEBUG, "setting up TLS connection");

	if (tls_conn == NULL)
	{
	tls_conn = (SSL *) SSL_new(ctx);
	}
	if (tls_conn == NULL)
	{
	return (-1);
	}
	SSL_clear(tls_conn);


	/* set the file descriptors for SSL to use */
	if (SSL_set_rfd(tls_conn, readfd)==0)
	{
	return (-1);
	}

	if (SSL_set_wfd(tls_conn, writefd)==0)
	{
	return (-1);
	}


	/*
	* This is the actual handshake routine. It will do all the negotiations
	* and will check the client cert etc.
	*/
	SSL_set_accept_state(tls_conn);


	/*
	* We do have an SSL_set_fd() and now suddenly a BIO_ routine is called?
	* Well there is a BIO below the SSL routines that is automatically
	* created for us, so we can use it for debugging purposes.
	*/
	if (var_imapd_tls_loglevel >= 3)
	BIO_set_callback(SSL_get_rbio(tls_conn), bio_dump_cb);

	/* Dump the negotiation for loglevels 3 and 4*/
	if (var_imapd_tls_loglevel >= 3)
	do_dump = 1;

	if ((sts = SSL_accept(tls_conn)) < 0) { /* xxx <= 0 */
	session = SSL_get_session(tls_conn);
	if (session) {
	SSL_CTX_remove_session(ctx, session);
	}
	if (tls_conn)
	SSL_free(tls_conn);
	tls_conn = NULL;
	return (-1);
	}
	/* Only loglevel==4 dumps everything */
	if (var_imapd_tls_loglevel < 4)
	do_dump = 0;

	/*
	* Lets see, whether a peer certificate is availabe and what is
	* the actual information. We want to save it for later use.
	*/
	peer = SSL_get_peer_certificate(tls_conn);
	if (peer != NULL) {

	syslog(LOG_ERR,"GOT CLIENT CERTIFICATE!!!\n");

	X509_NAME_oneline(X509_get_subject_name(peer),
	peer_subject, CCERT_BUFSIZ);
	if (var_imapd_tls_loglevel >= 2)
	printf("subject=%s", peer_subject);

	syslog(LOG_ERR, "subject=%s", peer_subject);
	tls_peer_subject = peer_subject;
	X509_NAME_oneline(X509_get_issuer_name(peer),
	peer_issuer, CCERT_BUFSIZ);
	if (var_imapd_tls_loglevel >= 2)
	printf("issuer=%s", peer_issuer);
	tls_peer_issuer = peer_issuer;
	if (X509_digest(peer, EVP_md5(), md, &n)) {
	for (j = 0; j < (int) n; j++)
	{
	fingerprint[j * 3] = hexcodes[(md[j] & 0xf0) >> 4];
	fingerprint[(j * 3) + 1] = hexcodes[(md[j] & 0x0f)];
	if (j + 1 != (int) n)
	fingerprint[(j * 3) + 2] = '_';
	else
	fingerprint[(j * 3) + 2] = '\0';
	}
	if (var_imapd_tls_loglevel >= 2)
	printf("fingerprint=%s", fingerprint);
	syslog(LOG_ERR,"fingerprint=%s", fingerprint);
	tls_peer_fingerprint = fingerprint;
	}
	X509_NAME_get_text_by_NID(X509_get_subject_name(peer),
	NID_commonName, peer_CN, CCERT_BUFSIZ);
	tls_peer_CN = peer_CN;
	X509_NAME_get_text_by_NID(X509_get_issuer_name(peer),
	NID_commonName, issuer_CN, CCERT_BUFSIZ);
	if (var_imapd_tls_loglevel >= 3)
	printf("subject_CN=%s, issuer_CN=%s", peer_CN, issuer_CN);

	syslog(LOG_ERR,"subject_CN=%s, issuer_CN=%s", peer_CN, issuer_CN);

	tls_issuer_CN = issuer_CN;
	/* xxx X509_free(peer);*/
	}
	tls_protocol = SSL_get_version(tls_conn);
	cipher = SSL_get_current_cipher(tls_conn);
	tls_cipher_name = SSL_CIPHER_get_name(cipher);
	tls_cipher_usebits = SSL_CIPHER_get_bits(cipher,
	&tls_cipher_algbits);
	tls_serveractive = 1;

	if (layerbits!=NULL)
	*layerbits = tls_cipher_usebits;

	if (authid!=NULL)
	{
	*authid = tls_peer_CN;
	}


	if ((*authid)!=NULL) {
	syslog(LOG_NOTICE, "starttls: %s with cipher %s (%d/%d bits)"
	" authenticated as %s",
	tls_protocol, tls_cipher_name,
	tls_cipher_usebits, tls_cipher_algbits,
	*authid);
	} else {
	syslog(LOG_NOTICE, "starttls: %s with cipher %s (%d/%d bits)"
	" no authentication",
	tls_protocol, tls_cipher_name,
	tls_cipher_usebits, tls_cipher_algbits);
	}

	return (0);
	}

	#endif /* HAVE_SSL */

File Metadata

Mime Type: text/x-c
Expires: Mon, Apr 6, 2:23 AM (1 w, 4 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 18831986
Default Alt Text: tls.c (18 KB)

tls.cNo OneTemporaryActions

tls.cView Options

File Metadata

Event Timeline

tls.c
No OneTemporary
Actions

tls.c
View Options