src/modules/extra/m_sqloper.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include <string>
  15 #include "users.h"
  16 #include "channels.h"
  17 #include "modules.h"
  18 #include "inspircd.h"
  19 #include "configreader.h"
  20
  21 #include "m_sqlv2.h"
  22 #include "m_sqlutils.h"
  23 #include "commands/cmd_oper.h"
  24
  25 /* $ModDesc: Allows storage of oper credentials in an SQL table */
  26 /* $ModDep: m_sqlv2.h m_sqlutils.h */
  27
  28 class ModuleSQLOper : public Module
  29 {
  30         InspIRCd* Srv;
  31         Module* SQLutils;
  32         std::string databaseid;
  33
  34 public:
  35         ModuleSQLOper(InspIRCd* Me)
  36         : Module::Module(Me), Srv(Me)
  37         {
  38                 ServerInstance->UseInterface("SQLutils");
  39                 ServerInstance->UseInterface("SQL");
  40
  41                 SQLutils = ServerInstance->FindModule("m_sqlutils.so");
  42                 if (!SQLutils)
  43                         throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqloper.so.");
  44
  45                 OnRehash("");
  46         }
  47
  48         virtual ~ModuleSQLOper()
  49         {
  50                 ServerInstance->DoneWithInterface("SQL");
  51                 ServerInstance->DoneWithInterface("SQLutils");
  52         }
  53
  54         void Implements(char* List)
  55         {
  56                 List[I_OnRequest] = List[I_OnRehash] = List[I_OnPreCommand] = 1;
  57         }
  58
  59         virtual void OnRehash(const std::string &parameter)
  60         {
  61                 ConfigReader Conf(Srv);
  62
  63                 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
  64         }
  65
  66         virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
  67         {
  68                 if ((validated) && (command == "OPER"))
  69                 {
  70                         if (LookupOper(user, parameters[0], parameters[1]))
  71                         {
  72                                 /* Returning true here just means the query is in progress, or on it's way to being
  73                                  * in progress. Nothing about the /oper actually being successful..
  74                                  * If the oper lookup fails later, we pass the command to the original handler
  75                                  * for /oper by calling its Handle method directly.
  76                                  */
  77                                 return 1;
  78                         }
  79                 }
  80                 return 0;
  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                                 user->Extend("oper_user", strdup(username.c_str()));
 107                                 user->Extend("oper_pass", strdup(password.c_str()));
 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                         char* tried_user = NULL;
 139                         char* tried_pass = NULL;
 140
 141                         user->GetExt("oper_user", tried_user);
 142                         user->GetExt("oper_pass", tried_pass);
 143
 144                         if (user)
 145                         {
 146                                 if (res->error.Id() == NO_ERROR)
 147                                 {
 148                                         ServerInstance->Log(DEBUG, "Associated query ID %lu with user %s", res->id, user->nick);
 149                                         ServerInstance->Log(DEBUG, "Got result with %d rows and %d columns", res->Rows(), res->Cols());
 150
 151                                         if (res->Rows())
 152                                         {
 153                                                 /* We got a row in the result, this means there was a record for the oper..
 154                                                  * now we just need to check if their host matches, and if it does then
 155                                                  * oper them up.
 156                                                  *
 157                                                  * We now (previous versions of the module didn't) support multiple SQL
 158                                                  * rows per-oper in the same way the config file does, all rows will be tried
 159                                                  * until one is found which matches. This is useful to define several different
 160                                                  * hosts for a single oper.
 161                                                  *
 162                                                  * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
 163                                                  * are no more rows to return.
 164                                                  */
 165
 166                                                 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
 167                                                 {
 168                                                         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());
 169
 170                                                         if (OperUser(user, row["username"].d, row["password"].d, row["hostname"].d, row["type"].d))
 171                                                         {
 172                                                                 /* If/when one of the rows matches, stop checking and return */
 173                                                                 return SQLSUCCESS;
 174                                                         }
 175                                                 }
 176                                         }
 177                                         else
 178                                         {
 179                                                 /* No rows in result, this means there was no oper line for the user,
 180                                                  * we should have already checked the o:lines so now we need an
 181                                                  * "insufficient awesomeness" (invalid credentials) error
 182                                                  */
 183                                                 if (tried_user && tried_pass)
 184                                                 {
 185                                                         LoginFail(user, tried_user, tried_pass);
 186                                                         free(tried_user);
 187                                                         free(tried_pass);
 188                                                         user->Shrink("oper_user");
 189                                                         user->Shrink("oper_pass");
 190                                                 }
 191                                         }
 192                                 }
 193                                 else
 194                                 {
 195                                         /* This one shouldn't happen, the query failed for some reason.
 196                                          * We have to fail the /oper request and give them the same error
 197                                          * as above.
 198                                          */
 199                                         ServerInstance->Log(DEBUG, "Query failed: %s", res->error.Str());
 200
 201                                         if (tried_user && tried_pass)
 202                                         {
 203                                                 LoginFail(user, tried_user, tried_pass);
 204                                                 free(tried_user);
 205                                                 free(tried_pass);
 206                                                 user->Shrink("oper_user");
 207                                                 user->Shrink("oper_pass");
 208                                         }
 209
 210                                 }
 211                         }
 212                         else
 213                         {
 214                                 ServerInstance->Log(DEBUG, "Got query with unknown ID, this probably means the user quit while the query was in progress");
 215                         }
 216
 217                         return SQLSUCCESS;
 218                 }
 219
 220                 ServerInstance->Log(DEBUG, "Got unsupported API version string: %s", request->GetId());
 221
 222                 return NULL;
 223         }
 224
 225         void LoginFail(userrec* user, const std::string &username, const std::string &pass)
 226         {
 227                 command_t* oper_command = ServerInstance->Parser->GetHandler("OPER");
 228
 229                 if (oper_command)
 230                 {
 231                         const char* params[] = { username.c_str(), pass.c_str() };
 232                         oper_command->Handle(params, 2, user);
 233                 }
 234                 else
 235                 {
 236                         ServerInstance->Log(DEBUG, "WHAT?! Why do we have no OPER command?!");
 237                 }
 238         }
 239
 240         bool OperUser(userrec* user, const std::string &username, const std::string &password, const std::string &pattern, const std::string &type)
 241         {
 242                 ConfigReader Conf(Srv);
 243
 244                 for (int j = 0; j < Conf.Enumerate("type"); j++)
 245                 {
 246                         std::string tname = Conf.ReadValue("type","name",j);
 247
 248                         ServerInstance->Log(DEBUG, "Scanning opertype: %s", tname.c_str());
 249
 250                         std::string hostname(user->ident);
 251                         hostname.append("@").append(user->host);
 252
 253                         if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
 254                         {
 255                                 /* Opertype and host match, looks like this is it. */
 256                                 ServerInstance->Log(DEBUG, "Host (%s matched %s OR %s) and type (%s)", pattern.c_str(), hostname.c_str(), user->GetIPString(), type.c_str());
 257
 258                                 std::string operhost = Conf.ReadValue("type", "host", j);
 259
 260                                 if (operhost.size())
 261                                         user->ChangeDisplayedHost(operhost.c_str());
 262
 263                                 Srv->SNO->WriteToSnoMask('o',"%s (%s@%s) is now an IRC operator of type %s", user->nick, user->ident, user->host, type.c_str());
 264                                 user->WriteServ("381 %s :You are now an IRC operator of type %s", user->nick, type.c_str());
 265
 266                                 if (!user->modes[UM_OPERATOR])
 267                                         user->Oper(type);
 268
 269                                 return true;
 270                         }
 271                 }
 272
 273                 return false;
 274         }
 275
 276         virtual Version GetVersion()
 277         {
 278                 return Version(1,1,1,0,VF_VENDOR,API_VERSION);
 279         }
 280
 281 };
 282
 283 class ModuleSQLOperFactory : public ModuleFactory
 284 {
 285  public:
 286         ModuleSQLOperFactory()
 287         {
 288         }
 289
 290         ~ModuleSQLOperFactory()
 291         {
 292         }
 293
 294         virtual Module * CreateModule(InspIRCd* Me)
 295         {
 296                 return new ModuleSQLOper(Me);
 297         }
 298
 299 };
 300
 301
 302 extern "C" void * init_module( void )
 303 {
 304         return new ModuleSQLOperFactory;
 305 }
 306