src/modules/extra/m_sqloper.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #include <string>
  18 #include "users.h"
  19 #include "channels.h"
  20 #include "modules.h"
  21 #include "inspircd.h"
  22 #include "configreader.h"
  23
  24 #include "m_sqlv2.h"
  25 #include "m_sqlutils.h"
  26 #include "commands/cmd_oper.h"
  27
  28 /* $ModDesc: Allows storage of oper credentials in an SQL table */
  29 /* $ModDep: m_sqlv2.h m_sqlutils.h */
  30
  31 class ModuleSQLOper : public Module
  32 {
  33         InspIRCd* Srv;
  34         Module* SQLutils;
  35         std::string databaseid;
  36
  37 public:
  38         ModuleSQLOper(InspIRCd* Me)
  39         : Module::Module(Me), Srv(Me)
  40         {
  41                 SQLutils = Srv->FindFeature("SQLutils");
  42
  43                 if (SQLutils)
  44                 {
  45                         ServerInstance->Log(DEBUG, "Successfully got SQLutils pointer");
  46                 }
  47                 else
  48                 {
  49                         ServerInstance->Log(DEFAULT, "ERROR: This module requires a module offering the 'SQLutils' feature (usually m_sqlutils.so). Please load it and try again.");
  50                         throw ModuleException("This module requires a module offering the 'SQLutils' feature (usually m_sqlutils.so). Please load it and try again.");
  51                 }
  52
  53                 OnRehash("");
  54         }
  55
  56         virtual void OnRehash(const std::string &parameter)
  57         {
  58                 ConfigReader Conf(Srv);
  59
  60                 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
  61         }
  62
  63         void Implements(char* List)
  64         {
  65                 List[I_OnRequest] = List[I_OnRehash] = List[I_OnPreCommand] = 1;
  66         }
  67
  68         virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
  69         {
  70                 if ((validated) && (command == "OPER"))
  71                 {
  72                         if (LookupOper(user, parameters[0], parameters[1]))
  73                         {
  74                                 /* Returning true here just means the query is in progress, or on it's way to being
  75                                  * in progress. Nothing about the /oper actually being successful..
  76                                  * If the oper lookup fails later, we pass the command to the original handler
  77                                  * for /oper by calling its Handle method directly.
  78                                  */
  79                                 return 1;
  80                         }
  81                 }
  82                 return 0;
  83         }
  84
  85         bool LookupOper(userrec* user, const std::string &username, const std::string &password)
  86         {
  87                 Module* target;
  88
  89                 target = Srv->FindFeature("SQL");
  90
  91                 if (target)
  92                 {
  93                         SQLrequest req = SQLreq(this, target, databaseid, "SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password=md5('?')", username, password);
  94
  95                         if (req.Send())
  96                         {
  97                                 /* When we get the query response from the service provider we will be given an ID to play with,
  98                                  * just an ID number which is unique to this query. We need a way of associating that ID with a userrec
  99                                  * so we insert it into a map mapping the IDs to users.
 100                                  * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
 101                                  * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
 102                                  * us to discard the query.
 103                                  */
 104                                 ServerInstance->Log(DEBUG, "Sent query, got given ID %lu", req.id);
 105
 106                                 AssociateUser(this, SQLutils, req.id, user).Send();
 107
 108                                 user->Extend("oper_user", strdup(username.c_str()));
 109                                 user->Extend("oper_pass", strdup(password.c_str()));
 110
 111                                 return true;
 112                         }
 113                         else
 114                         {
 115                                 ServerInstance->Log(DEBUG, "SQLrequest failed: %s", req.error.Str());
 116
 117                                 return false;
 118                         }
 119                 }
 120                 else
 121                 {
 122                         ServerInstance->Log(SPARSE, "WARNING: Couldn't find SQL provider module. NOBODY will be able to oper up unless their o:line is statically configured");
 123                         return false;
 124                 }
 125         }
 126
 127         virtual char* OnRequest(Request* request)
 128         {
 129                 if (strcmp(SQLRESID, request->GetId()) == 0)
 130                 {
 131                         SQLresult* res;
 132
 133                         res = static_cast<SQLresult*>(request);
 134
 135                         ServerInstance->Log(DEBUG, "Got SQL result (%s) with ID %lu", res->GetId(), res->id);
 136
 137                         userrec* user = GetAssocUser(this, SQLutils, res->id).S().user;
 138                         UnAssociate(this, SQLutils, res->id).S();
 139
 140                         char* tried_user = NULL;
 141                         char* tried_pass = NULL;
 142
 143                         user->GetExt("oper_user", tried_user);
 144                         user->GetExt("oper_pass", tried_pass);
 145
 146                         if (user)
 147                         {
 148                                 if (res->error.Id() == NO_ERROR)
 149                                 {
 150                                         ServerInstance->Log(DEBUG, "Associated query ID %lu with user %s", res->id, user->nick);
 151                                         ServerInstance->Log(DEBUG, "Got result with %d rows and %d columns", res->Rows(), res->Cols());
 152
 153                                         if (res->Rows())
 154                                         {
 155                                                 /* We got a row in the result, this means there was a record for the oper..
 156                                                  * now we just need to check if their host matches, and if it does then
 157                                                  * oper them up.
 158                                                  *
 159                                                  * We now (previous versions of the module didn't) support multiple SQL
 160                                                  * rows per-oper in the same way the config file does, all rows will be tried
 161                                                  * until one is found which matches. This is useful to define several different
 162                                                  * hosts for a single oper.
 163                                                  *
 164                                                  * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
 165                                                  * are no more rows to return.
 166                                                  */
 167
 168                                                 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
 169                                                 {
 170                                                         ServerInstance->Log(DEBUG, "Trying to oper user %s with username = '%s', passhash = '%s', hostname = '%s', type = '%s'", user->nick, row["username"].d.c_str(), row["password"].d.c_str(), row["hostname"].d.c_str(), row["type"].d.c_str());
 171
 172                                                         if (OperUser(user, row["username"].d, row["password"].d, row["hostname"].d, row["type"].d))
 173                                                         {
 174                                                                 /* If/when one of the rows matches, stop checking and return */
 175                                                                 return SQLSUCCESS;
 176                                                         }
 177                                                 }
 178                                         }
 179                                         else
 180                                         {
 181                                                 /* No rows in result, this means there was no oper line for the user,
 182                                                  * we should have already checked the o:lines so now we need an
 183                                                  * "insufficient awesomeness" (invalid credentials) error
 184                                                  */
 185                                                 if (tried_user && tried_pass)
 186                                                 {
 187                                                         LoginFail(user, tried_user, tried_pass);
 188                                                         free(tried_user);
 189                                                         free(tried_pass);
 190                                                         user->Shrink("oper_user");
 191                                                         user->Shrink("oper_pass");
 192                                                 }
 193                                         }
 194                                 }
 195                                 else
 196                                 {
 197                                         /* This one shouldn't happen, the query failed for some reason.
 198                                          * We have to fail the /oper request and give them the same error
 199                                          * as above.
 200                                          */
 201                                         ServerInstance->Log(DEBUG, "Query failed: %s", res->error.Str());
 202
 203                                         if (tried_user && tried_pass)
 204                                         {
 205                                                 LoginFail(user, tried_user, tried_pass);
 206                                                 free(tried_user);
 207                                                 free(tried_pass);
 208                                                 user->Shrink("oper_user");
 209                                                 user->Shrink("oper_pass");
 210                                         }
 211
 212                                 }
 213                         }
 214                         else
 215                         {
 216                                 ServerInstance->Log(DEBUG, "Got query with unknown ID, this probably means the user quit while the query was in progress");
 217                         }
 218
 219                         return SQLSUCCESS;
 220                 }
 221
 222                 ServerInstance->Log(DEBUG, "Got unsupported API version string: %s", request->GetId());
 223
 224                 return NULL;
 225         }
 226
 227         void LoginFail(userrec* user, const std::string &username, const std::string &pass)
 228         {
 229                 command_t* oper_command = ServerInstance->Parser->GetHandler("OPER");
 230
 231                 if (oper_command)
 232                 {
 233                         const char* params[] = { username.c_str(), pass.c_str() };
 234                         oper_command->Handle(params, 2, user);
 235                 }
 236                 else
 237                 {
 238                         ServerInstance->Log(DEBUG, "WHAT?! Why do we have no OPER command?!");
 239                 }
 240         }
 241
 242         bool OperUser(userrec* user, const std::string &username, const std::string &password, const std::string &pattern, const std::string &type)
 243         {
 244                 ConfigReader Conf(Srv);
 245
 246                 for (int j = 0; j < Conf.Enumerate("type"); j++)
 247                 {
 248                         std::string tname = Conf.ReadValue("type","name",j);
 249
 250                         ServerInstance->Log(DEBUG, "Scanning opertype: %s", tname.c_str());
 251
 252                         std::string hostname(user->ident);
 253                         hostname.append("@").append(user->host);
 254
 255                         if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
 256                         {
 257                                 /* Opertype and host match, looks like this is it. */
 258                                 ServerInstance->Log(DEBUG, "Host (%s matched %s OR %s) and type (%s)", pattern.c_str(), hostname.c_str(), user->GetIPString(), type.c_str());
 259
 260                                 std::string operhost = Conf.ReadValue("type", "host", j);
 261
 262                                 if (operhost.size())
 263                                         user->ChangeDisplayedHost(operhost.c_str());
 264
 265                                 Srv->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s", user->nick, user->ident, user->host, type.c_str());
 266                                 user->WriteServ("381 %s :You are now an IRC operator of type %s", user->nick, type.c_str());
 267
 268                                 if (!user->modes[UM_OPERATOR])
 269                                         user->Oper(type);
 270
 271                                 return true;
 272                         }
 273                 }
 274
 275                 return false;
 276         }
 277
 278         virtual ~ModuleSQLOper()
 279         {
 280         }
 281
 282         virtual Version GetVersion()
 283         {
 284                 return Version(1,1,1,0,VF_VENDOR,API_VERSION);
 285         }
 286
 287 };
 288
 289 class ModuleSQLOperFactory : public ModuleFactory
 290 {
 291  public:
 292         ModuleSQLOperFactory()
 293         {
 294         }
 295
 296         ~ModuleSQLOperFactory()
 297         {
 298         }
 299
 300         virtual Module * CreateModule(InspIRCd* Me)
 301         {
 302                 return new ModuleSQLOper(Me);
 303         }
 304
 305 };
 306
 307
 308 extern "C" void * init_module( void )
 309 {
 310         return new ModuleSQLOperFactory;
 311 }
 312