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