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