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