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         InspIRCd* 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(InspIRCd* 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(Srv);
  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                         userrec::QuitUser(Srv,user,killreason);
  98                 }
  99         }
 100
 101         bool CheckCredentials(userrec* user)
 102         {
 103                 Module* target;
 104
 105                 target = Srv->FindFeature("SQL");
 106
 107                 if(target)
 108                 {
 109                         SQLrequest req = SQLreq(this, target, databaseid, "SELECT ? FROM ? WHERE ? = '?' AND ? = ?'?')", userfield, usertable, userfield, user->nick, passfield, encryption, user->password);
 110
 111                         if(req.Send())
 112                         {
 113                                 /* When we get the query response from the service provider we will be given an ID to play with,
 114                                  * just an ID number which is unique to this query. We need a way of associating that ID with a userrec
 115                                  * so we insert it into a map mapping the IDs to users.
 116                                  * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
 117                                  * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
 118                                  * us to discard the query.
 119                                  */
 120                                 log(DEBUG, "Sent query, got given ID %lu", req.id);
 121
 122                                 AssociateUser(this, SQLutils, req.id, user).Send();
 123
 124                                 return true;
 125                         }
 126                         else
 127                         {
 128                                 log(DEBUG, "SQLrequest failed: %s", req.error.Str());
 129
 130                                 if (verbose)
 131                                         Srv->WriteOpers("Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick, user->ident, user->host, req.error.Str());
 132
 133                                 return false;
 134                         }
 135                 }
 136                 else
 137                 {
 138                         log(SPARSE, "WARNING: Couldn't find SQL provider module. NOBODY will be allowed to connect until it comes back unless they match an exception");
 139                         return false;
 140                 }
 141         }
 142
 143         virtual char* OnRequest(Request* request)
 144         {
 145                 if(strcmp(SQLRESID, request->GetId()) == 0)
 146                 {
 147                         SQLresult* res;
 148
 149                         res = static_cast<SQLresult*>(request);
 150
 151                         log(DEBUG, "Got SQL result (%s) with ID %lu", res->GetId(), res->id);
 152
 153                         userrec* user = GetAssocUser(this, SQLutils, res->id).S().user;
 154                         UnAssociate(this, SQLutils, res->id).S();
 155
 156                         if(user)
 157                         {
 158                                 if(res->error.Id() == NO_ERROR)
 159                                 {
 160                                         log(DEBUG, "Associated query ID %lu with user %s", res->id, user->nick);
 161                                         log(DEBUG, "Got result with %d rows and %d columns", res->Rows(), res->Cols());
 162
 163                                         if(res->Rows())
 164                                         {
 165                                                 /* We got a row in the result, this is enough really */
 166                                                 user->Extend("sqlauthed");
 167                                         }
 168                                         else if (verbose)
 169                                         {
 170                                                 /* No rows in result, this means there was no record matching the user */
 171                                                 Srv->WriteOpers("Forbidden connection from %s!%s@%s (SQL query returned no matches)", user->nick, user->ident, user->host);
 172                                                 user->Extend("sqlauth_failed");
 173                                         }
 174                                 }
 175                                 else if (verbose)
 176                                 {
 177                                         log(DEBUG, "Query failed: %s", res->error.Str());
 178                                         Srv->WriteOpers("Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick, user->ident, user->host, res->error.Str());
 179                                         user->Extend("sqlauth_failed");
 180                                 }
 181                         }
 182                         else
 183                         {
 184                                 log(DEBUG, "Got query with unknown ID, this probably means the user quit while the query was in progress");
 185                         }
 186
 187                         return SQLSUCCESS;
 188                 }
 189
 190                 log(DEBUG, "Got unsupported API version string: %s", request->GetId());
 191
 192                 return NULL;
 193         }
 194
 195         virtual void OnUserDisconnect(userrec* user)
 196         {
 197                 user->Shrink("sqlauthed");
 198                 user->Shrink("sqlauth_failed");
 199         }
 200
 201         virtual bool OnCheckReady(userrec* user)
 202         {
 203                 if(user->GetExt("sqlauth_failed"))
 204                 {
 205                         userrec::QuitUser(Srv,user,killreason);
 206                         return false;
 207                 }
 208
 209                 return user->GetExt("sqlauthed");
 210         }
 211
 212         virtual ~ModuleSQLAuth()
 213         {
 214         }
 215
 216         virtual Version GetVersion()
 217         {
 218                 return Version(1,0,1,0,VF_VENDOR);
 219         }
 220
 221 };
 222
 223 class ModuleSQLAuthFactory : public ModuleFactory
 224 {
 225  public:
 226         ModuleSQLAuthFactory()
 227         {
 228         }
 229
 230         ~ModuleSQLAuthFactory()
 231         {
 232         }
 233
 234         virtual Module * CreateModule(InspIRCd* Me)
 235         {
 236                 return new ModuleSQLAuth(Me);
 237         }
 238
 239 };
 240
 241
 242 extern "C" void * init_module( void )
 243 {
 244         return new ModuleSQLAuthFactory;
 245 }