src/modules/extra/m_sqlauth.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  *               <omster@gmail.com>
  10  *
  11  * Written by Craig Edwards, Craig McLure, and others.
  12  * This program is free but copyrighted software; see
  13  *            the file COPYING for details.
  14  *
  15  * ---------------------------------------------------
  16  */
  17
  18 #include <string>
  19
  20 #include "users.h"
  21 #include "channels.h"
  22 #include "modules.h"
  23 #include "inspircd.h"
  24 #include "helperfuncs.h"
  25 #include "m_sqlv2.h"
  26 #include "m_sqlutils.h"
  27
  28 /* $ModDesc: Allow/Deny connections based upon an arbitary SQL table */
  29
  30 class ModuleSQLAuth : public Module
  31 {
  32         Server* Srv;
  33         Module* SQLutils;
  34
  35         std::string usertable;
  36         std::string userfield;
  37         std::string passfield;
  38         std::string encryption;
  39         std::string killreason;
  40         std::string allowpattern;
  41         std::string databaseid;
  42
  43         bool verbose;
  44
  45 public:
  46         ModuleSQLAuth(Server* Me)
  47         : Module::Module(Me), Srv(Me)
  48         {
  49                 SQLutils = Srv->FindFeature("SQLutils");
  50
  51                 if(SQLutils)
  52                 {
  53                         log(DEBUG, "Successfully got SQLutils pointer");
  54                 }
  55                 else
  56                 {
  57                         log(DEFAULT, "ERROR: This module requires a module offering the 'SQLutils' feature (usually m_sqlutils.so). Please load it and try again.");
  58                         throw ModuleException("This module requires a module offering the 'SQLutils' feature (usually m_sqlutils.so). Please load it and try again.");
  59                 }
  60
  61                 OnRehash("");
  62         }
  63
  64         void Implements(char* List)
  65         {
  66                 List[I_OnUserDisconnect] = List[I_OnCheckReady] = List[I_OnRequest] = List[I_OnRehash] = List[I_OnUserRegister] = 1;
  67         }
  68
  69         virtual void OnRehash(const std::string &parameter)
  70         {
  71                 ConfigReader Conf;
  72
  73                 usertable       = Conf.ReadValue("sqlauth", "usertable", 0);    /* User table name */
  74                 databaseid      = Conf.ReadValue("sqlauth", "dbid", 0);                 /* Database ID, given to the SQL service provider */
  75                 userfield       = Conf.ReadValue("sqlauth", "userfield", 0);    /* Field name where username can be found */
  76                 passfield       = Conf.ReadValue("sqlauth", "passfield", 0);    /* Field name where password can be found */
  77                 killreason      = Conf.ReadValue("sqlauth", "killreason", 0);   /* Reason to give when access is denied to a user (put your reg details here) */
  78                 allowpattern= Conf.ReadValue("sqlauth", "allowpattern",0 );     /* Allow nicks matching this pattern without requiring auth */
  79                 encryption      = Conf.ReadValue("sqlauth", "encryption", 0);   /* Name of sql function used to encrypt password, e.g. "md5" or "passwd".
  80                                                                                                                                          * define, but leave blank if no encryption is to be used.
  81                                                                                                                                          */
  82                 verbose         = Conf.ReadFlag("sqlauth", "verbose", 0);               /* Set to true if failed connects should be reported to operators */
  83
  84                 if (encryption.find("(") == std::string::npos)
  85                 {
  86                         encryption.append("(");
  87                 }
  88         }
  89
  90         virtual void OnUserRegister(userrec* user)
  91         {
  92                 if ((allowpattern != "") && (Srv->MatchText(user->nick,allowpattern)))
  93                         return;
  94
  95                 if (!CheckCredentials(user))
  96                 {
  97                         Srv->QuitUser(user,killreason);
  98                 }
  99         }
 100
 101         bool CheckCredentials(userrec* user)
 102         {
 103                 bool found;
 104                 Module* target;
 105
 106                 found = false;
 107                 target = Srv->FindFeature("SQL");
 108
 109                 if(target)
 110                 {
 111                         SQLrequest req = SQLreq(this, target, databaseid, "SELECT ? FROM ? WHERE ? = '?' AND ? = ?'?')", userfield, usertable, userfield, user->nick, passfield, encryption, user->password);
 112
 113                         if(req.Send())
 114                         {
 115                                 /* When we get the query response from the service provider we will be given an ID to play with,
 116                                  * just an ID number which is unique to this query. We need a way of associating that ID with a userrec
 117                                  * so we insert it into a map mapping the IDs to users.
 118                                  * This isn't quite enough though, as if the user quit while the query was in progress then when the result
 119                                  * came to be processed we'd get an invalid userrec* out of the map. Now we *could* solve this by watching
 120                                  * OnUserDisconnect() and iterating the map every time someone quits to make sure they didn't have any queries
 121                                  * in progress, but that would be relatively slow and inefficient. Instead (thanks to w00t ;p) we attach a list
 122                                  * of query IDs associated with it to the userrec, so in OnUserDisconnect() we can remove it immediately.
 123                                  */
 124                                 log(DEBUG, "Sent query, got given ID %lu", req.id);
 125
 126                                 AssociateUser(this, SQLutils, req.id, user).Send();
 127
 128                                 return true;
 129                         }
 130                         else
 131                         {
 132                                 log(DEBUG, "SQLrequest failed: %s", req.error.Str());
 133
 134                                 if (verbose)
 135                                         WriteOpers("Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick, user->ident, user->host, req.error.Str());
 136
 137                                 return false;
 138                         }
 139                 }
 140                 else
 141                 {
 142                         log(SPARSE, "WARNING: Couldn't find SQL provider module. NOBODY will be allowed to connect until it comes back unless they match an exception");
 143                         return false;
 144                 }
 145         }
 146
 147         virtual char* OnRequest(Request* request)
 148         {
 149                 if(strcmp(SQLRESID, request->GetData()) == 0)
 150                 {
 151                         SQLresult* res;
 152
 153                         res = static_cast<SQLresult*>(request);
 154
 155                         log(DEBUG, "Got SQL result (%s) with ID %lu", res->GetData(), res->id);
 156
 157                         userrec* user = GetAssocUser(this, SQLutils, res->id).S().user;
 158                         UnAssociate(this, SQLutils, res->id).S();
 159
 160                         if(user)
 161                         {
 162                                 if(res->error.Id() == NO_ERROR)
 163                                 {
 164                                         log(DEBUG, "Associated query ID %lu with user %s", res->id, user->nick);
 165                                         log(DEBUG, "Got result with %d rows and %d columns", res->Rows(), res->Cols());
 166
 167                                         if(res->Rows())
 168                                         {
 169                                                 /* We got a row in the result, this is enough really */
 170                                                 user->Extend("sqlauthed");
 171                                         }
 172                                         else if (verbose)
 173                                         {
 174                                                 /* No rows in result, this means there was no record matching the user */
 175                                                 WriteOpers("Forbidden connection from %s!%s@%s (SQL query returned no matches)", user->nick, user->ident, user->host);
 176                                                 user->Extend("sqlauth_failed");
 177                                         }
 178                                 }
 179                                 else if (verbose)
 180                                 {
 181                                         log(DEBUG, "Query failed: %s", res->error.Str());
 182                                         WriteOpers("Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick, user->ident, user->host, res->error.Str());
 183                                         user->Extend("sqlauth_failed");
 184                                 }
 185                         }
 186                         else
 187                         {
 188                                 log(DEBUG, "Got query with unknown ID, this probably means the user quit while the query was in progress");
 189                         }
 190
 191                         return SQLSUCCESS;
 192                 }
 193
 194                 log(DEBUG, "Got unsupported API version string: %s", request->GetData());
 195
 196                 return NULL;
 197         }
 198
 199         virtual void OnUserDisconnect(userrec* user)
 200         {
 201                 user->Shrink("sqlauthed");
 202                 user->Shrink("sqlauth_failed");
 203         }
 204
 205         virtual bool OnCheckReady(userrec* user)
 206         {
 207                 if(user->GetExt("sqlauth_failed"))
 208                 {
 209                         Srv->QuitUser(user,killreason);
 210                         return false;
 211                 }
 212
 213                 return user->GetExt("sqlauthed");
 214         }
 215
 216         virtual ~ModuleSQLAuth()
 217         {
 218         }
 219
 220         virtual Version GetVersion()
 221         {
 222                 return Version(1,0,1,0,VF_VENDOR);
 223         }
 224
 225 };
 226
 227 class ModuleSQLAuthFactory : public ModuleFactory
 228 {
 229  public:
 230         ModuleSQLAuthFactory()
 231         {
 232         }
 233
 234         ~ModuleSQLAuthFactory()
 235         {
 236         }
 237
 238         virtual Module * CreateModule(Server* Me)
 239         {
 240                 return new ModuleSQLAuth(Me);
 241         }
 242
 243 };
 244
 245
 246 extern "C" void * init_module( void )
 247 {
 248         return new ModuleSQLAuthFactory;
 249 }