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