]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/extra/m_ssl_openssl.cpp
Catch the ModuleException thrown when AddIOHook fails, so that we can make a port...
[user/henk/code/inspircd.git] / src / modules / extra / m_ssl_openssl.cpp
index e8f62eb1c5eaae910b89972a2deb5f68d59bf8c8..5e6166fa49bb9deb2cb072db54b895afe3f835d5 100644 (file)
@@ -31,7 +31,7 @@
 
 /* $ModDesc: Provides SSL support for clients */
 /* $CompileFlags: pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
-/* $LinkerFlags: pkgconflibs("openssl","/libssl.so","-lssl -lcrypto") */
+/* $LinkerFlags: rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
 /* $ModDep: transport.h */
 
 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
@@ -44,7 +44,7 @@ bool isin(int port, const std::vector<int> &portlist)
        for(unsigned int i = 0; i < portlist.size(); i++)
                if(portlist[i] == port)
                        return true;
-                       
+
        return false;
 }
 
@@ -53,6 +53,8 @@ char* get_error()
        return ERR_error_string(ERR_get_error(), NULL);
 }
 
+static int error_callback(const char *str, size_t len, void *u);
+
 /** Represents an SSL user's extra data
  */
 class issl_session : public classbase
@@ -68,7 +70,7 @@ public:
        std::string outbuf;     // Buffer for outgoing data that OpenSSL will not take.
        int fd;
        bool outbound;
-       
+
        issl_session()
        {
                outbound = false;
@@ -90,47 +92,47 @@ static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
 
        return 1;
 }
-       
+
 class ModuleSSLOpenSSL : public Module
 {
-       
+
        ConfigReader* Conf;
-       
-       CullList* culllist;
-       
+
        std::vector<int> listenports;
-       
+
        int inbufsize;
        issl_session sessions[MAX_DESCRIPTORS];
-       
+
        SSL_CTX* ctx;
        SSL_CTX* clictx;
-       
+
        char* dummy;
-       
+
        std::string keyfile;
        std::string certfile;
        std::string cafile;
        // std::string crlfile;
        std::string dhfile;
-       
+
  public:
-       
+
+       InspIRCd* PublicInstance;
+
        ModuleSSLOpenSSL(InspIRCd* Me)
-               : Module::Module(Me)
+               : Module::Module(Me), PublicInstance(Me)
        {
-               culllist = new CullList(ServerInstance);
-
                ServerInstance->PublishInterface("InspSocketHook", this);
-               
+
                // Not rehashable...because I cba to reduce all the sizes of existing buffers.
                inbufsize = ServerInstance->Config->NetBufferSize;
-               
+
                /* Global SSL library initialization*/
                SSL_library_init();
                SSL_load_error_strings();
-               
-               /* Build our SSL context*/
+
+               /* Build our SSL contexts:
+                * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
+                */
                ctx = SSL_CTX_new( SSLv23_server_method() );
                clictx = SSL_CTX_new( SSLv23_client_method() );
 
@@ -140,21 +142,21 @@ class ModuleSSLOpenSSL : public Module
                // Needs the flag as it ignores a plain /rehash
                OnRehash(NULL,"ssl");
        }
-       
+
        virtual void OnRehash(userrec* user, const std::string &param)
        {
                if (param != "ssl")
                        return;
-       
+
                Conf = new ConfigReader(ServerInstance);
-                       
+
                for (unsigned int i = 0; i < listenports.size(); i++)
                {
                        ServerInstance->Config->DelIOHook(listenports[i]);
                }
-               
+
                listenports.clear();
-               
+
                for (int i = 0; i < Conf->Enumerate("bind"); i++)
                {
                        // For each <bind> tag
@@ -166,75 +168,87 @@ class ModuleSSLOpenSSL : public Module
                                long portno = -1;
                                while ((portno = portrange.GetToken()))
                                {
-                                       if (ServerInstance->Config->AddIOHook(portno, this))
+                                       try
                                        {
-                                               listenports.push_back(portno);
-                                               for (unsigned int i = 0; i < ServerInstance->stats->BoundPortCount; i++)
-                                                       if (ServerInstance->Config->ports[i] == portno)
-                                                               ServerInstance->Config->openSockfd[i]->SetDescription("ssl");
-                                               ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %d", portno);
+                                               if (ServerInstance->Config->AddIOHook(portno, this))
+                                               {
+                                                       listenports.push_back(portno);
+                                                               for (unsigned int i = 0; i < ServerInstance->stats->BoundPortCount; i++)
+                                                               if (ServerInstance->Config->ports[i] == portno)
+                                                                       ServerInstance->Config->openSockfd[i]->SetDescription("ssl");
+                                                       ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %d", portno);
+                                               }
+                                               else
+                                               {
+                                                       ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
+                                               }
                                        }
-                                       else
+                                       catch (ModuleException &e)
                                        {
-                                               ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: FAILED to enable SSL on port %d, maybe you have another ssl or similar module loaded?", portno);
+                                               ServerInstance->Log(DEFAULT, "m_ssl_openssl.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 another SSL or similar module loaded?", portno, e.GetReason());
                                        }
                                }
                        }
                }
-               
+
                std::string confdir(CONFIG_FILE);
                // +1 so we the path ends with a /
                confdir = confdir.substr(0, confdir.find_last_of('/') + 1);
-               
+
                cafile   = Conf->ReadValue("openssl", "cafile", 0);
                certfile = Conf->ReadValue("openssl", "certfile", 0);
                keyfile  = Conf->ReadValue("openssl", "keyfile", 0);
                dhfile   = Conf->ReadValue("openssl", "dhfile", 0);
-               
+
                // Set all the default values needed.
                if (cafile == "")
                        cafile = "ca.pem";
-                       
+
                if (certfile == "")
                        certfile = "cert.pem";
-                       
+
                if (keyfile == "")
                        keyfile = "key.pem";
-                       
+
                if (dhfile == "")
                        dhfile = "dhparams.pem";
-                       
-               // Prepend relative paths with the path to the config directory.        
+
+               // Prepend relative paths with the path to the config directory.
                if (cafile[0] != '/')
                        cafile = confdir + cafile;
-               
+
                //if(crlfile[0] != '/')
                //      crlfile = confdir + crlfile;
-                       
+
                if (certfile[0] != '/')
                        certfile = confdir + certfile;
-                       
+
                if (keyfile[0] != '/')
                        keyfile = confdir + keyfile;
-                       
+
                if (dhfile[0] != '/')
                        dhfile = confdir + dhfile;
 
-               /* Load our keys and certificates*/
+               /* Load our keys and certificates
+                * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
+                */
                if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
                {
-                       ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s", certfile.c_str());
+                       ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
+                       ERR_print_errors_cb(error_callback, this);
                }
 
-               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)))
+               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)))
                {
-                       ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read key file %s", keyfile.c_str());
+                       ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
+                       ERR_print_errors_cb(error_callback, this);
                }
 
                /* Load the CAs we trust*/
-               if ((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0)) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
+               if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
                {
-                       ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read CA list from ", cafile.c_str());
+                       ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Can't read CA list from %s. %s", cafile.c_str(), strerror(errno));
+                       ERR_print_errors_cb(error_callback, this);
                }
 
                FILE* dhpfile = fopen(dhfile.c_str(), "r");
@@ -248,13 +262,13 @@ class ModuleSSLOpenSSL : public Module
                else
                {
                        ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
-               
                        if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
                        {
-                               ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters");
+                               ServerInstance->Log(DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
+                               ERR_print_errors_cb(error_callback, this);
                        }
                }
-               
+
                fclose(dhpfile);
 
                DELETE(Conf);
@@ -264,20 +278,19 @@ class ModuleSSLOpenSSL : public Module
        {
                SSL_CTX_free(ctx);
                SSL_CTX_free(clictx);
-               delete culllist;
        }
-       
+
        virtual void OnCleanup(int target_type, void* item)
        {
                if (target_type == TYPE_USER)
                {
                        userrec* user = (userrec*)item;
-                       
+
                        if (user->GetExt("ssl", dummy) && IS_LOCAL(user) && isin(user->GetPort(), listenports))
                        {
                                // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
                                // Potentially there could be multiple SSL modules loaded at once on different ports.
-                               culllist->AddItem(user, "SSL module unloading");
+                               ServerInstance->GlobalCulls.AddItem(user, "SSL module unloading");
                        }
                        if (user->GetExt("ssl_cert", dummy) && isin(user->GetPort(), listenports))
                        {
@@ -288,14 +301,11 @@ class ModuleSSLOpenSSL : public Module
                        }
                }
        }
-       
+
        virtual void OnUnloadModule(Module* mod, const std::string &name)
        {
                if (mod == this)
                {
-                       // We're being unloaded, kill all the users added to the cull list in OnCleanup
-                       culllist->Apply();
-                       
                        for(unsigned int i = 0; i < listenports.size(); i++)
                        {
                                ServerInstance->Config->DelIOHook(listenports[i]);
@@ -306,7 +316,7 @@ class ModuleSSLOpenSSL : public Module
                        }
                }
        }
-       
+
        virtual Version GetVersion()
        {
                return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
@@ -364,17 +374,17 @@ class ModuleSSLOpenSSL : public Module
        virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport)
        {
                issl_session* session = &sessions[fd];
-       
+
                session->fd = fd;
                session->inbuf = new char[inbufsize];
-               session->inbufoffset = 0;               
+               session->inbufoffset = 0;
                session->sess = SSL_new(ctx);
                session->status = ISSL_NONE;
                session->outbound = false;
-       
+
                if (session->sess == NULL)
                        return;
-               
+
                if (SSL_set_fd(session->sess, fd) == 0)
                {
                        ServerInstance->Log(DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
@@ -386,7 +396,6 @@ class ModuleSSLOpenSSL : public Module
 
        virtual void OnRawSocketConnect(int fd)
        {
-               ServerInstance->Log(DEBUG,"ON RAW SOCKET CONNECT WITH FD %d", fd);
                issl_session* session = &sessions[fd];
 
                session->fd = fd;
@@ -396,8 +405,6 @@ class ModuleSSLOpenSSL : public Module
                session->status = ISSL_NONE;
                session->outbound = true;
 
-               ServerInstance->Log(DEBUG,"Session: %08x", session->sess);
-
                if (session->sess == NULL)
                        return;
 
@@ -414,8 +421,6 @@ class ModuleSSLOpenSSL : public Module
        {
                CloseSession(&sessions[fd]);
 
-               ServerInstance->Log(DEBUG,"SSL session close: %d", fd);
-
                EventHandler* user = ServerInstance->SE->GetRef(fd);
 
                if ((user) && (user->GetExt("ssl_cert", dummy)))
@@ -430,14 +435,14 @@ class ModuleSSLOpenSSL : public Module
        virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult)
        {
                issl_session* session = &sessions[fd];
-               
+
                if (!session->sess)
                {
                        readresult = 0;
                        CloseSession(session);
                        return 1;
                }
-               
+
                if (session->status == ISSL_HANDSHAKING)
                {
                        if (session->rstat == ISSL_READ || session->wstat == ISSL_READ)
@@ -445,18 +450,18 @@ class ModuleSSLOpenSSL : public Module
                                // The handshake isn't finished and it wants to read, try to finish it.
                                if (!Handshake(session))
                                {
-                                       // Couldn't resume handshake.   
+                                       // Couldn't resume handshake.
                                        return -1;
                                }
                        }
                        else
                        {
-                               return -1;                      
+                               return -1;
                        }
                }
 
                // If we resumed the handshake then session->status will be ISSL_OPEN
-                               
+
                if (session->status == ISSL_OPEN)
                {
                        if (session->wstat == ISSL_READ)
@@ -464,11 +469,11 @@ class ModuleSSLOpenSSL : public Module
                                if(DoWrite(session) == 0)
                                        return 0;
                        }
-                       
+
                        if (session->rstat == ISSL_READ)
                        {
                                int ret = DoRead(session);
-                       
+
                                if (ret > 0)
                                {
                                        if (count <= session->inbufoffset)
@@ -485,12 +490,12 @@ class ModuleSSLOpenSSL : public Module
                                        {
                                                // There's not as much in the inbuf as there is space in the buffer, so just copy the whole thing.
                                                memcpy(buffer, session->inbuf, session->inbufoffset);
-                                               
+
                                                readresult = session->inbufoffset;
                                                // Zero the offset, as there's nothing there..
                                                session->inbufoffset = 0;
                                        }
-                               
+
                                        return 1;
                                }
                                else
@@ -499,63 +504,57 @@ class ModuleSSLOpenSSL : public Module
                                }
                        }
                }
-               
+
                return -1;
        }
-       
+
        virtual int OnRawSocketWrite(int fd, const char* buffer, int count)
        {
                issl_session* session = &sessions[fd];
 
                if (!session->sess)
                {
-                       ServerInstance->Log(DEBUG,"BUG: file descriptor %d doesn't have an SSL session attached!", fd);
                        CloseSession(session);
                        return -1;
                }
 
                session->outbuf.append(buffer, count);
 
-               ServerInstance->Log(DEBUG,"Buffer now: %s", session->outbuf.c_str());
-               
                if (session->status == ISSL_HANDSHAKING)
                {
                        // The handshake isn't finished, try to finish it.
                        if (session->rstat == ISSL_WRITE || session->wstat == ISSL_WRITE)
                                Handshake(session);
                }
-               
+
                if (session->status == ISSL_OPEN)
                {
-                       ServerInstance->Log(DEBUG,"Session is open, writing to it");
                        if (session->rstat == ISSL_WRITE)
                                DoRead(session);
-                       
+
                        if (session->wstat == ISSL_WRITE)
                                return DoWrite(session);
                }
-               
+
                return 1;
        }
-       
+
        int DoWrite(issl_session* session)
        {
-               ServerInstance->Log(DEBUG,"DoWrite called");
                if (!session->outbuf.size())
                        return -1;
 
                int ret = SSL_write(session->sess, session->outbuf.data(), session->outbuf.size());
-               
+
                if (ret == 0)
                {
-                       ServerInstance->Log(DEBUG,"SSL_write returned 0");
                        CloseSession(session);
                        return 0;
                }
                else if (ret < 0)
                {
                        int err = SSL_get_error(session->sess, ret);
-                       
+
                        if (err == SSL_ERROR_WANT_WRITE)
                        {
                                session->wstat = ISSL_WRITE;
@@ -568,21 +567,6 @@ class ModuleSSLOpenSSL : public Module
                        }
                        else
                        {
-                               char errbuf[1024];
-                               ERR_print_errors_fp(stdout);
-                               if (err == SSL_ERROR_WANT_CONNECT)
-                                       ServerInstance->Log(DEBUG,"Closing in DoWrite() due to error: SSL_ERROR_WANT_CONNECT");
-                               if (err == SSL_ERROR_WANT_ACCEPT)
-                                       ServerInstance->Log(DEBUG,"Closing in DoWrite() due to error: SSL_ERROR_WANT_ACCEPT");
-                               if (err == SSL_ERROR_ZERO_RETURN)
-                                       ServerInstance->Log(DEBUG,"Closing in DoWrite() due to error: SSL_ERROR_ZERO_RETURN");
-                               if (err == SSL_ERROR_WANT_X509_LOOKUP)
-                                       ServerInstance->Log(DEBUG,"Closing in DoWrite() due to error: SSL_ERROR_WANT_X509_LOOKUP");
-                               if (err == SSL_ERROR_SSL)
-                                       ServerInstance->Log(DEBUG,"Closing in DoWrite() due to error: SSL_ERROR_SSL: %s", ERR_error_string(err, errbuf));
-                               if (err == SSL_ERROR_SYSCALL)
-                                       ServerInstance->Log(DEBUG,"Closing in DoWrite() due to error: SSL_ERROR_SYSCALL: %d %s", errno, strerror(errno));
-
                                CloseSession(session);
                                return 0;
                        }
@@ -593,12 +577,12 @@ class ModuleSSLOpenSSL : public Module
                        return ret;
                }
        }
-       
+
        int DoRead(issl_session* session)
        {
                // Is this right? Not sure if the unencrypted data is garaunteed to be the same length.
                // Read into the inbuffer, offset from the beginning by the amount of data we have that insp hasn't taken yet.
-                       
+
                int ret = SSL_read(session->sess, session->inbuf + session->inbufoffset, inbufsize - session->inbufoffset);
 
                if (ret == 0)
@@ -610,7 +594,7 @@ class ModuleSSLOpenSSL : public Module
                else if (ret < 0)
                {
                        int err = SSL_get_error(session->sess, ret);
-                               
+
                        if (err == SSL_ERROR_WANT_READ)
                        {
                                session->rstat = ISSL_READ;
@@ -638,7 +622,7 @@ class ModuleSSLOpenSSL : public Module
                        return ret;
                }
        }
-       
+
        // :kenny.chatspike.net 320 Om Epy|AFK :is a Secure Connection
        virtual void OnWhois(userrec* source, userrec* dest)
        {
@@ -648,7 +632,7 @@ class ModuleSSLOpenSSL : public Module
                        ServerInstance->SendWhoisLine(source, dest, 320, "%s %s :is using a secure connection", source->nick, dest->nick);
                }
        }
-       
+
        virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
        {
                // check if the linking module wants to know about OUR metadata
@@ -663,7 +647,7 @@ class ModuleSSLOpenSSL : public Module
                        }
                }
        }
-       
+
        virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
        {
                // check if its our metadata key, and its associated with a user
@@ -677,38 +661,33 @@ class ModuleSSLOpenSSL : public Module
                        }
                }
        }
-       
+
        bool Handshake(issl_session* session)
        {
-               ServerInstance->Log(DEBUG,"Handshake()");
                int ret;
 
                if (session->outbound)
                        ret = SSL_connect(session->sess);
                else
                        ret = SSL_accept(session->sess);
-      
+
                if (ret < 0)
                {
-                       ServerInstance->Log(DEBUG,"Handshake ret < 0");
                        int err = SSL_get_error(session->sess, ret);
-                               
+
                        if (err == SSL_ERROR_WANT_READ)
                        {
-                               ServerInstance->Log(DEBUG,"Handshake want read");
                                session->rstat = ISSL_READ;
                                session->status = ISSL_HANDSHAKING;
                        }
                        else if (err == SSL_ERROR_WANT_WRITE)
                        {
-                               ServerInstance->Log(DEBUG,"Handshake want write");
                                session->wstat = ISSL_WRITE;
                                session->status = ISSL_HANDSHAKING;
                                MakePollWrite(session);
                        }
                        else
                        {
-                               ServerInstance->Log(DEBUG,"Handshake other error");
                                CloseSession(session);
                        }
 
@@ -724,20 +703,15 @@ class ModuleSSLOpenSSL : public Module
                                if (!u->GetExt("ssl", dummy))
                                        u->Extend("ssl", "ON");
                        }
-                       
+
                        session->status = ISSL_OPEN;
 
-                       ServerInstance->Log(DEBUG,"Handshake complete, returned %d", ret);
-                       
                        MakePollWrite(session);
 
                        return true;
                }
                else if (ret == 0)
                {
-                       int err = SSL_get_error(session->sess, ret);
-                       ServerInstance->Log(DEBUG,"Handshake generic failure: %d", err);
-                       ERR_print_errors_fp(stdout);
                        CloseSession(session);
                        return true;
                }
@@ -764,12 +738,12 @@ class ModuleSSLOpenSSL : public Module
                        VerifyCertificate(&sessions[user->GetFd()], user);
                }
        }
-       
+
        void MakePollWrite(issl_session* session)
        {
                OnRawSocketWrite(session->fd, NULL, 0);
        }
-       
+
        void CloseSession(issl_session* session)
        {
                if (session->sess)
@@ -777,12 +751,12 @@ class ModuleSSLOpenSSL : public Module
                        SSL_shutdown(session->sess);
                        SSL_free(session->sess);
                }
-               
+
                if (session->inbuf)
                {
                        delete[] session->inbuf;
                }
-               
+
                session->outbuf.clear();
                session->inbuf = NULL;
                session->sess = NULL;
@@ -841,17 +815,24 @@ class ModuleSSLOpenSSL : public Module
        }
 };
 
+static int error_callback(const char *str, size_t len, void *u)
+{
+       ModuleSSLOpenSSL* mssl = (ModuleSSLOpenSSL*)u;
+       mssl->PublicInstance->Log(DEFAULT, "SSL error: " + std::string(str, len - 1));
+       return 0;
+}
+
 class ModuleSSLOpenSSLFactory : public ModuleFactory
 {
  public:
        ModuleSSLOpenSSLFactory()
        {
        }
-       
+
        ~ModuleSSLOpenSSLFactory()
        {
        }
-       
+
        virtual Module * CreateModule(InspIRCd* Me)
        {
                return new ModuleSSLOpenSSL(Me);