X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_sqloper.cpp;h=56c21c900f3fcb278d33cb81ba9dc5428929b493;hb=262ad80560b168da596a2c2874f07c9fe263bf35;hp=5f0df4c1064984d568991ebf1fb549d9d3e2d13e;hpb=83454575bcdc969e73fb9026dc3533dfb22c27a2;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_sqloper.cpp b/src/modules/m_sqloper.cpp index 5f0df4c10..56c21c900 100644 --- a/src/modules/m_sqloper.cpp +++ b/src/modules/m_sqloper.cpp @@ -1,325 +1,256 @@ -/* +------------------------------------+ - * | 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) 2019 B00mX0r + * Copyright (C) 2018 Dylan Frank + * Copyright (C) 2013-2014, 2018 Attila Molnar + * Copyright (C) 2013, 2017-2018, 2020 Sadie Powell + * Copyright (C) 2012, 2019 Robby + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2009 Uli Schlachter + * Copyright (C) 2007-2008 Dennis Friis + * Copyright (C) 2006-2007, 2010 Craig Edwards * - * 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 . */ -#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 hashymodules; +#include "inspircd.h" +#include "modules/sql.h" -class ModuleSQLOper : public Module +class OperQuery : public SQL::Query { - 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) + public: + // This variable will store all the OPER blocks from the DB + std::vector& my_blocks; + /** We want to store the username and password if this is called during an /OPER, as we're responsible for /OPER post-DB fetch + * Note: uid will be empty if this DB update was not called as a result of a user command (i.e. /REHASH) + */ + const std::string uid, username, password; + OperQuery(Module* me, std::vector& mb, const std::string& u, const std::string& un, const std::string& pw) + : SQL::Query(me) + , my_blocks(mb) + , uid(u) + , username(un) + , password(pw) { - ServerInstance->Modules->UseInterface("SQLutils"); - ServerInstance->Modules->UseInterface("SQL"); - ServerInstance->Modules->UseInterface("HashRequest"); - - OnRehash(NULL); - - diduseiface = false; + } + OperQuery(Module* me, std::vector& mb) + : SQL::Query(me) + , my_blocks(mb) + { + } - /* Find all modules which implement the interface 'HashRequest' */ - modulelist* ml = ServerInstance->Modules->FindInterface("HashRequest"); + void OnResult(SQL::Result& res) CXX11_OVERRIDE + { + ServerConfig::OperIndex& oper_blocks = ServerInstance->Config->oper_blocks; - /* Did we find any modules? */ - if (ml) + // Remove our previous blocks from oper_blocks for a clean update + for (std::vector::const_iterator i = my_blocks.begin(); i != my_blocks.end(); ++i) { - /* 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).Send(); - /* 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"); + oper_blocks.erase(*i); } + my_blocks.clear(); - 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."); + SQL::Row row; + // Iterate through DB results to create oper blocks from sqloper rows + while (res.GetRow(row)) + { + std::vector cols; + res.GetCols(cols); - Implementation eventlist[] = { I_OnRehash, I_OnPreCommand, I_OnLoadModule }; - ServerInstance->Modules->Attach(eventlist, this, 4); - } + // Create the oper tag as if we were the conf file. + ConfigItems* items; + reference tag = ConfigTag::create("oper", MODNAME, 0, items); - bool OneOfMatches(const char* host, const char* ip, const char* hostlist) - { - 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)) + /** Iterate through each column in the SQLOpers table. An infinite number of fields can be specified. + * Column 'x' with cell value 'y' will be the same as x=y in an OPER block in opers.conf. + */ + for (unsigned int i=0; i < cols.size(); ++i) { - return true; + if (!row[i].IsNull()) + (*items)[cols[i]] = row[i]; } - } - return false; - } + const std::string name = tag->getString("name"); - virtual void OnLoadModule(Module* mod, const std::string& name) - { - if (ServerInstance->Modules->ModuleHasInterface(mod, "HashRequest")) - { - ServerInstance->Logs->Log("m_sqloper",DEBUG, "Post-load registering hasher: %s", name.c_str()); - std::string sname = HashNameRequest(this, mod).Send(); - hashers[sname.c_str()] = mod; - names.push_back(sname); - if (!diduseiface) + // Skip both duplicate sqloper blocks and sqloper blocks that attempt to override conf blocks. + if (oper_blocks.find(name) != oper_blocks.end()) + continue; + + const std::string type = tag->getString("type"); + ServerConfig::OperIndex::iterator tblk = ServerInstance->Config->OperTypes.find(type); + if (tblk == ServerInstance->Config->OperTypes.end()) { - ServerInstance->Modules->UseInterface("HashRequest"); - diduseiface = true; + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Sqloper block " + name + " has missing type " + type); + ServerInstance->SNO->WriteGlobalSno('a', "m_sqloper: Oper block %s has missing type %s", name.c_str(), type.c_str()); + continue; } - } - } - - virtual ~ModuleSQLOper() - { - ServerInstance->Modules->DoneWithInterface("SQL"); - ServerInstance->Modules->DoneWithInterface("SQLutils"); - if (diduseiface) - ServerInstance->Modules->DoneWithInterface("HashRequest"); - } + OperInfo* ifo = new OperInfo(type); - virtual void OnRehash(User* user) - { - ConfigReader Conf; + ifo->type_block = tblk->second->type_block; + ifo->oper_block = tag; + ifo->class_blocks.assign(tblk->second->class_blocks.begin(), tblk->second->class_blocks.end()); + oper_blocks[name] = ifo; + my_blocks.push_back(name); + row.clear(); + } - databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */ - hashtype = assign(Conf.ReadValue("sqloper", "hash", 0)); + // If this was done as a result of /OPER and not a config read + if (!uid.empty()) + { + // Now that we've updated the DB, call any other /OPER hooks and then call /OPER + OperExec(); + } } - virtual ModResult OnPreCommand(std::string &command, std::vector ¶meters, User *user, bool validated, const std::string &original_line) + void OnError(SQL::Error& error) CXX11_OVERRIDE { - if ((validated) && (command == "OPER")) + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "query failed (%s)", error.ToString()); + ServerInstance->SNO->WriteGlobalSno('a', "m_sqloper: Failed to update blocks from database"); + if (!uid.empty()) { - 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; - } + // Fallback. We don't want to block a netadmin from /OPER + OperExec(); } - return MOD_RES_PASSTHRU; } - bool LookupOper(User* user, const std::string &username, const std::string &password) + // Call /oper after placing all blocks from the SQL table into the config->oper_blocks list. + void OperExec() { - Module* target; + User* user = ServerInstance->FindNick(uid); + LocalUser* localuser = IS_LOCAL(user); + // This should never be true + if (!localuser) + return; - target = ServerInstance->Modules->FindFeature("SQL"); + Command* oper_command = ServerInstance->Parser.GetHandler("OPER"); - if (target) + if (oper_command) { - hashymodules::iterator x = hashers.find(hashtype); - if (x == hashers.end()) - return false; + CommandBase::Params params; + params.push_back(username); + params.push_back(password); - /* Reset hash module first back to MD5 standard state */ - HashResetRequest(this, x->second).Send(); - /* Make an MD5 hash of the password for using in the query */ - std::string md5_pass_hash = HashSumRequest(this, x->second, password.c_str()).Send(); + // Begin callback to other modules (i.e. sslinfo) now that we completed the DB fetch + ModResult MOD_RESULT; - /* 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 origin = "OPER"; + FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (origin, params, localuser, true)); + if (MOD_RESULT == MOD_RES_DENY) + return; - if (req.Send()) - { - /* 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(); - - saved_user.set(user, username); - saved_pass.set(user, password); - - return true; - } - else - { - return false; - } + // Now handle /OPER. + ClientProtocol::TagMap tags; + oper_command->Handle(user, CommandBase::Params(params, tags)); } 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; + ServerInstance->Logs->Log(MODNAME, LOG_SPARSE, "BUG: WHAT?! Why do we have no OPER command?!"); } } +}; + +class ModuleSQLOper : public Module +{ + // Whether OperQuery is running + bool active; + std::string query; + // Stores oper blocks from DB + std::vector my_blocks; + dynamic_reference SQL; - const char* OnRequest(Request* request) +public: + ModuleSQLOper() + : active(false) + , SQL(this, "SQL") { - if (strcmp(SQLRESID, request->GetId()) == 0) - { - SQLresult* res = static_cast(request); + } - User* user = GetAssocUser(this, SQLutils, res->id).S().user; - UnAssociate(this, SQLutils, res->id).S(); + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE + { + // Clear list of our blocks, as ConfigReader just wiped them anyway + my_blocks.clear(); - 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. - */ - - 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); - return SQLSUCCESS; - } - 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); - } - - } - } + ConfigTag* tag = ServerInstance->Config->ConfValue("sqloper"); - return SQLSUCCESS; - } + std::string dbid = tag->getString("dbid"); + if (dbid.empty()) + SQL.SetProvider("SQL"); + else + SQL.SetProvider("SQL/" + dbid); - return NULL; + query = tag->getString("query", "SELECT * FROM ircd_opers WHERE active=1;", 1); + // Update sqloper list from the database. + GetOperBlocks(); } - void LoginFail(User* user, const std::string &username, const std::string &pass) + ~ModuleSQLOper() { - Command* oper_command = ServerInstance->Parser->GetHandler("OPER"); - - if (oper_command) + // Remove all oper blocks that were from the DB + for (std::vector::const_iterator i = my_blocks.begin(); i != my_blocks.end(); ++i) { - std::vector 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?!"); + ServerInstance->Config->oper_blocks.erase(*i); } } - bool OperUser(User* user, const std::string &pattern, const std::string &type) + ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE { - ConfigReader Conf; - - for (int j = 0; j < Conf.Enumerate("type"); j++) + // If we are not in the middle of an existing /OPER and someone is trying to oper-up + if (validated && command == "OPER" && parameters.size() >= 2 && !active) { - 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())) + if (SQL) { - /* Opertype and host match, looks like this is it. */ - std::string operhost = Conf.ReadValue("type", "host", j); - - if (operhost.size()) - user->ChangeDisplayedHost(operhost.c_str()); - - user->Oper(type, tname); - return true; + GetOperBlocks(user->uuid, parameters[0], parameters[1]); + /** We need to reload oper blocks from the DB before other + * hooks can run (i.e. sslinfo). We will re-call /OPER later. + */ + return MOD_RES_DENY; } + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "database not present"); + } + else if (active) + { + active = false; } + // There is either no DB or we successfully reloaded oper blocks + return MOD_RES_PASSTHRU; + } - return false; + // The one w/o params is for non-/OPER DB updates, such as a rehash. + void GetOperBlocks() + { + SQL->Submit(new OperQuery(this, my_blocks), query); + } + void GetOperBlocks(const std::string u, const std::string& un, const std::string& pw) + { + active = true; + // Call to SQL query to fetch oper list from SQL table. + SQL->Submit(new OperQuery(this, my_blocks, u, un, pw), query); } - Version GetVersion() + void Prioritize() CXX11_OVERRIDE { - return Version("Allows storage of oper credentials in an SQL table", VF_VENDOR, API_VERSION); + /** Run before other /OPER hooks that expect populated blocks, i.e. sslinfo or a TOTP module. + * We issue a DENY first, and will re-run OnPreCommand later to trigger the other hooks post-DB update. + */ + ServerInstance->Modules.SetPriority(this, I_OnPreCommand, PRIORITY_FIRST); } + Version GetVersion() CXX11_OVERRIDE + { + return Version("Allows server operators to be authenticated against an SQL table.", VF_VENDOR); + } }; MODULE_INIT(ModuleSQLOper)