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