1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
16 #include "m_sqlutils.h"
19 /* $ModDesc: Allow/Deny connections based upon an arbitary SQL table */
20 /* $ModDep: m_sqlv2.h m_sqlutils.h m_hash.h */
22 class ModuleSQLAuth : public Module
27 std::string freeformquery;
28 std::string killreason;
29 std::string allowpattern;
30 std::string databaseid;
35 ModuleSQLAuth(InspIRCd* Me)
38 ServerInstance->Modules->UseInterface("SQLutils");
39 ServerInstance->Modules->UseInterface("SQL");
41 SQLutils = ServerInstance->Modules->Find("m_sqlutils.so");
43 throw ModuleException("Can't find m_sqlutils.so. Please load m_sqlutils.so before m_sqlauth.so.");
45 SQLprovider = ServerInstance->Modules->FindFeature("SQL");
47 throw ModuleException("Can't find an SQL provider module. Please load one before attempting to load m_sqlauth.");
50 Implementation eventlist[] = { I_OnUserDisconnect, I_OnCheckReady, I_OnRequest, I_OnRehash, I_OnUserRegister };
51 ServerInstance->Modules->Attach(eventlist, this, 5);
54 virtual ~ModuleSQLAuth()
56 ServerInstance->Modules->DoneWithInterface("SQL");
57 ServerInstance->Modules->DoneWithInterface("SQLutils");
61 virtual void OnRehash(User* user)
63 ConfigReader Conf(ServerInstance);
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 */
72 virtual ModResult OnUserRegister(User* user)
74 if ((!allowpattern.empty()) && (InspIRCd::Match(user->nick,allowpattern)))
76 user->Extend("sqlauthed");
77 return MOD_RES_PASSTHRU;
80 if (!CheckCredentials(user))
82 ServerInstance->Users->QuitUser(user, killreason);
85 return MOD_RES_PASSTHRU;
88 bool CheckCredentials(User* user)
90 std::string thisquery = freeformquery;
91 std::string safepass = user->password;
92 std::string safegecos = user->fullname;
94 /* Search and replace the escaped nick and escaped pass into the query */
96 SearchAndReplace(safepass, std::string("\""), std::string("\\\""));
97 SearchAndReplace(safegecos, std::string("\""), std::string("\\\""));
99 SearchAndReplace(thisquery, std::string("$nick"), user->nick);
100 SearchAndReplace(thisquery, std::string("$pass"), safepass);
101 SearchAndReplace(thisquery, std::string("$host"), user->host);
102 SearchAndReplace(thisquery, std::string("$ip"), std::string(user->GetIPString()));
103 SearchAndReplace(thisquery, std::string("$gecos"), safegecos);
104 SearchAndReplace(thisquery, std::string("$ident"), user->ident);
105 SearchAndReplace(thisquery, std::string("$server"), std::string(user->server));
106 SearchAndReplace(thisquery, std::string("$uuid"), user->uuid);
108 Module* HashMod = ServerInstance->Modules->Find("m_md5.so");
112 HashResetRequest(this, HashMod).Send();
113 SearchAndReplace(thisquery, std::string("$md5pass"), std::string(HashSumRequest(this, HashMod, user->password).Send()));
116 HashMod = ServerInstance->Modules->Find("m_sha256.so");
120 HashResetRequest(this, HashMod).Send();
121 SearchAndReplace(thisquery, std::string("$sha256pass"), std::string(HashSumRequest(this, HashMod, user->password).Send()));
124 /* Build the query */
125 SQLrequest req = SQLrequest(this, SQLprovider, databaseid, SQLquery(thisquery));
129 /* When we get the query response from the service provider we will be given an ID to play with,
130 * just an ID number which is unique to this query. We need a way of associating that ID with a User
131 * so we insert it into a map mapping the IDs to users.
132 * Thankfully m_sqlutils provides this, it will associate a ID with a user or channel, and if the user quits it removes the
133 * association. This means that if the user quits during a query we will just get a failed lookup from m_sqlutils - telling
134 * us to discard the query.
136 AssociateUser(this, SQLutils, req.id, user).Send();
143 ServerInstance->SNO->WriteGlobalSno('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());
148 virtual const char* OnRequest(Request* request)
150 if(strcmp(SQLRESID, request->GetId()) == 0)
152 SQLresult* res = static_cast<SQLresult*>(request);
154 User* user = GetAssocUser(this, SQLutils, res->id).S().user;
155 UnAssociate(this, SQLutils, res->id).S();
159 if(res->error.Id() == SQL_NO_ERROR)
163 /* We got a row in the result, this is enough really */
164 user->Extend("sqlauthed");
168 /* No rows in result, this means there was no record matching the user */
169 ServerInstance->SNO->WriteGlobalSno('a', "Forbidden connection from %s!%s@%s (SQL query returned no matches)", user->nick.c_str(), user->ident.c_str(), user->host.c_str());
170 user->Extend("sqlauth_failed");
175 ServerInstance->SNO->WriteGlobalSno('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());
176 user->Extend("sqlauth_failed");
184 if (!user->GetExt("sqlauthed"))
186 ServerInstance->Users->QuitUser(user, killreason);
193 virtual void OnUserDisconnect(User* user)
195 user->Shrink("sqlauthed");
196 user->Shrink("sqlauth_failed");
199 virtual ModResult OnCheckReady(User* user)
201 return user->GetExt("sqlauthed") ? MOD_RES_PASSTHRU : MOD_RES_DENY;
204 virtual Version GetVersion()
206 return Version("$Id$", VF_VENDOR, API_VERSION);
211 MODULE_INIT(ModuleSQLAuth)