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
  19 #include "users.h"
  20 #include "channels.h"
  21 #include "modules.h"
  22 #include "inspircd.h"
  23 #include "configreader.h"
  24
  25 #include "m_sqlv2.h"
  26 #include "m_sqlutils.h"
  27 #include "commands/cmd_oper.h"
  28
  29 /* $ModDesc: Allows storage of oper credentials in an SQL table */
  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                                  */
  77                                 return 1;
  78                         }
  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                                 return true;
 108                         }
 109                         else
 110                         {
 111                                 ServerInstance->Log(DEBUG, "SQLrequest failed: %s", req.error.Str());
 112
 113                                 return false;
 114                         }
 115                 }
 116                 else
 117                 {
 118                         ServerInstance->Log(SPARSE, "WARNING: Couldn't find SQL provider module. NOBODY will be able to oper up unless their o:line is statically configured");
 119                         return false;
 120                 }
 121         }
 122
 123         virtual char* OnRequest(Request* request)
 124         {
 125                 if (strcmp(SQLRESID, request->GetId()) == 0)
 126                 {
 127                         SQLresult* res;
 128
 129                         res = static_cast<SQLresult*>(request);
 130
 131                         ServerInstance->Log(DEBUG, "Got SQL result (%s) with ID %lu", res->GetId(), res->id);
 132
 133                         userrec* user = GetAssocUser(this, SQLutils, res->id).S().user;
 134                         UnAssociate(this, SQLutils, res->id).S();
 135
 136                         if (user)
 137                         {
 138                                 if (res->error.Id() == NO_ERROR)
 139                                 {
 140                                         ServerInstance->Log(DEBUG, "Associated query ID %lu with user %s", res->id, user->nick);
 141                                         ServerInstance->Log(DEBUG, "Got result with %d rows and %d columns", res->Rows(), res->Cols());
 142
 143                                         if (res->Rows())
 144                                         {
 145                                                 /* We got a row in the result, this means there was a record for the oper..
 146                                                  * now we just need to check if their host matches, and if it does then
 147                                                  * oper them up.
 148                                                  *
 149                                                  * We now (previous versions of the module didn't) support multiple SQL
 150                                                  * rows per-oper in the same way the config file does, all rows will be tried
 151                                                  * until one is found which matches. This is useful to define several different
 152                                                  * hosts for a single oper.
 153                                                  *
 154                                                  * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
 155                                                  * are no more rows to return.
 156                                                  */
 157
 158                                                 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
 159                                                 {
 160                                                         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());
 161
 162                                                         if (OperUser(user, row["username"].d, row["password"].d, row["hostname"].d, row["type"].d))
 163                                                         {
 164                                                                 /* If/when one of the rows matches, stop checking and return */
 165                                                                 return SQLSUCCESS;
 166                                                         }
 167                                                 }
 168                                         }
 169                                         else
 170                                         {
 171                                                 /* No rows in result, this means there was no oper line for the user,
 172                                                  * we should have already checked the o:lines so now we need an
 173                                                  * "insufficient awesomeness" (invalid credentials) error
 174                                                  */
 175
 176                                                 user->WriteServ( "491 %s :Invalid oper credentials", user->nick);
 177                                                 Srv->SNO->WriteToSnoMask('o',"WARNING! Failed oper attempt by %s!%s@%s!", user->nick, user->ident, user->host);
 178                                                 ServerInstance->Log(DEFAULT,"OPER: Failed oper attempt by %s!%s@%s: user, host or password did not match.", user->nick, user->ident, user->host);
 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                                         user->WriteServ( "491 %s :Invalid oper credentials", user->nick);
 190                                         Srv->SNO->WriteToSnoMask('o',"WARNING! Failed oper attempt by %s!%s@%s! (SQL query failed: %s)", user->nick, user->ident, user->host, res->error.Str());
 191                                         ServerInstance->Log(DEFAULT,"OPER: Failed oper attempt by %s!%s@%s: user, host or password did not match.", user->nick, user->ident, user->host);
 192                                 }
 193                         }
 194                         else
 195                         {
 196                                 ServerInstance->Log(DEBUG, "Got query with unknown ID, this probably means the user quit while the query was in progress");
 197                         }
 198
 199                         return SQLSUCCESS;
 200                 }
 201
 202                 ServerInstance->Log(DEBUG, "Got unsupported API version string: %s", request->GetId());
 203
 204                 return NULL;
 205         }
 206
 207         bool OperUser(userrec* user, const std::string &username, const std::string &password, const std::string &pattern, const std::string &type)
 208         {
 209                 ConfigReader Conf(Srv);
 210
 211                 for (int j = 0; j < Conf.Enumerate("type"); j++)
 212                 {
 213                         std::string tname = Conf.ReadValue("type","name",j);
 214
 215                         ServerInstance->Log(DEBUG, "Scanning opertype: %s", tname.c_str());
 216
 217                         std::string hostname(user->ident);
 218                         hostname.append("@").append(user->host);
 219
 220                         if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
 221                         {
 222                                 /* Opertype and host match, looks like this is it. */
 223                                 ServerInstance->Log(DEBUG, "Host (%s matched %s OR %s) and type (%s)", pattern.c_str(), hostname.c_str(), user->GetIPString(), type.c_str());
 224
 225                                 std::string operhost = Conf.ReadValue("type", "host", j);
 226
 227                                 if (operhost.size())
 228                                         user->ChangeDisplayedHost(operhost.c_str());
 229
 230                                 Srv->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s", user->nick, user->ident, user->host, type.c_str());
 231                                 user->WriteServ("381 %s :You are now an IRC operator of type %s", user->nick, type.c_str());
 232
 233                                 if (!user->modes[UM_OPERATOR])
 234                                         user->Oper(type);
 235
 236                                 return true;
 237                         }
 238                 }
 239
 240                 return false;
 241         }
 242
 243         virtual ~ModuleSQLOper()
 244         {
 245         }
 246
 247         virtual Version GetVersion()
 248         {
 249                 return Version(1,1,1,0,VF_VENDOR,API_VERSION);
 250         }
 251
 252 };
 253
 254 class ModuleSQLOperFactory : public ModuleFactory
 255 {
 256  public:
 257         ModuleSQLOperFactory()
 258         {
 259         }
 260
 261         ~ModuleSQLOperFactory()
 262         {
 263         }
 264
 265         virtual Module * CreateModule(InspIRCd* Me)
 266         {
 267                 return new ModuleSQLOper(Me);
 268         }
 269
 270 };
 271
 272
 273 extern "C" void * init_module( void )
 274 {
 275         return new ModuleSQLOperFactory;
 276 }
 277