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 extern InspIRCd* ServerInstance;
  31
  32 class ModuleSQLAuth : public Module
  33 {
  34         Server* Srv;
  35         Module* SQLutils;
  36
  37         std::string usertable;
  38         std::string userfield;
  39         std::string passfield;
  40         std::string encryption;
  41         std::string killreason;
  42         std::string allowpattern;
  43         std::string databaseid;
  44
  45         bool verbose;
  46
  47 public:
  48         ModuleSQLAuth(Server* Me)
  49         : Module::Module(Me), Srv(Me)
  50         {
  51                 SQLutils = ServerInstance->FindFeature("SQLutils");
  52
  53                 if(SQLutils)
  54                 {
  55                         log(DEBUG, "Successfully got SQLutils pointer");
  56                 }
  57                 else
  58                 {
  59                         log(DEFAULT, "ERROR: This module requires a module offering the 'SQLutils' feature (usually m_sqlutils.so). Please load it and try again.");
  60                         throw ModuleException("This module requires a module offering the 'SQLutils' feature (usually m_sqlutils.so). Please load it and try again.");
  61                 }
  62
  63                 OnRehash("");
  64         }
  65
  66         void Implements(char* List)
  67         {
  68                 List[I_OnUserDisconnect] = List[I_OnCheckReady] = List[I_OnRequest] = List[I_OnRehash] = List[I_OnUserRegister] = 1;
  69         }
  70
  71         virtual void OnRehash(const std::string &parameter)
  72         {
  73                 ConfigReader Conf;
  74
  75                 usertable       = Conf.ReadValue("sqlauth", "usertable", 0);    /* User table name */
  76                 databaseid      = Conf.ReadValue("sqlauth", "dbid", 0);                 /* Database ID, given to the SQL service provider */
  77                 userfield       = Conf.ReadValue("sqlauth", "userfield", 0);    /* Field name where username can be found */
  78                 passfield       = Conf.ReadValue("sqlauth", "passfield", 0);    /* Field name where password can be found */
  79                 killreason      = Conf.ReadValue("sqlauth", "killreason", 0);   /* Reason to give when access is denied to a user (put your reg details here) */
  80                 allowpattern= Conf.ReadValue("sqlauth", "allowpattern",0 );     /* Allow nicks matching this pattern without requiring auth */
  81                 encryption      = Conf.ReadValue("sqlauth", "encryption", 0);   /* Name of sql function used to encrypt password, e.g. "md5" or "passwd".
  82                                                                                                                                          * define, but leave blank if no encryption is to be used.
  83                                                                                                                                          */
  84                 verbose         = Conf.ReadFlag("sqlauth", "verbose", 0);               /* Set to true if failed connects should be reported to operators */
  85
  86                 if (encryption.find("(") == std::string::npos)
  87                 {
  88                         encryption.append("(");
  89                 }
  90         }
  91
  92         virtual void OnUserRegister(userrec* user)
  93         {
  94                 if ((allowpattern != "") && (Srv->MatchText(user->nick,allowpattern)))
  95                         return;
  96
  97                 if (!CheckCredentials(user))
  98                 {
  99                         userrec::QuitUser(ServerInstance,user,killreason);
 100                 }
 101         }
 102
 103         bool CheckCredentials(userrec* user)
 104         {
 105                 Module* target;
 106
 107                 target = ServerInstance->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                                  * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
 119                                  * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
 120                                  * us to discard the query.
 121                                  */
 122                                 log(DEBUG, "Sent query, got given ID %lu", req.id);
 123
 124                                 AssociateUser(this, SQLutils, req.id, user).Send();
 125
 126                                 return true;
 127                         }
 128                         else
 129                         {
 130                                 log(DEBUG, "SQLrequest failed: %s", req.error.Str());
 131
 132                                 if (verbose)
 133                                         ServerInstance->WriteOpers("Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick, user->ident, user->host, req.error.Str());
 134
 135                                 return false;
 136                         }
 137                 }
 138                 else
 139                 {
 140                         log(SPARSE, "WARNING: Couldn't find SQL provider module. NOBODY will be allowed to connect until it comes back unless they match an exception");
 141                         return false;
 142                 }
 143         }
 144
 145         virtual char* OnRequest(Request* request)
 146         {
 147                 if(strcmp(SQLRESID, request->GetId()) == 0)
 148                 {
 149                         SQLresult* res;
 150
 151                         res = static_cast<SQLresult*>(request);
 152
 153                         log(DEBUG, "Got SQL result (%s) with ID %lu", res->GetId(), res->id);
 154
 155                         userrec* user = GetAssocUser(this, SQLutils, res->id).S().user;
 156                         UnAssociate(this, SQLutils, res->id).S();
 157
 158                         if(user)
 159                         {
 160                                 if(res->error.Id() == NO_ERROR)
 161                                 {
 162                                         log(DEBUG, "Associated query ID %lu with user %s", res->id, user->nick);
 163                                         log(DEBUG, "Got result with %d rows and %d columns", res->Rows(), res->Cols());
 164
 165                                         if(res->Rows())
 166                                         {
 167                                                 /* We got a row in the result, this is enough really */
 168                                                 user->Extend("sqlauthed");
 169                                         }
 170                                         else if (verbose)
 171                                         {
 172                                                 /* No rows in result, this means there was no record matching the user */
 173                                                 ServerInstance->WriteOpers("Forbidden connection from %s!%s@%s (SQL query returned no matches)", user->nick, user->ident, user->host);
 174                                                 user->Extend("sqlauth_failed");
 175                                         }
 176                                 }
 177                                 else if (verbose)
 178                                 {
 179                                         log(DEBUG, "Query failed: %s", res->error.Str());
 180                                         ServerInstance->WriteOpers("Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick, user->ident, user->host, res->error.Str());
 181                                         user->Extend("sqlauth_failed");
 182                                 }
 183                         }
 184                         else
 185                         {
 186                                 log(DEBUG, "Got query with unknown ID, this probably means the user quit while the query was in progress");
 187                         }
 188
 189                         return SQLSUCCESS;
 190                 }
 191
 192                 log(DEBUG, "Got unsupported API version string: %s", request->GetId());
 193
 194                 return NULL;
 195         }
 196
 197         virtual void OnUserDisconnect(userrec* user)
 198         {
 199                 user->Shrink("sqlauthed");
 200                 user->Shrink("sqlauth_failed");
 201         }
 202
 203         virtual bool OnCheckReady(userrec* user)
 204         {
 205                 if(user->GetExt("sqlauth_failed"))
 206                 {
 207                         userrec::QuitUser(ServerInstance,user,killreason);
 208                         return false;
 209                 }
 210
 211                 return user->GetExt("sqlauthed");
 212         }
 213
 214         virtual ~ModuleSQLAuth()
 215         {
 216         }
 217
 218         virtual Version GetVersion()
 219         {
 220                 return Version(1,0,1,0,VF_VENDOR);
 221         }
 222
 223 };
 224
 225 class ModuleSQLAuthFactory : public ModuleFactory
 226 {
 227  public:
 228         ModuleSQLAuthFactory()
 229         {
 230         }
 231
 232         ~ModuleSQLAuthFactory()
 233         {
 234         }
 235
 236         virtual Module * CreateModule(Server* Me)
 237         {
 238                 return new ModuleSQLAuth(Me);
 239         }
 240
 241 };
 242
 243
 244 extern "C" void * init_module( void )
 245 {
 246         return new ModuleSQLAuthFactory;
 247 }