1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
22 #include "configreader.h"
25 #include "m_sqlutils.h"
26 #include "commands/cmd_oper.h"
28 /* $ModDesc: Allows storage of oper credentials in an SQL table */
30 class ModuleSQLOper : public Module
34 std::string databaseid;
37 ModuleSQLOper(InspIRCd* Me)
38 : Module::Module(Me), Srv(Me)
40 SQLutils = Srv->FindFeature("SQLutils");
44 ServerInstance->Log(DEBUG, "Successfully got SQLutils pointer");
48 ServerInstance->Log(DEFAULT, "ERROR: This module requires a module offering the 'SQLutils' feature (usually m_sqlutils.so). Please load it and try again.");
49 throw ModuleException("This module requires a module offering the 'SQLutils' feature (usually m_sqlutils.so). Please load it and try again.");
55 virtual void OnRehash(const std::string ¶meter)
57 ConfigReader Conf(Srv);
59 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
62 void Implements(char* List)
64 List[I_OnRequest] = List[I_OnRehash] = List[I_OnPreCommand] = 1;
67 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
69 if ((validated) && (command == "OPER"))
71 if (LookupOper(user, parameters[0], parameters[1]))
73 /* Returning true here just means the query is in progress, or on it's way to being
74 * in progress. Nothing about the /oper actually being successful..
75 * If the oper lookup fails later, we pass the command to the original handler
76 * for /oper by calling its Handle method directly.
84 bool LookupOper(userrec* user, const std::string &username, const std::string &password)
88 target = Srv->FindFeature("SQL");
92 SQLrequest req = SQLreq(this, target, databaseid, "SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password=md5('?')", username, password);
96 /* When we get the query response from the service provider we will be given an ID to play with,
97 * just an ID number which is unique to this query. We need a way of associating that ID with a userrec
98 * so we insert it into a map mapping the IDs to users.
99 * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
100 * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
101 * us to discard the query.
103 ServerInstance->Log(DEBUG, "Sent query, got given ID %lu", req.id);
105 AssociateUser(this, SQLutils, req.id, user).Send();
107 user->Extend("oper_user", strdup(username.c_str()));
108 user->Extend("oper_pass", strdup(password.c_str()));
114 ServerInstance->Log(DEBUG, "SQLrequest failed: %s", req.error.Str());
121 ServerInstance->Log(SPARSE, "WARNING: Couldn't find SQL provider module. NOBODY will be able to oper up unless their o:line is statically configured");
126 virtual char* OnRequest(Request* request)
128 if (strcmp(SQLRESID, request->GetId()) == 0)
132 res = static_cast<SQLresult*>(request);
134 ServerInstance->Log(DEBUG, "Got SQL result (%s) with ID %lu", res->GetId(), res->id);
136 userrec* user = GetAssocUser(this, SQLutils, res->id).S().user;
137 UnAssociate(this, SQLutils, res->id).S();
139 char* tried_user = NULL;
140 char* tried_pass = NULL;
142 user->GetExt("oper_user", tried_user);
143 user->GetExt("oper_pass", tried_pass);
147 if (res->error.Id() == NO_ERROR)
149 ServerInstance->Log(DEBUG, "Associated query ID %lu with user %s", res->id, user->nick);
150 ServerInstance->Log(DEBUG, "Got result with %d rows and %d columns", res->Rows(), res->Cols());
154 /* We got a row in the result, this means there was a record for the oper..
155 * now we just need to check if their host matches, and if it does then
158 * We now (previous versions of the module didn't) support multiple SQL
159 * rows per-oper in the same way the config file does, all rows will be tried
160 * until one is found which matches. This is useful to define several different
161 * hosts for a single oper.
163 * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
164 * are no more rows to return.
167 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
169 ServerInstance->Log(DEBUG, "Trying to oper user %s with username = '%s', passhash = '%s', hostname = '%s', type = '%s'", user->nick, row["username"].d.c_str(), row["password"].d.c_str(), row["hostname"].d.c_str(), row["type"].d.c_str());
171 if (OperUser(user, row["username"].d, row["password"].d, row["hostname"].d, row["type"].d))
173 /* If/when one of the rows matches, stop checking and return */
180 /* No rows in result, this means there was no oper line for the user,
181 * we should have already checked the o:lines so now we need an
182 * "insufficient awesomeness" (invalid credentials) error
184 if (tried_user && tried_pass)
186 LoginFail(user, tried_user, tried_pass);
189 user->Shrink("oper_user");
190 user->Shrink("oper_pass");
196 /* This one shouldn't happen, the query failed for some reason.
197 * We have to fail the /oper request and give them the same error
200 ServerInstance->Log(DEBUG, "Query failed: %s", res->error.Str());
202 if (tried_user && tried_pass)
204 LoginFail(user, tried_user, tried_pass);
207 user->Shrink("oper_user");
208 user->Shrink("oper_pass");
215 ServerInstance->Log(DEBUG, "Got query with unknown ID, this probably means the user quit while the query was in progress");
221 ServerInstance->Log(DEBUG, "Got unsupported API version string: %s", request->GetId());
226 void LoginFail(userrec* user, const std::string &username, const std::string &pass)
228 command_t* oper_command = ServerInstance->Parser->GetHandler("OPER");
232 const char* params[] = { username.c_str(), pass.c_str() };
233 oper_command->Handle(params, 2, user);
237 ServerInstance->Log(DEBUG, "WHAT?! Why do we have no OPER command?!");
241 bool OperUser(userrec* user, const std::string &username, const std::string &password, const std::string &pattern, const std::string &type)
243 ConfigReader Conf(Srv);
245 for (int j = 0; j < Conf.Enumerate("type"); j++)
247 std::string tname = Conf.ReadValue("type","name",j);
249 ServerInstance->Log(DEBUG, "Scanning opertype: %s", tname.c_str());
251 std::string hostname(user->ident);
252 hostname.append("@").append(user->host);
254 if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
256 /* Opertype and host match, looks like this is it. */
257 ServerInstance->Log(DEBUG, "Host (%s matched %s OR %s) and type (%s)", pattern.c_str(), hostname.c_str(), user->GetIPString(), type.c_str());
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 ~ModuleSQLOper()
281 virtual Version GetVersion()
283 return Version(1,1,1,0,VF_VENDOR,API_VERSION);
288 class ModuleSQLOperFactory : public ModuleFactory
291 ModuleSQLOperFactory()
295 ~ModuleSQLOperFactory()
299 virtual Module * CreateModule(InspIRCd* Me)
301 return new ModuleSQLOper(Me);
307 extern "C" void * init_module( void )
309 return new ModuleSQLOperFactory;