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 */
28 class ModuleSQLOper : public Module
32 std::string databaseid;
35 ModuleSQLOper(InspIRCd* Me)
38 ServerInstance->Modules->UseInterface("SQLutils");
39 ServerInstance->Modules->UseInterface("SQL");
40 ServerInstance->Modules->UseInterface("HashRequest");
42 /* Attempt to locate the md5 service provider, bail if we can't find it */
43 HashModule = ServerInstance->Modules->Find("m_md5.so");
45 throw ModuleException("Can't find m_md5.so. Please load m_md5.so before m_sqloper.so.");
47 SQLutils = ServerInstance->Modules->Find("m_sqlutils.so");
49 throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqloper.so.");
52 Implementation eventlist[] = { I_OnRequest, I_OnRehash, I_OnPreCommand };
53 ServerInstance->Modules->Attach(eventlist, this, 3);
56 virtual ~ModuleSQLOper()
58 ServerInstance->Modules->DoneWithInterface("SQL");
59 ServerInstance->Modules->DoneWithInterface("SQLutils");
60 ServerInstance->Modules->DoneWithInterface("HashRequest");
64 virtual void OnRehash(User* user, const std::string ¶meter)
66 ConfigReader Conf(ServerInstance);
68 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
71 virtual int OnPreCommand(const std::string &command, const char* const* parameters, int pcnt, User *user, bool validated, const std::string &original_line)
73 if ((validated) && (command == "OPER"))
75 if (LookupOper(user, parameters[0], parameters[1]))
77 /* Returning true here just means the query is in progress, or on it's way to being
78 * in progress. Nothing about the /oper actually being successful..
79 * If the oper lookup fails later, we pass the command to the original handler
80 * for /oper by calling its Handle method directly.
88 bool LookupOper(User* user, const std::string &username, const std::string &password)
92 target = ServerInstance->Modules->FindFeature("SQL");
96 /* Reset hash module first back to MD5 standard state */
97 HashResetRequest(this, HashModule).Send();
98 /* Make an MD5 hash of the password for using in the query */
99 std::string md5_pass_hash = HashSumRequest(this, HashModule, password.c_str()).Send();
101 /* We generate our own MD5 sum here because some database providers (e.g. SQLite) dont have a builtin md5 function,
102 * also hashing it in the module and only passing a remote query containing a hash is more secure.
105 SQLrequest req = SQLrequest(this, target, databaseid,
106 SQLquery("SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password='?'") % username % md5_pass_hash);
110 /* When we get the query response from the service provider we will be given an ID to play with,
111 * just an ID number which is unique to this query. We need a way of associating that ID with a User
112 * so we insert it into a map mapping the IDs to users.
113 * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
114 * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
115 * us to discard the query.
117 AssociateUser(this, SQLutils, req.id, user).Send();
119 user->Extend("oper_user", strdup(username.c_str()));
120 user->Extend("oper_pass", strdup(password.c_str()));
131 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");
136 virtual const char* OnRequest(Request* request)
138 if (strcmp(SQLRESID, request->GetId()) == 0)
140 SQLresult* res = static_cast<SQLresult*>(request);
142 User* user = GetAssocUser(this, SQLutils, res->id).S().user;
143 UnAssociate(this, SQLutils, res->id).S();
145 char* tried_user = NULL;
146 char* tried_pass = NULL;
148 user->GetExt("oper_user", tried_user);
149 user->GetExt("oper_pass", tried_pass);
153 if (res->error.Id() == NO_ERROR)
157 /* We got a row in the result, this means there was a record for the oper..
158 * now we just need to check if their host matches, and if it does then
161 * We now (previous versions of the module didn't) support multiple SQL
162 * rows per-oper in the same way the config file does, all rows will be tried
163 * until one is found which matches. This is useful to define several different
164 * hosts for a single oper.
166 * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
167 * are no more rows to return.
170 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
172 if (OperUser(user, row["username"].d, row["password"].d, row["hostname"].d, row["type"].d))
174 /* If/when one of the rows matches, stop checking and return */
177 if (tried_user && tried_pass)
179 LoginFail(user, tried_user, tried_pass);
182 user->Shrink("oper_user");
183 user->Shrink("oper_pass");
189 /* No rows in result, this means there was no oper line for the user,
190 * we should have already checked the o:lines so now we need an
191 * "insufficient awesomeness" (invalid credentials) error
193 if (tried_user && tried_pass)
195 LoginFail(user, tried_user, tried_pass);
198 user->Shrink("oper_user");
199 user->Shrink("oper_pass");
205 /* This one shouldn't happen, the query failed for some reason.
206 * We have to fail the /oper request and give them the same error
209 if (tried_user && tried_pass)
211 LoginFail(user, tried_user, tried_pass);
214 user->Shrink("oper_user");
215 user->Shrink("oper_pass");
227 void LoginFail(User* user, const std::string &username, const std::string &pass)
229 Command* oper_command = ServerInstance->Parser->GetHandler("OPER");
233 const char* params[] = { username.c_str(), pass.c_str() };
234 oper_command->Handle(params, 2, user);
238 ServerInstance->Logs->Log("m_sqloper",DEBUG, "BUG: WHAT?! Why do we have no OPER command?!");
242 bool OperUser(User* user, const std::string &username, const std::string &password, const std::string &pattern, const std::string &type)
244 ConfigReader Conf(ServerInstance);
246 for (int j = 0; j < Conf.Enumerate("type"); j++)
248 std::string tname = Conf.ReadValue("type","name",j);
249 std::string hostname(user->ident);
251 hostname.append("@").append(user->host);
253 if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
255 /* Opertype and host match, looks like this is it. */
256 std::string operhost = Conf.ReadValue("type", "host", j);
259 user->ChangeDisplayedHost(operhost.c_str());
261 ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s", user->nick, user->ident, user->host, type.c_str());
262 user->WriteServ("381 %s :You are now %s %s",user->nick, strchr("aeiouAEIOU", type[0]) ? "an" : "a", irc::Spacify(type.c_str()));
264 if (!user->modes[UM_OPERATOR])
265 user->Oper(type, tname);
274 virtual Version GetVersion()
276 return Version(1,1,1,0,VF_VENDOR,API_VERSION);
281 MODULE_INIT(ModuleSQLOper)