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