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