X-Git-Url: http://sjero.net/git/?p=wget;a=blobdiff_plain;f=src%2Fopenssl.c;h=a6e77adcd5618e0c4bcedc1f07bd0b9687e133fb;hp=664ed1e68d602b78009a5bba79752dd5255e09e8;hb=d763f8bf6d6e13ce006ffab616cc8a77e747a633;hpb=b8d826f243803c7a2234f0d038ce182d91df3967 diff --git a/src/openssl.c b/src/openssl.c index 664ed1e6..a6e77adc 100644 --- a/src/openssl.c +++ b/src/openssl.c @@ -1,12 +1,13 @@ /* SSL support via OpenSSL library. - Copyright (C) 2000-2005 Free Software Foundation, Inc. + Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, + 2008 Free Software Foundation, Inc. Originally contributed by Christian Fraenkel. This file is part of GNU Wget. GNU Wget is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or +the Free Software Foundation; either version 3 of the License, or (at your option) any later version. GNU Wget is distributed in the hope that it will be useful, @@ -15,73 +16,75 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License -along with Wget; if not, write to the Free Software -Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +along with Wget. If not, see . -In addition, as a special exception, the Free Software Foundation -gives permission to link the code of its release of Wget with the -OpenSSL project's "OpenSSL" library (or with modified versions of it -that use the same license as the "OpenSSL" library), and distribute -the linked executables. You must obey the GNU General Public License -in all respects for all of the code used other than "OpenSSL". If you -modify this file, you may extend this exception to your version of the -file, but you are not obligated to do so. If you do not wish to do -so, delete this exception statement from your version. */ +Additional permission under GNU GPL version 3 section 7 -#include +If you modify this program, or any covered work, by linking or +combining it with the OpenSSL project's OpenSSL library (or a +modified version of that library), containing parts covered by the +terms of the OpenSSL or SSLeay licenses, the Free Software Foundation +grants you additional permission to convey the resulting work. +Corresponding Source for a non-source form of such a combination +shall include the source code for the parts of OpenSSL used as well +as that of the covered work. */ + +#include "wget.h" #include #include #ifdef HAVE_UNISTD_H # include #endif -#ifdef HAVE_STRING_H -# include -#else -# include -#endif +#include -#include -#include -#include #include +#include #include -#include #include -#include "wget.h" #include "utils.h" #include "connect.h" #include "url.h" #include "ssl.h" -#ifndef errno -extern int errno; -#endif +/* Application-wide SSL context. This is common to all SSL + connections. */ +static SSL_CTX *ssl_ctx; -SSL_CTX *ssl_ctx; +/* Initialize the SSL's PRNG using various methods. */ static void -ssl_init_prng (void) +init_prng (void) { - /* It is likely that older versions of OpenSSL will fail on - non-Linux machines because this code is unable to seed the PRNG - on older versions of the library. */ + char namebuf[256]; + const char *random_file; -#if SSLEAY_VERSION_NUMBER >= 0x00905100 - char rand_file[256]; + if (RAND_status ()) + /* The PRNG has been seeded; no further action is necessary. */ + return; - /* First, seed from a file specified by the user. This will be - $RANDFILE, if set, or ~/.rnd. */ - RAND_file_name (rand_file, sizeof (rand_file)); - if (rand_file) - /* Seed at most 16k (value borrowed from curl) from random file. */ - RAND_load_file (rand_file, 16384); + /* Seed from a file specified by the user. This will be the file + specified with --random-file, $RANDFILE, if set, or ~/.rnd, if it + exists. */ + if (opt.random_file) + random_file = opt.random_file; + else + { + /* Get the random file name using RAND_file_name. */ + namebuf[0] = '\0'; + random_file = RAND_file_name (namebuf, sizeof (namebuf)); + } + + if (random_file && *random_file) + /* Seed at most 16k (apparently arbitrary value borrowed from + curl) from random file. */ + RAND_load_file (random_file, 16384); if (RAND_status ()) return; - /* Get random data from EGD if opt.egd_file was set. */ + /* Get random data from EGD if opt.egd_file was used. */ if (opt.egd_file && *opt.egd_file) RAND_egd (opt.egd_file); @@ -107,76 +110,75 @@ ssl_init_prng (void) PRNG. This is cryptographically weak and defeats the purpose of using OpenSSL, which is why it is highly discouraged. */ - logprintf (LOG_VERBOSE, _("WARNING: using a weak random seed.\n")); + logprintf (LOG_NOTQUIET, _("WARNING: using a weak random seed.\n")); while (RAND_status () == 0 && maxrand-- > 0) { - unsigned char rnd = random_number (256); - RAND_seed (&rnd, sizeof (rnd)); + unsigned char rnd = random_number (256); + RAND_seed (&rnd, sizeof (rnd)); } } #endif +} + +/* Print errors in the OpenSSL error stack. */ -#endif /* SSLEAY_VERSION_NUMBER >= 0x00905100 */ +static void +print_errors (void) +{ + unsigned long err; + while ((err = ERR_get_error ()) != 0) + logprintf (LOG_NOTQUIET, "OpenSSL: %s\n", ERR_error_string (err, NULL)); } +/* Convert keyfile type as used by options.h to a type as accepted by + SSL_CTX_use_certificate_file and SSL_CTX_use_PrivateKey_file. + + (options.h intentionally doesn't use values from openssl/ssl.h so + it doesn't depend specifically on OpenSSL for SSL functionality.) */ + static int -verify_callback (int ok, X509_STORE_CTX *ctx) +key_type_to_ssl_type (enum keyfile_type type) { - char *s, buf[256]; - s = X509_NAME_oneline (X509_get_subject_name (ctx->current_cert), - buf, sizeof (buf)); - if (ok == 0) + switch (type) { - switch (ctx->error) - { - case X509_V_ERR_CERT_NOT_YET_VALID: - case X509_V_ERR_CERT_HAS_EXPIRED: - /* This mean the CERT is not valid !!! */ - ok = 0; - break; - case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT: - /* Unsure if we should handle that this way */ - ok = 1; - break; - } + case keyfile_pem: + return SSL_FILETYPE_PEM; + case keyfile_asn1: + return SSL_FILETYPE_ASN1; + default: + abort (); } - return ok; } -/* Print SSL errors. */ +/* Create an SSL Context and set default paths etc. Called the first + time an HTTP download is attempted. -static void -ssl_print_errors (void) -{ - unsigned long curerr = 0; - while ((curerr = ERR_get_error ()) != 0) - logprintf (LOG_NOTQUIET, "OpenSSL: %s\n", ERR_error_string (curerr, NULL)); -} + Returns true on success, false otherwise. */ -/* Creates a SSL Context and sets some defaults for it */ -uerr_t +bool ssl_init () { - SSL_METHOD *meth = NULL; + SSL_METHOD *meth; if (ssl_ctx) - return 0; + /* The SSL has already been initialized. */ + return true; /* Init the PRNG. If that fails, bail out. */ - ssl_init_prng (); - if (RAND_status () == 0) + init_prng (); + if (RAND_status () != 1) { logprintf (LOG_NOTQUIET, - _("Could not seed OpenSSL PRNG; disabling SSL.\n")); - scheme_disable (SCHEME_HTTPS); - return SSLERRCTXCREATE; + _("Could not seed PRNG; consider using --random-file.\n")); + goto error; } SSL_library_init (); SSL_load_error_strings (); SSLeay_add_all_algorithms (); SSLeay_add_ssl_algorithms (); + switch (opt.secure_protocol) { case secure_protocol_auto: @@ -191,164 +193,404 @@ ssl_init () case secure_protocol_tlsv1: meth = TLSv1_client_method (); break; - } - if (meth == NULL) - { - ssl_print_errors (); - return SSLERRCTXCREATE; + default: + abort (); } ssl_ctx = SSL_CTX_new (meth); - if (meth == NULL) - { - ssl_print_errors (); - return SSLERRCTXCREATE; - } + if (!ssl_ctx) + goto error; SSL_CTX_set_default_verify_paths (ssl_ctx); SSL_CTX_load_verify_locations (ssl_ctx, opt.ca_cert, opt.ca_directory); - SSL_CTX_set_verify (ssl_ctx, - opt.check_cert ? SSL_VERIFY_PEER : SSL_VERIFY_NONE, - verify_callback); - if (opt.cert_file != NULL || opt.cert_key != NULL) - { - int ssl_cert_type = SSL_FILETYPE_PEM; - switch (opt.cert_type) - { - case cert_type_pem: - ssl_cert_type = SSL_FILETYPE_PEM; - break; - case cert_type_asn1: - ssl_cert_type = SSL_FILETYPE_ASN1; - break; - } - -#if 0 /* what was this supposed to achieve? */ - if (opt.cert_key == NULL) - opt.cert_key = opt.cert_file; - if (opt.cert_file == NULL) - opt.cert_file = opt.cert_key; -#endif + /* SSL_VERIFY_NONE instructs OpenSSL not to abort SSL_connect if the + certificate is invalid. We verify the certificate separately in + ssl_check_certificate, which provides much better diagnostics + than examining the error stack after a failed SSL_connect. */ + SSL_CTX_set_verify (ssl_ctx, SSL_VERIFY_NONE, NULL); - if (SSL_CTX_use_certificate_file (ssl_ctx, opt.cert_file, - ssl_cert_type) != 1) - { - ssl_print_errors (); - return SSLERRCERTFILE; - } - if (SSL_CTX_use_PrivateKey_file (ssl_ctx, opt.cert_key, - ssl_cert_type) != 1) - { - ssl_print_errors (); - return SSLERRCERTKEY; - } + /* Use the private key from the cert file unless otherwise specified. */ + if (opt.cert_file && !opt.private_key) + { + opt.private_key = opt.cert_file; + opt.private_key_type = opt.cert_type; } - return 0; /* Succeded */ + if (opt.cert_file) + if (SSL_CTX_use_certificate_file (ssl_ctx, opt.cert_file, + key_type_to_ssl_type (opt.cert_type)) + != 1) + goto error; + if (opt.private_key) + if (SSL_CTX_use_PrivateKey_file (ssl_ctx, opt.private_key, + key_type_to_ssl_type (opt.private_key_type)) + != 1) + goto error; + + /* Since fd_write unconditionally assumes partial writes (and + handles them correctly), allow them in OpenSSL. */ + SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE); + + /* The OpenSSL library can handle renegotiations automatically, so + tell it to do so. */ + SSL_CTX_set_mode (ssl_ctx, SSL_MODE_AUTO_RETRY); + + return true; + + error: + if (ssl_ctx) + SSL_CTX_free (ssl_ctx); + print_errors (); + return false; } +struct openssl_transport_context { + SSL *conn; /* SSL connection handle */ + char *last_error; /* last error printed with openssl_errstr */ +}; + static int -ssl_read (int fd, char *buf, int bufsize, void *ctx) +openssl_read (int fd, char *buf, int bufsize, void *arg) { int ret; - SSL *ssl = (SSL *) ctx; + struct openssl_transport_context *ctx = arg; + SSL *conn = ctx->conn; do - ret = SSL_read (ssl, buf, bufsize); + ret = SSL_read (conn, buf, bufsize); while (ret == -1 - && SSL_get_error (ssl, ret) == SSL_ERROR_SYSCALL - && errno == EINTR); + && SSL_get_error (conn, ret) == SSL_ERROR_SYSCALL + && errno == EINTR); return ret; } static int -ssl_write (int fd, char *buf, int bufsize, void *ctx) +openssl_write (int fd, char *buf, int bufsize, void *arg) { int ret = 0; - SSL *ssl = (SSL *) ctx; + struct openssl_transport_context *ctx = arg; + SSL *conn = ctx->conn; do - ret = SSL_write (ssl, buf, bufsize); + ret = SSL_write (conn, buf, bufsize); while (ret == -1 - && SSL_get_error (ssl, ret) == SSL_ERROR_SYSCALL - && errno == EINTR); + && SSL_get_error (conn, ret) == SSL_ERROR_SYSCALL + && errno == EINTR); return ret; } static int -ssl_poll (int fd, double timeout, int wait_for, void *ctx) +openssl_poll (int fd, double timeout, int wait_for, void *arg) { - SSL *ssl = (SSL *) ctx; + struct openssl_transport_context *ctx = arg; + SSL *conn = ctx->conn; if (timeout == 0) return 1; - if (SSL_pending (ssl)) + if (SSL_pending (conn)) return 1; return select_fd (fd, timeout, wait_for); } static int -ssl_peek (int fd, char *buf, int bufsize, void *ctx) +openssl_peek (int fd, char *buf, int bufsize, void *arg) { int ret; - SSL *ssl = (SSL *) ctx; + struct openssl_transport_context *ctx = arg; + SSL *conn = ctx->conn; do - ret = SSL_peek (ssl, buf, bufsize); + ret = SSL_peek (conn, buf, bufsize); while (ret == -1 - && SSL_get_error (ssl, ret) == SSL_ERROR_SYSCALL - && errno == EINTR); + && SSL_get_error (conn, ret) == SSL_ERROR_SYSCALL + && errno == EINTR); return ret; } +static const char * +openssl_errstr (int fd, void *arg) +{ + struct openssl_transport_context *ctx = arg; + unsigned long errcode; + char *errmsg = NULL; + int msglen = 0; + + /* If there are no SSL-specific errors, just return NULL. */ + if ((errcode = ERR_get_error ()) == 0) + return NULL; + + /* Get rid of previous contents of ctx->last_error, if any. */ + xfree_null (ctx->last_error); + + /* Iterate over OpenSSL's error stack and accumulate errors in the + last_error buffer, separated by "; ". This is better than using + a static buffer, which *always* takes up space (and has to be + large, to fit more than one error message), whereas these + allocations are only performed when there is an actual error. */ + + for (;;) + { + const char *str = ERR_error_string (errcode, NULL); + int len = strlen (str); + + /* Allocate space for the existing message, plus two more chars + for the "; " separator and one for the terminating \0. */ + errmsg = xrealloc (errmsg, msglen + len + 2 + 1); + memcpy (errmsg + msglen, str, len); + msglen += len; + + /* Get next error and bail out if there are no more. */ + errcode = ERR_get_error (); + if (errcode == 0) + break; + + errmsg[msglen++] = ';'; + errmsg[msglen++] = ' '; + } + errmsg[msglen] = '\0'; + + /* Store the error in ctx->last_error where openssl_close will + eventually find it and free it. */ + ctx->last_error = errmsg; + + return errmsg; +} + static void -ssl_close (int fd, void *ctx) +openssl_close (int fd, void *arg) { - SSL *ssl = (SSL *) ctx; - SSL_shutdown (ssl); - SSL_free (ssl); + struct openssl_transport_context *ctx = arg; + SSL *conn = ctx->conn; -#ifdef WINDOWS + SSL_shutdown (conn); + SSL_free (conn); + xfree_null (ctx->last_error); + xfree (ctx); + +#if defined(WINDOWS) || defined(MSDOS) closesocket (fd); #else close (fd); #endif - DEBUGP (("Closed %d/SSL 0x%0lx\n", fd, (unsigned long) ssl)); + DEBUGP (("Closed %d/SSL 0x%0*lx\n", fd, PTR_FORMAT (conn))); } -/* Sets up a SSL structure and performs the handshake on fd. The - resulting SSL structure is registered with the file descriptor FD - using fd_register_transport. That way subsequent calls to xread, - xwrite, etc., will use the appropriate SSL functions. +/* openssl_transport is the singleton that describes the SSL transport + methods provided by this file. */ - Returns 1 on success, 0 on failure. */ +static struct transport_implementation openssl_transport = { + openssl_read, openssl_write, openssl_poll, + openssl_peek, openssl_errstr, openssl_close +}; -int -ssl_connect (int fd) +/* Perform the SSL handshake on file descriptor FD, which is assumed + to be connected to an SSL server. The SSL handle provided by + OpenSSL is registered with the file descriptor FD using + fd_register_transport, so that subsequent calls to fd_read, + fd_write, etc., will use the corresponding SSL functions. + + Returns true on success, false on failure. */ + +bool +ssl_connect_wget (int fd) { - SSL *ssl; + SSL *conn; + struct openssl_transport_context *ctx; + + DEBUGP (("Initiating SSL handshake.\n")); assert (ssl_ctx != NULL); - ssl = SSL_new (ssl_ctx); - if (!ssl) - goto err; - if (!SSL_set_fd (ssl, fd)) - goto err; - SSL_set_connect_state (ssl); - if (SSL_connect (ssl) <= 0 || ssl->state != SSL_ST_OK) - goto err; - - /* Register FD with Wget's transport layer, i.e. arrange that - SSL-enabled functions are used for reading, writing, and polling. - That way the rest of Wget can keep using xread, xwrite, and - friends and not care what happens underneath. */ - fd_register_transport (fd, ssl_read, ssl_write, ssl_poll, ssl_peek, - ssl_close, ssl); - DEBUGP (("Connected %d to SSL 0x%0*lx\n", fd, 2 * sizeof (void *), - (unsigned long) ssl)); - return 1; - - err: - ssl_print_errors (); - if (ssl) - SSL_free (ssl); - return 0; + conn = SSL_new (ssl_ctx); + if (!conn) + goto error; + if (!SSL_set_fd (conn, fd)) + goto error; + SSL_set_connect_state (conn); + if (SSL_connect (conn) <= 0 || conn->state != SSL_ST_OK) + goto error; + + ctx = xnew0 (struct openssl_transport_context); + ctx->conn = conn; + + /* Register FD with Wget's transport layer, i.e. arrange that our + functions are used for reading, writing, and polling. */ + fd_register_transport (fd, &openssl_transport, ctx); + DEBUGP (("Handshake successful; connected socket %d to SSL handle 0x%0*lx\n", + fd, PTR_FORMAT (conn))); + return true; + + error: + DEBUGP (("SSL handshake failed.\n")); + print_errors (); + if (conn) + SSL_free (conn); + return false; +} + +#define ASTERISK_EXCLUDES_DOT /* mandated by rfc2818 */ + +/* Return true is STRING (case-insensitively) matches PATTERN, false + otherwise. The recognized wildcard character is "*", which matches + any character in STRING except ".". Any number of the "*" wildcard + may be present in the pattern. + + This is used to match of hosts as indicated in rfc2818: "Names may + contain the wildcard character * which is considered to match any + single domain name component or component fragment. E.g., *.a.com + matches foo.a.com but not bar.foo.a.com. f*.com matches foo.com but + not bar.com [or foo.bar.com]." + + If the pattern contain no wildcards, pattern_match(a, b) is + equivalent to !strcasecmp(a, b). */ + +static bool +pattern_match (const char *pattern, const char *string) +{ + const char *p = pattern, *n = string; + char c; + for (; (c = c_tolower (*p++)) != '\0'; n++) + if (c == '*') + { + for (c = c_tolower (*p); c == '*'; c = c_tolower (*++p)) + ; + for (; *n != '\0'; n++) + if (c_tolower (*n) == c && pattern_match (p, n)) + return true; +#ifdef ASTERISK_EXCLUDES_DOT + else if (*n == '.') + return false; +#endif + return c == '\0'; + } + else + { + if (c != c_tolower (*n)) + return false; + } + return *n == '\0'; +} + +/* Verify the validity of the certificate presented by the server. + Also check that the "common name" of the server, as presented by + its certificate, corresponds to HOST. (HOST typically comes from + the URL and is what the user thinks he's connecting to.) + + This assumes that ssl_connect_wget has successfully finished, i.e. that + the SSL handshake has been performed and that FD is connected to an + SSL handle. + + If opt.check_cert is true (the default), this returns 1 if the + certificate is valid, 0 otherwise. If opt.check_cert is 0, the + function always returns 1, but should still be called because it + warns the user about any problems with the certificate. */ + +bool +ssl_check_certificate (int fd, const char *host) +{ + X509 *cert; + char common_name[256]; + long vresult; + bool success = true; + + /* If the user has specified --no-check-cert, we still want to warn + him about problems with the server's certificate. */ + const char *severity = opt.check_cert ? _("ERROR") : _("WARNING"); + + struct openssl_transport_context *ctx = fd_transport_context (fd); + SSL *conn = ctx->conn; + assert (conn != NULL); + + cert = SSL_get_peer_certificate (conn); + if (!cert) + { + logprintf (LOG_NOTQUIET, _("%s: No certificate presented by %s.\n"), + severity, quotearg_style (escape_quoting_style, host)); + success = false; + goto no_cert; /* must bail out since CERT is NULL */ + } + + IF_DEBUG + { + char *subject = X509_NAME_oneline (X509_get_subject_name (cert), 0, 0); + char *issuer = X509_NAME_oneline (X509_get_issuer_name (cert), 0, 0); + DEBUGP (("certificate:\n subject: %s\n issuer: %s\n", + quotearg_style (escape_quoting_style, subject), + quotearg_style (escape_quoting_style, issuer))); + OPENSSL_free (subject); + OPENSSL_free (issuer); + } + + vresult = SSL_get_verify_result (conn); + if (vresult != X509_V_OK) + { + char *issuer = X509_NAME_oneline (X509_get_issuer_name (cert), 0, 0); + logprintf (LOG_NOTQUIET, + _("%s: cannot verify %s's certificate, issued by %s:\n"), + severity, quotearg_style (escape_quoting_style, host), + quote (issuer)); + /* Try to print more user-friendly (and translated) messages for + the frequent verification errors. */ + switch (vresult) + { + case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY: + logprintf (LOG_NOTQUIET, + _(" Unable to locally verify the issuer's authority.\n")); + break; + case X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN: + case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT: + logprintf (LOG_NOTQUIET, _(" Self-signed certificate encountered.\n")); + break; + case X509_V_ERR_CERT_NOT_YET_VALID: + logprintf (LOG_NOTQUIET, _(" Issued certificate not yet valid.\n")); + break; + case X509_V_ERR_CERT_HAS_EXPIRED: + logprintf (LOG_NOTQUIET, _(" Issued certificate has expired.\n")); + break; + default: + /* For the less frequent error strings, simply provide the + OpenSSL error message. */ + logprintf (LOG_NOTQUIET, " %s\n", + X509_verify_cert_error_string (vresult)); + } + success = false; + /* Fall through, so that the user is warned about *all* issues + with the cert (important with --no-check-certificate.) */ + } + + /* Check that HOST matches the common name in the certificate. + #### The following remains to be done: + + - It should use dNSName/ipAddress subjectAltName extensions if + available; according to rfc2818: "If a subjectAltName extension + of type dNSName is present, that MUST be used as the identity." + + - When matching against common names, it should loop over all + common names and choose the most specific one, i.e. the last + one, not the first one, which the current code picks. + + - Ensure that ASN1 strings from the certificate are encoded as + UTF-8 which can be meaningfully compared to HOST. */ + + common_name[0] = '\0'; + X509_NAME_get_text_by_NID (X509_get_subject_name (cert), + NID_commonName, common_name, sizeof (common_name)); + if (!pattern_match (common_name, host)) + { + logprintf (LOG_NOTQUIET, _("\ +%s: certificate common name %s doesn't match requested host name %s.\n"), + severity, quote (common_name), quote (host)); + success = false; + } + + if (success) + DEBUGP (("X509 certificate successfully verified and matches host %s\n", + quotearg_style (escape_quoting_style, host))); + X509_free (cert); + + no_cert: + if (opt.check_cert && !success) + logprintf (LOG_NOTQUIET, _("\ +To connect to %s insecurely, use `--no-check-certificate'.\n"), + quotearg_style (escape_quoting_style, host)); + + /* Allow --no-check-cert to disable certificate checking. */ + return opt.check_cert ? success : true; }