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