1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
15 #include <openssl/ssl.h>
16 #include <openssl/err.h>
17 #include "transport.h"
20 #pragma comment(lib, "libeay32MTd")
21 #pragma comment(lib, "ssleay32MTd")
22 #undef MAX_DESCRIPTORS
23 #define MAX_DESCRIPTORS 10000
26 /* $ModDesc: Provides SSL support for clients */
28 /* $LinkerFlags: if("USE_FREEBSD_BASE_SSL") -lssl -lcrypto */
29 /* $CompileFlags: if(!"USE_FREEBSD_BASE_SSL") pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
30 /* $LinkerFlags: if(!"USE_FREEBSD_BASE_SSL") rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
32 /* $ModDep: transport.h */
34 /* $CopyInstall: conf/key.pem $(CONPATH) */
35 /* $CopyInstall: conf/cert.pem $(CONPATH) */
38 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
39 enum issl_io_status { ISSL_WRITE, ISSL_READ };
41 static bool SelfSigned = false;
45 return ERR_error_string(ERR_get_error(), NULL);
48 static int error_callback(const char *str, size_t len, void *u);
50 /** Represents an SSL user's extra data
52 class issl_session : public classbase
60 unsigned int inbufoffset;
61 char* inbuf; // Buffer OpenSSL reads into.
62 std::string outbuf; // Buffer for outgoing data that OpenSSL will not take.
74 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
76 /* XXX: This will allow self signed certificates.
77 * In the future if we want an option to not allow this,
78 * we can just return preverify_ok here, and openssl
79 * will boot off self-signed and invalid peer certs.
81 int ve = X509_STORE_CTX_get_error(ctx);
83 SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
88 class ModuleSSLOpenSSL : public Module
90 std::set<ListenSocketBase*> listenports;
93 issl_session* sessions;
102 std::string certfile;
104 // std::string crlfile;
106 std::string sslports;
110 InspIRCd* PublicInstance;
112 ModuleSSLOpenSSL(InspIRCd* Me)
113 : Module(Me), PublicInstance(Me)
115 ServerInstance->Modules->PublishInterface("BufferedSocketHook", this);
117 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
119 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
120 inbufsize = ServerInstance->Config->NetBufferSize;
122 /* Global SSL library initialization*/
124 SSL_load_error_strings();
126 /* Build our SSL contexts:
127 * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
129 ctx = SSL_CTX_new( SSLv23_server_method() );
130 clictx = SSL_CTX_new( SSLv23_client_method() );
132 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
133 SSL_CTX_set_mode(clictx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
135 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
136 SSL_CTX_set_verify(clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
138 // Needs the flag as it ignores a plain /rehash
139 OnModuleRehash(NULL,"ssl");
140 Implementation eventlist[] = { I_OnRawSocketConnect, I_OnRawSocketAccept,
141 I_OnRawSocketClose, I_OnRawSocketRead, I_OnRawSocketWrite, I_OnCleanup, I_On005Numeric,
142 I_OnBufferFlushed, I_OnRequest, I_OnRehash, I_OnModuleRehash, I_OnPostConnect,
144 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
147 virtual void OnHookIO(EventHandler* user, ListenSocketBase* lsb)
149 if (!user->GetIOHook() && listenports.find(lsb) != listenports.end())
151 /* Hook the user with our module */
152 user->AddIOHook(this);
156 virtual void OnRehash(User* user)
158 ConfigReader Conf(ServerInstance);
163 for (size_t i = 0; i < ServerInstance->ports.size(); i++)
165 ListenSocketBase* port = ServerInstance->ports[i];
166 std::string desc = port->GetDescription();
167 if (desc != "openssl")
170 listenports.insert(port);
171 std::string portid = port->GetBindDesc();
173 ServerInstance->Logs->Log("m_ssl_openssl", DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %s", portid.c_str());
174 if (port->GetIP() != "127.0.0.1")
175 sslports.append(portid).append(";");
178 if (!sslports.empty())
179 sslports.erase(sslports.end() - 1);
182 virtual void OnModuleRehash(User* user, const std::string ¶m)
189 ConfigReader Conf(ServerInstance);
191 std::string confdir(ServerInstance->ConfigFileName);
192 // +1 so we the path ends with a /
193 confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
195 cafile = Conf.ReadValue("openssl", "cafile", 0);
196 certfile = Conf.ReadValue("openssl", "certfile", 0);
197 keyfile = Conf.ReadValue("openssl", "keyfile", 0);
198 dhfile = Conf.ReadValue("openssl", "dhfile", 0);
200 // Set all the default values needed.
204 if (certfile.empty())
205 certfile = "cert.pem";
211 dhfile = "dhparams.pem";
213 // Prepend relative paths with the path to the config directory.
214 if ((cafile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(cafile)))
215 cafile = confdir + cafile;
217 if ((certfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(certfile)))
218 certfile = confdir + certfile;
220 if ((keyfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(keyfile)))
221 keyfile = confdir + keyfile;
223 if ((dhfile[0] != '/') && (!ServerInstance->Config->StartsWithWindowsDriveLetter(dhfile)))
224 dhfile = confdir + dhfile;
226 /* Load our keys and certificates
227 * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
229 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
231 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
232 ERR_print_errors_cb(error_callback, this);
235 if (((!SSL_CTX_use_PrivateKey_file(ctx, keyfile.c_str(), SSL_FILETYPE_PEM))) || (!SSL_CTX_use_PrivateKey_file(clictx, keyfile.c_str(), SSL_FILETYPE_PEM)))
237 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
238 ERR_print_errors_cb(error_callback, this);
241 /* Load the CAs we trust*/
242 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
244 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read CA list from %s. %s", cafile.c_str(), strerror(errno));
245 ERR_print_errors_cb(error_callback, this);
248 FILE* dhpfile = fopen(dhfile.c_str(), "r");
253 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
254 throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
258 ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
259 if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
261 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
262 ERR_print_errors_cb(error_callback, this);
269 virtual void On005Numeric(std::string &output)
271 if (!sslports.empty())
272 output.append(" SSL=" + sslports);
275 virtual ~ModuleSSLOpenSSL()
278 SSL_CTX_free(clictx);
279 ServerInstance->Modules->UnpublishInterface("BufferedSocketHook", this);
283 virtual void OnCleanup(int target_type, void* item)
285 if (target_type == TYPE_USER)
287 User* user = (User*)item;
289 if (user->GetIOHook() == this)
291 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
292 // Potentially there could be multiple SSL modules loaded at once on different ports.
293 ServerInstance->Users->QuitUser(user, "SSL module unloading");
296 if (user->GetExt("ssl_cert", dummy))
299 user->GetExt("ssl_cert", tofree);
301 user->Shrink("ssl_cert");
306 virtual Version GetVersion()
308 return Version("$Id$", VF_VENDOR, API_VERSION);
312 virtual const char* OnRequest(Request* request)
314 ISHRequest* ISR = (ISHRequest*)request;
315 if (strcmp("IS_NAME", request->GetId()) == 0)
319 else if (strcmp("IS_HOOK", request->GetId()) == 0)
321 const char* ret = "OK";
324 ret = ISR->Sock->AddIOHook((Module*)this) ? "OK" : NULL;
326 catch (ModuleException &e)
333 else if (strcmp("IS_UNHOOK", request->GetId()) == 0)
335 return ISR->Sock->DelIOHook() ? "OK" : NULL;
337 else if (strcmp("IS_HSDONE", request->GetId()) == 0)
339 if (ISR->Sock->GetFd() < 0)
342 issl_session* session = &sessions[ISR->Sock->GetFd()];
343 return (session->status == ISSL_HANDSHAKING) ? NULL : "OK";
345 else if (strcmp("IS_ATTACH", request->GetId()) == 0)
347 issl_session* session = &sessions[ISR->Sock->GetFd()];
350 VerifyCertificate(session, (BufferedSocket*)ISR->Sock);
354 else if (strcmp("GET_FP", request->GetId()) == 0)
356 if (ISR->Sock->GetFd() > -1)
358 issl_session* session = &sessions[ISR->Sock->GetFd()];
361 Extensible* ext = ISR->Sock;
363 if (ext->GetExt("ssl_cert",certinfo))
364 return certinfo->GetFingerprint().c_str();
372 virtual void OnRawSocketAccept(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
374 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
375 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
378 issl_session* session = &sessions[fd];
381 session->inbuf = new char[inbufsize];
382 session->inbufoffset = 0;
383 session->sess = SSL_new(ctx);
384 session->status = ISSL_NONE;
385 session->outbound = false;
387 if (session->sess == NULL)
390 if (SSL_set_fd(session->sess, fd) == 0)
392 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
399 virtual void OnRawSocketConnect(int fd)
401 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
402 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
405 issl_session* session = &sessions[fd];
408 session->inbuf = new char[inbufsize];
409 session->inbufoffset = 0;
410 session->sess = SSL_new(clictx);
411 session->status = ISSL_NONE;
412 session->outbound = true;
414 if (session->sess == NULL)
417 if (SSL_set_fd(session->sess, fd) == 0)
419 ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
426 virtual void OnRawSocketClose(int fd)
428 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
429 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
432 CloseSession(&sessions[fd]);
434 EventHandler* user = ServerInstance->SE->GetRef(fd);
436 if ((user) && (user->GetExt("ssl_cert", dummy)))
439 user->GetExt("ssl_cert", tofree);
441 user->Shrink("ssl_cert");
445 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
447 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
448 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
451 issl_session* session = &sessions[fd];
456 CloseSession(session);
460 if (session->status == ISSL_HANDSHAKING)
462 if (session->rstat == ISSL_READ || session->wstat == ISSL_READ)
464 // The handshake isn't finished and it wants to read, try to finish it.
465 if (!Handshake(session))
467 // Couldn't resume handshake.
468 errno = session->status == ISSL_NONE ? EIO : EAGAIN;
479 // If we resumed the handshake then session->status will be ISSL_OPEN
481 if (session->status == ISSL_OPEN)
483 if (session->wstat == ISSL_READ)
485 if(DoWrite(session) == 0)
489 if (session->rstat == ISSL_READ)
491 int ret = DoRead(session);
495 if (count <= session->inbufoffset)
497 memcpy(buffer, session->inbuf, count);
498 // Move the stuff left in inbuf to the beginning of it
499 memmove(session->inbuf, session->inbuf + count, (session->inbufoffset - count));
500 // Now we need to set session->inbufoffset to the amount of data still waiting to be handed to insp.
501 session->inbufoffset -= count;
502 // Insp uses readresult as the count of how much data there is in buffer, so:
507 // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
508 memcpy(buffer, session->inbuf, session->inbufoffset);
510 readresult = session->inbufoffset;
511 // Zero the offset, as there's nothing there..
512 session->inbufoffset = 0;
523 virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
525 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
526 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
530 issl_session* session = &sessions[fd];
534 CloseSession(session);
538 session->outbuf.append(buffer, count);
539 MakePollWrite(session);
541 if (session->status == ISSL_HANDSHAKING)
543 // The handshake isn't finished, try to finish it.
544 if (session->rstat == ISSL_WRITE || session->wstat == ISSL_WRITE)
546 if (!Handshake(session))
548 // Couldn't resume handshake.
549 errno = session->status == ISSL_NONE ? EIO : EAGAIN;
555 if (session->status == ISSL_OPEN)
557 if (session->rstat == ISSL_WRITE)
562 if (session->wstat == ISSL_WRITE)
564 return DoWrite(session);
571 int DoWrite(issl_session* session)
573 if (!session->outbuf.size())
576 int ret = SSL_write(session->sess, session->outbuf.data(), session->outbuf.size());
580 CloseSession(session);
585 int err = SSL_get_error(session->sess, ret);
587 if (err == SSL_ERROR_WANT_WRITE)
589 session->wstat = ISSL_WRITE;
592 else if (err == SSL_ERROR_WANT_READ)
594 session->wstat = ISSL_READ;
599 CloseSession(session);
605 session->outbuf = session->outbuf.substr(ret);
610 int DoRead(issl_session* session)
612 // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
613 // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
615 int ret = SSL_read(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
619 // Client closed connection.
620 CloseSession(session);
625 int err = SSL_get_error(session->sess, ret);
627 if (err == SSL_ERROR_WANT_READ)
629 session->rstat = ISSL_READ;
632 else if (err == SSL_ERROR_WANT_WRITE)
634 session->rstat = ISSL_WRITE;
635 MakePollWrite(session);
640 CloseSession(session);
646 // Read successfully 'ret' bytes into inbuf + inbufoffset
647 // There are 'ret' + 'inbufoffset' bytes of data in 'inbuf'
648 // 'buffer' is 'count' long
650 session->inbufoffset += ret;
656 bool Handshake(issl_session* session)
660 if (session->outbound)
661 ret = SSL_connect(session->sess);
663 ret = SSL_accept(session->sess);
667 int err = SSL_get_error(session->sess, ret);
669 if (err == SSL_ERROR_WANT_READ)
671 session->rstat = ISSL_READ;
672 session->status = ISSL_HANDSHAKING;
675 else if (err == SSL_ERROR_WANT_WRITE)
677 session->wstat = ISSL_WRITE;
678 session->status = ISSL_HANDSHAKING;
679 MakePollWrite(session);
684 CloseSession(session);
691 // Handshake complete.
692 // This will do for setting the ssl flag...it could be done earlier if it's needed. But this seems neater.
693 EventHandler *u = ServerInstance->SE->GetRef(session->fd);
699 session->status = ISSL_OPEN;
701 MakePollWrite(session);
707 CloseSession(session);
714 virtual void OnPostConnect(User* user)
716 // This occurs AFTER OnUserConnect so we can be sure the
717 // protocol module has propagated the NICK message.
718 if ((user->GetIOHook() == this) && (IS_LOCAL(user)))
720 ssl_cert* certdata = VerifyCertificate(&sessions[user->GetFd()], user);
721 if (sessions[user->GetFd()].sess)
722 user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), SSL_get_cipher(sessions[user->GetFd()].sess));
724 ServerInstance->PI->SendMetaData(user, "ssl", "ON");
726 ServerInstance->PI->SendMetaData(user, "ssl_cert", certdata->GetMetaLine().c_str());
730 void MakePollWrite(issl_session* session)
732 //OnRawSocketWrite(session->fd, NULL, 0);
733 EventHandler* eh = ServerInstance->SE->GetRef(session->fd);
736 ServerInstance->SE->WantWrite(eh);
740 virtual void OnBufferFlushed(User* user)
742 if (user->GetIOHook() == this)
744 issl_session* session = &sessions[user->GetFd()];
745 if (session && session->outbuf.size())
746 OnRawSocketWrite(user->GetFd(), NULL, 0);
750 void CloseSession(issl_session* session)
754 SSL_shutdown(session->sess);
755 SSL_free(session->sess);
760 delete[] session->inbuf;
763 session->outbuf.clear();
764 session->inbuf = NULL;
765 session->sess = NULL;
766 session->status = ISSL_NONE;
770 ssl_cert* VerifyCertificate(issl_session* session, Extensible* user)
772 if (!session->sess || !user)
776 ssl_cert* certinfo = new ssl_cert;
778 unsigned char md[EVP_MAX_MD_SIZE];
779 const EVP_MD *digest = EVP_md5();
781 user->Extend("ssl_cert",certinfo);
783 cert = SSL_get_peer_certificate((SSL*)session->sess);
787 certinfo->error = "Could not get peer certificate: "+std::string(get_error());
791 certinfo->invalid = (SSL_get_verify_result(session->sess) != X509_V_OK);
795 certinfo->unknownsigner = false;
796 certinfo->trusted = true;
800 certinfo->unknownsigner = true;
801 certinfo->trusted = false;
804 certinfo->dn = X509_NAME_oneline(X509_get_subject_name(cert),0,0);
805 certinfo->issuer = X509_NAME_oneline(X509_get_issuer_name(cert),0,0);
807 if (!X509_digest(cert, digest, md, &n))
809 certinfo->error = "Out of memory generating fingerprint";
813 certinfo->fingerprint = irc::hex(md, n);
816 if ((ASN1_UTCTIME_cmp_time_t(X509_get_notAfter(cert), ServerInstance->Time()) == -1) || (ASN1_UTCTIME_cmp_time_t(X509_get_notBefore(cert), ServerInstance->Time()) == 0))
818 certinfo->error = "Not activated, or expired certificate";
827 Module* server = ServerInstance->Modules->Find("m_spanningtree.so");
828 ServerInstance->Modules->SetPriority(this, I_OnPostConnect, PRIORITY_AFTER, &server);
833 static int error_callback(const char *str, size_t len, void *u)
835 ModuleSSLOpenSSL* mssl = (ModuleSSLOpenSSL*)u;
836 mssl->PublicInstance->Logs->Log("m_ssl_openssl",DEFAULT, "SSL error: " + std::string(str, len - 1));
839 // XXX: Remove this line, it causes valgrind warnings...
841 // MD_update(&m, buf, j);
844 // ... ONLY JOKING! :-)
850 MODULE_INIT(ModuleSSLOpenSSL)