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, const std::string& name)
  91         {
  92                 if (ServerInstance->Modules->ModuleHasInterface(mod, "HashRequest"))
  93                 {
  94                         ServerInstance->Logs->Log("m_sqloper",DEBUG, "Post-load registering hasher: %s", name.c_str());
  95                         std::string sname = HashNameRequest(this, mod).response;
  96                         hashers[sname.c_str()] = mod;
  97                         names.push_back(sname);
  98                         if (!diduseiface)
  99                         {
 100                                 ServerInstance->Modules->UseInterface("HashRequest");
 101                                 diduseiface = true;
 102                         }
 103                 }
 104         }
 105
 106         virtual ~ModuleSQLOper()
 107         {
 108                 ServerInstance->Modules->DoneWithInterface("SQL");
 109                 ServerInstance->Modules->DoneWithInterface("SQLutils");
 110                 if (diduseiface)
 111                         ServerInstance->Modules->DoneWithInterface("HashRequest");
 112         }
 113
 114
 115         virtual void OnRehash(User* user)
 116         {
 117                 ConfigReader Conf;
 118
 119                 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
 120                 hashtype = assign(Conf.ReadValue("sqloper", "hash", 0));
 121         }
 122
 123         virtual ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, User *user, bool validated, const std::string &original_line)
 124         {
 125                 if ((validated) && (command == "OPER"))
 126                 {
 127                         if (LookupOper(user, parameters[0], parameters[1]))
 128                         {
 129                                 /* Returning true here just means the query is in progress, or on it's way to being
 130                                  * in progress. Nothing about the /oper actually being successful..
 131                                  * If the oper lookup fails later, we pass the command to the original handler
 132                                  * for /oper by calling its Handle method directly.
 133                                  */
 134                                 return MOD_RES_DENY;
 135                         }
 136                 }
 137                 return MOD_RES_PASSTHRU;
 138         }
 139
 140         bool LookupOper(User* user, const std::string &username, const std::string &password)
 141         {
 142                 Module* target;
 143
 144                 target = ServerInstance->Modules->FindFeature("SQL");
 145
 146                 if (target)
 147                 {
 148                         hashymodules::iterator x = hashers.find(hashtype);
 149                         if (x == hashers.end())
 150                                 return false;
 151
 152                         /* Make an MD5 hash of the password for using in the query */
 153                         std::string md5_pass_hash = HashRequest(this, x->second, password).hex();
 154
 155                         /* We generate our own sum here because some database providers (e.g. SQLite) dont have a builtin md5/sha256 function,
 156                          * also hashing it in the module and only passing a remote query containing a hash is more secure.
 157                          */
 158                         SQLrequest req = SQLrequest(this, target, databaseid,
 159                                         SQLquery("SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password='?'") % username % md5_pass_hash);
 160
 161                         /* When we get the query response from the service provider we will be given an ID to play with,
 162                          * just an ID number which is unique to this query. We need a way of associating that ID with a User
 163                          * so we insert it into a map mapping the IDs to users.
 164                          * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
 165                          * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
 166                          * us to discard the query.
 167                          */
 168                         AssociateUser(this, SQLutils, req.id, user).Send();
 169
 170                         saved_user.set(user, username);
 171                         saved_pass.set(user, password);
 172
 173                         return true;
 174                 }
 175                 else
 176                 {
 177                         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");
 178                         return false;
 179                 }
 180         }
 181
 182         void OnRequest(Request& request)
 183         {
 184                 if (strcmp(SQLRESID, request.id) == 0)
 185                 {
 186                         SQLresult* res = static_cast<SQLresult*>(&request);
 187
 188                         User* user = GetAssocUser(this, SQLutils, res->id).S().user;
 189                         UnAssociate(this, SQLutils, res->id).S();
 190
 191                         if (user)
 192                         {
 193                                 std::string* tried_user = saved_user.get(user);
 194                                 std::string* tried_pass = saved_pass.get(user);
 195                                 if (res->error.Id() == SQL_NO_ERROR)
 196                                 {
 197                                         if (res->Rows())
 198                                         {
 199                                                 /* We got a row in the result, this means there was a record for the oper..
 200                                                  * now we just need to check if their host matches, and if it does then
 201                                                  * oper them up.
 202                                                  *
 203                                                  * We now (previous versions of the module didn't) support multiple SQL
 204                                                  * rows per-oper in the same way the config file does, all rows will be tried
 205                                                  * until one is found which matches. This is useful to define several different
 206                                                  * hosts for a single oper.
 207                                                  *
 208                                                  * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
 209                                                  * are no more rows to return.
 210                                                  */
 211
 212                                                 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
 213                                                 {
 214                                                         if (OperUser(user, row["hostname"].d, row["type"].d))
 215                                                         {
 216                                                                 /* If/when one of the rows matches, stop checking and return */
 217                                                                 saved_user.unset(user);
 218                                                                 saved_pass.unset(user);
 219                                                         }
 220                                                         if (tried_user && tried_pass)
 221                                                         {
 222                                                                 LoginFail(user, *tried_user, *tried_pass);
 223                                                                 saved_user.unset(user);
 224                                                                 saved_pass.unset(user);
 225                                                         }
 226                                                 }
 227                                         }
 228                                         else
 229                                         {
 230                                                 /* No rows in result, this means there was no oper line for the user,
 231                                                  * we should have already checked the o:lines so now we need an
 232                                                  * "insufficient awesomeness" (invalid credentials) error
 233                                                  */
 234                                                 if (tried_user && tried_pass)
 235                                                 {
 236                                                         LoginFail(user, *tried_user, *tried_pass);
 237                                                         saved_user.unset(user);
 238                                                         saved_pass.unset(user);
 239                                                 }
 240                                         }
 241                                 }
 242                                 else
 243                                 {
 244                                         /* This one shouldn't happen, the query failed for some reason.
 245                                          * We have to fail the /oper request and give them the same error
 246                                          * as above.
 247                                          */
 248                                         if (tried_user && tried_pass)
 249                                         {
 250                                                 LoginFail(user, *tried_user, *tried_pass);
 251                                                 saved_user.unset(user);
 252                                                 saved_pass.unset(user);
 253                                         }
 254
 255                                 }
 256                         }
 257                 }
 258         }
 259
 260         void LoginFail(User* user, const std::string &username, const std::string &pass)
 261         {
 262                 Command* oper_command = ServerInstance->Parser->GetHandler("OPER");
 263
 264                 if (oper_command)
 265                 {
 266                         std::vector<std::string> params;
 267                         params.push_back(username);
 268                         params.push_back(pass);
 269                         oper_command->Handle(params, user);
 270                 }
 271                 else
 272                 {
 273                         ServerInstance->Logs->Log("m_sqloper",DEBUG, "BUG: WHAT?! Why do we have no OPER command?!");
 274                 }
 275         }
 276
 277         bool OperUser(User* user, const std::string &pattern, const std::string &type)
 278         {
 279                 ConfigReader Conf;
 280
 281                 for (int j = 0; j < Conf.Enumerate("type"); j++)
 282                 {
 283                         std::string tname = Conf.ReadValue("type","name",j);
 284                         std::string hostname(user->ident);
 285
 286                         hostname.append("@").append(user->host);
 287
 288                         if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
 289                         {
 290                                 /* Opertype and host match, looks like this is it. */
 291                                 std::string operhost = Conf.ReadValue("type", "host", j);
 292
 293                                 if (operhost.size())
 294                                         user->ChangeDisplayedHost(operhost.c_str());
 295
 296                                 user->Oper(type, tname);
 297                                 return true;
 298                         }
 299                 }
 300
 301                 return false;
 302         }
 303
 304         Version GetVersion()
 305         {
 306                 return Version("Allows storage of oper credentials in an SQL table", VF_VENDOR, API_VERSION);
 307         }
 308
 309 };
 310
 311 MODULE_INIT(ModuleSQLOper)