1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
18 #include "configreader.h"
21 #include "m_sqlutils.h"
23 #include "commands/cmd_oper.h"
25 /* $ModDesc: Allows storage of oper credentials in an SQL table */
26 /* $ModDep: m_sqlv2.h m_sqlutils.h m_hash.h */
28 typedef std::map<irc::string, Module*> hashymodules;
30 class ModuleSQLOper : public Module
33 std::string databaseid;
37 std::deque<std::string> names;
40 ModuleSQLOper(InspIRCd* Me)
43 ServerInstance->Modules->UseInterface("SQLutils");
44 ServerInstance->Modules->UseInterface("SQL");
45 ServerInstance->Modules->UseInterface("HashRequest");
51 /* Find all modules which implement the interface 'HashRequest' */
52 modulelist* ml = ServerInstance->Modules->FindInterface("HashRequest");
54 /* Did we find any modules? */
57 /* Yes, enumerate them all to find out the hashing algorithm name */
58 for (modulelist::iterator m = ml->begin(); m != ml->end(); m++)
60 /* Make a request to it for its name, its implementing
61 * HashRequest so we know its safe to do this
63 std::string name = HashNameRequest(this, *m).Send();
64 /* Build a map of them */
65 hashers[name.c_str()] = *m;
66 names.push_back(name);
68 /* 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. */
70 ServerInstance->Modules->UseInterface("HashRequest");
73 SQLutils = ServerInstance->Modules->Find("m_sqlutils.so");
75 throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqloper.so.");
77 Implementation eventlist[] = { I_OnRequest, I_OnRehash, I_OnPreCommand, I_OnLoadModule };
78 ServerInstance->Modules->Attach(eventlist, this, 3);
81 virtual void OnLoadModule(Module* mod, const std::string& name)
83 if (ServerInstance->Modules->ModuleHasInterface(mod, "HashRequest"))
85 ServerInstance->Logs->Log("m_sqloper",DEBUG, "Post-load registering hasher: %s", name.c_str());
86 std::string sname = HashNameRequest(this, mod).Send();
87 hashers[sname.c_str()] = mod;
88 names.push_back(sname);
91 ServerInstance->Modules->UseInterface("HashRequest");
97 virtual ~ModuleSQLOper()
99 ServerInstance->Modules->DoneWithInterface("SQL");
100 ServerInstance->Modules->DoneWithInterface("SQLutils");
102 ServerInstance->Modules->DoneWithInterface("HashRequest");
106 virtual void OnRehash(User* user, const std::string ¶meter)
108 ConfigReader Conf(ServerInstance);
110 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
111 hashtype = assign(Conf.ReadValue("sqloper", "hash", 0));
114 virtual int OnPreCommand(std::string &command, std::vector<std::string> ¶meters, User *user, bool validated, const std::string &original_line)
116 if ((validated) && (command == "OPER"))
118 if (LookupOper(user, parameters[0], parameters[1]))
120 /* Returning true here just means the query is in progress, or on it's way to being
121 * in progress. Nothing about the /oper actually being successful..
122 * If the oper lookup fails later, we pass the command to the original handler
123 * for /oper by calling its Handle method directly.
131 bool LookupOper(User* user, const std::string &username, const std::string &password)
135 target = ServerInstance->Modules->FindFeature("SQL");
139 hashymodules::iterator x = hashers.find(hashtype);
140 if (x == hashers.end())
143 /* Reset hash module first back to MD5 standard state */
144 HashResetRequest(this, x->second).Send();
145 /* Make an MD5 hash of the password for using in the query */
146 std::string md5_pass_hash = HashSumRequest(this, x->second, password.c_str()).Send();
148 /* We generate our own sum here because some database providers (e.g. SQLite) dont have a builtin md5/sha256 function,
149 * also hashing it in the module and only passing a remote query containing a hash is more secure.
151 SQLrequest req = SQLrequest(this, target, databaseid,
152 SQLquery("SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password='?'") % username % md5_pass_hash);
156 /* When we get the query response from the service provider we will be given an ID to play with,
157 * just an ID number which is unique to this query. We need a way of associating that ID with a User
158 * so we insert it into a map mapping the IDs to users.
159 * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
160 * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
161 * us to discard the query.
163 AssociateUser(this, SQLutils, req.id, user).Send();
165 user->Extend("oper_user", strdup(username.c_str()));
166 user->Extend("oper_pass", strdup(password.c_str()));
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 virtual const char* OnRequest(Request* request)
184 if (strcmp(SQLRESID, request->GetId()) == 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();
191 char* tried_user = NULL;
192 char* tried_pass = NULL;
194 user->GetExt("oper_user", tried_user);
195 user->GetExt("oper_pass", tried_pass);
199 if (res->error.Id() == NO_ERROR)
203 /* We got a row in the result, this means there was a record for the oper..
204 * now we just need to check if their host matches, and if it does then
207 * We now (previous versions of the module didn't) support multiple SQL
208 * rows per-oper in the same way the config file does, all rows will be tried
209 * until one is found which matches. This is useful to define several different
210 * hosts for a single oper.
212 * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
213 * are no more rows to return.
216 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
218 if (OperUser(user, row["hostname"].d, row["type"].d))
220 /* If/when one of the rows matches, stop checking and return */
223 if (tried_user && tried_pass)
225 LoginFail(user, tried_user, tried_pass);
228 user->Shrink("oper_user");
229 user->Shrink("oper_pass");
235 /* No rows in result, this means there was no oper line for the user,
236 * we should have already checked the o:lines so now we need an
237 * "insufficient awesomeness" (invalid credentials) error
239 if (tried_user && tried_pass)
241 LoginFail(user, tried_user, tried_pass);
244 user->Shrink("oper_user");
245 user->Shrink("oper_pass");
251 /* This one shouldn't happen, the query failed for some reason.
252 * We have to fail the /oper request and give them the same error
255 if (tried_user && tried_pass)
257 LoginFail(user, tried_user, tried_pass);
260 user->Shrink("oper_user");
261 user->Shrink("oper_pass");
273 void LoginFail(User* user, const std::string &username, const std::string &pass)
275 Command* oper_command = ServerInstance->Parser->GetHandler("OPER");
279 std::vector<std::string> params;
280 params.push_back(username);
281 params.push_back(pass);
282 oper_command->Handle(params, user);
286 ServerInstance->Logs->Log("m_sqloper",DEBUG, "BUG: WHAT?! Why do we have no OPER command?!");
290 bool OperUser(User* user, const std::string &pattern, const std::string &type)
292 ConfigReader Conf(ServerInstance);
294 for (int j = 0; j < Conf.Enumerate("type"); j++)
296 std::string tname = Conf.ReadValue("type","name",j);
297 std::string hostname(user->ident);
299 hostname.append("@").append(user->host);
301 if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
303 /* Opertype and host match, looks like this is it. */
304 std::string operhost = Conf.ReadValue("type", "host", j);
307 user->ChangeDisplayedHost(operhost.c_str());
309 user->Oper(type, tname);
317 virtual Version GetVersion()
319 return Version("$Id$", VF_VENDOR, API_VERSION);
324 MODULE_INIT(ModuleSQLOper)