src/modules/extra/m_sqloper.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *          the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15 #include "users.h"
  16 #include "channels.h"
  17 #include "modules.h"
  18 #include "configreader.h"
  19
  20 #include "m_sqlv2.h"
  21 #include "m_sqlutils.h"
  22 #include "m_hash.h"
  23 #include "commands/cmd_oper.h"
  24
  25 /* $ModDesc: Allows storage of oper credentials in an SQL table */
  26 /* $ModDep: m_sqlv2.h m_sqlutils.h m_hash.h */
  27
  28 typedef std::map<irc::string, Module*> hashymodules;
  29
  30 class ModuleSQLOper : public Module
  31 {
  32         Module* SQLutils;
  33         std::string databaseid;
  34         irc::string hashtype;
  35         hashymodules hashers;
  36         bool diduseiface;
  37         std::deque<std::string> names;
  38
  39 public:
  40         ModuleSQLOper(InspIRCd* Me)
  41         : Module(Me)
  42         {
  43                 ServerInstance->Modules->UseInterface("SQLutils");
  44                 ServerInstance->Modules->UseInterface("SQL");
  45                 ServerInstance->Modules->UseInterface("HashRequest");
  46
  47                 OnRehash(NULL, "");
  48
  49                 diduseiface = false;
  50
  51                 /* Find all modules which implement the interface 'HashRequest' */
  52                 modulelist* ml = ServerInstance->Modules->FindInterface("HashRequest");
  53
  54                 /* Did we find any modules? */
  55                 if (ml)
  56                 {
  57                         /* Yes, enumerate them all to find out the hashing algorithm name */
  58                         for (modulelist::iterator m = ml->begin(); m != ml->end(); m++)
  59                         {
  60                                 /* Make a request to it for its name, its implementing
  61                                  * HashRequest so we know its safe to do this
  62                                  */
  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);
  67                         }
  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. */
  69                         diduseiface = true;
  70                         ServerInstance->Modules->UseInterface("HashRequest");
  71                 }
  72
  73                 SQLutils = ServerInstance->Modules->Find("m_sqlutils.so");
  74                 if (!SQLutils)
  75                         throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqloper.so.");
  76
  77                 Implementation eventlist[] = { I_OnRequest, I_OnRehash, I_OnPreCommand, I_OnLoadModule };
  78                 ServerInstance->Modules->Attach(eventlist, this, 3);
  79         }
  80
  81
  82         bool OneOfMatches(const char* host, const char* ip, const char* hostlist)
  83         {
  84                 std::stringstream hl(hostlist);
  85                 std::string xhost;
  86                 while (hl >> xhost)
  87                 {
  88                         if (InspIRCd::Match(host, xhost, NULL) || InspIRCd::MatchCIDR(ip, xhost, NULL))
  89                         {
  90                                 return true;
  91                         }
  92                 }
  93                 return false;
  94         }
  95
  96         virtual void OnLoadModule(Module* mod, const std::string& name)
  97         {
  98                 if (ServerInstance->Modules->ModuleHasInterface(mod, "HashRequest"))
  99                 {
 100                         ServerInstance->Logs->Log("m_sqloper",DEBUG, "Post-load registering hasher: %s", name.c_str());
 101                         std::string sname = HashNameRequest(this, mod).Send();
 102                         hashers[sname.c_str()] = mod;
 103                         names.push_back(sname);
 104                         if (!diduseiface)
 105                         {
 106                                 ServerInstance->Modules->UseInterface("HashRequest");
 107                                 diduseiface = true;
 108                         }
 109                 }
 110         }
 111
 112         virtual ~ModuleSQLOper()
 113         {
 114                 ServerInstance->Modules->DoneWithInterface("SQL");
 115                 ServerInstance->Modules->DoneWithInterface("SQLutils");
 116                 if (diduseiface)
 117                         ServerInstance->Modules->DoneWithInterface("HashRequest");
 118         }
 119
 120
 121         virtual void OnRehash(User* user, const std::string &parameter)
 122         {
 123                 ConfigReader Conf(ServerInstance);
 124
 125                 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
 126                 hashtype = assign(Conf.ReadValue("sqloper", "hash", 0));
 127         }
 128
 129         virtual int OnPreCommand(std::string &command, std::vector<std::string> &parameters, User *user, bool validated, const std::string &original_line)
 130         {
 131                 if ((validated) && (command == "OPER"))
 132                 {
 133                         if (LookupOper(user, parameters[0], parameters[1]))
 134                         {
 135                                 /* Returning true here just means the query is in progress, or on it's way to being
 136                                  * in progress. Nothing about the /oper actually being successful..
 137                                  * If the oper lookup fails later, we pass the command to the original handler
 138                                  * for /oper by calling its Handle method directly.
 139                                  */
 140                                 return 1;
 141                         }
 142                 }
 143                 return 0;
 144         }
 145
 146         bool LookupOper(User* user, const std::string &username, const std::string &password)
 147         {
 148                 Module* target;
 149
 150                 target = ServerInstance->Modules->FindFeature("SQL");
 151
 152                 if (target)
 153                 {
 154                         hashymodules::iterator x = hashers.find(hashtype);
 155                         if (x == hashers.end())
 156                                 return false;
 157
 158                         /* Reset hash module first back to MD5 standard state */
 159                         HashResetRequest(this, x->second).Send();
 160                         /* Make an MD5 hash of the password for using in the query */
 161                         std::string md5_pass_hash = HashSumRequest(this, x->second, password.c_str()).Send();
 162
 163                         /* We generate our own sum here because some database providers (e.g. SQLite) dont have a builtin md5/sha256 function,
 164                          * also hashing it in the module and only passing a remote query containing a hash is more secure.
 165                          */
 166                         SQLrequest req = SQLrequest(this, target, databaseid,
 167                                         SQLquery("SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password='?'") % username % md5_pass_hash);
 168
 169                         if (req.Send())
 170                         {
 171                                 /* When we get the query response from the service provider we will be given an ID to play with,
 172                                  * just an ID number which is unique to this query. We need a way of associating that ID with a User
 173                                  * so we insert it into a map mapping the IDs to users.
 174                                  * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
 175                                  * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
 176                                  * us to discard the query.
 177                                  */
 178                                 AssociateUser(this, SQLutils, req.id, user).Send();
 179
 180                                 user->Extend("oper_user", strdup(username.c_str()));
 181                                 user->Extend("oper_pass", strdup(password.c_str()));
 182
 183                                 return true;
 184                         }
 185                         else
 186                         {
 187                                 return false;
 188                         }
 189                 }
 190                 else
 191                 {
 192                         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");
 193                         return false;
 194                 }
 195         }
 196
 197         virtual const char* OnRequest(Request* request)
 198         {
 199                 if (strcmp(SQLRESID, request->GetId()) == 0)
 200                 {
 201                         SQLresult* res = static_cast<SQLresult*>(request);
 202
 203                         User* user = GetAssocUser(this, SQLutils, res->id).S().user;
 204                         UnAssociate(this, SQLutils, res->id).S();
 205
 206                         char* tried_user = NULL;
 207                         char* tried_pass = NULL;
 208
 209                         user->GetExt("oper_user", tried_user);
 210                         user->GetExt("oper_pass", tried_pass);
 211
 212                         if (user)
 213                         {
 214                                 if (res->error.Id() == SQL_NO_ERROR)
 215                                 {
 216                                         if (res->Rows())
 217                                         {
 218                                                 /* We got a row in the result, this means there was a record for the oper..
 219                                                  * now we just need to check if their host matches, and if it does then
 220                                                  * oper them up.
 221                                                  *
 222                                                  * We now (previous versions of the module didn't) support multiple SQL
 223                                                  * rows per-oper in the same way the config file does, all rows will be tried
 224                                                  * until one is found which matches. This is useful to define several different
 225                                                  * hosts for a single oper.
 226                                                  *
 227                                                  * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
 228                                                  * are no more rows to return.
 229                                                  */
 230
 231                                                 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
 232                                                 {
 233                                                         if (OperUser(user, row["hostname"].d, row["type"].d))
 234                                                         {
 235                                                                 /* If/when one of the rows matches, stop checking and return */
 236                                                                 return SQLSUCCESS;
 237                                                         }
 238                                                         if (tried_user && tried_pass)
 239                                                         {
 240                                                                 LoginFail(user, tried_user, tried_pass);
 241                                                                 free(tried_user);
 242                                                                 free(tried_pass);
 243                                                                 user->Shrink("oper_user");
 244                                                                 user->Shrink("oper_pass");
 245                                                         }
 246                                                 }
 247                                         }
 248                                         else
 249                                         {
 250                                                 /* No rows in result, this means there was no oper line for the user,
 251                                                  * we should have already checked the o:lines so now we need an
 252                                                  * "insufficient awesomeness" (invalid credentials) error
 253                                                  */
 254                                                 if (tried_user && tried_pass)
 255                                                 {
 256                                                         LoginFail(user, tried_user, tried_pass);
 257                                                         free(tried_user);
 258                                                         free(tried_pass);
 259                                                         user->Shrink("oper_user");
 260                                                         user->Shrink("oper_pass");
 261                                                 }
 262                                         }
 263                                 }
 264                                 else
 265                                 {
 266                                         /* This one shouldn't happen, the query failed for some reason.
 267                                          * We have to fail the /oper request and give them the same error
 268                                          * as above.
 269                                          */
 270                                         if (tried_user && tried_pass)
 271                                         {
 272                                                 LoginFail(user, tried_user, tried_pass);
 273                                                 free(tried_user);
 274                                                 free(tried_pass);
 275                                                 user->Shrink("oper_user");
 276                                                 user->Shrink("oper_pass");
 277                                         }
 278
 279                                 }
 280                         }
 281
 282                         return SQLSUCCESS;
 283                 }
 284
 285                 return NULL;
 286         }
 287
 288         void LoginFail(User* user, const std::string &username, const std::string &pass)
 289         {
 290                 Command* oper_command = ServerInstance->Parser->GetHandler("OPER");
 291
 292                 if (oper_command)
 293                 {
 294                         std::vector<std::string> params;
 295                         params.push_back(username);
 296                         params.push_back(pass);
 297                         oper_command->Handle(params, user);
 298                 }
 299                 else
 300                 {
 301                         ServerInstance->Logs->Log("m_sqloper",DEBUG, "BUG: WHAT?! Why do we have no OPER command?!");
 302                 }
 303         }
 304
 305         bool OperUser(User* user, const std::string &pattern, const std::string &type)
 306         {
 307                 ConfigReader Conf(ServerInstance);
 308
 309                 for (int j = 0; j < Conf.Enumerate("type"); j++)
 310                 {
 311                         std::string tname = Conf.ReadValue("type","name",j);
 312                         std::string hostname(user->ident);
 313
 314                         hostname.append("@").append(user->host);
 315
 316                         if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
 317                         {
 318                                 /* Opertype and host match, looks like this is it. */
 319                                 std::string operhost = Conf.ReadValue("type", "host", j);
 320
 321                                 if (operhost.size())
 322                                         user->ChangeDisplayedHost(operhost.c_str());
 323
 324                                 user->Oper(type, tname);
 325                                 return true;
 326                         }
 327                 }
 328
 329                 return false;
 330         }
 331
 332         virtual Version GetVersion()
 333         {
 334                 return Version("$Id$", VF_VENDOR, API_VERSION);
 335         }
 336
 337 };
 338
 339 MODULE_INIT(ModuleSQLOper)