src/ssl/support.h

   1
   2 /*
   3  * $Id$
   4  *
   5  * AUTHOR: Benno Rice
   6  *
   7  * SQUID Internet Object Cache  http://squid.nlanr.net/Squid/
   8  * ----------------------------------------------------------
   9  *
  10  *  Squid is the result of efforts by numerous individuals from the
  11  *  Internet community.  Development is led by Duane Wessels of the
  12  *  National Laboratory for Applied Network Research and funded by the
  13  *  National Science Foundation.  Squid is Copyrighted (C) 1998 by
  14  *  Duane Wessels and the University of California San Diego.  Please
  15  *  see the COPYRIGHT file for full details.  Squid incorporates
  16  *  software developed and/or copyrighted by other sources.  Please see
  17  *  the CREDITS file for full details.
  18  *
  19  *  This program is free software; you can redistribute it and/or modify
  20  *  it under the terms of the GNU General Public License as published by
  21  *  the Free Software Foundation; either version 2 of the License, or
  22  *  (at your option) any later version.
  23  *
  24  *  This program is distributed in the hope that it will be useful,
  25  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  *  GNU General Public License for more details.
  28  *
  29  *  You should have received a copy of the GNU General Public License
  30  *  along with this program; if not, write to the Free Software
  31  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  32  *
  33  */
  34
  35 #ifndef SQUID_SSL_SUPPORT_H
  36 #define SQUID_SSL_SUPPORT_H
  37
  38 #include "ssl/gadgets.h"
  39
  40 #if HAVE_OPENSSL_SSL_H
  41 #include <openssl/ssl.h>
  42 #endif
  43 #if HAVE_OPENSSL_X509V3_H
  44 #include <openssl/x509v3.h>
  45 #endif
  46 #if HAVE_OPENSSL_ERR_H
  47 #include <openssl/err.h>
  48 #endif
  49 #if HAVE_OPENSSL_ENGINE_H
  50 #include <openssl/engine.h>
  51 #endif
  52
  53 /**
  54  \defgroup ServerProtocolSSLAPI Server-Side SSL API
  55  \ingroup ServerProtocol
  56  */
  57
  58 // Custom SSL errors; assumes all official errors are positive
  59 #define SQUID_X509_V_ERR_CERT_CHANGE -3
  60 #define SQUID_ERR_SSL_HANDSHAKE -2
  61 #define SQUID_X509_V_ERR_DOMAIN_MISMATCH -1
  62 // All SSL errors range: from smallest (negative) custom to largest SSL error
  63 #define SQUID_SSL_ERROR_MIN SQUID_X509_V_ERR_CERT_CHANGE
  64 #define SQUID_SSL_ERROR_MAX INT_MAX
  65
  66 namespace Ssl
  67 {
  68 /// Squid defined error code (<0),  an error code returned by SSL X509 api, or SSL_ERROR_NONE
  69 typedef int ssl_error_t;
  70
  71 /// \ingroup ServerProtocolSSLAPI
  72 /// SSL error codes in the order they were encountered
  73 typedef std::vector<ssl_error_t> Errors;
  74 } //namespace Ssl
  75
  76 /// \ingroup ServerProtocolSSLAPI
  77 SSL_CTX *sslCreateServerContext(const char *certfile, const char *keyfile, int version, const char *cipher, const char *options, const char *flags, const char *clientCA, const char *CAfile, const char *CApath, const char *CRLfile, const char *dhpath, const char *context);
  78
  79 /// \ingroup ServerProtocolSSLAPI
  80 SSL_CTX *sslCreateClientContext(const char *certfile, const char *keyfile, int version, const char *cipher, const char *options, const char *flags, const char *CAfile, const char *CApath, const char *CRLfile);
  81
  82 /// \ingroup ServerProtocolSSLAPI
  83 int ssl_read_method(int, char *, int);
  84
  85 /// \ingroup ServerProtocolSSLAPI
  86 int ssl_write_method(int, const char *, int);
  87
  88 /// \ingroup ServerProtocolSSLAPI
  89 void ssl_shutdown_method(SSL *ssl);
  90
  91
  92 /// \ingroup ServerProtocolSSLAPI
  93 const char *sslGetUserEmail(SSL *ssl);
  94
  95 /// \ingroup ServerProtocolSSLAPI
  96 typedef char const *SSLGETATTRIBUTE(SSL *, const char *);
  97
  98 /// \ingroup ServerProtocolSSLAPI
  99 SSLGETATTRIBUTE sslGetUserAttribute;
 100
 101 /// \ingroup ServerProtocolSSLAPI
 102 SSLGETATTRIBUTE sslGetCAAttribute;
 103
 104 /// \ingroup ServerProtocolSSLAPI
 105 const char *sslGetUserCertificatePEM(SSL *ssl);
 106
 107 /// \ingroup ServerProtocolSSLAPI
 108 const char *sslGetUserCertificateChainPEM(SSL *ssl);
 109
 110 namespace Ssl
 111 {
 112 /**
 113   \ingroup ServerProtocolSSLAPI
 114   * Decide on the kind of certificate and generate a CA- or self-signed one
 115 */
 116     SSL_CTX *generateSslContext(char const *host, Ssl::X509_Pointer const & mimicCert, Ssl::X509_Pointer const & signedX509, Ssl::EVP_PKEY_Pointer const & signedPkey, CrtdMessage::BodyParams const & mimicExceptions);
 117
 118 /**
 119   \ingroup ServerProtocolSSLAPI
 120   * Check if the certificate of the given context is still valid
 121   \param sslContext The context to check
 122   \param checkCert Also check if the context certificate matches this certificate
 123   \return true if the contexts certificate is valid, false otherwise
 124  */
 125 bool verifySslCertificate(SSL_CTX * sslContext, X509 *checkCert = NULL);
 126
 127 /**
 128   \ingroup ServerProtocolSSLAPI
 129   * Read private key and certificate from memory and generate SSL context
 130   * using their.
 131  */
 132 SSL_CTX * generateSslContextUsingPkeyAndCertFromMemory(const char * data);
 133
 134 /**
 135   \ingroup ServerProtocolSSLAPI
 136   * Adds the certificates in certList to the certificate chain of the SSL context
 137  */
 138 void addChainToSslContext(SSL_CTX *sslContext, STACK_OF(X509) *certList);
 139
 140 /**
 141  \ingroup ServerProtocolSSLAPI
 142  *  Read certificate, private key and any certificates which must be chained from files.
 143  * See also: Ssl::readCertAndPrivateKeyFromFiles function,  defined in gadgets.h
 144  * \param certFilename name of file with certificate and certificates which must be chainned.
 145  * \param keyFilename name of file with private key.
 146  */
 147 void readCertChainAndPrivateKeyFromFiles(X509_Pointer & cert, EVP_PKEY_Pointer & pkey, X509_STACK_Pointer & chain, char const * certFilename, char const * keyFilename);
 148
 149 /**
 150    \ingroup ServerProtocolSSLAPI
 151    * Iterates over the X509 common and alternate names and to see if  matches with given data
 152    * using the check_func.
 153    \param peer_cert  The X509 cert to check
 154    \param check_data The data with which the X509 CNs compared
 155    \param check_func The function used to match X509 CNs. The CN data passed as ASN1_STRING data
 156    \return   1 if any of the certificate CN matches, 0 if none matches.
 157  */
 158 int matchX509CommonNames(X509 *peer_cert, void *check_data, int (*check_func)(void *check_data,  ASN1_STRING *cn_data));
 159
 160 /**
 161    \ingroup ServerProtocolSSLAPI
 162    * Check if the certificate is valid for a server
 163    \param cert  The X509 cert to check.
 164    \param server The server name.
 165    \return   true if the certificate is valid for the server or false otherwise.
 166  */
 167 bool checkX509ServerValidity(X509 *cert, const char *server);
 168
 169 /**
 170    \ingroup ServerProtocolSSLAPI
 171    * Convert a given ASN1_TIME to a string form.
 172    \param tm the time in ASN1_TIME form
 173    \param buf the buffer to write the output
 174    \param len write at most len bytes
 175    \return The number of bytes written
 176  */
 177 int asn1timeToString(ASN1_TIME *tm, char *buf, int len);
 178
 179 /**
 180    \ingroup ServerProtocolSSLAPI
 181    * Sets the hostname for the Server Name Indication (SNI) TLS extension
 182    * if supported by the used openssl toolkit.
 183    \return true if SNI set false otherwise
 184 */
 185 bool setClientSNI(SSL *ssl, const char *fqdn);
 186
 187 /**
 188    \ingroup ServerProtocolSSLAPI
 189    * Returns CN from the certificate, suitable for use as a host name.
 190    * Uses static memory to temporary store the extracted name.
 191 */
 192 const char *CommonHostName(X509 *x509);
 193 } //namespace Ssl
 194
 195 #if _SQUID_MSWIN_
 196
 197 #if defined(__cplusplus)
 198
 199 /** \cond AUTODOCS-IGNORE */
 200 namespace Squid
 201 {
 202 /** \endcond */
 203
 204 /// \ingroup ServerProtocolSSLAPI
 205 inline
 206 int SSL_set_fd(SSL *ssl, int fd)
 207 {
 208     return ::SSL_set_fd(ssl, _get_osfhandle(fd));
 209 }
 210
 211 /// \ingroup ServerProtocolSSLAPI
 212 #define SSL_set_fd(ssl,fd) Squid::SSL_set_fd(ssl,fd)
 213
 214 } /* namespace Squid */
 215
 216 #else
 217
 218 /// \ingroup ServerProtocolSSLAPI
 219 #define SSL_set_fd(s,f) (SSL_set_fd(s, _get_osfhandle(f)))
 220
 221 #endif /* __cplusplus */
 222
 223 #endif /* _SQUID_MSWIN_ */
 224
 225 #endif /* SQUID_SSL_SUPPORT_H */