src/modules/extra/m_sqloper.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 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 */
  27
  28 class ModuleSQLOper : public Module
  29 {
  30         Module* SQLutils;
  31         Module* HashModule;
  32         std::string databaseid;
  33
  34 public:
  35         ModuleSQLOper(InspIRCd* Me)
  36         : Module::Module(Me)
  37         {
  38                 ServerInstance->UseInterface("SQLutils");
  39                 ServerInstance->UseInterface("SQL");
  40                 ServerInstance->UseInterface("HashRequest");
  41
  42                 /* Attempt to locate the md5 service provider, bail if we can't find it */
  43                 HashModule = ServerInstance->FindModule("m_md5.so");
  44                 if (!HashModule)
  45                         throw ModuleException("Can't find m_md5.so. Please load m_md5.so before m_sqloper.so.");
  46
  47                 SQLutils = ServerInstance->FindModule("m_sqlutils.so");
  48                 if (!SQLutils)
  49                         throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqloper.so.");
  50
  51                 OnRehash(NULL,"");
  52         }
  53
  54         virtual ~ModuleSQLOper()
  55         {
  56                 ServerInstance->DoneWithInterface("SQL");
  57                 ServerInstance->DoneWithInterface("SQLutils");
  58                 ServerInstance->DoneWithInterface("HashRequest");
  59         }
  60
  61         void Implements(char* List)
  62         {
  63                 List[I_OnRequest] = List[I_OnRehash] = List[I_OnPreCommand] = 1;
  64         }
  65
  66         virtual void OnRehash(userrec* user, const std::string &parameter)
  67         {
  68                 ConfigReader Conf(ServerInstance);
  69
  70                 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
  71         }
  72
  73         virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
  74         {
  75                 if ((validated) && (command == "OPER"))
  76                 {
  77                         if (LookupOper(user, parameters[0], parameters[1]))
  78                         {
  79                                 /* Returning true here just means the query is in progress, or on it's way to being
  80                                  * in progress. Nothing about the /oper actually being successful..
  81                                  * If the oper lookup fails later, we pass the command to the original handler
  82                                  * for /oper by calling its Handle method directly.
  83                                  */
  84                                 return 1;
  85                         }
  86                 }
  87                 return 0;
  88         }
  89
  90         bool LookupOper(userrec* user, const std::string &username, const std::string &password)
  91         {
  92                 Module* target;
  93
  94                 target = ServerInstance->FindFeature("SQL");
  95
  96                 if (target)
  97                 {
  98                         /* Reset hash module first back to MD5 standard state */
  99                         HashResetRequest(this, HashModule).Send();
 100                         /* Make an MD5 hash of the password for using in the query */
 101                         std::string md5_pass_hash = HashSumRequest(this, HashModule, password.c_str()).Send();
 102
 103                         /* We generate our own MD5 sum here because some database providers (e.g. SQLite) dont have a builtin md5 function,
 104                          * also hashing it in the module and only passing a remote query containing a hash is more secure.
 105                          */
 106
 107                         SQLrequest req = SQLreq(this, target, databaseid, "SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password='?'", username, md5_pass_hash);
 108
 109                         if (req.Send())
 110                         {
 111                                 /* When we get the query response from the service provider we will be given an ID to play with,
 112                                  * just an ID number which is unique to this query. We need a way of associating that ID with a userrec
 113                                  * so we insert it into a map mapping the IDs to users.
 114                                  * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
 115                                  * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
 116                                  * us to discard the query.
 117                                  */
 118                                 AssociateUser(this, SQLutils, req.id, user).Send();
 119
 120                                 user->Extend("oper_user", strdup(username.c_str()));
 121                                 user->Extend("oper_pass", strdup(password.c_str()));
 122
 123                                 return true;
 124                         }
 125                         else
 126                         {
 127                                 return false;
 128                         }
 129                 }
 130                 else
 131                 {
 132                         ServerInstance->Log(SPARSE, "WARNING: Couldn't find SQL provider module. NOBODY will be able to oper up unless their o:line is statically configured");
 133                         return false;
 134                 }
 135         }
 136
 137         virtual char* OnRequest(Request* request)
 138         {
 139                 if (strcmp(SQLRESID, request->GetId()) == 0)
 140                 {
 141                         SQLresult* res = static_cast<SQLresult*>(request);
 142
 143                         userrec* user = GetAssocUser(this, SQLutils, res->id).S().user;
 144                         UnAssociate(this, SQLutils, res->id).S();
 145
 146                         char* tried_user = NULL;
 147                         char* tried_pass = NULL;
 148
 149                         user->GetExt("oper_user", tried_user);
 150                         user->GetExt("oper_pass", tried_pass);
 151
 152                         if (user)
 153                         {
 154                                 if (res->error.Id() == NO_ERROR)
 155                                 {
 156                                         if (res->Rows())
 157                                         {
 158                                                 /* We got a row in the result, this means there was a record for the oper..
 159                                                  * now we just need to check if their host matches, and if it does then
 160                                                  * oper them up.
 161                                                  *
 162                                                  * We now (previous versions of the module didn't) support multiple SQL
 163                                                  * rows per-oper in the same way the config file does, all rows will be tried
 164                                                  * until one is found which matches. This is useful to define several different
 165                                                  * hosts for a single oper.
 166                                                  *
 167                                                  * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
 168                                                  * are no more rows to return.
 169                                                  */
 170
 171                                                 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
 172                                                 {
 173                                                         if (OperUser(user, row["username"].d, row["password"].d, row["hostname"].d, row["type"].d))
 174                                                         {
 175                                                                 /* If/when one of the rows matches, stop checking and return */
 176                                                                 return SQLSUCCESS;
 177                                                         }
 178                                                         if (tried_user && tried_pass)
 179                                                         {
 180                                                                 LoginFail(user, tried_user, tried_pass);
 181                                                                 free(tried_user);
 182                                                                 free(tried_pass);
 183                                                                 user->Shrink("oper_user");
 184                                                                 user->Shrink("oper_pass");
 185                                                         }
 186                                                 }
 187                                         }
 188                                         else
 189                                         {
 190                                                 /* No rows in result, this means there was no oper line for the user,
 191                                                  * we should have already checked the o:lines so now we need an
 192                                                  * "insufficient awesomeness" (invalid credentials) error
 193                                                  */
 194                                                 if (tried_user && tried_pass)
 195                                                 {
 196                                                         LoginFail(user, tried_user, tried_pass);
 197                                                         free(tried_user);
 198                                                         free(tried_pass);
 199                                                         user->Shrink("oper_user");
 200                                                         user->Shrink("oper_pass");
 201                                                 }
 202                                         }
 203                                 }
 204                                 else
 205                                 {
 206                                         /* This one shouldn't happen, the query failed for some reason.
 207                                          * We have to fail the /oper request and give them the same error
 208                                          * as above.
 209                                          */
 210                                         if (tried_user && tried_pass)
 211                                         {
 212                                                 LoginFail(user, tried_user, tried_pass);
 213                                                 free(tried_user);
 214                                                 free(tried_pass);
 215                                                 user->Shrink("oper_user");
 216                                                 user->Shrink("oper_pass");
 217                                         }
 218
 219                                 }
 220                         }
 221
 222                         return SQLSUCCESS;
 223                 }
 224
 225                 return NULL;
 226         }
 227
 228         void LoginFail(userrec* user, const std::string &username, const std::string &pass)
 229         {
 230                 command_t* oper_command = ServerInstance->Parser->GetHandler("OPER");
 231
 232                 if (oper_command)
 233                 {
 234                         const char* params[] = { username.c_str(), pass.c_str() };
 235                         oper_command->Handle(params, 2, user);
 236                 }
 237                 else
 238                 {
 239                         ServerInstance->Log(DEBUG, "BUG: WHAT?! Why do we have no OPER command?!");
 240                 }
 241         }
 242
 243         bool OperUser(userrec* user, const std::string &username, const std::string &password, const std::string &pattern, const std::string &type)
 244         {
 245                 ConfigReader Conf(ServerInstance);
 246
 247                 for (int j = 0; j < Conf.Enumerate("type"); j++)
 248                 {
 249                         std::string tname = Conf.ReadValue("type","name",j);
 250                         std::string hostname(user->ident);
 251
 252                         hostname.append("@").append(user->host);
 253
 254                         if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
 255                         {
 256                                 /* Opertype and host match, looks like this is it. */
 257                                 std::string operhost = Conf.ReadValue("type", "host", j);
 258
 259                                 if (operhost.size())
 260                                         user->ChangeDisplayedHost(operhost.c_str());
 261
 262                                 ServerInstance->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s", user->nick, user->ident, user->host, type.c_str());
 263                                 user->WriteServ("381 %s :You are now an IRC operator of type %s", user->nick, type.c_str());
 264
 265                                 if (!user->modes[UM_OPERATOR])
 266                                         user->Oper(type);
 267
 268                                 return true;
 269                         }
 270                 }
 271
 272                 return false;
 273         }
 274
 275         virtual Version GetVersion()
 276         {
 277                 return Version(1,1,1,0,VF_VENDOR,API_VERSION);
 278         }
 279
 280 };
 281
 282 MODULE_INIT(ModuleSQLOper);
 283