src/modules/extra/m_ssl_gnutls.cpp

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