summaryrefslogtreecommitdiff
path: root/src/modules/m_ident.cpp
blob: b5bc9e435f9f250c66b593c9c4d14c45fe2566aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
/*       +------------------------------------+
 *       | Inspire Internet Relay Chat Daemon |
 *       +------------------------------------+
 *
 *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
 *                       E-mail:
 *                <brain@chatspike.net>
 *           	  <Craig@chatspike.net>
 *     
 * Written by Craig Edwards, Craig McLure, and others.
 * This program is free but copyrighted software; see
 *            the file COPYING for details.
 *
 * ---------------------------------------------------
 */

using namespace std;

#include <stdio.h>
#include <string>
#include <stdlib.h>
#include <time.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/time.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>
#include <fcntl.h>
#include <poll.h>
#include "users.h"
#include "channels.h"
#include "modules.h"
#include "inspircd.h"

/* $ModDesc: Provides support for RFC 1413 ident lookups */

Server *Srv;

// State engine constants. We have three states,
// connecting, waiting for data, and finished.

#define IDENT_STATE_CONNECT	1
#define IDENT_STATE_WAITDATA	2
#define IDENT_STATE_DONE	3

// Ident lookups are done by attaching an RFC1413 class to the
// userrec record using the Extensible system.
// The RFC1413 class is written especially for this module but
// it should be relatively standalone for anyone else who wishes
// to have a nonblocking ident lookup in a program :)
// the class operates on a simple state engine, each state of the
// connection incrementing a state counter, leading through to
// a concluding state which terminates the lookup.

class RFC1413
{
 protected:
	int fd;			 // file descriptor
	userrec* u;		 // user record that the lookup is associated with
	sockaddr_in addr;	 // address we're connecting to
	in_addr addy;		 // binary ip address
	int state;		 // state (this class operates on a state engine)
	char ibuf[MAXBUF];	 // input buffer
	sockaddr_in sock_us;	 // our port number
	sockaddr_in sock_them;	 // their port number
	socklen_t uslen;	 // length of our port number
	socklen_t themlen;	 // length of their port number
	int nrecv;		 // how many bytes we've received
	time_t timeout_end;	 // how long until the operation times out
	bool timeout;		 // true if we've timed out and should bail
	char ident_request[128]; // buffer used to make up the request string
 public:

	// The destructor makes damn sure the socket is freed :)

	~RFC1413()
	{
		if (this->fd != -1)
		{
			shutdown(this->fd,2);
			close(this->fd);
			this->fd = -1;
		}
	}

	// establish an ident connection, maxtime is the time to spend trying
	// returns true if successful, false if something was catastrophically wrong.
	// note that failed connects are not reported here but detected in RFC1413::Poll()
	// as the socket is nonblocking

	bool Connect(userrec* user, int maxtime)
	{
		timeout_end = time(NULL)+maxtime;
		timeout = false;
		if ((this->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
		{
			// theres been a boo-boo... no more fd's left for us, woe is me!
			Srv->Log(DEBUG,"Ident: socket failed for: "+std::string(user->ip));
			return false;
		}
		inet_aton(user->ip,&addy);
		addr.sin_family = AF_INET;
		addr.sin_addr = addy;
		addr.sin_port = htons(113);

                int flags;
                flags = fcntl(this->fd, F_GETFL, 0);
                fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);

		if(connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
		{
			// theres been an error, but EINPROGRESS just means 'right, im on it, call me later'
			if (errno != EINPROGRESS)
			{
				// ... so that error isnt fatal, like the rest.
				Srv->Log(DEBUG,"Ident: connect failed for: "+std::string(user->ip));
				shutdown(this->fd,2);
                                close(this->fd);
				this->fd = -1;
	                        return false;
			}
                }
		Srv->Log(DEBUG,"Ident: successful connect associated with user "+std::string(user->nick));
		this->u = user;
		this->state = IDENT_STATE_CONNECT;
		return true;
	}

	// Poll the socket to see if we have an ident result, and if we do apply it to the user.
	// returns false if we cannot poll for some reason (e.g. timeout).

	bool Poll()
	{
		if (time(NULL) > timeout_end)
		{
			timeout = true;
			Srv->SendServ(u->fd,"NOTICE "+std::string(u->nick)+" :*** Could not find your ident, using "+std::string(u->ident)+" instead.");
			shutdown(this->fd,2);
			close(this->fd);
			this->fd = -1;
			return false;
		}
		pollfd polls;
		polls.fd = this->fd;
		if (state == IDENT_STATE_CONNECT)
		{
			// during state IDENT_STATE_CONNECT (leading up to the connect)
			// we're watching for writeability
			polls.events = POLLOUT;
		}
		else
		{
			// the rest of the time we're waiting for data
			// back on the socket, or a socket close
			polls.events = POLLIN;
		}
		int ret = poll(&polls,1,1);

		if (ret > 0)
		{
			switch (this->state)
			{
				case IDENT_STATE_CONNECT:
					uslen = sizeof(sock_us);
					themlen = sizeof(sock_them);
					if ((getsockname(this->u->fd,(sockaddr*)&sock_us,&uslen) || getpeername(this->u->fd, (sockaddr*)&sock_them, &themlen)))
					{
						Srv->Log(DEBUG,"Ident: failed to get socket names, bailing to state 3");
						shutdown(this->fd,2);
                                                close(this->fd);
						this->fd = -1;
						state = IDENT_STATE_DONE;
					}
					else
					{
						// send the request in the following format: theirsocket,oursocket
						snprintf(ident_request,127,"%d,%d\r\n",ntohs(sock_them.sin_port),ntohs(sock_us.sin_port));
						send(this->fd,ident_request,strlen(ident_request),0);
						Srv->Log(DEBUG,"Sent ident request, moving to state 2");
						state = IDENT_STATE_WAITDATA;
					}
				break;
				case IDENT_STATE_WAITDATA:
					nrecv = recv(this->fd,ibuf,sizeof(ibuf),0);
					if (nrecv > 0)
					{
						// we have the response line in the following format:
						// 6193, 23 : USERID : UNIX : stjohns
						// 6195, 23 : ERROR : NO-USER
						ibuf[nrecv] = '\0';
						Srv->Log(DEBUG,"Received ident response: "+std::string(ibuf));
						shutdown(this->fd,2);
						close(this->fd);
						this->fd = -1;
						char* savept;
						char* section = strtok_r(ibuf,":",&savept);
						while (section)
						{
							if (strstr(section,"USERID"))
							{
								section = strtok_r(NULL,":",&savept);
								if (section)
								{
									// ID type, usually UNIX or OTHER... we dont want it, so read the next token
									section = strtok_r(NULL,":",&savept);
									if (section)
									{
										while ((*section == ' ') && (strlen(section)>0)) section++; // strip leading spaces
										int t = strlen(section);
										for (int j = 0; j < t; j++)
											if ((section[j] < 33) || (section[j]>126))
												section[j] = '\0'; // truncate at invalid chars
										if (strlen(section))
										{
											strlcpy(u->ident,section,IDENTMAX);
											Srv->Log(DEBUG,"IDENT SET: "+std::string(u->ident));
											Srv->SendServ(u->fd,"NOTICE "+std::string(u->nick)+" :*** Found your ident: "+std::string(u->ident));
										}
										break;
									}
								}
							}
							section = strtok_r(NULL,":",&savept);
						}
						state = IDENT_STATE_DONE;
					}
				break;
				case IDENT_STATE_DONE:
					shutdown(this->fd,2);
					close(this->fd);
					this->fd = -1;
					Srv->Log(DEBUG,"Ident lookup is complete!");
				break;
				default:
					Srv->Log(DEBUG,"Ident: invalid ident state!!!");
				break;
			}
		}
		return true;
	}

	// returns true if the operation is completed,
	// either due to complete request, or a timeout

	bool Done()
	{
		return ((state == IDENT_STATE_DONE) || (timeout == true));
	}
};

class ModuleIdent : public Module
{

	ConfigReader* Conf;
	int IdentTimeout;

 public:
	void ReadSettings()
	{
		Conf = new ConfigReader;
		IdentTimeout = Conf->ReadInteger("ident","timeout",0,true);
		delete Conf;
	}

	ModuleIdent(Server* Me)
		: Module::Module(Me)
	{
		Srv = Me;
		ReadSettings();
	}

	void Implements(char* List)
	{
		List[I_OnRehash] = List[I_OnUserRegister] = List[I_OnCheckReady] = List[I_OnUserDisconnect] = 1;
	}

	virtual void OnRehash(std::string parameter)
	{
		ReadSettings();
	}

	virtual void OnUserRegister(userrec* user)
	{
		// when the new user connects, before they authenticate with USER/NICK/PASS, we do
		// their ident lookup.

		RFC1413* ident = new RFC1413;
		Srv->SendServ(user->fd,"NOTICE "+std::string(user->nick)+" :*** Looking up your ident...");
		if (ident->Connect(user,IdentTimeout))
		{
			// attach the object to the user record
			user->Extend("ident_data",(char*)ident);
			// start it off polling (always good to have a head start)
			// because usually connect has completed by now
			ident->Poll();
		}
		else
		{
			// something went wrong, call an irc-ambulance!
			Srv->SendServ(user->fd,"NOTICE "+std::string(user->nick)+" :*** Could not look up your ident.");
			delete ident;
		}
	}

	virtual bool OnCheckReady(userrec* user)
	{
		RFC1413* ident = (RFC1413*)user->GetExt("ident_data");
		if (ident)
		{
			// this user has a pending ident lookup, poll it
			ident->Poll();
			// is it done?
			if (ident->Done())
			{
				// their ident is done, zap the structures
				Srv->Log(DEBUG,"Ident: removing ident gubbins");
				user->Shrink("ident_data");
				delete ident;
				// ...and send them on their way
				return true;
			}
			// nope, we hold them in this state, they dont go anywhere
			return false;
		}
		return true;
	}

        virtual void OnUserDisconnect(userrec* user)
        {
                // when the user quits tidy up any ident lookup they have pending to keep things tidy
                // and to prevent a memory and FD leaks
		RFC1413* ident = (RFC1413*)user->GetExt("ident_data");
                if (ident)
                {
                        delete ident;
                        user->Shrink("ident_data");
                }
        }
	
	virtual ~ModuleIdent()
	{
	}
	
	virtual Version GetVersion()
	{
		return Version(1,0,0,1,VF_VENDOR);
	}
	
};

class ModuleIdentFactory : public ModuleFactory
{
 public:
	ModuleIdentFactory()
	{
	}
	
	~ModuleIdentFactory()
	{
	}
	
	virtual Module * CreateModule(Server* Me)
	{
		return new ModuleIdent(Me);
	}
	
};


extern "C" void * init_module( void )
{
	return new ModuleIdentFactory;
}