src/modules/extra/m_sqlauth.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 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 "m_sqlv2.h"
  16 #include "m_sqlutils.h"
  17 #include "m_hash.h"
  18
  19 /* $ModDesc: Allow/Deny connections based upon an arbitary SQL table */
  20 /* $ModDep: m_sqlv2.h m_sqlutils.h m_hash.h */
  21
  22 class ModuleSQLAuth : public Module
  23 {
  24         Module* SQLutils;
  25         Module* SQLprovider;
  26
  27         std::string freeformquery;
  28         std::string killreason;
  29         std::string allowpattern;
  30         std::string databaseid;
  31
  32         bool verbose;
  33
  34 public:
  35         ModuleSQLAuth(InspIRCd* Me)
  36         : Module(Me)
  37         {
  38                 ServerInstance->Modules->UseInterface("SQLutils");
  39                 ServerInstance->Modules->UseInterface("SQL");
  40
  41                 SQLutils = ServerInstance->Modules->Find("m_sqlutils.so");
  42                 if (!SQLutils)
  43                         throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqlauth.so.");
  44
  45                 SQLprovider = ServerInstance->Modules->FindFeature("SQL");
  46                 if (!SQLprovider)
  47                         throw ModuleException("Can't find an SQL provider module. Please load one before attempting to load m_sqlauth.");
  48
  49                 OnRehash(NULL,"");
  50                 Implementation eventlist[] = { I_OnUserDisconnect, I_OnCheckReady, I_OnRequest, I_OnRehash, I_OnUserRegister };
  51                 ServerInstance->Modules->Attach(eventlist, this, 5);
  52         }
  53
  54         virtual ~ModuleSQLAuth()
  55         {
  56                 ServerInstance->Modules->DoneWithInterface("SQL");
  57                 ServerInstance->Modules->DoneWithInterface("SQLutils");
  58         }
  59
  60
  61         virtual void OnRehash(User* user, const std::string &parameter)
  62         {
  63                 ConfigReader Conf(ServerInstance);
  64
  65                 databaseid      = Conf.ReadValue("sqlauth", "dbid", 0);                 /* Database ID, given to the SQL service provider */
  66                 freeformquery   = Conf.ReadValue("sqlauth", "query", 0);        /* Field name where username can be found */
  67                 killreason      = Conf.ReadValue("sqlauth", "killreason", 0);   /* Reason to give when access is denied to a user (put your reg details here) */
  68                 allowpattern    = Conf.ReadValue("sqlauth", "allowpattern",0 ); /* Allow nicks matching this pattern without requiring auth */
  69                 verbose         = Conf.ReadFlag("sqlauth", "verbose", 0);               /* Set to true if failed connects should be reported to operators */
  70         }
  71
  72         virtual int OnUserRegister(User* user)
  73         {
  74                 if ((!allowpattern.empty()) && (InspIRCd::Match(user->nick,allowpattern)))
  75                 {
  76                         user->Extend("sqlauthed");
  77                         return 0;
  78                 }
  79
  80                 if (!CheckCredentials(user))
  81                 {
  82                         ServerInstance->Users->QuitUser(user, killreason);
  83                         return 1;
  84                 }
  85                 return 0;
  86         }
  87
  88         bool CheckCredentials(User* user)
  89         {
  90                 std::string thisquery = freeformquery;
  91                 std::string safepass = user->password;
  92
  93                 /* Search and replace the escaped nick and escaped pass into the query */
  94
  95                 SearchAndReplace(safepass, "\"", "");
  96
  97                 SearchAndReplace(thisquery, "$nick", user->nick);
  98                 SearchAndReplace(thisquery, "$pass", safepass);
  99                 SearchAndReplace(thisquery, "$host", user->host);
 100                 SearchAndReplace(thisquery, "$ip", user->GetIPString());
 101                 SearchAndReplace(thisquery, "$gecos", user->fullname);
 102                 SearchAndReplace(thisquery, "$ident", user->ident);
 103                 SearchAndReplace(thisquery, "$server", user->server);
 104                 SearchAndReplace(thisquery, "$uuid", user->uuid);
 105
 106                 Module* HashMod = ServerInstance->Modules->Find("m_md5.so");
 107
 108                 if (HashMod)
 109                 {
 110                         HashResetRequest(this, HashMod).Send();
 111                         SearchAndReplace(thisquery, "$md5pass", HashSumRequest(this, HashMod, user->password).Send());
 112                 }
 113
 114                 HashMod = ServerInstance->Modules->Find("m_sha256.so");
 115
 116                 if (HashMod)
 117                 {
 118                         HashResetRequest(this, HashMod).Send();
 119                         SearchAndReplace(thisquery, "$sha256pass", HashSumRequest(this, HashMod, user->password).Send());
 120                 }
 121
 122                 /* Build the query */
 123                 SQLrequest req = SQLrequest(this, SQLprovider, databaseid, SQLquery(thisquery));
 124
 125                 if(req.Send())
 126                 {
 127                         /* When we get the query response from the service provider we will be given an ID to play with,
 128                          * just an ID number which is unique to this query. We need a way of associating that ID with a User
 129                          * so we insert it into a map mapping the IDs to users.
 130                          * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
 131                          * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
 132                          * us to discard the query.
 133                          */
 134                         AssociateUser(this, SQLutils, req.id, user).Send();
 135
 136                         return true;
 137                 }
 138                 else
 139                 {
 140                         if (verbose)
 141                                 ServerInstance->SNO->WriteToSnoMask('A', "Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick.c_str(), user->ident.c_str(), user->host.c_str(), req.error.Str());
 142                         return false;
 143                 }
 144         }
 145
 146         virtual const char* OnRequest(Request* request)
 147         {
 148                 if(strcmp(SQLRESID, request->GetId()) == 0)
 149                 {
 150                         SQLresult* res = static_cast<SQLresult*>(request);
 151
 152                         User* user = GetAssocUser(this, SQLutils, res->id).S().user;
 153                         UnAssociate(this, SQLutils, res->id).S();
 154
 155                         if(user)
 156                         {
 157                                 if(res->error.Id() == SQL_NO_ERROR)
 158                                 {
 159                                         if(res->Rows())
 160                                         {
 161                                                 /* We got a row in the result, this is enough really */
 162                                                 user->Extend("sqlauthed");
 163                                         }
 164                                         else if (verbose)
 165                                         {
 166                                                 /* No rows in result, this means there was no record matching the user */
 167                                                 ServerInstance->SNO->WriteToSnoMask('A', "Forbidden connection from %s!%s@%s (SQL query returned no matches)", user->nick.c_str(), user->ident.c_str(), user->host.c_str());
 168                                                 user->Extend("sqlauth_failed");
 169                                         }
 170                                 }
 171                                 else if (verbose)
 172                                 {
 173                                         ServerInstance->SNO->WriteToSnoMask('A', "Forbidden connection from %s!%s@%s (SQL query failed: %s)", user->nick.c_str(), user->ident.c_str(), user->host.c_str(), res->error.Str());
 174                                         user->Extend("sqlauth_failed");
 175                                 }
 176                         }
 177                         else
 178                         {
 179                                 return NULL;
 180                         }
 181
 182                         if (!user->GetExt("sqlauthed"))
 183                         {
 184                                 ServerInstance->Users->QuitUser(user, killreason);
 185                         }
 186                         return SQLSUCCESS;
 187                 }
 188                 return NULL;
 189         }
 190
 191         virtual void OnUserDisconnect(User* user)
 192         {
 193                 user->Shrink("sqlauthed");
 194                 user->Shrink("sqlauth_failed");
 195         }
 196
 197         virtual bool OnCheckReady(User* user)
 198         {
 199                 return user->GetExt("sqlauthed");
 200         }
 201
 202         virtual Version GetVersion()
 203         {
 204                 return Version("$Id$", VF_VENDOR, API_VERSION);
 205         }
 206
 207 };
 208
 209 MODULE_INIT(ModuleSQLAuth)