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