src/modules/extra/m_ssl_gnutls.cpp

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