2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2017 Dylan Frank <b00mx0r@aureus.pw>
5 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
7 * This file is part of InspIRCd. InspIRCd is free software: you can
8 * redistribute it and/or modify it under the terms of the GNU General Public
9 * License as published by the Free Software Foundation, version 2.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "modules/sql.h"
24 class OperQuery : public SQL::Query
27 // This variable will store all the OPER blocks from the DB
28 std::vector<std::string>& my_blocks;
29 /** We want to store the username and password if this is called during an /OPER, as we're responsible for /OPER post-DB fetch
30 * Note: uid will be empty if this DB update was not called as a result of a user command (i.e. /REHASH)
32 const std::string uid, username, password;
33 OperQuery(Module* me, std::vector<std::string>& mb, const std::string& u, const std::string& un, const std::string& pw)
41 OperQuery(Module* me, std::vector<std::string>& mb)
47 void OnResult(SQL::Result& res) CXX11_OVERRIDE
49 ServerConfig::OperIndex& oper_blocks = ServerInstance->Config->oper_blocks;
51 // Remove our previous blocks from oper_blocks for a clean update
52 for (std::vector<std::string>::const_iterator i = my_blocks.begin(); i != my_blocks.end(); ++i)
54 oper_blocks.erase(*i);
59 // Iterate through DB results to create oper blocks from sqloper rows
60 while (res.GetRow(row))
62 std::vector<std::string> cols;
65 // Create the oper tag as if we were the conf file.
67 reference<ConfigTag> tag = ConfigTag::create("oper", MODNAME, 0, items);
69 /** Iterate through each column in the SQLOpers table. An infinite number of fields can be specified.
70 * Column 'x' with cell value 'y' will be the same as x=y in an OPER block in opers.conf.
72 for (unsigned int i=0; i < cols.size(); ++i)
75 (*items)[cols[i]] = row[i];
77 const std::string name = tag->getString("name");
79 // Skip both duplicate sqloper blocks and sqloper blocks that attempt to override conf blocks.
80 if (oper_blocks.find(name) != oper_blocks.end())
83 const std::string type = tag->getString("type");
84 ServerConfig::OperIndex::iterator tblk = ServerInstance->Config->OperTypes.find(type);
85 if (tblk == ServerInstance->Config->OperTypes.end())
87 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Sqloper block " + name + " has missing type " + type);
88 ServerInstance->SNO->WriteGlobalSno('a', "m_sqloper: Oper block %s has missing type %s", name.c_str(), type.c_str());
92 OperInfo* ifo = new OperInfo(type);
94 ifo->type_block = tblk->second->type_block;
95 ifo->oper_block = tag;
96 ifo->class_blocks.assign(tblk->second->class_blocks.begin(), tblk->second->class_blocks.end());
97 oper_blocks[name] = ifo;
98 my_blocks.push_back(name);
101 // If this was done as a result of /OPER and not a config read
104 // Now that we've updated the DB, call any other /OPER hooks and then call /OPER
109 void OnError(SQL::Error& error) CXX11_OVERRIDE
111 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "query failed (%s)", error.ToString());
112 ServerInstance->SNO->WriteGlobalSno('a', "m_sqloper: failed to update blocks from database");
115 // Fallback. We don't want to block a netadmin from /OPER
120 // Call /oper after placing all blocks from the SQL table into the config->oper_blocks list.
123 User* user = ServerInstance->FindNick(uid);
124 LocalUser* localuser = IS_LOCAL(user);
125 // This should never be true
129 Command* oper_command = ServerInstance->Parser.GetHandler("OPER");
133 CommandBase::Params params;
134 params.push_back(username);
135 params.push_back(password);
137 // Begin callback to other modules (i.e. sslinfo) now that we completed the DB fetch
138 ModResult MOD_RESULT;
140 std::string origin = "OPER";
141 FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (origin, params, localuser, true));
142 if (MOD_RESULT == MOD_RES_DENY)
146 ClientProtocol::TagMap tags;
147 oper_command->Handle(user, CommandBase::Params(params, tags));
151 ServerInstance->Logs->Log(MODNAME, LOG_SPARSE, "BUG: WHAT?! Why do we have no OPER command?!");
156 class ModuleSQLOper : public Module
158 // Whether OperQuery is running
161 // Stores oper blocks from DB
162 std::vector<std::string> my_blocks;
163 dynamic_reference<SQL::Provider> SQL;
172 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
174 // Clear list of our blocks, as ConfigReader just wiped them anyway
177 ConfigTag* tag = ServerInstance->Config->ConfValue("sqloper");
179 std::string dbid = tag->getString("dbid");
181 SQL.SetProvider("SQL");
183 SQL.SetProvider("SQL/" + dbid);
185 query = tag->getString("query", "SELECT * FROM ircd_opers WHERE active=1;");
186 // Update sqloper list from the database.
192 // Remove all oper blocks that were from the DB
193 for (std::vector<std::string>::const_iterator i = my_blocks.begin(); i != my_blocks.end(); ++i)
195 ServerInstance->Config->oper_blocks.erase(*i);
199 ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
201 // If we are not in the middle of an existing /OPER and someone is trying to oper-up
202 if (validated && command == "OPER" && parameters.size() >= 2 && !active)
206 GetOperBlocks(user->uuid, parameters[0], parameters[1]);
207 /** We need to reload oper blocks from the DB before other
208 * hooks can run (i.e. sslinfo). We will re-call /OPER later.
212 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "database not present");
218 // There is either no DB or we successfully reloaded oper blocks
219 return MOD_RES_PASSTHRU;
222 // The one w/o params is for non-/OPER DB updates, such as a rehash.
225 SQL->Submit(new OperQuery(this, my_blocks), query);
227 void GetOperBlocks(const std::string u, const std::string& un, const std::string& pw)
230 // Call to SQL query to fetch oper list from SQL table.
231 SQL->Submit(new OperQuery(this, my_blocks, u, un, pw), query);
234 void Prioritize() CXX11_OVERRIDE
236 /** Run before other /OPER hooks that expect populated blocks, i.e. sslinfo or a TOTP module.
237 * We issue a DENY first, and will re-run OnPreCommand later to trigger the other hooks post-DB update.
239 ServerInstance->Modules.SetPriority(this, I_OnPreCommand, PRIORITY_FIRST);
242 Version GetVersion() CXX11_OVERRIDE
244 return Version("Allows storage of oper credentials in an SQL table", VF_VENDOR);
248 MODULE_INIT(ModuleSQLOper)