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