]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_sqloper.cpp
Change allocation of InspIRCd::Parser to be physically part of the object containing it
[user/henk/code/inspircd.git] / src / modules / m_sqloper.cpp
index 36bda5c58d468bbc8a69f8eb8ee2d9dfb5c9195f..3d5551eb0d1fb453195da155a2430d0bfff00e14 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
  *
- * This program is free but copyrighted software; see
- *         the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "inspircd.h"
-#include "m_sqlv2.h"
-#include "m_sqlutils.h"
-#include "m_hash.h"
-
-/* $ModDesc: Allows storage of oper credentials in an SQL table */
-/* $ModDep: m_sqlv2.h m_sqlutils.h m_hash.h */
 
-typedef std::map<irc::string, Module*> hashymodules;
+#include "inspircd.h"
+#include "modules/sql.h"
+#include "modules/hash.h"
 
-class ModuleSQLOper : public Module
+class OpMeQuery : public SQLQuery
 {
-       LocalStringExt saved_user;
-       LocalStringExt saved_pass;
-       Module* SQLutils;
-       std::string databaseid;
-       irc::string hashtype;
-       hashymodules hashers;
-       bool diduseiface;
-       parameterlist names;
-
-public:
-       ModuleSQLOper() : saved_user("sqloper_user", this), saved_pass("sqloper_pass", this)
-       {
-               ServerInstance->Modules->UseInterface("SQLutils");
-               ServerInstance->Modules->UseInterface("SQL");
-               ServerInstance->Modules->UseInterface("HashRequest");
-
-               OnRehash(NULL);
-
-               diduseiface = false;
-
-               /* Find all modules which implement the interface 'HashRequest' */
-               modulelist* ml = ServerInstance->Modules->FindInterface("HashRequest");
-
-               /* Did we find any modules? */
-               if (ml)
-               {
-                       /* Yes, enumerate them all to find out the hashing algorithm name */
-                       for (modulelist::iterator m = ml->begin(); m != ml->end(); m++)
-                       {
-                               /* Make a request to it for its name, its implementing
-                                * HashRequest so we know its safe to do this
-                                */
-                               std::string name = HashNameRequest(this, *m).response;
-                               /* Build a map of them */
-                               hashers[name.c_str()] = *m;
-                               names.push_back(name);
-                       }
-                       /* UseInterface doesn't do anything if there are no providers, so we'll have to call it later if a module gets loaded later on. */
-                       diduseiface = true;
-                       ServerInstance->Modules->UseInterface("HashRequest");
-               }
-
-               SQLutils = ServerInstance->Modules->Find("m_sqlutils.so");
-               if (!SQLutils)
-                       throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqloper.so.");
-
-               Implementation eventlist[] = { I_OnRehash, I_OnPreCommand, I_OnLoadModule };
-               ServerInstance->Modules->Attach(eventlist, this, 4);
-       }
-
-       bool OneOfMatches(const char* host, const char* ip, const char* hostlist)
+ public:
+       const std::string uid, username, password;
+       OpMeQuery(Module* me, const std::string& u, const std::string& un, const std::string& pw)
+               : SQLQuery(me), uid(u), username(un), password(pw)
        {
-               std::stringstream hl(hostlist);
-               std::string xhost;
-               while (hl >> xhost)
-               {
-                       if (InspIRCd::Match(host, xhost, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(ip, xhost, ascii_case_insensitive_map))
-                       {
-                               return true;
-                       }
-               }
-               return false;
        }
 
-       virtual void OnLoadModule(Module* mod, const std::string& name)
+       void OnResult(SQLResult& res) CXX11_OVERRIDE
        {
-               if (ServerInstance->Modules->ModuleHasInterface(mod, "HashRequest"))
+               ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "result for %s", uid.c_str());
+               User* user = ServerInstance->FindNick(uid);
+               if (!user)
+                       return;
+
+               // multiple rows may exist
+               SQLEntries row;
+               while (res.GetRow(row))
                {
-                       ServerInstance->Logs->Log("m_sqloper",DEBUG, "Post-load registering hasher: %s", name.c_str());
-                       std::string sname = HashNameRequest(this, mod).response;
-                       hashers[sname.c_str()] = mod;
-                       names.push_back(sname);
-                       if (!diduseiface)
-                       {
-                               ServerInstance->Modules->UseInterface("HashRequest");
-                               diduseiface = true;
-                       }
+                       if (OperUser(user, row[0], row[1]))
+                               return;
                }
+               ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "no matches for %s (checked %d rows)", uid.c_str(), res.Rows());
+               // nobody succeeded... fall back to OPER
+               fallback();
        }
 
-       virtual ~ModuleSQLOper()
+       void OnError(SQLerror& error) CXX11_OVERRIDE
        {
-               ServerInstance->Modules->DoneWithInterface("SQL");
-               ServerInstance->Modules->DoneWithInterface("SQLutils");
-               if (diduseiface)
-                       ServerInstance->Modules->DoneWithInterface("HashRequest");
+               ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "query failed (%s)", error.Str());
+               fallback();
        }
 
-
-       virtual void OnRehash(User* user)
+       void fallback()
        {
-               ConfigReader Conf;
+               User* user = ServerInstance->FindNick(uid);
+               if (!user)
+                       return;
 
-               databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
-               hashtype = assign(Conf.ReadValue("sqloper", "hash", 0));
-       }
+               Command* oper_command = ServerInstance->Parser.GetHandler("OPER");
 
-       virtual ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, User *user, bool validated, const std::string &original_line)
-       {
-               if ((validated) && (command == "OPER"))
+               if (oper_command)
                {
-                       if (LookupOper(user, parameters[0], parameters[1]))
-                       {
-                               /* Returning true here just means the query is in progress, or on it's way to being
-                                * in progress. Nothing about the /oper actually being successful..
-                                * If the oper lookup fails later, we pass the command to the original handler
-                                * for /oper by calling its Handle method directly.
-                                */
-                               return MOD_RES_DENY;
-                       }
+                       std::vector<std::string> params;
+                       params.push_back(username);
+                       params.push_back(password);
+                       oper_command->Handle(params, user);
+               }
+               else
+               {
+                       ServerInstance->Logs->Log(MODNAME, LOG_SPARSE, "BUG: WHAT?! Why do we have no OPER command?!");
                }
-               return MOD_RES_PASSTHRU;
        }
 
-       bool LookupOper(User* user, const std::string &username, const std::string &password)
+       bool OperUser(User* user, const std::string &pattern, const std::string &type)
        {
-               Module* target;
-
-               target = ServerInstance->Modules->FindFeature("SQL");
-
-               if (target)
+               OperIndex::iterator iter = ServerInstance->Config->OperTypes.find(type);
+               if (iter == ServerInstance->Config->OperTypes.end())
                {
-                       hashymodules::iterator x = hashers.find(hashtype);
-                       if (x == hashers.end())
-                               return false;
-
-                       /* Make an MD5 hash of the password for using in the query */
-                       std::string md5_pass_hash = HashRequest(this, x->second, password).result;
+                       ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "bad type '%s' in returned row for oper %s", type.c_str(), username.c_str());
+                       return false;
+               }
+               OperInfo* ifo = iter->second;
 
-                       /* We generate our own sum here because some database providers (e.g. SQLite) dont have a builtin md5/sha256 function,
-                        * also hashing it in the module and only passing a remote query containing a hash is more secure.
-                        */
-                       SQLrequest req = SQLrequest(this, target, databaseid,
-                                       SQLquery("SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password='?'") % username % md5_pass_hash);
+               std::string hostname(user->ident);
 
-                       /* When we get the query response from the service provider we will be given an ID to play with,
-                        * just an ID number which is unique to this query. We need a way of associating that ID with a User
-                        * so we insert it into a map mapping the IDs to users.
-                        * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
-                        * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
-                        * us to discard the query.
-                        */
-                       AssociateUser(this, SQLutils, req.id, user).Send();
+               hostname.append("@").append(user->host);
 
-                       saved_user.set(user, username);
-                       saved_pass.set(user, password);
+               if (InspIRCd::MatchMask(pattern, hostname, user->GetIPString()))
+               {
+                       /* Opertype and host match, looks like this is it. */
 
+                       user->Oper(ifo);
                        return true;
                }
-               else
-               {
-                       ServerInstance->Logs->Log("m_sqloper",SPARSE, "WARNING: Couldn't find SQL provider module. NOBODY will be able to oper up unless their o:line is statically configured");
-                       return false;
-               }
+
+               return false;
        }
+};
 
-       void OnRequest(Request& request)
-       {
-               if (strcmp(SQLRESID, request.id) == 0)
-               {
-                       SQLresult* res = static_cast<SQLresult*>(&request);
+class ModuleSQLOper : public Module
+{
+       std::string query;
+       std::string hashtype;
+       dynamic_reference<SQLProvider> SQL;
 
-                       User* user = GetAssocUser(this, SQLutils, res->id).S().user;
-                       UnAssociate(this, SQLutils, res->id).S();
+public:
+       ModuleSQLOper() : SQL(this, "SQL") {}
 
-                       if (user)
-                       {
-                               std::string* tried_user = saved_user.get(user);
-                               std::string* tried_pass = saved_pass.get(user);
-                               if (res->error.Id() == SQL_NO_ERROR)
-                               {
-                                       if (res->Rows())
-                                       {
-                                               /* We got a row in the result, this means there was a record for the oper..
-                                                * now we just need to check if their host matches, and if it does then
-                                                * oper them up.
-                                                *
-                                                * We now (previous versions of the module didn't) support multiple SQL
-                                                * rows per-oper in the same way the config file does, all rows will be tried
-                                                * until one is found which matches. This is useful to define several different
-                                                * hosts for a single oper.
-                                                *
-                                                * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
-                                                * are no more rows to return.
-                                                */
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
+       {
+               ConfigTag* tag = ServerInstance->Config->ConfValue("sqloper");
 
-                                               for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
-                                               {
-                                                       if (OperUser(user, row["hostname"].d, row["type"].d))
-                                                       {
-                                                               /* If/when one of the rows matches, stop checking and return */
-                                                               saved_user.unset(user);
-                                                               saved_pass.unset(user);
-                                                       }
-                                                       if (tried_user && tried_pass)
-                                                       {
-                                                               LoginFail(user, *tried_user, *tried_pass);
-                                                               saved_user.unset(user);
-                                                               saved_pass.unset(user);
-                                                       }
-                                               }
-                                       }
-                                       else
-                                       {
-                                               /* No rows in result, this means there was no oper line for the user,
-                                                * we should have already checked the o:lines so now we need an
-                                                * "insufficient awesomeness" (invalid credentials) error
-                                                */
-                                               if (tried_user && tried_pass)
-                                               {
-                                                       LoginFail(user, *tried_user, *tried_pass);
-                                                       saved_user.unset(user);
-                                                       saved_pass.unset(user);
-                                               }
-                                       }
-                               }
-                               else
-                               {
-                                       /* This one shouldn't happen, the query failed for some reason.
-                                        * We have to fail the /oper request and give them the same error
-                                        * as above.
-                                        */
-                                       if (tried_user && tried_pass)
-                                       {
-                                               LoginFail(user, *tried_user, *tried_pass);
-                                               saved_user.unset(user);
-                                               saved_pass.unset(user);
-                                       }
+               std::string dbid = tag->getString("dbid");
+               if (dbid.empty())
+                       SQL.SetProvider("SQL");
+               else
+                       SQL.SetProvider("SQL/" + dbid);
 
-                               }
-                       }
-               }
+               hashtype = tag->getString("hash");
+               query = tag->getString("query", "SELECT hostname as host, type FROM ircd_opers WHERE username='$username' AND password='$password'");
        }
 
-       void LoginFail(User* user, const std::string &username, const std::string &pass)
+       ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE
        {
-               Command* oper_command = ServerInstance->Parser->GetHandler("OPER");
-
-               if (oper_command)
+               if (validated && command == "OPER" && parameters.size() >= 2)
                {
-                       std::vector<std::string> params;
-                       params.push_back(username);
-                       params.push_back(pass);
-                       oper_command->Handle(params, user);
-               }
-               else
-               {
-                       ServerInstance->Logs->Log("m_sqloper",DEBUG, "BUG: WHAT?! Why do we have no OPER command?!");
+                       if (SQL)
+                       {
+                               LookupOper(user, parameters[0], parameters[1]);
+                               /* Query is in progress, it will re-invoke OPER if needed */
+                               return MOD_RES_DENY;
+                       }
+                       ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "database not present");
                }
+               return MOD_RES_PASSTHRU;
        }
 
-       bool OperUser(User* user, const std::string &pattern, const std::string &type)
+       void LookupOper(User* user, const std::string &username, const std::string &password)
        {
-               ConfigReader Conf;
-
-               for (int j = 0; j < Conf.Enumerate("type"); j++)
-               {
-                       std::string tname = Conf.ReadValue("type","name",j);
-                       std::string hostname(user->ident);
-
-                       hostname.append("@").append(user->host);
-
-                       if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
-                       {
-                               /* Opertype and host match, looks like this is it. */
-                               std::string operhost = Conf.ReadValue("type", "host", j);
+               HashProvider* hash = ServerInstance->Modules->FindDataService<HashProvider>("hash/" + hashtype);
 
-                               if (operhost.size())
-                                       user->ChangeDisplayedHost(operhost.c_str());
+               ParamM userinfo;
+               SQL->PopulateUserInfo(user, userinfo);
+               userinfo["username"] = username;
+               userinfo["password"] = hash ? hash->hexsum(password) : password;
 
-                               user->Oper(type, tname);
-                               return true;
-                       }
-               }
-
-               return false;
+               SQL->submit(new OpMeQuery(this, user->uuid, username, password), query, userinfo);
        }
 
-       Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Allows storage of oper credentials in an SQL table", VF_VENDOR, API_VERSION);
+               return Version("Allows storage of oper credentials in an SQL table", VF_VENDOR);
        }
-
 };
 
 MODULE_INIT(ModuleSQLOper)