1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 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 * ---------------------------------------------------
19 #include "configreader.h"
22 #include "m_sqlutils.h"
24 #include "commands/cmd_oper.h"
26 /* $ModDesc: Allows storage of oper credentials in an SQL table */
27 /* $ModDep: m_sqlv2.h m_sqlutils.h */
29 class ModuleSQLOper : public Module
34 std::string databaseid;
37 ModuleSQLOper(InspIRCd* Me)
38 : Module::Module(Me), Srv(Me)
40 ServerInstance->UseInterface("SQLutils");
41 ServerInstance->UseInterface("SQL");
42 ServerInstance->UseInterface("HashRequest");
44 /* Attempt to locate the md5 service provider, bail if we can't find it */
45 HashModule = ServerInstance->FindModule("m_md5.so");
47 throw ModuleException("Can't find m_md5.so. Please load m_md5.so before m_sqloper.so.");
49 SQLutils = ServerInstance->FindModule("m_sqlutils.so");
51 throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqloper.so.");
56 virtual ~ModuleSQLOper()
58 ServerInstance->DoneWithInterface("SQL");
59 ServerInstance->DoneWithInterface("SQLutils");
60 ServerInstance->DoneWithInterface("HashRequest");
63 void Implements(char* List)
65 List[I_OnRequest] = List[I_OnRehash] = List[I_OnPreCommand] = 1;
68 virtual void OnRehash(userrec* user, const std::string ¶meter)
70 ConfigReader Conf(Srv);
72 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
75 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
77 if ((validated) && (command == "OPER"))
79 if (LookupOper(user, parameters[0], parameters[1]))
81 /* Returning true here just means the query is in progress, or on it's way to being
82 * in progress. Nothing about the /oper actually being successful..
83 * If the oper lookup fails later, we pass the command to the original handler
84 * for /oper by calling its Handle method directly.
92 bool LookupOper(userrec* user, const std::string &username, const std::string &password)
96 target = Srv->FindFeature("SQL");
100 /* Reset hash module first back to MD5 standard state */
101 HashResetRequest(this, HashModule).Send();
102 /* Make an MD5 hash of the password for using in the query */
103 std::string md5_pass_hash = HashSumRequest(this, HashModule, password.c_str()).Send();
105 /* We generate our own MD5 sum here because some database providers (e.g. SQLite) dont have a builtin md5 function,
106 * also hashing it in the module and only passing a remote query containing a hash is more secure.
109 SQLrequest req = SQLreq(this, target, databaseid, "SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password='?'", username, md5_pass_hash);
113 /* When we get the query response from the service provider we will be given an ID to play with,
114 * just an ID number which is unique to this query. We need a way of associating that ID with a userrec
115 * so we insert it into a map mapping the IDs to users.
116 * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
117 * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
118 * us to discard the query.
120 AssociateUser(this, SQLutils, req.id, user).Send();
122 user->Extend("oper_user", strdup(username.c_str()));
123 user->Extend("oper_pass", strdup(password.c_str()));
134 ServerInstance->Log(SPARSE, "WARNING: Couldn't find SQL provider module. NOBODY will be able to oper up unless their o:line is statically configured");
139 virtual char* OnRequest(Request* request)
141 if (strcmp(SQLRESID, request->GetId()) == 0)
143 SQLresult* res = static_cast<SQLresult*>(request);
145 userrec* user = GetAssocUser(this, SQLutils, res->id).S().user;
146 UnAssociate(this, SQLutils, res->id).S();
148 char* tried_user = NULL;
149 char* tried_pass = NULL;
151 user->GetExt("oper_user", tried_user);
152 user->GetExt("oper_pass", tried_pass);
156 if (res->error.Id() == NO_ERROR)
160 /* We got a row in the result, this means there was a record for the oper..
161 * now we just need to check if their host matches, and if it does then
164 * We now (previous versions of the module didn't) support multiple SQL
165 * rows per-oper in the same way the config file does, all rows will be tried
166 * until one is found which matches. This is useful to define several different
167 * hosts for a single oper.
169 * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
170 * are no more rows to return.
173 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
175 if (OperUser(user, row["username"].d, row["password"].d, row["hostname"].d, row["type"].d))
177 /* If/when one of the rows matches, stop checking and return */
180 if (tried_user && tried_pass)
182 LoginFail(user, tried_user, tried_pass);
185 user->Shrink("oper_user");
186 user->Shrink("oper_pass");
192 /* No rows in result, this means there was no oper line for the user,
193 * we should have already checked the o:lines so now we need an
194 * "insufficient awesomeness" (invalid credentials) error
196 if (tried_user && tried_pass)
198 LoginFail(user, tried_user, tried_pass);
201 user->Shrink("oper_user");
202 user->Shrink("oper_pass");
208 /* This one shouldn't happen, the query failed for some reason.
209 * We have to fail the /oper request and give them the same error
212 if (tried_user && tried_pass)
214 LoginFail(user, tried_user, tried_pass);
217 user->Shrink("oper_user");
218 user->Shrink("oper_pass");
230 void LoginFail(userrec* user, const std::string &username, const std::string &pass)
232 command_t* oper_command = ServerInstance->Parser->GetHandler("OPER");
236 const char* params[] = { username.c_str(), pass.c_str() };
237 oper_command->Handle(params, 2, user);
241 ServerInstance->Log(DEBUG, "BUG: WHAT?! Why do we have no OPER command?!");
245 bool OperUser(userrec* user, const std::string &username, const std::string &password, const std::string &pattern, const std::string &type)
247 ConfigReader Conf(Srv);
249 for (int j = 0; j < Conf.Enumerate("type"); j++)
251 std::string tname = Conf.ReadValue("type","name",j);
252 std::string hostname(user->ident);
254 hostname.append("@").append(user->host);
256 if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
258 /* Opertype and host match, looks like this is it. */
259 std::string operhost = Conf.ReadValue("type", "host", j);
262 user->ChangeDisplayedHost(operhost.c_str());
264 Srv->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s", user->nick, user->ident, user->host, type.c_str());
265 user->WriteServ("381 %s :You are now an IRC operator of type %s", user->nick, type.c_str());
267 if (!user->modes[UM_OPERATOR])
277 virtual Version GetVersion()
279 return Version(1,1,1,0,VF_VENDOR,API_VERSION);
284 class ModuleSQLOperFactory : public ModuleFactory
287 ModuleSQLOperFactory()
291 ~ModuleSQLOperFactory()
295 virtual Module * CreateModule(InspIRCd* Me)
297 return new ModuleSQLOper(Me);
303 extern "C" void * init_module( void )
305 return new ModuleSQLOperFactory;