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