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 "inspircd.h"
  15 #include "users.h"
  16 #include "channels.h"
  17 #include "modules.h"
  18 #include "configreader.h"
  19
  20 #include "m_sqlv2.h"
  21 #include "m_sqlutils.h"
  22 #include "m_hash.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         Module* SQLutils;
  31         Module* HashModule;
  32         std::string databaseid;
  33
  34 public:
  35         ModuleSQLOper(InspIRCd* Me)
  36         : Module::Module(Me)
  37         {
  38                 ServerInstance->Modules->UseInterface("SQLutils");
  39                 ServerInstance->Modules->UseInterface("SQL");
  40                 ServerInstance->Modules->UseInterface("HashRequest");
  41
  42                 /* Attempt to locate the md5 service provider, bail if we can't find it */
  43                 HashModule = ServerInstance->Modules->Find("m_md5.so");
  44                 if (!HashModule)
  45                         throw ModuleException("Can't find m_md5.so. Please load m_md5.so before m_sqloper.so.");
  46
  47                 SQLutils = ServerInstance->Modules->Find("m_sqlutils.so");
  48                 if (!SQLutils)
  49                         throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqloper.so.");
  50
  51                 OnRehash(NULL,"");
  52         }
  53
  54         virtual ~ModuleSQLOper()
  55         {
  56                 ServerInstance->Modules->DoneWithInterface("SQL");
  57                 ServerInstance->Modules->DoneWithInterface("SQLutils");
  58                 ServerInstance->Modules->DoneWithInterface("HashRequest");
  59         }
  60
  61         void Implements(char* List)
  62         {
  63                 List[I_OnRequest] = List[I_OnRehash] = List[I_OnPreCommand] = 1;
  64         }
  65
  66         virtual void OnRehash(User* user, const std::string &parameter)
  67         {
  68                 ConfigReader Conf(ServerInstance);
  69
  70                 databaseid = Conf.ReadValue("sqloper", "dbid", 0); /* Database ID of a database configured for the service provider module */
  71         }
  72
  73         virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, User *user, bool validated, const std::string &original_line)
  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                                  * If the oper lookup fails later, we pass the command to the original handler
  82                                  * for /oper by calling its Handle method directly.
  83                                  */
  84                                 return 1;
  85                         }
  86                 }
  87                 return 0;
  88         }
  89
  90         bool LookupOper(User* user, const std::string &username, const std::string &password)
  91         {
  92                 Module* target;
  93
  94                 target = ServerInstance->Modules->FindFeature("SQL");
  95
  96                 if (target)
  97                 {
  98                         /* Reset hash module first back to MD5 standard state */
  99                         HashResetRequest(this, HashModule).Send();
 100                         /* Make an MD5 hash of the password for using in the query */
 101                         std::string md5_pass_hash = HashSumRequest(this, HashModule, password.c_str()).Send();
 102
 103                         /* We generate our own MD5 sum here because some database providers (e.g. SQLite) dont have a builtin md5 function,
 104                          * also hashing it in the module and only passing a remote query containing a hash is more secure.
 105                          */
 106
 107                         SQLrequest req = SQLrequest(this, target, databaseid,
 108                                         SQLquery("SELECT username, password, hostname, type FROM ircd_opers WHERE username = '?' AND password='?'") % username % md5_pass_hash);
 109
 110                         if (req.Send())
 111                         {
 112                                 /* When we get the query response from the service provider we will be given an ID to play with,
 113                                  * just an ID number which is unique to this query. We need a way of associating that ID with a User
 114                                  * so we insert it into a map mapping the IDs to users.
 115                                  * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
 116                                  * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
 117                                  * us to discard the query.
 118                                  */
 119                                 AssociateUser(this, SQLutils, req.id, user).Send();
 120
 121                                 user->Extend("oper_user", strdup(username.c_str()));
 122                                 user->Extend("oper_pass", strdup(password.c_str()));
 123
 124                                 return true;
 125                         }
 126                         else
 127                         {
 128                                 return false;
 129                         }
 130                 }
 131                 else
 132                 {
 133                         ServerInstance->Log(SPARSE, "WARNING: Couldn't find SQL provider module. NOBODY will be able to oper up unless their o:line is statically configured");
 134                         return false;
 135                 }
 136         }
 137
 138         virtual char* OnRequest(Request* request)
 139         {
 140                 if (strcmp(SQLRESID, request->GetId()) == 0)
 141                 {
 142                         SQLresult* res = static_cast<SQLresult*>(request);
 143
 144                         User* user = GetAssocUser(this, SQLutils, res->id).S().user;
 145                         UnAssociate(this, SQLutils, res->id).S();
 146
 147                         char* tried_user = NULL;
 148                         char* tried_pass = NULL;
 149
 150                         user->GetExt("oper_user", tried_user);
 151                         user->GetExt("oper_pass", tried_pass);
 152
 153                         if (user)
 154                         {
 155                                 if (res->error.Id() == NO_ERROR)
 156                                 {
 157                                         if (res->Rows())
 158                                         {
 159                                                 /* We got a row in the result, this means there was a record for the oper..
 160                                                  * now we just need to check if their host matches, and if it does then
 161                                                  * oper them up.
 162                                                  *
 163                                                  * We now (previous versions of the module didn't) support multiple SQL
 164                                                  * rows per-oper in the same way the config file does, all rows will be tried
 165                                                  * until one is found which matches. This is useful to define several different
 166                                                  * hosts for a single oper.
 167                                                  *
 168                                                  * The for() loop works as SQLresult::GetRowMap() returns an empty map when there
 169                                                  * are no more rows to return.
 170                                                  */
 171
 172                                                 for (SQLfieldMap& row = res->GetRowMap(); row.size(); row = res->GetRowMap())
 173                                                 {
 174                                                         if (OperUser(user, row["username"].d, row["password"].d, row["hostname"].d, row["type"].d))
 175                                                         {
 176                                                                 /* If/when one of the rows matches, stop checking and return */
 177                                                                 return SQLSUCCESS;
 178                                                         }
 179                                                         if (tried_user && tried_pass)
 180                                                         {
 181                                                                 LoginFail(user, tried_user, tried_pass);
 182                                                                 free(tried_user);
 183                                                                 free(tried_pass);
 184                                                                 user->Shrink("oper_user");
 185                                                                 user->Shrink("oper_pass");
 186                                                         }
 187                                                 }
 188                                         }
 189                                         else
 190                                         {
 191                                                 /* No rows in result, this means there was no oper line for the user,
 192                                                  * we should have already checked the o:lines so now we need an
 193                                                  * "insufficient awesomeness" (invalid credentials) error
 194                                                  */
 195                                                 if (tried_user && tried_pass)
 196                                                 {
 197                                                         LoginFail(user, tried_user, tried_pass);
 198                                                         free(tried_user);
 199                                                         free(tried_pass);
 200                                                         user->Shrink("oper_user");
 201                                                         user->Shrink("oper_pass");
 202                                                 }
 203                                         }
 204                                 }
 205                                 else
 206                                 {
 207                                         /* This one shouldn't happen, the query failed for some reason.
 208                                          * We have to fail the /oper request and give them the same error
 209                                          * as above.
 210                                          */
 211                                         if (tried_user && tried_pass)
 212                                         {
 213                                                 LoginFail(user, tried_user, tried_pass);
 214                                                 free(tried_user);
 215                                                 free(tried_pass);
 216                                                 user->Shrink("oper_user");
 217                                                 user->Shrink("oper_pass");
 218                                         }
 219
 220                                 }
 221                         }
 222
 223                         return SQLSUCCESS;
 224                 }
 225
 226                 return NULL;
 227         }
 228
 229         void LoginFail(User* user, const std::string &username, const std::string &pass)
 230         {
 231                 Command* oper_command = ServerInstance->Parser->GetHandler("OPER");
 232
 233                 if (oper_command)
 234                 {
 235                         const char* params[] = { username.c_str(), pass.c_str() };
 236                         oper_command->Handle(params, 2, user);
 237                 }
 238                 else
 239                 {
 240                         ServerInstance->Log(DEBUG, "BUG: WHAT?! Why do we have no OPER command?!");
 241                 }
 242         }
 243
 244         bool OperUser(User* user, const std::string &username, const std::string &password, const std::string &pattern, const std::string &type)
 245         {
 246                 ConfigReader Conf(ServerInstance);
 247
 248                 for (int j = 0; j < Conf.Enumerate("type"); j++)
 249                 {
 250                         std::string tname = Conf.ReadValue("type","name",j);
 251                         std::string hostname(user->ident);
 252
 253                         hostname.append("@").append(user->host);
 254
 255                         if ((tname == type) && OneOfMatches(hostname.c_str(), user->GetIPString(), pattern.c_str()))
 256                         {
 257                                 /* Opertype and host match, looks like this is it. */
 258                                 std::string operhost = Conf.ReadValue("type", "host", j);
 259
 260                                 if (operhost.size())
 261                                         user->ChangeDisplayedHost(operhost.c_str());
 262
 263                                 ServerInstance->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 %s %s",user->nick, strchr("aeiouAEIOU", type[0]) ? "an" : "a", irc::Spacify(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 MODULE_INIT(ModuleSQLOper)