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