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"
18 #include "commands/cmd_oper.h"
20 /* $ModDesc: Allows storage of oper credentials in an SQL table */
21 /* $ModDep: m_sqlv2.h m_sqlutils.h m_hash.h */
23 typedef std::map<irc::string, Module*> hashymodules;
25 class ModuleSQLOper : public Module
28 std::string databaseid;
37 ServerInstance->Modules->UseInterface("SQLutils");
38 ServerInstance->Modules->UseInterface("SQL");
39 ServerInstance->Modules->UseInterface("HashRequest");
45 /* Find all modules which implement the interface 'HashRequest' */
46 modulelist* ml = ServerInstance->Modules->FindInterface("HashRequest");
48 /* Did we find any modules? */
51 /* Yes, enumerate them all to find out the hashing algorithm name */
52 for (modulelist::iterator m = ml->begin(); m != ml->end(); m++)
54 /* Make a request to it for its name, its implementing
55 * HashRequest so we know its safe to do this
57 std::string name = HashNameRequest(this, *m).Send();
58 /* Build a map of them */
59 hashers[name.c_str()] = *m;
60 names.push_back(name);
62 /* 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. */
64 ServerInstance->Modules->UseInterface("HashRequest");
67 SQLutils = ServerInstance->Modules->Find("m_sqlutils.so");
69 throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqloper.so.");
71 Implementation eventlist[] = { I_OnRequest, I_OnRehash, I_OnPreCommand, I_OnLoadModule };
72 ServerInstance->Modules->Attach(eventlist, this, 3);
75 bool OneOfMatches(const char* host, const char* ip, const char* hostlist)
77 std::stringstream hl(hostlist);
81 if (InspIRCd::Match(host, xhost, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(ip, xhost, ascii_case_insensitive_map))
89 virtual void OnLoadModule(Module* mod, const std::string& name)
91 if (ServerInstance->Modules->ModuleHasInterface(mod, "HashRequest"))
93 ServerInstance->Logs->Log("m_sqloper",DEBUG, "Post-load registering hasher: %s", name.c_str());
94 std::string sname = HashNameRequest(this, mod).Send();
95 hashers[sname.c_str()] = mod;
96 names.push_back(sname);
99 ServerInstance->Modules->UseInterface("HashRequest");
105 virtual ~ModuleSQLOper()
107 ServerInstance->Modules->DoneWithInterface("SQL");
108 ServerInstance->Modules->DoneWithInterface("SQLutils");
110 ServerInstance->Modules->DoneWithInterface("HashRequest");
114 virtual void OnRehash(User* user)
118 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
119 hashtype = assign(Conf.ReadValue("sqloper", "hash", 0));
122 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, User *user, bool validated, const std::string &original_line)
124 if ((validated) && (command == "OPER"))
126 if (LookupOper(user, parameters[0], parameters[1]))
128 /* Returning true here just means the query is in progress, or on it's way to being
129 * in progress. Nothing about the /oper actually being successful..
130 * If the oper lookup fails later, we pass the command to the original handler
131 * for /oper by calling its Handle method directly.
136 return MOD_RES_PASSTHRU;
139 bool LookupOper(User* user, const std::string &username, const std::string &password)
143 target = ServerInstance->Modules->FindFeature("SQL");
147 hashymodules::iterator x = hashers.find(hashtype);
148 if (x == hashers.end())
151 /* Reset hash module first back to MD5 standard state */
152 HashResetRequest(this, x->second).Send();
153 /* Make an MD5 hash of the password for using in the query */
154 std::string md5_pass_hash = HashSumRequest(this, x->second, password.c_str()).Send();
156 /* We generate our own sum here because some database providers (e.g. SQLite) dont have a builtin md5/sha256 function,
157 * also hashing it in the module and only passing a remote query containing a hash is more secure.
159 SQLrequest req = SQLrequest(this, target, databaseid,
160 SQLquery("SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password='?'") % username % md5_pass_hash);
164 /* When we get the query response from the service provider we will be given an ID to play with,
165 * just an ID number which is unique to this query. We need a way of associating that ID with a User
166 * so we insert it into a map mapping the IDs to users.
167 * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
168 * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
169 * us to discard the query.
171 AssociateUser(this, SQLutils, req.id, user).Send();
173 user->Extend("oper_user", strdup(username.c_str()));
174 user->Extend("oper_pass", strdup(password.c_str()));
185 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");
190 virtual const char* OnRequest(Request* request)
192 if (strcmp(SQLRESID, request->GetId()) == 0)
194 SQLresult* res = static_cast<SQLresult*>(request);
196 User* user = GetAssocUser(this, SQLutils, res->id).S().user;
197 UnAssociate(this, SQLutils, res->id).S();
199 char* tried_user = NULL;
200 char* tried_pass = NULL;
202 user->GetExt("oper_user", tried_user);
203 user->GetExt("oper_pass", tried_pass);
207 if (res->error.Id() == SQL_NO_ERROR)
211 /* We got a row in the result, this means there was a record for the oper..
212 * now we just need to check if their host matches, and if it does then
215 * We now (previous versions of the module didn't) support multiple SQL
216 * rows per-oper in the same way the config file does, all rows will be tried
217 * until one is found which matches. This is useful to define several different
218 * hosts for a single oper.
220 * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
221 * are no more rows to return.
224 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
226 if (OperUser(user, row["hostname"].d, row["type"].d))
228 /* If/when one of the rows matches, stop checking and return */
231 if (tried_user && tried_pass)
233 LoginFail(user, tried_user, tried_pass);
236 user->Shrink("oper_user");
237 user->Shrink("oper_pass");
243 /* No rows in result, this means there was no oper line for the user,
244 * we should have already checked the o:lines so now we need an
245 * "insufficient awesomeness" (invalid credentials) error
247 if (tried_user && tried_pass)
249 LoginFail(user, tried_user, tried_pass);
252 user->Shrink("oper_user");
253 user->Shrink("oper_pass");
259 /* This one shouldn't happen, the query failed for some reason.
260 * We have to fail the /oper request and give them the same error
263 if (tried_user && tried_pass)
265 LoginFail(user, tried_user, tried_pass);
268 user->Shrink("oper_user");
269 user->Shrink("oper_pass");
281 void LoginFail(User* user, const std::string &username, const std::string &pass)
283 Command* oper_command = ServerInstance->Parser->GetHandler("OPER");
287 std::vector<std::string> params;
288 params.push_back(username);
289 params.push_back(pass);
290 oper_command->Handle(params, user);
294 ServerInstance->Logs->Log("m_sqloper",DEBUG, "BUG: WHAT?! Why do we have no OPER command?!");
298 bool OperUser(User* user, const std::string &pattern, const std::string &type)
302 for (int j = 0; j < Conf.Enumerate("type"); j++)
304 std::string tname = Conf.ReadValue("type","name",j);
305 std::string hostname(user->ident);
307 hostname.append("@").append(user->host);
309 if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
311 /* Opertype and host match, looks like this is it. */
312 std::string operhost = Conf.ReadValue("type", "host", j);
315 user->ChangeDisplayedHost(operhost.c_str());
317 user->Oper(type, tname);
325 virtual Version GetVersion()
327 return Version("Allows storage of oper credentials in an SQL table", VF_VENDOR, API_VERSION);
332 MODULE_INIT(ModuleSQLOper)