src/modules/extra/m_ssl_gnutls.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 <string>
  15 #include <vector>
  16
  17 #include <gnutls/gnutls.h>
  18 #include <gnutls/x509.h>
  19
  20 #include "inspircd_config.h"
  21 #include "configreader.h"
  22 #include "users.h"
  23 #include "channels.h"
  24 #include "modules.h"
  25
  26 #include "socket.h"
  27 #include "hashcomp.h"
  28 #include "inspircd.h"
  29
  30 #include "transport.h"
  31
  32 /* $ModDesc: Provides SSL support for clients */
  33 /* $CompileFlags: `libgnutls-config --cflags` */
  34 /* $LinkerFlags: `perl extra/gnutls_rpath.pl` */
  35 /* $ModDep: transport.h */
  36
  37
  38 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
  39
  40 bool isin(int port, const std::vector<int> &portlist)
  41 {
  42         for(unsigned int i = 0; i < portlist.size(); i++)
  43                 if(portlist[i] == port)
  44                         return true;
  45
  46         return false;
  47 }
  48
  49 /** Represents an SSL user's extra data
  50  */
  51 class issl_session : public classbase
  52 {
  53 public:
  54         gnutls_session_t sess;
  55         issl_status status;
  56         std::string outbuf;
  57         int inbufoffset;
  58         char* inbuf;
  59         int fd;
  60 };
  61
  62 class ModuleSSLGnuTLS : public Module
  63 {
  64
  65         ConfigReader* Conf;
  66
  67         char* dummy;
  68
  69         CullList* culllist;
  70
  71         std::vector<int> listenports;
  72
  73         int inbufsize;
  74         issl_session sessions[MAX_DESCRIPTORS];
  75
  76         gnutls_certificate_credentials x509_cred;
  77         gnutls_dh_params dh_params;
  78
  79         std::string keyfile;
  80         std::string certfile;
  81         std::string cafile;
  82         std::string crlfile;
  83         int dh_bits;
  84
  85  public:
  86
  87         ModuleSSLGnuTLS(InspIRCd* Me)
  88                 : Module::Module(Me)
  89         {
  90
  91
  92                 culllist = new CullList(ServerInstance);
  93
  94                 ServerInstance->PublishInterface("InspSocketHook", this);
  95
  96                 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
  97                 inbufsize = ServerInstance->Config->NetBufferSize;
  98
  99                 gnutls_global_init(); // This must be called once in the program
 100
 101                 if(gnutls_certificate_allocate_credentials(&x509_cred) != 0)
 102                         ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to allocate certificate credentials");
 103
 104                 // Guessing return meaning
 105                 if(gnutls_dh_params_init(&dh_params) < 0)
 106                         ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters");
 107
 108                 // Needs the flag as it ignores a plain /rehash
 109                 OnRehash("ssl");
 110
 111                 // Void return, guess we assume success
 112                 gnutls_certificate_set_dh_params(x509_cred, dh_params);
 113         }
 114
 115         virtual void OnRehash(const std::string &param)
 116         {
 117                 if(param != "ssl")
 118                         return;
 119
 120                 Conf = new ConfigReader(ServerInstance);
 121
 122                 for(unsigned int i = 0; i < listenports.size(); i++)
 123                 {
 124                         ServerInstance->Config->DelIOHook(listenports[i]);
 125                 }
 126
 127                 listenports.clear();
 128
 129                 for(int i = 0; i < Conf->Enumerate("bind"); i++)
 130                 {
 131                         // For each <bind> tag
 132                         if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "gnutls"))
 133                         {
 134                                 // Get the port we're meant to be listening on with SSL
 135                                 std::string port = Conf->ReadValue("bind", "port", i);
 136                                 irc::portparser portrange(port, false);
 137                                 long portno = -1;
 138                                 while ((portno = portrange.GetToken()))
 139                                 {
 140                                         if (ServerInstance->Config->AddIOHook(portno, this))
 141                                         {
 142                                                 listenports.push_back(portno);
 143                                                 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %d", portno);
 144                                         }
 145                                         else
 146                                         {
 147                                                 ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
 148                                         }
 149                                 }
 150                         }
 151                 }
 152
 153                 std::string confdir(CONFIG_FILE);
 154                 // +1 so we the path ends with a /
 155                 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
 156
 157                 cafile  = Conf->ReadValue("gnutls", "cafile", 0);
 158                 crlfile = Conf->ReadValue("gnutls", "crlfile", 0);
 159                 certfile        = Conf->ReadValue("gnutls", "certfile", 0);
 160                 keyfile = Conf->ReadValue("gnutls", "keyfile", 0);
 161                 dh_bits = Conf->ReadInteger("gnutls", "dhbits", 0, false);
 162
 163                 // Set all the default values needed.
 164                 if(cafile == "")
 165                         cafile = "ca.pem";
 166
 167                 if(crlfile == "")
 168                         crlfile = "crl.pem";
 169
 170                 if(certfile == "")
 171                         certfile = "cert.pem";
 172
 173                 if(keyfile == "")
 174                         keyfile = "key.pem";
 175
 176                 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
 177                         dh_bits = 1024;
 178
 179                 // Prepend relative paths with the path to the config directory.
 180                 if(cafile[0] != '/')
 181                         cafile = confdir + cafile;
 182
 183                 if(crlfile[0] != '/')
 184                         crlfile = confdir + crlfile;
 185
 186                 if(certfile[0] != '/')
 187                         certfile = confdir + certfile;
 188
 189                 if(keyfile[0] != '/')
 190                         keyfile = confdir + keyfile;
 191
 192                 if(gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
 193                         ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 trust file: %s", cafile.c_str());
 194
 195                 if(gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
 196                         ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 CRL file: %s", crlfile.c_str());
 197
 198                 // Guessing on the return value of this, manual doesn't say :|
 199                 if(gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
 200                         ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 certificate and key files: %s and %s", certfile.c_str(), keyfile.c_str());
 201
 202                 // This may be on a large (once a day or week) timer eventually.
 203                 GenerateDHParams();
 204
 205                 DELETE(Conf);
 206         }
 207
 208         void GenerateDHParams()
 209         {
 210                 // Generate Diffie Hellman parameters - for use with DHE
 211                 // kx algorithms. These should be discarded and regenerated
 212                 // once a day, once a week or once a month. Depending on the
 213                 // security requirements.
 214
 215                 if(gnutls_dh_params_generate2(dh_params, dh_bits) < 0)
 216                         ServerInstance->Log(DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits)", dh_bits);
 217         }
 218
 219         virtual ~ModuleSSLGnuTLS()
 220         {
 221                 gnutls_dh_params_deinit(dh_params);
 222                 gnutls_certificate_free_credentials(x509_cred);
 223                 gnutls_global_deinit();
 224                 delete culllist;
 225         }
 226
 227         virtual void OnCleanup(int target_type, void* item)
 228         {
 229                 if(target_type == TYPE_USER)
 230                 {
 231                         userrec* user = (userrec*)item;
 232
 233                         if(user->GetExt("ssl", dummy) && isin(user->GetPort(), listenports))
 234                         {
 235                                 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
 236                                 // Potentially there could be multiple SSL modules loaded at once on different ports.
 237                                 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Adding user %s to cull list", user->nick);
 238                                 culllist->AddItem(user, "SSL module unloading");
 239                         }
 240                         if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
 241                         {
 242                                 ssl_cert* tofree;
 243                                 user->GetExt("ssl_cert", tofree);
 244                                 delete tofree;
 245                                 user->Shrink("ssl_cert");
 246                         }
 247                 }
 248         }
 249
 250         virtual void OnUnloadModule(Module* mod, const std::string &name)
 251         {
 252                 if(mod == this)
 253                 {
 254                         // We're being unloaded, kill all the users added to the cull list in OnCleanup
 255                         int numusers = culllist->Apply();
 256                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Killed %d users for unload of GnuTLS SSL module", numusers);
 257
 258                         for(unsigned int i = 0; i < listenports.size(); i++)
 259                                 ServerInstance->Config->DelIOHook(listenports[i]);
 260                 }
 261         }
 262
 263         virtual Version GetVersion()
 264         {
 265                 return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
 266         }
 267
 268         void Implements(char* List)
 269         {
 270                 List[I_OnRawSocketConnect] = List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
 271                 List[I_OnRequest] = List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = List[I_OnPostConnect] = 1;
 272         }
 273
 274         virtual char* OnRequest(Request* request)
 275         {
 276                 ISHRequest* ISR = (ISHRequest*)request;
 277                 if (strcmp("IS_NAME", request->GetId()) == 0)
 278                 {
 279                         return "gnutls";
 280                 }
 281                 else if (strcmp("IS_HOOK", request->GetId()) == 0)
 282                 {
 283                         char* ret = "OK";
 284                         try
 285                         {
 286                                 ret = ServerInstance->Config->AddIOHook((Module*)this, (InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
 287                         }
 288                         catch (ModuleException &e)
 289                         {
 290                                 return NULL;
 291                         }
 292                         return ret;
 293                 }
 294                 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
 295                 {
 296                         return ServerInstance->Config->DelIOHook((InspSocket*)ISR->Sock) ? (char*)"OK" : NULL;
 297                 }
 298                 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
 299                 {
 300                         issl_session* session = &sessions[ISR->Sock->GetFd()];
 301                         return (session->status == ISSL_HANDSHAKING_READ || session->status == ISSL_HANDSHAKING_WRITE) ? NULL : (char*)"OK";
 302                 }
 303                 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
 304                 {
 305                         issl_session* session = &sessions[ISR->Sock->GetFd()];
 306                         if (session)
 307                         {
 308                                 VerifyCertificate(session, (InspSocket*)ISR->Sock);
 309                                 return "OK";
 310                         }
 311                 }
 312                 return NULL;
 313         }
 314
 315
 316         virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
 317         {
 318                 issl_session* session = &sessions[fd];
 319
 320                 session->fd = fd;
 321                 session->inbuf = new char[inbufsize];
 322                 session->inbufoffset = 0;
 323
 324                 gnutls_init(&session->sess, GNUTLS_SERVER);
 325
 326                 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
 327                 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
 328                 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
 329                 gnutls_dh_set_prime_bits(session->sess, dh_bits);
 330
 331                 /* This is an experimental change to avoid a warning on 64bit systems about casting between integer and pointer of different sizes
 332                  * This needs testing, but it's easy enough to rollback if need be
 333                  * Old: gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
 334                  * New: gnutls_transport_set_ptr(session->sess, &fd); // Give gnutls the fd for the socket.
 335                  *
 336                  * With testing this seems to...not work :/
 337                  */
 338
 339                 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
 340
 341                 Handshake(session);
 342         }
 343
 344         virtual void OnRawSocketConnect(int fd)
 345         {
 346                 issl_session* session = &sessions[fd];
 347
 348                 session->fd = fd;
 349                 session->inbuf = new char[inbufsize];
 350                 session->inbufoffset = 0;
 351
 352                 gnutls_init(&session->sess, GNUTLS_SERVER);
 353
 354                 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
 355                 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
 356                 gnutls_dh_set_prime_bits(session->sess, dh_bits);
 357
 358                 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
 359
 360                 Handshake(session);
 361         }
 362
 363         virtual void OnRawSocketClose(int fd)
 364         {
 365                 ServerInstance->Log(DEBUG, "OnRawSocketClose: %d", fd);
 366                 CloseSession(&sessions[fd]);
 367
 368                 EventHandler* user = ServerInstance->SE->GetRef(fd);
 369
 370                 if ((user) && (user->GetExt("ssl_cert", dummy)))
 371                 {
 372                         ssl_cert* tofree;
 373                         user->GetExt("ssl_cert", tofree);
 374                         delete tofree;
 375                         user->Shrink("ssl_cert");
 376                 }
 377         }
 378
 379         virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
 380         {
 381                 issl_session* session = &sessions[fd];
 382
 383                 if (!session->sess)
 384                 {
 385                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: No session to read from");
 386                         readresult = 0;
 387                         CloseSession(session);
 388                         return 1;
 389                 }
 390
 391                 if (session->status == ISSL_HANDSHAKING_READ)
 392                 {
 393                         // The handshake isn't finished, try to finish it.
 394
 395                         if(Handshake(session))
 396                         {
 397                                 // Handshake successfully resumed.
 398                                 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: successfully resumed handshake");
 399                         }
 400                         else
 401                         {
 402                                 // Couldn't resume handshake.
 403                                 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: failed to resume handshake");
 404                                 return -1;
 405                         }
 406                 }
 407                 else if (session->status == ISSL_HANDSHAKING_WRITE)
 408                 {
 409                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: handshake wants to write data but we are currently reading");
 410                         return -1;
 411                 }
 412
 413                 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
 414
 415                 if (session->status == ISSL_HANDSHAKEN)
 416                 {
 417                         // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
 418                         // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
 419                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: gnutls_record_recv(sess, inbuf+%d, %d-%d)", session->inbufoffset, inbufsize, session->inbufoffset);
 420
 421                         int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
 422
 423                         if (ret == 0)
 424                         {
 425                                 // Client closed connection.
 426                                 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Client closed the connection");
 427                                 readresult = 0;
 428                                 CloseSession(session);
 429                                 return 1;
 430                         }
 431                         else if (ret < 0)
 432                         {
 433                                 if (ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
 434                                 {
 435                                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Not all SSL data read: %s", gnutls_strerror(ret));
 436                                         return -1;
 437                                 }
 438                                 else
 439                                 {
 440                                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Error reading SSL data: %s", gnutls_strerror(ret));
 441                                         readresult = 0;
 442                                         CloseSession(session);
 443                                 }
 444                         }
 445                         else
 446                         {
 447                                 // Read successfully 'ret' bytes into inbuf + inbufoffset
 448                                 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
 449                                 // 'buffer' is 'count' long
 450
 451                                 unsigned int length = ret + session->inbufoffset;
 452
 453                                 if(count <= length)
 454                                 {
 455                                         memcpy(buffer, session->inbuf, count);
 456                                         // Move the stuff left in inbuf to the beginning of it
 457                                         memcpy(session->inbuf, session->inbuf + count, (length - count));
 458                                         // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
 459                                         session->inbufoffset = length - count;
 460                                         // Insp uses readresult as the count of how much data there is in buffer, so:
 461                                         readresult = count;
 462                                 }
 463                                 else
 464                                 {
 465                                         // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
 466                                         memcpy(buffer, session->inbuf, length);
 467                                         // Zero the offset, as there's nothing there..
 468                                         session->inbufoffset = 0;
 469                                         // As above
 470                                         readresult = length;
 471                                 }
 472                         }
 473                 }
 474                 else if(session->status == ISSL_CLOSING)
 475                 {
 476                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: session closing...");
 477                         readresult = 0;
 478                 }
 479
 480                 return 1;
 481         }
 482
 483         virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
 484         {
 485                 if (!count)
 486                         return 0;
 487
 488                 issl_session* session = &sessions[fd];
 489                 const char* sendbuffer = buffer;
 490
 491                 if(!session->sess)
 492                 {
 493                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: No session to write to");
 494                         CloseSession(session);
 495                         return 1;
 496                 }
 497
 498                 if(session->status == ISSL_HANDSHAKING_WRITE)
 499                 {
 500                         // The handshake isn't finished, try to finish it.
 501
 502                         if(Handshake(session))
 503                         {
 504                                 // Handshake successfully resumed.
 505                                 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: successfully resumed handshake");
 506                         }
 507                         else
 508                         {
 509                                 // Couldn't resume handshake.
 510                                 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: failed to resume handshake");
 511                         }
 512                 }
 513                 else if(session->status == ISSL_HANDSHAKING_READ)
 514                 {
 515                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: handshake wants to read data but we are currently writing");
 516                 }
 517
 518                 session->outbuf.append(sendbuffer, count);
 519                 sendbuffer = session->outbuf.c_str();
 520                 count = session->outbuf.size();
 521
 522                 if(session->status == ISSL_HANDSHAKEN)
 523                 {
 524                         int ret = gnutls_record_send(session->sess, sendbuffer, count);
 525
 526                         if(ret == 0)
 527                         {
 528                                 ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Client closed the connection");
 529                                 CloseSession(session);
 530                         }
 531                         else if(ret < 0)
 532                         {
 533                                 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
 534                                 {
 535                                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Not all SSL data written: %s", gnutls_strerror(ret));
 536                                 }
 537                                 else
 538                                 {
 539                                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Error writing SSL data: %s", gnutls_strerror(ret));
 540                                         CloseSession(session);
 541                                 }
 542                         }
 543                         else
 544                         {
 545                                 session->outbuf = session->outbuf.substr(ret);
 546                         }
 547                 }
 548                 else if(session->status == ISSL_CLOSING)
 549                 {
 550                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: session closing...");
 551                 }
 552
 553                 return 1;
 554         }
 555
 556         // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
 557         virtual void OnWhois(userrec* source, userrec* dest)
 558         {
 559                 // Bugfix, only send this numeric for *our* SSL users
 560                 if(dest->GetExt("ssl", dummy) || (IS_LOCAL(dest) &&  isin(dest->GetPort(), listenports)))
 561                 {
 562                         ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
 563                 }
 564         }
 565
 566         virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
 567         {
 568                 // check if the linking module wants to know about OUR metadata
 569                 if(extname == "ssl")
 570                 {
 571                         // check if this user has an swhois field to send
 572                         if(user->GetExt(extname, dummy))
 573                         {
 574                                 // call this function in the linking module, let it format the data how it
 575                                 // sees fit, and send it on its way. We dont need or want to know how.
 576                                 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
 577                         }
 578                 }
 579         }
 580
 581         virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
 582         {
 583                 // check if its our metadata key, and its associated with a user
 584                 if ((target_type == TYPE_USER) && (extname == "ssl"))
 585                 {
 586                         userrec* dest = (userrec*)target;
 587                         // if they dont already have an ssl flag, accept the remote server's
 588                         if (!dest->GetExt(extname, dummy))
 589                         {
 590                                 dest->Extend(extname, "ON");
 591                         }
 592                 }
 593         }
 594
 595         bool Handshake(issl_session* session)
 596         {
 597                 int ret = gnutls_handshake(session->sess);
 598
 599                 if(ret < 0)
 600                 {
 601                         if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
 602                         {
 603                                 // Handshake needs resuming later, read() or write() would have blocked.
 604
 605                                 if(gnutls_record_get_direction(session->sess) == 0)
 606                                 {
 607                                         // gnutls_handshake() wants to read() again.
 608                                         session->status = ISSL_HANDSHAKING_READ;
 609                                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (reading) later, error string: %s", gnutls_strerror(ret));
 610                                 }
 611                                 else
 612                                 {
 613                                         // gnutls_handshake() wants to write() again.
 614                                         session->status = ISSL_HANDSHAKING_WRITE;
 615                                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (writing) later, error string: %s", gnutls_strerror(ret));
 616                                         MakePollWrite(session);
 617                                 }
 618                         }
 619                         else
 620                         {
 621                                 // Handshake failed.
 622                                 CloseSession(session);
 623                            ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake failed, error string: %s", gnutls_strerror(ret));
 624                            session->status = ISSL_CLOSING;
 625                         }
 626
 627                         return false;
 628                 }
 629                 else
 630                 {
 631                         // Handshake complete.
 632                         ServerInstance->Log(DEBUG, "m_ssl_gnutls.so: Handshake completed");
 633
 634                         // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
 635                         userrec* extendme = ServerInstance->FindDescriptor(session->fd);
 636                         if (extendme)
 637                         {
 638                                 if (!extendme->GetExt("ssl", dummy))
 639                                         extendme->Extend("ssl", "ON");
 640                         }
 641
 642                         // Change the seesion state
 643                         session->status = ISSL_HANDSHAKEN;
 644
 645                         // Finish writing, if any left
 646                         MakePollWrite(session);
 647
 648                         return true;
 649                 }
 650         }
 651
 652         virtual void OnPostConnect(userrec* user)
 653         {
 654                 // This occurs AFTER OnUserConnect so we can be sure the
 655                 // protocol module has propogated the NICK message.
 656                 if ((user->GetExt("ssl", dummy)) && (IS_LOCAL(user)))
 657                 {
 658                         // Tell whatever protocol module we're using that we need to inform other servers of this metadata NOW.
 659                         std::deque<std::string>* metadata = new std::deque<std::string>;
 660                         metadata->push_back(user->nick);
 661                         metadata->push_back("ssl");             // The metadata id
 662                         metadata->push_back("ON");              // The value to send
 663                         Event* event = new Event((char*)metadata,(Module*)this,"send_metadata");
 664                         event->Send(ServerInstance);            // Trigger the event. We don't care what module picks it up.
 665                         DELETE(event);
 666                         DELETE(metadata);
 667
 668                         VerifyCertificate(&sessions[user->GetFd()],user);
 669                 }
 670         }
 671
 672         void MakePollWrite(issl_session* session)
 673         {
 674                 OnRawSocketWrite(session->fd, NULL, 0);
 675         }
 676
 677         void CloseSession(issl_session* session)
 678         {
 679                 if(session->sess)
 680                 {
 681                         gnutls_bye(session->sess, GNUTLS_SHUT_WR);
 682                         gnutls_deinit(session->sess);
 683                 }
 684
 685                 if(session->inbuf)
 686                 {
 687                         delete[] session->inbuf;
 688                 }
 689
 690                 session->outbuf.clear();
 691                 session->inbuf = NULL;
 692                 session->sess = NULL;
 693                 session->status = ISSL_NONE;
 694         }
 695
 696         void VerifyCertificate(issl_session* session, Extensible* user)
 697         {
 698                 unsigned int status;
 699                 const gnutls_datum_t* cert_list;
 700                 int ret;
 701                 unsigned int cert_list_size;
 702                 gnutls_x509_crt_t cert;
 703                 char name[MAXBUF];
 704                 unsigned char digest[MAXBUF];
 705                 size_t digest_size = sizeof(digest);
 706                 size_t name_size = sizeof(name);
 707                 ssl_cert* certinfo = new ssl_cert;
 708
 709                 user->Extend("ssl_cert",certinfo);
 710
 711                 /* This verification function uses the trusted CAs in the credentials
 712                  * structure. So you must have installed one or more CA certificates.
 713                  */
 714                 ret = gnutls_certificate_verify_peers2(session->sess, &status);
 715
 716                 if (ret < 0)
 717                 {
 718                         certinfo->data.insert(std::make_pair("error",std::string(gnutls_strerror(ret))));
 719                         return;
 720                 }
 721
 722                 if (status & GNUTLS_CERT_INVALID)
 723                 {
 724                         certinfo->data.insert(std::make_pair("invalid",ConvToStr(1)));
 725                 }
 726                 else
 727                 {
 728                         certinfo->data.insert(std::make_pair("invalid",ConvToStr(0)));
 729                 }
 730                 if (status & GNUTLS_CERT_SIGNER_NOT_FOUND)
 731                 {
 732                         certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(1)));
 733                 }
 734                 else
 735                 {
 736                         certinfo->data.insert(std::make_pair("unknownsigner",ConvToStr(0)));
 737                 }
 738                 if (status & GNUTLS_CERT_REVOKED)
 739                 {
 740                         certinfo->data.insert(std::make_pair("revoked",ConvToStr(1)));
 741                 }
 742                 else
 743                 {
 744                         certinfo->data.insert(std::make_pair("revoked",ConvToStr(0)));
 745                 }
 746                 if (status & GNUTLS_CERT_SIGNER_NOT_CA)
 747                 {
 748                         certinfo->data.insert(std::make_pair("trusted",ConvToStr(0)));
 749                 }
 750                 else
 751                 {
 752                         certinfo->data.insert(std::make_pair("trusted",ConvToStr(1)));
 753                 }
 754
 755                 /* Up to here the process is the same for X.509 certificates and
 756                  * OpenPGP keys. From now on X.509 certificates are assumed. This can
 757                  * be easily extended to work with openpgp keys as well.
 758                  */
 759                 if (gnutls_certificate_type_get(session->sess) != GNUTLS_CRT_X509)
 760                 {
 761                         certinfo->data.insert(std::make_pair("error","No X509 keys sent"));
 762                         return;
 763                 }
 764
 765                 ret = gnutls_x509_crt_init(&cert);
 766                 if (ret < 0)
 767                 {
 768                         certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
 769                         return;
 770                 }
 771
 772                 cert_list_size = 0;
 773                 cert_list = gnutls_certificate_get_peers(session->sess, &cert_list_size);
 774                 if (cert_list == NULL)
 775                 {
 776                         certinfo->data.insert(std::make_pair("error","No certificate was found"));
 777                         return;
 778                 }
 779
 780                 /* This is not a real world example, since we only check the first
 781                  * certificate in the given chain.
 782                  */
 783
 784                 ret = gnutls_x509_crt_import(cert, &cert_list[0], GNUTLS_X509_FMT_DER);
 785                 if (ret < 0)
 786                 {
 787                         certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
 788                         return;
 789                 }
 790
 791                 gnutls_x509_crt_get_dn(cert, name, &name_size);
 792
 793                 certinfo->data.insert(std::make_pair("dn",name));
 794
 795                 gnutls_x509_crt_get_issuer_dn(cert, name, &name_size);
 796
 797                 certinfo->data.insert(std::make_pair("issuer",name));
 798
 799                 if ((ret = gnutls_x509_crt_get_fingerprint(cert, GNUTLS_DIG_MD5, digest, &digest_size)) < 0)
 800                 {
 801                         certinfo->data.insert(std::make_pair("error",gnutls_strerror(ret)));
 802                 }
 803                 else
 804                 {
 805                         certinfo->data.insert(std::make_pair("fingerprint",irc::hex(digest, digest_size)));
 806                 }
 807
 808                 /* Beware here we do not check for errors.
 809                  */
 810                 if ((gnutls_x509_crt_get_expiration_time(cert) < time(0)) || (gnutls_x509_crt_get_activation_time(cert) > time(0)))
 811                 {
 812                         certinfo->data.insert(std::make_pair("error","Not activated, or expired certificate"));
 813                 }
 814
 815                 gnutls_x509_crt_deinit(cert);
 816
 817                 return;
 818         }
 819
 820 };
 821
 822 class ModuleSSLGnuTLSFactory : public ModuleFactory
 823 {
 824  public:
 825         ModuleSSLGnuTLSFactory()
 826         {
 827         }
 828
 829         ~ModuleSSLGnuTLSFactory()
 830         {
 831         }
 832
 833         virtual Module * CreateModule(InspIRCd* Me)
 834         {
 835                 return new ModuleSSLGnuTLS(Me);
 836         }
 837 };
 838
 839
 840 extern "C" void * init_module( void )
 841 {
 842         return new ModuleSSLGnuTLSFactory;
 843 }