8 #include <sys/socket.h>
9 #include <netinet/in.h>
10 #include <arpa/inet.h>
14 #include <gnutls/gnutls.h>
16 #include "inspircd_config.h"
20 #include "helperfuncs.h"
24 /* $ModDesc: Provides SSL support for clients */
25 /* $CompileFlags: `libgnutls-config --cflags` */
26 /* $LinkerFlags: `libgnutls-config --libs` */
28 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING_READ, ISSL_HANDSHAKING_WRITE, ISSL_HANDSHAKEN, ISSL_CLOSING, ISSL_CLOSED };
30 bool isin(int port, std::vector<int> portlist)
32 for(unsigned int i = 0; i < portlist.size(); i++)
33 if(portlist[i] == port)
42 gnutls_session_t sess;
50 class ModuleSSL : public Module
53 ServerConfig* SrvConf;
58 std::vector<int> listenports;
61 issl_session sessions[MAX_DESCRIPTORS];
63 gnutls_certificate_credentials x509_cred;
64 gnutls_dh_params dh_params;
78 SrvConf = Srv->GetConfig();
79 Conf = new ConfigReader;
81 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
82 inbufsize = SrvConf->NetBufferSize;
84 gnutls_global_init(); // This must be called once in the program
86 if(gnutls_certificate_allocate_credentials(&x509_cred) != 0)
87 log(DEFAULT, "m_ssl_gnutls.so: Failed to allocate certificate credentials");
89 // Guessing return meaning
90 if(gnutls_dh_params_init(&dh_params) < 0)
91 log(DEFAULT, "m_ssl_gnutls.so: Failed to initialise DH parameters");
93 // Needs the flag as it ignores a plain /rehash
96 // Void return, guess we assume success
97 gnutls_certificate_set_dh_params(x509_cred, dh_params);
100 virtual void OnRehash(std::string param)
106 Conf = new ConfigReader;
108 for(unsigned int i = 0; i < listenports.size(); i++)
110 SrvConf->DelIOHook(listenports[i]);
115 for(int i = 0; i < Conf->Enumerate("bind"); i++)
117 // For each <bind> tag
118 if(((Conf->ReadValue("bind", "type", i) == "") || (Conf->ReadValue("bind", "type", i) == "clients")) && (Conf->ReadValue("bind", "ssl", i) == "gnutls"))
120 // Get the port we're meant to be listening on with SSL
121 unsigned int port = Conf->ReadInteger("bind", "port", i, true);
122 SrvConf->AddIOHook(port, this);
124 // We keep a record of which ports we're listening on with SSL
125 listenports.push_back(port);
127 log(DEFAULT, "m_ssl_gnutls.so: Enabling SSL for port %d", port);
131 std::string confdir(CONFIG_FILE);
132 // +1 so we the path ends with a /
133 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
135 cafile = Conf->ReadValue("gnutls", "cafile", 0);
136 crlfile = Conf->ReadValue("gnutls", "crlfile", 0);
137 certfile = Conf->ReadValue("gnutls", "certfile", 0);
138 keyfile = Conf->ReadValue("gnutls", "keyfile", 0);
139 dh_bits = Conf->ReadInteger("gnutls", "dhbits", 0, false);
141 // Set all the default values needed.
149 certfile = "cert.pem";
154 if((dh_bits != 768) && (dh_bits != 1024) && (dh_bits != 2048) && (dh_bits != 3072) && (dh_bits != 4096))
157 // Prepend relative paths with the path to the config directory.
159 cafile = confdir + cafile;
161 if(crlfile[0] != '/')
162 crlfile = confdir + crlfile;
164 if(certfile[0] != '/')
165 certfile = confdir + certfile;
167 if(keyfile[0] != '/')
168 keyfile = confdir + keyfile;
170 if(gnutls_certificate_set_x509_trust_file(x509_cred, cafile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
171 log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 trust file: %s", cafile.c_str());
173 if(gnutls_certificate_set_x509_crl_file (x509_cred, crlfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
174 log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 CRL file: %s", crlfile.c_str());
176 // Guessing on the return value of this, manual doesn't say :|
177 if(gnutls_certificate_set_x509_key_file (x509_cred, certfile.c_str(), keyfile.c_str(), GNUTLS_X509_FMT_PEM) < 0)
178 log(DEFAULT, "m_ssl_gnutls.so: Failed to set X.509 certificate and key files: %s and %s", certfile.c_str(), keyfile.c_str());
180 // This may be on a large (once a day or week) timer eventually.
184 void GenerateDHParams()
186 // Generate Diffie Hellman parameters - for use with DHE
187 // kx algorithms. These should be discarded and regenerated
188 // once a day, once a week or once a month. Depending on the
189 // security requirements.
191 if(gnutls_dh_params_generate2(dh_params, dh_bits) < 0)
192 log(DEFAULT, "m_ssl_gnutls.so: Failed to generate DH parameters (%d bits)", dh_bits);
198 gnutls_dh_params_deinit(dh_params);
199 gnutls_certificate_free_credentials(x509_cred);
200 gnutls_global_deinit();
203 virtual void OnCleanup(int target_type, void* item)
205 if(target_type == TYPE_USER)
207 userrec* user = (userrec*)item;
209 if(user->GetExt("ssl") && IS_LOCAL(user) && isin(user->port, listenports))
211 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
212 // Potentially there could be multiple SSL modules loaded at once on different ports.
213 log(DEBUG, "m_ssl_gnutls.so: Adding user %s to cull list", user->nick);
214 culllist.AddItem(user, "SSL module unloading");
219 virtual void OnUnloadModule(Module* mod, std::string name)
223 // We're being unloaded, kill all the users added to the cull list in OnCleanup
224 int numusers = culllist.Apply();
225 log(DEBUG, "m_ssl_gnutls.so: Killed %d users for unload of GnuTLS SSL module", numusers);
227 for(unsigned int i = 0; i < listenports.size(); i++)
228 SrvConf->DelIOHook(listenports[i]);
232 virtual Version GetVersion()
234 return Version(1, 0, 0, 0, VF_VENDOR);
237 void Implements(char* List)
239 List[I_OnRawSocketAccept] = List[I_OnRawSocketClose] = List[I_OnRawSocketRead] = List[I_OnRawSocketWrite] = List[I_OnCleanup] = 1;
240 List[I_OnSyncUserMetaData] = List[I_OnDecodeMetaData] = List[I_OnUnloadModule] = List[I_OnRehash] = List[I_OnWhois] = 1;
243 virtual void OnRawSocketAccept(int fd, std::string ip, int localport)
245 issl_session* session = &sessions[fd];
248 session->inbuf = new char[inbufsize];
249 session->inbufoffset = 0;
251 gnutls_init(&session->sess, GNUTLS_SERVER);
253 gnutls_set_default_priority(session->sess); // Avoid calling all the priority functions, defaults are adequate.
254 gnutls_credentials_set(session->sess, GNUTLS_CRD_CERTIFICATE, x509_cred);
255 gnutls_certificate_server_set_request(session->sess, GNUTLS_CERT_REQUEST); // Request client certificate if any.
256 gnutls_dh_set_prime_bits(session->sess, dh_bits);
257 gnutls_transport_set_ptr(session->sess, (gnutls_transport_ptr_t) fd); // Give gnutls the fd for the socket.
262 virtual void OnRawSocketClose(int fd)
264 log(DEBUG, "OnRawSocketClose: %d", fd);
265 CloseSession(&sessions[fd]);
268 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
270 issl_session* session = &sessions[fd];
274 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: No session to read from");
276 CloseSession(session);
280 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead(%d, buffer, %u, %d)", fd, count, readresult);
282 if(session->status == ISSL_HANDSHAKING_READ)
284 // The handshake isn't finished, try to finish it.
286 if(Handshake(session))
288 // Handshake successfully resumed.
289 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: successfully resumed handshake");
293 // Couldn't resume handshake.
294 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: failed to resume handshake");
298 else if(session->status == ISSL_HANDSHAKING_WRITE)
300 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: handshake wants to write data but we are currently reading");
304 // If we resumed the handshake then session->status will be ISSL_HANDSHAKEN.
306 if(session->status == ISSL_HANDSHAKEN)
308 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
309 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
310 log(DEBUG, "m_ssl_gnutls.so: gnutls_record_recv(sess, inbuf+%d, %d-%d)", session->inbufoffset, inbufsize, session->inbufoffset);
312 int ret = gnutls_record_recv(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
316 // Client closed connection.
317 log(DEBUG, "m_ssl_gnutls.so: Client closed the connection");
319 CloseSession(session);
324 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
326 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Not all SSL data read: %s", gnutls_strerror(ret));
331 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Error reading SSL data: %s", gnutls_strerror(ret));
333 CloseSession(session);
338 // Read successfully 'ret' bytes into inbuf + inbufoffset
339 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
340 // 'buffer' is 'count' long
342 unsigned int length = ret + session->inbufoffset;
344 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Read %d bytes, now have %d waiting to be passed up", ret, length);
348 memcpy(buffer, session->inbuf, count);
349 // Move the stuff left in inbuf to the beginning of it
350 memcpy(session->inbuf, session->inbuf + count, (length - count));
351 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
352 session->inbufoffset = length - count;
353 // Insp uses readresult as the count of how much data there is in buffer, so:
358 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
359 memcpy(buffer, session->inbuf, length);
360 // Zero the offset, as there's nothing there..
361 session->inbufoffset = 0;
366 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: Passing %d bytes up to insp:");
367 Srv->Log(DEBUG, std::string(buffer, readresult));
370 else if(session->status == ISSL_CLOSING)
372 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketRead: session closing...");
379 virtual int OnRawSocketWrite(int fd, char* buffer, int count)
381 issl_session* session = &sessions[fd];
382 const char* sendbuffer = buffer;
386 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: No session to write to");
387 CloseSession(session);
391 if(session->status == ISSL_HANDSHAKING_WRITE)
393 // The handshake isn't finished, try to finish it.
395 if(Handshake(session))
397 // Handshake successfully resumed.
398 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: successfully resumed handshake");
402 // Couldn't resume handshake.
403 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: failed to resume handshake");
406 else if(session->status == ISSL_HANDSHAKING_READ)
408 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: handshake wants to read data but we are currently writing");
411 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Adding %d bytes to the outgoing buffer", count);
412 session->outbuf.append(sendbuffer, count);
413 sendbuffer = session->outbuf.c_str();
414 count = session->outbuf.size();
416 if(session->status == ISSL_HANDSHAKEN)
418 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Trying to write %d bytes:", count);
419 Srv->Log(DEBUG, session->outbuf);
421 int ret = gnutls_record_send(session->sess, sendbuffer, count);
425 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Client closed the connection");
426 CloseSession(session);
430 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
432 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Not all SSL data written: %s", gnutls_strerror(ret));
436 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Error writing SSL data: %s", gnutls_strerror(ret));
437 CloseSession(session);
442 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: Successfully wrote %d bytes", ret);
443 session->outbuf = session->outbuf.substr(ret);
446 else if(session->status == ISSL_CLOSING)
448 log(DEBUG, "m_ssl_gnutls.so: OnRawSocketWrite: session closing...");
454 // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
455 virtual void OnWhois(userrec* source, userrec* dest)
457 if(dest->GetExt("ssl"))
459 WriteServ(source->fd, "320 %s %s :is a Secure Connection", source->nick, dest->nick);
463 virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, std::string extname)
465 // check if the linking module wants to know about OUR metadata
468 // check if this user has an swhois field to send
469 if(user->GetExt(extname))
471 // call this function in the linking module, let it format the data how it
472 // sees fit, and send it on its way. We dont need or want to know how.
473 proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, "ON");
478 virtual void OnDecodeMetaData(int target_type, void* target, std::string extname, std::string extdata)
480 // check if its our metadata key, and its associated with a user
481 if ((target_type == TYPE_USER) && (extname == "ssl"))
483 userrec* dest = (userrec*)target;
484 // if they dont already have an ssl flag, accept the remote server's
485 if (!dest->GetExt(extname))
487 dest->Extend(extname, "ON");
492 bool Handshake(issl_session* session)
494 int ret = gnutls_handshake(session->sess);
498 if(ret == GNUTLS_E_AGAIN || ret == GNUTLS_E_INTERRUPTED)
500 // Handshake needs resuming later, read() or write() would have blocked.
502 if(gnutls_record_get_direction(session->sess) == 0)
504 // gnutls_handshake() wants to read() again.
505 session->status = ISSL_HANDSHAKING_READ;
506 log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (reading) later, error string: %s", gnutls_strerror(ret));
510 // gnutls_handshake() wants to write() again.
511 session->status = ISSL_HANDSHAKING_WRITE;
512 log(DEBUG, "m_ssl_gnutls.so: Handshake needs resuming (writing) later, error string: %s", gnutls_strerror(ret));
513 MakePollWrite(session);
519 CloseSession(session);
520 log(DEBUG, "m_ssl_gnutls.so: Handshake failed, error string: %s", gnutls_strerror(ret));
521 session->status = ISSL_CLOSING;
528 // Handshake complete.
529 log(DEBUG, "m_ssl_gnutls.so: Handshake completed");
531 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
532 Srv->FindDescriptor(session->fd)->Extend("ssl", "ON");
534 session->status = ISSL_HANDSHAKEN;
536 MakePollWrite(session);
542 void MakePollWrite(issl_session* session)
544 OnRawSocketWrite(session->fd, NULL, 0);
547 void CloseSession(issl_session* session)
551 gnutls_bye(session->sess, GNUTLS_SHUT_WR);
552 gnutls_deinit(session->sess);
557 delete[] session->inbuf;
560 session->outbuf.clear();
561 session->inbuf = NULL;
562 session->sess = NULL;
563 session->status = ISSL_NONE;
567 class ModuleSSLFactory : public ModuleFactory
578 virtual Module * CreateModule(Server* Me)
580 return new ModuleSSL(Me);
585 extern "C" void * init_module( void )
587 return new ModuleSSLFactory;