* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
*/
-using namespace std;
-
-#include <stdio.h>
-#include <string>
-#include <stdlib.h>
-#include <time.h>
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <sys/time.h>
-#include <string.h>
-#include <unistd.h>
-#include <errno.h>
-#include <fcntl.h>
-#include <poll.h>
+#include "inspircd.h"
#include "users.h"
#include "channels.h"
#include "modules.h"
-#include "inspircd.h"
-#include "helperfuncs.h"
-#include "m_sql.h"
-
-/* $ModDesc: Allows storage of oper credentials in an SQL table */
+#include "configreader.h"
-/* Required for the FOREACH_MOD alias (OnOper event) */
-extern int MODCOUNT;
-extern ServerConfig* Config;
-extern std::vector<Module*> modules;
-extern std::vector<ircd_module*> factory;
+#include "m_sqlv2.h"
+#include "m_sqlutils.h"
+#include "m_hash.h"
+#include "commands/cmd_oper.h"
-Server *Srv;
+/* $ModDesc: Allows storage of oper credentials in an SQL table */
+/* $ModDep: m_sqlv2.h m_sqlutils.h */
class ModuleSQLOper : public Module
{
- ConfigReader* Conf;
- unsigned long dbid;
- Module* SQLModule;
+ Module* SQLutils;
+ Module* HashModule;
+ std::string databaseid;
- public:
- bool ReadConfig()
+public:
+ ModuleSQLOper(InspIRCd* Me)
+ : Module::Module(Me)
{
- dbid = Conf->ReadInteger("sqloper","dbid",0,true); // database id of a database configured in m_sql (see m_sql config)
- SQLModule = Srv->FindModule("m_sql.so");
- if (!SQLModule)
- Srv->Log(DEFAULT,"WARNING: m_sqloper.so could not initialize because m_sql.so is not loaded. Load the module and rehash your server.");
- return (SQLModule);
+ ServerInstance->Modules->UseInterface("SQLutils");
+ ServerInstance->Modules->UseInterface("SQL");
+ ServerInstance->Modules->UseInterface("HashRequest");
+
+ /* Attempt to locate the md5 service provider, bail if we can't find it */
+ HashModule = ServerInstance->Modules->Find("m_md5.so");
+ if (!HashModule)
+ throw ModuleException("Can't find m_md5.so. Please load m_md5.so before m_sqloper.so.");
+
+ SQLutils = ServerInstance->Modules->Find("m_sqlutils.so");
+ if (!SQLutils)
+ throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqloper.so.");
+
+ OnRehash(NULL,"");
}
- ModuleSQLOper(Server* Me)
- : Module::Module(Me)
+ virtual ~ModuleSQLOper()
{
- Srv = Me;
- Conf = new ConfigReader();
- ReadConfig();
+ ServerInstance->Modules->DoneWithInterface("SQL");
+ ServerInstance->Modules->DoneWithInterface("SQLutils");
+ ServerInstance->Modules->DoneWithInterface("HashRequest");
}
- virtual void OnRehash(std::string parameter)
+ void Implements(char* List)
{
- delete Conf;
- Conf = new ConfigReader();
- ReadConfig();
+ List[I_OnRequest] = List[I_OnRehash] = List[I_OnPreCommand] = 1;
}
- void Implements(char* List)
+ virtual void OnRehash(userrec* user, const std::string ¶meter)
{
- List[I_OnRehash] = List[I_OnPreCommand] = 1;
+ ConfigReader Conf(ServerInstance);
+
+ databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
}
- virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user, bool validated)
+ virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
{
- if ((command == "OPER") && (validated))
+ if ((validated) && (command == "OPER"))
{
- if (LookupOper(parameters[0],parameters[1],user))
+ if (LookupOper(user, parameters[0], parameters[1]))
+ {
+ /* Returning true here just means the query is in progress, or on it's way to being
+ * in progress. Nothing about the /oper actually being successful..
+ * If the oper lookup fails later, we pass the command to the original handler
+ * for /oper by calling its Handle method directly.
+ */
return 1;
+ }
}
return 0;
}
- bool LookupOper(std::string username, std::string password, userrec* user)
+ bool LookupOper(userrec* user, const std::string &username, const std::string &password)
{
- bool found = false;
+ Module* target;
+
+ target = ServerInstance->Modules->FindFeature("SQL");
- // is the sql module loaded? If not, we don't attempt to do anything.
- if (!SQLModule)
- return false;
-
- // sanitize the password (we dont want any mysql insertion exploits!)
- std::string temp = "";
- for (unsigned int q = 0; q < password.length(); q++)
+ if (target)
{
- if (password[q] == '\'')
+ /* Reset hash module first back to MD5 standard state */
+ HashResetRequest(this, HashModule).Send();
+ /* Make an MD5 hash of the password for using in the query */
+ std::string md5_pass_hash = HashSumRequest(this, HashModule, password.c_str()).Send();
+
+ /* We generate our own MD5 sum here because some database providers (e.g. SQLite) dont have a builtin md5 function,
+ * also hashing it in the module and only passing a remote query containing a hash is more secure.
+ */
+
+ SQLrequest req = SQLreq(this, target, databaseid, "SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password='?'", username, md5_pass_hash);
+
+ if (req.Send())
{
- temp = temp + "\'";
+ /* When we get the query response from the service provider we will be given an ID to play with,
+ * just an ID number which is unique to this query. We need a way of associating that ID with a userrec
+ * so we insert it into a map mapping the IDs to users.
+ * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
+ * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
+ * us to discard the query.
+ */
+ AssociateUser(this, SQLutils, req.id, user).Send();
+
+ user->Extend("oper_user", strdup(username.c_str()));
+ user->Extend("oper_pass", strdup(password.c_str()));
+
+ return true;
}
- else if (password[q] == '"')
+ else
{
- temp = temp + "\\\"";
+ return false;
}
- else temp = temp + password[q];
}
- password = temp;
- temp = "";
- for (unsigned int v = 0; v < username.length(); v++)
+ else
{
- if (username[v] == '\'')
- {
- temp = temp + "\'";
- }
- if (username[v] == '"')
- {
- temp = temp + "\\\"";
- }
- else temp = temp + username[v];
+ ServerInstance->Log(SPARSE, "WARNING: Couldn't find SQL provider module. NOBODY will be able to oper up unless their o:line is statically configured");
+ return false;
}
- username = temp;
+ }
+
+ virtual char* OnRequest(Request* request)
+ {
+ if (strcmp(SQLRESID, request->GetId()) == 0)
+ {
+ SQLresult* res = static_cast<SQLresult*>(request);
- // Create a request containing the SQL query and send it to m_sql.so
- SQLRequest* query = new SQLRequest(SQL_RESULT,dbid,"SELECT username,password,hostname,type FROM ircd_opers WHERE username='"+username+"' AND password=md5('"+password+"')");
- Request queryrequest((char*)query, this, SQLModule);
- SQLResult* result = (SQLResult*)queryrequest.Send();
+ userrec* user = GetAssocUser(this, SQLutils, res->id).S().user;
+ UnAssociate(this, SQLutils, res->id).S();
- // Did we get "OK" as a result?
- if (result->GetType() == SQL_OK)
- {
- Srv->Log(DEBUG,"An SQL based oper exists");
- // if we did, this means we may now request a row... there should be only one row for each user, so,
- // we don't need to loop to fetch multiple rows.
- SQLRequest* rowrequest = new SQLRequest(SQL_ROW,dbid,"");
- Request rowquery((char*)rowrequest, this, SQLModule);
- SQLResult* rowresult = (SQLResult*)rowquery.Send();
-
- // did we get a row? If we did, we can now do something with the fields
- if (rowresult->GetType() == SQL_ROW)
+ char* tried_user = NULL;
+ char* tried_pass = NULL;
+
+ user->GetExt("oper_user", tried_user);
+ user->GetExt("oper_pass", tried_pass);
+
+ if (user)
{
- if (rowresult->GetField("username") == username)
+ if (res->error.Id() == NO_ERROR)
{
- found = true;
- // oper up the user.
- for (int j =0; j < Conf->Enumerate("type"); j++)
- {
- std::string TypeName = Conf->ReadValue("type","name",j);
- Srv->Log(DEBUG,"Scanning opertype: "+TypeName);
- std::string pattern = std::string(user->ident) + "@" + std::string(user->host);
- if ((TypeName == rowresult->GetField("type")) && (Srv->MatchText(pattern,rowresult->GetField("hostname"))));
- {
- Srv->Log(DEBUG,"Host and type match: "+TypeName+" "+rowresult->GetField("type"));
- /* found this oper's opertype */
- std::string HostName = Conf->ReadValue("type","host",j);
- if (HostName != "")
- Srv->ChangeHost(user,HostName);
- strlcpy(user->oper,rowresult->GetField("type").c_str(),NICKMAX);
- WriteOpers("*** %s (%s@%s) is now an IRC operator of type %s",user->nick,user->ident,user->host,rowresult->GetField("type").c_str());
- WriteServ(user->fd,"381 %s :You are now an IRC operator of type %s",user->nick,rowresult->GetField("type").c_str());
- if (!strchr(user->modes,'o'))
- {
- strcat(user->modes,"o");
- WriteServ(user->fd,"MODE %s :+o",user->nick);
- FOREACH_MOD(I_OnOper,OnOper(user,rowresult->GetField("type")));
- AddOper(user);
- log(DEFAULT,"OPER: %s!%s@%s opered as type: %s",user->nick,user->ident,user->host,rowresult->GetField("type").c_str());
- }
- break;
- }
- }
+ if (res->Rows())
+ {
+ /* We got a row in the result, this means there was a record for the oper..
+ * now we just need to check if their host matches, and if it does then
+ * oper them up.
+ *
+ * We now (previous versions of the module didn't) support multiple SQL
+ * rows per-oper in the same way the config file does, all rows will be tried
+ * until one is found which matches. This is useful to define several different
+ * hosts for a single oper.
+ *
+ * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
+ * are no more rows to return.
+ */
+
+ for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
+ {
+ if (OperUser(user, row["username"].d, row["password"].d, row["hostname"].d, row["type"].d))
+ {
+ /* If/when one of the rows matches, stop checking and return */
+ return SQLSUCCESS;
+ }
+ if (tried_user && tried_pass)
+ {
+ LoginFail(user, tried_user, tried_pass);
+ free(tried_user);
+ free(tried_pass);
+ user->Shrink("oper_user");
+ user->Shrink("oper_pass");
+ }
+ }
+ }
+ else
+ {
+ /* No rows in result, this means there was no oper line for the user,
+ * we should have already checked the o:lines so now we need an
+ * "insufficient awesomeness" (invalid credentials) error
+ */
+ if (tried_user && tried_pass)
+ {
+ LoginFail(user, tried_user, tried_pass);
+ free(tried_user);
+ free(tried_pass);
+ user->Shrink("oper_user");
+ user->Shrink("oper_pass");
+ }
+ }
+ }
+ else
+ {
+ /* This one shouldn't happen, the query failed for some reason.
+ * We have to fail the /oper request and give them the same error
+ * as above.
+ */
+ if (tried_user && tried_pass)
+ {
+ LoginFail(user, tried_user, tried_pass);
+ free(tried_user);
+ free(tried_pass);
+ user->Shrink("oper_user");
+ user->Shrink("oper_pass");
+ }
}
- delete rowresult;
- }
- else
- {
- // we didn't have a row.
- found = false;
}
- delete rowrequest;
- delete result;
+
+ return SQLSUCCESS;
+ }
+
+ return NULL;
+ }
+
+ void LoginFail(userrec* user, const std::string &username, const std::string &pass)
+ {
+ command_t* oper_command = ServerInstance->Parser->GetHandler("OPER");
+
+ if (oper_command)
+ {
+ const char* params[] = { username.c_str(), pass.c_str() };
+ oper_command->Handle(params, 2, user);
}
else
{
- // the query was bad
- found = false;
+ ServerInstance->Log(DEBUG, "BUG: WHAT?! Why do we have no OPER command?!");
}
- query->SetQueryType(SQL_DONE);
- query->SetConnID(dbid);
- Request donerequest((char*)query, this, SQLModule);
- donerequest.Send();
- delete query;
- return found;
}
- virtual ~ModuleSQLOper()
+ bool OperUser(userrec* user, const std::string &username, const std::string &password, const std::string &pattern, const std::string &type)
{
- delete Conf;
- }
-
- virtual Version GetVersion()
- {
- return Version(1,0,0,1,VF_VENDOR);
- }
-
-};
+ ConfigReader Conf(ServerInstance);
+
+ for (int j = 0; j < Conf.Enumerate("type"); j++)
+ {
+ std::string tname = Conf.ReadValue("type","name",j);
+ std::string hostname(user->ident);
-class ModuleSQLOperFactory : public ModuleFactory
-{
- public:
- ModuleSQLOperFactory()
- {
- }
-
- ~ModuleSQLOperFactory()
- {
+ hostname.append("@").append(user->host);
+
+ if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
+ {
+ /* Opertype and host match, looks like this is it. */
+ std::string operhost = Conf.ReadValue("type", "host", j);
+
+ if (operhost.size())
+ user->ChangeDisplayedHost(operhost.c_str());
+
+ ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s", user->nick, user->ident, user->host, type.c_str());
+ user->WriteServ("381 %s :You are now %s %s",user->nick, strchr("aeiouAEIOU", type[0]) ? "an" : "a", irc::Spacify(type.c_str()));
+
+ if (!user->modes[UM_OPERATOR])
+ user->Oper(type);
+
+ return true;
+ }
+ }
+
+ return false;
}
-
- virtual Module * CreateModule(Server* Me)
+
+ virtual Version GetVersion()
{
- return new ModuleSQLOper(Me);
+ return Version(1,1,1,0,VF_VENDOR,API_VERSION);
}
};
-
-extern "C" void * init_module( void )
-{
- return new ModuleSQLOperFactory;
-}
-
+MODULE_INIT(ModuleSQLOper);