src/modules/extra/m_ssl_openssl.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15
  16 #include <openssl/ssl.h>
  17 #include <openssl/err.h>
  18
  19 #ifdef WINDOWS
  20 #include <openssl/applink.c>
  21 #endif
  22
  23 #include "configreader.h"
  24 #include "users.h"
  25 #include "channels.h"
  26 #include "modules.h"
  27
  28 #include "socket.h"
  29 #include "hashcomp.h"
  30
  31 #include "transport.h"
  32
  33 #ifdef WINDOWS
  34 #pragma comment(lib, "libeay32MTd")
  35 #pragma comment(lib, "ssleay32MTd")
  36 #undef MAX_DESCRIPTORS
  37 #define MAX_DESCRIPTORS 10000
  38 #endif
  39
  40 /* $ModDesc: Provides SSL support for clients */
  41 /* $CompileFlags: pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
  42 /* $LinkerFlags: rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
  43 /* $ModDep: transport.h */
  44
  45 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
  46 enum issl_io_status { ISSL_WRITE, ISSL_READ };
  47
  48 static bool SelfSigned = false;
  49
  50 bool isin(int port, const std::vector<int> &portlist)
  51 {
  52         for(unsigned int i = 0; i < portlist.size(); i++)
  53                 if(portlist[i] == port)
  54                         return true;
  55
  56         return false;
  57 }
  58
  59 char* get_error()
  60 {
  61         return ERR_error_string(ERR_get_error(), NULL);
  62 }
  63
  64 static int error_callback(const char *str, size_t len, void *u);
  65
  66 /** Represents an SSL user's extra data
  67  */
  68 class issl_session : public classbase
  69 {
  70 public:
  71         SSL* sess;
  72         issl_status status;
  73         issl_io_status rstat;
  74         issl_io_status wstat;
  75
  76         unsigned int inbufoffset;
  77         char* inbuf;                    // Buffer OpenSSL reads into.
  78         std::string outbuf;     // Buffer for outgoing data that OpenSSL will not take.
  79         int fd;
  80         bool outbound;
  81
  82         issl_session()
  83         {
  84                 outbound = false;
  85                 rstat = ISSL_READ;
  86                 wstat = ISSL_WRITE;
  87         }
  88 };
  89
  90 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
  91 {
  92         /* XXX: This will allow self signed certificates.
  93          * In the future if we want an option to not allow this,
  94          * we can just return preverify_ok here, and openssl
  95          * will boot off self-signed and invalid peer certs.
  96          */
  97         int ve = X509_STORE_CTX_get_error(ctx);
  98
  99         SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
 100
 101         return 1;
 102 }
 103
 104 class ModuleSSLOpenSSL : public Module
 105 {
 106         std::vector<int> listenports;
 107
 108         int inbufsize;
 109         issl_session sessions[MAX_DESCRIPTORS];
 110
 111         SSL_CTX* ctx;
 112         SSL_CTX* clictx;
 113
 114         char* dummy;
 115         char cipher[MAXBUF];
 116
 117         std::string keyfile;
 118         std::string certfile;
 119         std::string cafile;
 120         // std::string crlfile;
 121         std::string dhfile;
 122         std::string sslports;
 123
 124         int clientactive;
 125
 126  public:
 127
 128         InspIRCd* PublicInstance;
 129
 130         ModuleSSLOpenSSL(InspIRCd* Me)
 131         : Module(Me), PublicInstance(Me)
 132         {
 133                 ServerInstance->Modules->PublishInterface("BufferedSocketHook", this);
 134
 135                 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
 136                 inbufsize = ServerInstance->Config->NetBufferSize;
 137
 138                 /* Global SSL library initialization*/
 139                 SSL_library_init();
 140                 SSL_load_error_strings();
 141
 142                 /* Build our SSL contexts:
 143                  * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
 144                  */
 145                 ctx = SSL_CTX_new( SSLv23_server_method() );
 146                 clictx = SSL_CTX_new( SSLv23_client_method() );
 147
 148                 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
 149                 SSL_CTX_set_verify(clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
 150
 151                 // Needs the flag as it ignores a plain /rehash
 152                 OnRehash(NULL,"ssl");
 153         }
 154
 155         virtual void OnRehash(User* user, const std::string &param)
 156         {
 157                 if (param != "ssl")
 158                         return;
 159
 160                 ConfigReader Conf(ServerInstance);
 161
 162                 for (unsigned int i = 0; i < listenports.size(); i++)
 163                 {
 164                         ServerInstance->Config->DelIOHook(listenports[i]);
 165                 }
 166
 167                 listenports.clear();
 168                 clientactive = 0;
 169                 sslports.clear();
 170
 171                 for (int i = 0; i < Conf.Enumerate("bind"); i++)
 172                 {
 173                         // For each <bind> tag
 174                         std::string x = Conf.ReadValue("bind", "type", i);
 175                         if (((x.empty()) || (x == "clients")) && (Conf.ReadValue("bind", "ssl", i) == "openssl"))
 176                         {
 177                                 // Get the port we're meant to be listening on with SSL
 178                                 std::string port = Conf.ReadValue("bind", "port", i);
 179                                 irc::portparser portrange(port, false);
 180                                 long portno = -1;
 181                                 while ((portno = portrange.GetToken()))
 182                                 {
 183                                         clientactive++;
 184                                         try
 185                                         {
 186                                                 if (ServerInstance->Config->AddIOHook(portno, this))
 187                                                 {
 188                                                         listenports.push_back(portno);
 189                                                                 for (size_t i = 0; i < ServerInstance->Config->ports.size(); i++)
 190                                                                 if (ServerInstance->Config->ports[i]->GetPort() == portno)
 191                                                                         ServerInstance->Config->ports[i]->SetDescription("ssl");
 192                                                         ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %d", portno);
 193                                                         sslports.append("*:").append(ConvToStr(portno)).append(";");
 194                                                 }
 195                                                 else
 196                                                 {
 197                                                         ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
 198                                                 }
 199                                         }
 200                                         catch (ModuleException &e)
 201                                         {
 202                                                 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: FAILED to enable SSL on port %d: %s. Maybe it's already hooked by the same port on a different IP, or you have another SSL or similar module loaded?", portno, e.GetReason());
 203                                         }
 204                                 }
 205                         }
 206                 }
 207
 208                 if (!sslports.empty())
 209                         sslports.erase(sslports.end() - 1);
 210
 211                 std::string confdir(ServerInstance->ConfigFileName);
 212                 // +1 so we the path ends with a /
 213                 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
 214
 215                 cafile   = Conf.ReadValue("openssl", "cafile", 0);
 216                 certfile = Conf.ReadValue("openssl", "certfile", 0);
 217                 keyfile  = Conf.ReadValue("openssl", "keyfile", 0);
 218                 dhfile   = Conf.ReadValue("openssl", "dhfile", 0);
 219
 220                 // Set all the default values needed.
 221                 if (cafile.empty())
 222                         cafile = "ca.pem";
 223
 224                 if (certfile.empty())
 225                         certfile = "cert.pem";
 226
 227                 if (keyfile.empty())
 228                         keyfile = "key.pem";
 229
 230                 if (dhfile.empty())
 231                         dhfile = "dhparams.pem";
 232
 233                 // Prepend relative paths with the path to the config directory.
 234                 if (cafile[0] != '/')
 235                         cafile = confdir + cafile;
 236
 237                 if (certfile[0] != '/')
 238                         certfile = confdir + certfile;
 239
 240                 if (keyfile[0] != '/')
 241                         keyfile = confdir + keyfile;
 242
 243                 if (dhfile[0] != '/')
 244                         dhfile = confdir + dhfile;
 245
 246                 /* Load our keys and certificates
 247                  * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
 248                  */
 249                 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
 250                 {
 251                         ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
 252                         ERR_print_errors_cb(error_callback, this);
 253                 }
 254
 255                 if (((!SSL_CTX_use_PrivateKey_file(ctx, keyfile.c_str(), SSL_FILETYPE_PEM))) || (!SSL_CTX_use_PrivateKey_file(clictx, keyfile.c_str(), SSL_FILETYPE_PEM)))
 256                 {
 257                         ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
 258                         ERR_print_errors_cb(error_callback, this);
 259                 }
 260
 261                 /* Load the CAs we trust*/
 262                 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
 263                 {
 264                         ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read CA list from %s. %s", cafile.c_str(), strerror(errno));
 265                         ERR_print_errors_cb(error_callback, this);
 266                 }
 267
 268                 FILE* dhpfile = fopen(dhfile.c_str(), "r");
 269                 DH* ret;
 270
 271                 if (dhpfile == NULL)
 272                 {
 273                         ServerInstance->Log(DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
 274                         throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
 275                 }
 276                 else
 277                 {
 278                         ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
 279                         if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
 280                         {
 281                                 ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
 282                                 ERR_print_errors_cb(error_callback, this);
 283                         }
 284                 }
 285
 286                 fclose(dhpfile);
 287         }
 288
 289         virtual void On005Numeric(std::string &output)
 290         {
 291                 output.append(" SSL=" + sslports);
 292         }
 293
 294         virtual ~ModuleSSLOpenSSL()
 295         {
 296                 SSL_CTX_free(ctx);
 297                 SSL_CTX_free(clictx);
 298         }
 299
 300         virtual void OnCleanup(int target_type, void* item)
 301         {
 302                 if (target_type == TYPE_USER)
 303                 {
 304                         User* user = (User*)item;
 305
 306                         if (user->GetExt("ssl", dummy) && IS_LOCAL(user) && isin(user->GetPort(), listenports))
 307                         {
 308                                 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
 309                                 // Potentially there could be multiple SSL modules loaded at once on different ports.
 310                                 User::QuitUser(ServerInstance, user, "SSL module unloading");
 311                         }
 312                         if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
 313                         {
 314                                 ssl_cert* tofree;
 315                                 user->GetExt("ssl_cert", tofree);
 316                                 delete tofree;
 317                                 user->Shrink("ssl_cert");
 318                         }
 319                 }
 320         }
 321
 322         virtual void OnUnloadModule(Module* mod, const std::string &name)
 323         {
 324                 if (mod == this)
 325                 {
 326                         for(unsigned int i = 0; i < listenports.size(); i++)
 327                         {
 328                                 ServerInstance->Config->DelIOHook(listenports[i]);
 329                                 for (size_t j = 0; j < ServerInstance->Config->ports.size(); j++)
 330                                         if (ServerInstance->Config->ports[j]->GetPort() == listenports[i])
 331                                                 ServerInstance->Config->ports[j]->SetDescription("plaintext");
 332                         }
 333                 }
 334         }
 335
 336         virtual Version GetVersion()
 337         {
 338                 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
 339         }
 340
 341         void Implements(char* List)
 342         {
 343                 List[I_OnRawSocketConnect] = List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = List[I_On005Numeric] = 1;
 344                 List[I_OnBufferFlushed] = List[I_OnRequest] = List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
 345         }
 346
 347         virtual char* OnRequest(Request* request)
 348         {
 349                 ISHRequest* ISR = (ISHRequest*)request;
 350                 if (strcmp("IS_NAME", request->GetId()) == 0)
 351                 {
 352                         return "openssl";
 353                 }
 354                 else if (strcmp("IS_HOOK", request->GetId()) == 0)
 355                 {
 356                         char* ret = "OK";
 357                         try
 358                         {
 359                                 ret = ServerInstance->Config->AddIOHook((Module*)this, (BufferedSocket*)ISR->Sock) ? (char*)"OK" : NULL;
 360                         }
 361                         catch (ModuleException &e)
 362                         {
 363                                 return NULL;
 364                         }
 365
 366                         return ret;
 367                 }
 368                 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
 369                 {
 370                         return ServerInstance->Config->DelIOHook((BufferedSocket*)ISR->Sock) ? (char*)"OK" : NULL;
 371                 }
 372                 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
 373                 {
 374                         if (ISR->Sock->GetFd() < 0)
 375                                 return (char*)"OK";
 376
 377                         issl_session* session = &sessions[ISR->Sock->GetFd()];
 378                         return (session->status == ISSL_HANDSHAKING) ? NULL : (char*)"OK";
 379                 }
 380                 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
 381                 {
 382                         issl_session* session = &sessions[ISR->Sock->GetFd()];
 383                         if (session->sess)
 384                         {
 385                                 VerifyCertificate(session, (BufferedSocket*)ISR->Sock);
 386                                 return "OK";
 387                         }
 388                 }
 389                 return NULL;
 390         }
 391
 392
 393         virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
 394         {
 395                 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
 396                 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
 397                         return;
 398
 399                 issl_session* session = &sessions[fd];
 400
 401                 session->fd = fd;
 402                 session->inbuf = new char[inbufsize];
 403                 session->inbufoffset = 0;
 404                 session->sess = SSL_new(ctx);
 405                 session->status = ISSL_NONE;
 406                 session->outbound = false;
 407
 408                 if (session->sess == NULL)
 409                         return;
 410
 411                 if (SSL_set_fd(session->sess, fd) == 0)
 412                 {
 413                         ServerInstance->Log(DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
 414                         return;
 415                 }
 416
 417                 Handshake(session);
 418         }
 419
 420         virtual void OnRawSocketConnect(int fd)
 421         {
 422                 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
 423                 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
 424                         return;
 425
 426                 issl_session* session = &sessions[fd];
 427
 428                 session->fd = fd;
 429                 session->inbuf = new char[inbufsize];
 430                 session->inbufoffset = 0;
 431                 session->sess = SSL_new(clictx);
 432                 session->status = ISSL_NONE;
 433                 session->outbound = true;
 434
 435                 if (session->sess == NULL)
 436                         return;
 437
 438                 if (SSL_set_fd(session->sess, fd) == 0)
 439                 {
 440                         ServerInstance->Log(DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
 441                         return;
 442                 }
 443
 444                 Handshake(session);
 445         }
 446
 447         virtual void OnRawSocketClose(int fd)
 448         {
 449                 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
 450                 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
 451                         return;
 452
 453                 CloseSession(&sessions[fd]);
 454
 455                 EventHandler* user = ServerInstance->SE->GetRef(fd);
 456
 457                 if ((user) && (user->GetExt("ssl_cert", dummy)))
 458                 {
 459                         ssl_cert* tofree;
 460                         user->GetExt("ssl_cert", tofree);
 461                         delete tofree;
 462                         user->Shrink("ssl_cert");
 463                 }
 464         }
 465
 466         virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
 467         {
 468                 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
 469                 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
 470                         return 0;
 471
 472                 issl_session* session = &sessions[fd];
 473
 474                 if (!session->sess)
 475                 {
 476                         readresult = 0;
 477                         CloseSession(session);
 478                         return 1;
 479                 }
 480
 481                 if (session->status == ISSL_HANDSHAKING)
 482                 {
 483                         if (session->rstat == ISSL_READ || session->wstat == ISSL_READ)
 484                         {
 485                                 // The handshake isn't finished and it wants to read, try to finish it.
 486                                 if (!Handshake(session))
 487                                 {
 488                                         // Couldn't resume handshake.
 489                                         return -1;
 490                                 }
 491                         }
 492                         else
 493                         {
 494                                 errno = EAGAIN;
 495                                 return -1;
 496                         }
 497                 }
 498
 499                 // If we resumed the handshake then session->status will be ISSL_OPEN
 500
 501                 if (session->status == ISSL_OPEN)
 502                 {
 503                         if (session->wstat == ISSL_READ)
 504                         {
 505                                 if(DoWrite(session) == 0)
 506                                         return 0;
 507                         }
 508
 509                         if (session->rstat == ISSL_READ)
 510                         {
 511                                 int ret = DoRead(session);
 512
 513                                 if (ret > 0)
 514                                 {
 515                                         if (count <= session->inbufoffset)
 516                                         {
 517                                                 memcpy(buffer, session->inbuf, count);
 518                                                 // Move the stuff left in inbuf to the beginning of it
 519                                                 memcpy(session->inbuf, session->inbuf + count, (session->inbufoffset - count));
 520                                                 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
 521                                                 session->inbufoffset -= count;
 522                                                 // Insp uses readresult as the count of how much data there is in buffer, so:
 523                                                 readresult = count;
 524                                         }
 525                                         else
 526                                         {
 527                                                 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
 528                                                 memcpy(buffer, session->inbuf, session->inbufoffset);
 529
 530                                                 readresult = session->inbufoffset;
 531                                                 // Zero the offset, as there's nothing there..
 532                                                 session->inbufoffset = 0;
 533                                         }
 534                                         return 1;
 535                                 }
 536                                 return ret;
 537                         }
 538                 }
 539
 540                 return -1;
 541         }
 542
 543         virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
 544         {
 545                 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
 546                 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
 547                         return 0;
 548
 549                 issl_session* session = &sessions[fd];
 550
 551                 if (!session->sess)
 552                 {
 553                         CloseSession(session);
 554                         return -1;
 555                 }
 556
 557                 session->outbuf.append(buffer, count);
 558                 MakePollWrite(session);
 559
 560                 if (session->status == ISSL_HANDSHAKING)
 561                 {
 562                         // The handshake isn't finished, try to finish it.
 563                         if (session->rstat == ISSL_WRITE || session->wstat == ISSL_WRITE)
 564                         {
 565                                 Handshake(session);
 566                         }
 567                 }
 568
 569                 if (session->status == ISSL_OPEN)
 570                 {
 571                         if (session->rstat == ISSL_WRITE)
 572                         {
 573                                 DoRead(session);
 574                         }
 575
 576                         if (session->wstat == ISSL_WRITE)
 577                         {
 578                                 return DoWrite(session);
 579                         }
 580                 }
 581
 582                 return 1;
 583         }
 584
 585         int DoWrite(issl_session* session)
 586         {
 587                 if (!session->outbuf.size())
 588                         return -1;
 589
 590                 int ret = SSL_write(session->sess, session->outbuf.data(), session->outbuf.size());
 591
 592                 if (ret == 0)
 593                 {
 594                         CloseSession(session);
 595                         return 0;
 596                 }
 597                 else if (ret < 0)
 598                 {
 599                         int err = SSL_get_error(session->sess, ret);
 600
 601                         if (err == SSL_ERROR_WANT_WRITE)
 602                         {
 603                                 session->wstat = ISSL_WRITE;
 604                                 return -1;
 605                         }
 606                         else if (err == SSL_ERROR_WANT_READ)
 607                         {
 608                                 session->wstat = ISSL_READ;
 609                                 return -1;
 610                         }
 611                         else
 612                         {
 613                                 CloseSession(session);
 614                                 return 0;
 615                         }
 616                 }
 617                 else
 618                 {
 619                         session->outbuf = session->outbuf.substr(ret);
 620                         return ret;
 621                 }
 622         }
 623
 624         int DoRead(issl_session* session)
 625         {
 626                 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
 627                 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
 628
 629                 int ret = SSL_read(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
 630
 631                 if (ret == 0)
 632                 {
 633                         // Client closed connection.
 634                         CloseSession(session);
 635                         return 0;
 636                 }
 637                 else if (ret < 0)
 638                 {
 639                         int err = SSL_get_error(session->sess, ret);
 640
 641                         if (err == SSL_ERROR_WANT_READ)
 642                         {
 643                                 session->rstat = ISSL_READ;
 644                                 return -1;
 645                         }
 646                         else if (err == SSL_ERROR_WANT_WRITE)
 647                         {
 648                                 session->rstat = ISSL_WRITE;
 649                                 MakePollWrite(session);
 650                                 return -1;
 651                         }
 652                         else
 653                         {
 654                                 CloseSession(session);
 655                                 return 0;
 656                         }
 657                 }
 658                 else
 659                 {
 660                         // Read successfully 'ret' bytes into inbuf + inbufoffset
 661                         // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
 662                         // 'buffer' is 'count' long
 663
 664                         session->inbufoffset += ret;
 665
 666                         return ret;
 667                 }
 668         }
 669
 670         // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
 671         virtual void OnWhois(User* source, User* dest)
 672         {
 673                 if (!clientactive)
 674                         return;
 675
 676                 // Bugfix, only send this numeric for *our* SSL users
 677                 if (dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) &&  isin(dest->GetPort(), listenports)))
 678                 {
 679                         ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
 680                 }
 681         }
 682
 683         virtual void OnSyncUserMetaData(User* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
 684         {
 685                 // check if the linking module wants to know about OUR metadata
 686                 if (extname == "ssl")
 687                 {
 688                         // check if this user has an swhois field to send
 689                         if(user->GetExt(extname, dummy))
 690                         {
 691                                 // call this function in the linking module, let it format the data how it
 692                                 // sees fit, and send it on its way. We dont need or want to know how.
 693                                 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, displayable ? "Enabled" : "ON");
 694                         }
 695                 }
 696         }
 697
 698         virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
 699         {
 700                 // check if its our metadata key, and its associated with a user
 701                 if ((target_type == TYPE_USER) && (extname == "ssl"))
 702                 {
 703                         User* dest = (User*)target;
 704                         // if they dont already have an ssl flag, accept the remote server's
 705                         if (!dest->GetExt(extname, dummy))
 706                         {
 707                                 dest->Extend(extname, "ON");
 708                         }
 709                 }
 710         }
 711
 712         bool Handshake(issl_session* session)
 713         {
 714                 int ret;
 715
 716                 if (session->outbound)
 717                         ret = SSL_connect(session->sess);
 718                 else
 719                         ret = SSL_accept(session->sess);
 720
 721                 if (ret < 0)
 722                 {
 723                         int err = SSL_get_error(session->sess, ret);
 724
 725                         if (err == SSL_ERROR_WANT_READ)
 726                         {
 727                                 session->rstat = ISSL_READ;
 728                                 session->status = ISSL_HANDSHAKING;
 729                                 return true;
 730                         }
 731                         else if (err == SSL_ERROR_WANT_WRITE)
 732                         {
 733                                 session->wstat = ISSL_WRITE;
 734                                 session->status = ISSL_HANDSHAKING;
 735                                 MakePollWrite(session);
 736                                 return true;
 737                         }
 738                         else
 739                         {
 740                                 CloseSession(session);
 741                         }
 742
 743                         return false;
 744                 }
 745                 else if (ret > 0)
 746                 {
 747                         // Handshake complete.
 748                         // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
 749                         User* u = ServerInstance->FindDescriptor(session->fd);
 750                         if (u)
 751                         {
 752                                 if (!u->GetExt("ssl", dummy))
 753                                         u->Extend("ssl", "ON");
 754                         }
 755
 756                         session->status = ISSL_OPEN;
 757
 758                         MakePollWrite(session);
 759
 760                         return true;
 761                 }
 762                 else if (ret == 0)
 763                 {
 764                         CloseSession(session);
 765                         return true;
 766                 }
 767
 768                 return true;
 769         }
 770
 771         virtual void OnPostConnect(User* user)
 772         {
 773                 // This occurs AFTER OnUserConnect so we can be sure the
 774                 // protocol module has propagated the NICK message.
 775                 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
 776                 {
 777                         // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
 778                         std::deque<std::string>* metadata = new std::deque<std::string>;
 779                         metadata->push_back(user->nick);
 780                         metadata->push_back("ssl");             // The metadata id
 781                         metadata->push_back("ON");              // The value to send
 782                         Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
 783                         event->Send(ServerInstance);            // Trigger the event. We don't care what module picks it up.
 784                         DELETE(event);
 785                         DELETE(metadata);
 786
 787                         VerifyCertificate(&sessions[user->GetFd()], user);
 788                         if (sessions[user->GetFd()].sess)
 789                                 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick, SSL_get_cipher(sessions[user->GetFd()].sess));
 790                 }
 791         }
 792
 793         void MakePollWrite(issl_session* session)
 794         {
 795                 //OnRawSocketWrite(session->fd, NULL, 0);
 796                 EventHandler* eh = ServerInstance->FindDescriptor(session->fd);
 797                 if (eh)
 798                 {
 799                         ServerInstance->SE->WantWrite(eh);
 800                 }
 801         }
 802
 803         virtual void OnBufferFlushed(User* user)
 804         {
 805                 if (user->GetExt("ssl"))
 806                 {
 807                         issl_session* session = &sessions[user->GetFd()];
 808                         if (session && session->outbuf.size())
 809                                 OnRawSocketWrite(user->GetFd(), NULL, 0);
 810                 }
 811         }
 812
 813         void CloseSession(issl_session* session)
 814         {
 815                 if (session->sess)
 816                 {
 817                         SSL_shutdown(session->sess);
 818                         SSL_free(session->sess);
 819                 }
 820
 821                 if (session->inbuf)
 822                 {
 823                         delete[] session->inbuf;
 824                 }
 825
 826                 session->outbuf.clear();
 827                 session->inbuf = NULL;
 828                 session->sess = NULL;
 829                 session->status = ISSL_NONE;
 830         }
 831
 832         void VerifyCertificate(issl_session* session, Extensible* user)
 833         {
 834                 if (!session->sess || !user)
 835                         return;
 836
 837                 X509* cert;
 838                 ssl_cert* certinfo = new ssl_cert;
 839                 unsigned int n;
 840                 unsigned char md[EVP_MAX_MD_SIZE];
 841                 const EVP_MD *digest = EVP_md5();
 842
 843                 user->Extend("ssl_cert",certinfo);
 844
 845                 cert = SSL_get_peer_certificate((SSL*)session->sess);
 846
 847                 if (!cert)
 848                 {
 849                         certinfo->data.insert(std::make_pair("error","Could not get peer certificate: "+std::string(get_error())));
 850                         return;
 851                 }
 852
 853                 certinfo->data.insert(std::make_pair("invalid", SSL_get_verify_result(session->sess) != X509_V_OK ? ConvToStr(1) : ConvToStr(0)));
 854
 855                 if (SelfSigned)
 856                 {
 857                         certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
 858                         certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
 859                 }
 860                 else
 861                 {
 862                         certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
 863                         certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
 864                 }
 865
 866                 certinfo->data.insert(std::make_pair("dn",std::string(X509_NAME_oneline(X509_get_subject_name(cert),0,0))));
 867                 certinfo->data.insert(std::make_pair("issuer",std::string(X509_NAME_oneline(X509_get_issuer_name(cert),0,0))));
 868
 869                 if (!X509_digest(cert, digest, md, &n))
 870                 {
 871                         certinfo->data.insert(std::make_pair("error","Out of memory generating fingerprint"));
 872                 }
 873                 else
 874                 {
 875                         certinfo->data.insert(std::make_pair("fingerprint",irc::hex(md, n)));
 876                 }
 877
 878                 if ((ASN1_UTCTIME_cmp_time_t(X509_get_notAfter(cert), time(NULL)) == -1) || (ASN1_UTCTIME_cmp_time_t(X509_get_notBefore(cert), time(NULL)) == 0))
 879                 {
 880                         certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
 881                 }
 882
 883                 X509_free(cert);
 884         }
 885 };
 886
 887 static int error_callback(const char *str, size_t len, void *u)
 888 {
 889         ModuleSSLOpenSSL* mssl = (ModuleSSLOpenSSL*)u;
 890         mssl->PublicInstance->Log(DEFAULT, "SSL error: " + std::string(str, len - 1));
 891         return 0;
 892 }
 893
 894 MODULE_INIT(ModuleSSLOpenSSL);