src/modules/m_sqloper.cpp

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