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 * ---------------------------------------------------
16 #include "m_sqlutils.h"
19 /* $ModDesc: Allows storage of oper credentials in an SQL table */
20 /* $ModDep: m_sqlv2.h m_sqlutils.h m_hash.h */
22 typedef std::map<irc::string, Module*> hashymodules;
24 class ModuleSQLOper : public Module
26 LocalStringExt saved_user;
27 LocalStringExt saved_pass;
29 std::string databaseid;
36 ModuleSQLOper() : saved_user("sqloper_user", this), saved_pass("sqloper_pass", this)
38 ServerInstance->Modules->UseInterface("SQLutils");
39 ServerInstance->Modules->UseInterface("SQL");
40 ServerInstance->Modules->UseInterface("HashRequest");
46 /* Find all modules which implement the interface 'HashRequest' */
47 modulelist* ml = ServerInstance->Modules->FindInterface("HashRequest");
49 /* Did we find any modules? */
52 /* Yes, enumerate them all to find out the hashing algorithm name */
53 for (modulelist::iterator m = ml->begin(); m != ml->end(); m++)
55 /* Make a request to it for its name, its implementing
56 * HashRequest so we know its safe to do this
58 std::string name = HashNameRequest(this, *m).response;
59 /* Build a map of them */
60 hashers[name.c_str()] = *m;
61 names.push_back(name);
63 /* 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. */
65 ServerInstance->Modules->UseInterface("HashRequest");
68 SQLutils = ServerInstance->Modules->Find("m_sqlutils.so");
70 throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqloper.so.");
72 Implementation eventlist[] = { I_OnRehash, I_OnPreCommand, I_OnLoadModule };
73 ServerInstance->Modules->Attach(eventlist, this, 4);
76 bool OneOfMatches(const char* host, const char* ip, const char* hostlist)
78 std::stringstream hl(hostlist);
82 if (InspIRCd::Match(host, xhost, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(ip, xhost, ascii_case_insensitive_map))
90 virtual void OnLoadModule(Module* mod, const std::string& name)
92 if (ServerInstance->Modules->ModuleHasInterface(mod, "HashRequest"))
94 ServerInstance->Logs->Log("m_sqloper",DEBUG, "Post-load registering hasher: %s", name.c_str());
95 std::string sname = HashNameRequest(this, mod).response;
96 hashers[sname.c_str()] = mod;
97 names.push_back(sname);
100 ServerInstance->Modules->UseInterface("HashRequest");
106 virtual ~ModuleSQLOper()
108 ServerInstance->Modules->DoneWithInterface("SQL");
109 ServerInstance->Modules->DoneWithInterface("SQLutils");
111 ServerInstance->Modules->DoneWithInterface("HashRequest");
115 virtual void OnRehash(User* user)
119 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
120 hashtype = assign(Conf.ReadValue("sqloper", "hash", 0));
123 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, User *user, bool validated, const std::string &original_line)
125 if ((validated) && (command == "OPER"))
127 if (LookupOper(user, parameters[0], parameters[1]))
129 /* Returning true here just means the query is in progress, or on it's way to being
130 * in progress. Nothing about the /oper actually being successful..
131 * If the oper lookup fails later, we pass the command to the original handler
132 * for /oper by calling its Handle method directly.
137 return MOD_RES_PASSTHRU;
140 bool LookupOper(User* user, const std::string &username, const std::string &password)
144 target = ServerInstance->Modules->FindFeature("SQL");
148 hashymodules::iterator x = hashers.find(hashtype);
149 if (x == hashers.end())
152 /* Make an MD5 hash of the password for using in the query */
153 std::string md5_pass_hash = HashRequest(this, x->second, password).hex();
155 /* We generate our own sum here because some database providers (e.g. SQLite) dont have a builtin md5/sha256 function,
156 * also hashing it in the module and only passing a remote query containing a hash is more secure.
158 SQLrequest req = SQLrequest(this, target, databaseid,
159 SQLquery("SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password='?'") % username % md5_pass_hash);
161 /* When we get the query response from the service provider we will be given an ID to play with,
162 * just an ID number which is unique to this query. We need a way of associating that ID with a User
163 * so we insert it into a map mapping the IDs to users.
164 * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
165 * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
166 * us to discard the query.
168 AssociateUser(this, SQLutils, req.id, user).Send();
170 saved_user.set(user, username);
171 saved_pass.set(user, password);
177 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");
182 void OnRequest(Request& request)
184 if (strcmp(SQLRESID, request.id) == 0)
186 SQLresult* res = static_cast<SQLresult*>(&request);
188 User* user = GetAssocUser(this, SQLutils, res->id).S().user;
189 UnAssociate(this, SQLutils, res->id).S();
193 std::string* tried_user = saved_user.get(user);
194 std::string* tried_pass = saved_pass.get(user);
195 if (res->error.Id() == SQL_NO_ERROR)
199 /* We got a row in the result, this means there was a record for the oper..
200 * now we just need to check if their host matches, and if it does then
203 * We now (previous versions of the module didn't) support multiple SQL
204 * rows per-oper in the same way the config file does, all rows will be tried
205 * until one is found which matches. This is useful to define several different
206 * hosts for a single oper.
208 * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
209 * are no more rows to return.
212 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
214 if (OperUser(user, row["hostname"].d, row["type"].d))
216 /* If/when one of the rows matches, stop checking and return */
217 saved_user.unset(user);
218 saved_pass.unset(user);
220 if (tried_user && tried_pass)
222 LoginFail(user, *tried_user, *tried_pass);
223 saved_user.unset(user);
224 saved_pass.unset(user);
230 /* No rows in result, this means there was no oper line for the user,
231 * we should have already checked the o:lines so now we need an
232 * "insufficient awesomeness" (invalid credentials) error
234 if (tried_user && tried_pass)
236 LoginFail(user, *tried_user, *tried_pass);
237 saved_user.unset(user);
238 saved_pass.unset(user);
244 /* This one shouldn't happen, the query failed for some reason.
245 * We have to fail the /oper request and give them the same error
248 if (tried_user && tried_pass)
250 LoginFail(user, *tried_user, *tried_pass);
251 saved_user.unset(user);
252 saved_pass.unset(user);
260 void LoginFail(User* user, const std::string &username, const std::string &pass)
262 Command* oper_command = ServerInstance->Parser->GetHandler("OPER");
266 std::vector<std::string> params;
267 params.push_back(username);
268 params.push_back(pass);
269 oper_command->Handle(params, user);
273 ServerInstance->Logs->Log("m_sqloper",DEBUG, "BUG: WHAT?! Why do we have no OPER command?!");
277 bool OperUser(User* user, const std::string &pattern, const std::string &type)
281 for (int j = 0; j < Conf.Enumerate("type"); j++)
283 std::string tname = Conf.ReadValue("type","name",j);
284 std::string hostname(user->ident);
286 hostname.append("@").append(user->host);
288 if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
290 /* Opertype and host match, looks like this is it. */
291 std::string operhost = Conf.ReadValue("type", "host", j);
294 user->ChangeDisplayedHost(operhost.c_str());
296 user->Oper(type, tname);
306 return Version("Allows storage of oper credentials in an SQL table", VF_VENDOR, API_VERSION);
311 MODULE_INIT(ModuleSQLOper)