include/modules/ssl.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2006 Craig Edwards <craigedwards@brainbox.cc>
   6  *
   7  * This file is part of InspIRCd.  InspIRCd is free software: you can
   8  * redistribute it and/or modify it under the terms of the GNU General Public
   9  * License as published by the Free Software Foundation, version 2.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  14  * details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20
  21 #pragma once
  22
  23 #include <string>
  24 #include "iohook.h"
  25
  26 /** ssl_cert is a class which abstracts SSL certificate
  27  * and key information.
  28  *
  29  * Because gnutls and openssl represent key information in
  30  * wildly different ways, this class allows it to be accessed
  31  * in a unified manner. These classes are attached to ssl-
  32  * connected local users using SSLCertExt
  33  */
  34 class ssl_cert : public refcountbase
  35 {
  36  public:
  37         std::string dn;
  38         std::string issuer;
  39         std::string error;
  40         std::string fingerprint;
  41         bool trusted, invalid, unknownsigner, revoked;
  42
  43         ssl_cert() : trusted(false), invalid(true), unknownsigner(true), revoked(false) {}
  44
  45         /** Get certificate distinguished name
  46          * @return Certificate DN
  47          */
  48         const std::string& GetDN()
  49         {
  50                 return dn;
  51         }
  52
  53         /** Get Certificate issuer
  54          * @return Certificate issuer
  55          */
  56         const std::string& GetIssuer()
  57         {
  58                 return issuer;
  59         }
  60
  61         /** Get error string if an error has occured
  62          * @return The error associated with this users certificate,
  63          * or an empty string if there is no error.
  64          */
  65         const std::string& GetError()
  66         {
  67                 return error;
  68         }
  69
  70         /** Get key fingerprint.
  71          * @return The key fingerprint as a hex string.
  72          */
  73         const std::string& GetFingerprint()
  74         {
  75                 return fingerprint;
  76         }
  77
  78         /** Get trust status
  79          * @return True if this is a trusted certificate
  80          * (the certificate chain validates)
  81          */
  82         bool IsTrusted()
  83         {
  84                 return trusted;
  85         }
  86
  87         /** Get validity status
  88          * @return True if the certificate itself is
  89          * correctly formed.
  90          */
  91         bool IsInvalid()
  92         {
  93                 return invalid;
  94         }
  95
  96         /** Get signer status
  97          * @return True if the certificate appears to be
  98          * self-signed.
  99          */
 100         bool IsUnknownSigner()
 101         {
 102                 return unknownsigner;
 103         }
 104
 105         /** Get revokation status.
 106          * @return True if the certificate is revoked.
 107          * Note that this only works properly for GnuTLS
 108          * right now.
 109          */
 110         bool IsRevoked()
 111         {
 112                 return revoked;
 113         }
 114
 115         bool IsCAVerified()
 116         {
 117                 return trusted && !invalid && !revoked && !unknownsigner && error.empty();
 118         }
 119
 120         std::string GetMetaLine()
 121         {
 122                 std::stringstream value;
 123                 bool hasError = !error.empty();
 124                 value << (IsInvalid() ? "v" : "V") << (IsTrusted() ? "T" : "t") << (IsRevoked() ? "R" : "r")
 125                         << (IsUnknownSigner() ? "s" : "S") << (hasError ? "E" : "e") << " ";
 126                 if (hasError)
 127                         value << GetError();
 128                 else
 129                         value << GetFingerprint() << " " << GetDN() << " " << GetIssuer();
 130                 return value.str();
 131         }
 132 };
 133
 134 class SSLIOHook : public IOHook
 135 {
 136  protected:
 137         /** Peer SSL certificate, set by the SSL module
 138          */
 139         reference<ssl_cert> certificate;
 140
 141         /** Reduce elements in a send queue by appending later elements to the first element until there are no more
 142          * elements to append or a desired length is reached
 143          * @param sendq SendQ to work on
 144          * @param targetsize Target size of the front element
 145          */
 146         static void FlattenSendQueue(StreamSocket::SendQueue& sendq, size_t targetsize)
 147         {
 148                 if ((sendq.size() <= 1) || (sendq.front().length() >= targetsize))
 149                         return;
 150
 151                 // Avoid multiple repeated SSL encryption invocations
 152                 // This adds a single copy of the queue, but avoids
 153                 // much more overhead in terms of system calls invoked
 154                 // by an IOHook.
 155                 std::string tmp;
 156                 tmp.reserve(std::min(targetsize, sendq.bytes())+1);
 157                 do
 158                 {
 159                         tmp.append(sendq.front());
 160                         sendq.pop_front();
 161                 }
 162                 while (!sendq.empty() && tmp.length() < targetsize);
 163                 sendq.push_front(tmp);
 164         }
 165
 166  public:
 167         static SSLIOHook* IsSSL(StreamSocket* sock)
 168         {
 169                 IOHook* const iohook = sock->GetIOHook();
 170                 if ((iohook) && ((iohook->prov->type == IOHookProvider::IOH_SSL)))
 171                         return static_cast<SSLIOHook*>(iohook);
 172                 return NULL;
 173         }
 174
 175         SSLIOHook(IOHookProvider* hookprov)
 176                 : IOHook(hookprov)
 177         {
 178         }
 179
 180         /**
 181          * Get the certificate sent by this peer
 182          * @return The SSL certificate sent by the peer, NULL if no cert was sent
 183          */
 184         ssl_cert* GetCertificate() const
 185         {
 186                 return certificate;
 187         }
 188
 189         /**
 190          * Get the fingerprint of the peer's certificate
 191          * @return The fingerprint of the SSL client certificate sent by the peer,
 192          * empty if no cert was sent
 193          */
 194         std::string GetFingerprint() const
 195         {
 196                 ssl_cert* cert = GetCertificate();
 197                 if (cert)
 198                         return cert->GetFingerprint();
 199                 return "";
 200         }
 201
 202         /**
 203          * Get the ciphersuite negotiated with the peer
 204          * @param out String where the ciphersuite string will be appended to
 205          */
 206         virtual void GetCiphersuite(std::string& out) const = 0;
 207 };
 208
 209 /** Helper functions for obtaining SSL client certificates and key fingerprints
 210  * from StreamSockets
 211  */
 212 class SSLClientCert
 213 {
 214  public:
 215         /**
 216          * Get the client certificate from a socket
 217          * @param sock The socket to get the certificate from, the socket does not have to use SSL
 218          * @return The SSL client certificate information, NULL if the peer is not using SSL
 219          */
 220         static ssl_cert* GetCertificate(StreamSocket* sock)
 221         {
 222                 SSLIOHook* ssliohook = SSLIOHook::IsSSL(sock);
 223                 if (!ssliohook)
 224                         return NULL;
 225
 226                 return ssliohook->GetCertificate();
 227         }
 228
 229         /**
 230          * Get the fingerprint of a client certificate from a socket
 231          * @param sock The socket to get the certificate fingerprint from, the
 232          * socket does not have to use SSL
 233          * @return The key fingerprint from the SSL certificate sent by the peer,
 234          * empty if no cert was sent or the peer is not using SSL
 235          */
 236         static std::string GetFingerprint(StreamSocket* sock)
 237         {
 238                 ssl_cert* cert = SSLClientCert::GetCertificate(sock);
 239                 if (cert)
 240                         return cert->GetFingerprint();
 241                 return "";
 242         }
 243 };
 244
 245 class UserCertificateAPIBase : public DataProvider
 246 {
 247  public:
 248         UserCertificateAPIBase(Module* parent)
 249                 : DataProvider(parent, "m_sslinfo_api")
 250         {
 251         }
 252
 253         /** Get the SSL certificate of a user
 254          * @param user The user whose certificate to get, user may be remote
 255          * @return The SSL certificate of the user or NULL if the user is not using SSL
 256          */
 257         virtual ssl_cert* GetCertificate(User* user) = 0;
 258
 259         /** Get the key fingerprint from a user's certificate
 260          * @param user The user whose key fingerprint to get, user may be remote
 261          * @return The key fingerprint from the user's SSL certificate or an empty string
 262          * if the user is not using SSL or did not provide a client certificate
 263          */
 264         std::string GetFingerprint(User* user)
 265         {
 266                 ssl_cert* cert = GetCertificate(user);
 267                 if (cert)
 268                         return cert->GetFingerprint();
 269                 return "";
 270         }
 271 };
 272
 273 /** API implemented by m_sslinfo that allows modules to retrive the SSL certificate
 274  * information of local and remote users. It can also be used to find out whether a
 275  * user is using SSL or not.
 276  */
 277 class UserCertificateAPI : public dynamic_reference<UserCertificateAPIBase>
 278 {
 279  public:
 280         UserCertificateAPI(Module* parent)
 281                 : dynamic_reference<UserCertificateAPIBase>(parent, "m_sslinfo_api")
 282         {
 283         }
 284 };