Remove unused macros and #include <arpa/inet.h>s.
[ircu2.10.12-pk.git] / ircd / s_auth.c
1 /************************************************************************
2  *   IRC - Internet Relay Chat, src/s_auth.c
3  *   Copyright (C) 1992 Darren Reed
4  *
5  *   This program is free software; you can redistribute it and/or modify
6  *   it under the terms of the GNU General Public License as published by
7  *   the Free Software Foundation; either version 1, or (at your option)
8  *   any later version.
9  *
10  *   This program is distributed in the hope that it will be useful,
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *   GNU General Public License for more details.
14  *
15  *   You should have received a copy of the GNU General Public License
16  *   along with this program; if not, write to the Free Software
17  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  *
19  * Changes:
20  *   July 6, 1999 - Rewrote most of the code here. When a client connects
21  *     to the server and passes initial socket validation checks, it
22  *     is owned by this module (auth) which returns it to the rest of the
23  *     server when dns and auth queries are finished. Until the client is
24  *     released, the server does not know it exists and does not process
25  *     any messages from it.
26  *     --Bleep  Thomas Helvey <tomh@inxpress.net>
27  */
28 /** @file
29  * @brief Implementation of DNS and ident lookups.
30  * @version $Id$
31  */
32 #include "config.h"
33
34 #include "s_auth.h"
35 #include "client.h"
36 #include "IPcheck.h"
37 #include "ircd.h"
38 #include "ircd_alloc.h"
39 #include "ircd_chattr.h"
40 #include "ircd_events.h"
41 #include "ircd_features.h"
42 #include "ircd_log.h"
43 #include "ircd_osdep.h"
44 #include "ircd_snprintf.h"
45 #include "ircd_string.h"
46 #include "list.h"
47 #include "numeric.h"
48 #include "querycmds.h"
49 #include "res.h"
50 #include "s_bsd.h"
51 #include "s_debug.h"
52 #include "s_misc.h"
53 #include "send.h"
54 #include "struct.h"
55 #include "sys.h"               /* TRUE bleah */
56
57 #include <netdb.h>             /* struct hostent */
58 #include <string.h>
59 #include <stdlib.h>
60 #include <unistd.h>
61 #include <errno.h>
62 #include <fcntl.h>
63 /* #include <assert.h> -- Now using assert in ircd_log.h */
64 #include <sys/socket.h>
65 #include <sys/file.h>
66 #include <sys/ioctl.h>
67
68 /** Array of message text (with length) pairs for AUTH status
69  * messages.  Indexed using #ReportType. */
70 static struct {
71   const char*  message;
72   unsigned int length;
73 } HeaderMessages [] = {
74 #define MSG(STR) { STR, sizeof(STR) - 1 }
75   MSG("NOTICE AUTH :*** Looking up your hostname\r\n"),
76   MSG("NOTICE AUTH :*** Found your hostname\r\n"),
77   MSG("NOTICE AUTH :*** Found your hostname, cached\r\n"),
78   MSG("NOTICE AUTH :*** Couldn't look up your hostname\r\n"),
79   MSG("NOTICE AUTH :*** Checking Ident\r\n"),
80   MSG("NOTICE AUTH :*** Got ident response\r\n"),
81   MSG("NOTICE AUTH :*** No ident response\r\n"),
82   MSG("NOTICE AUTH :*** Your forward and reverse DNS do not match, "
83     "ignoring hostname.\r\n"),
84   MSG("NOTICE AUTH :*** Invalid hostname\r\n")
85 #undef MSG
86 };
87
88 /** Enum used to index messages in the HeaderMessages[] array. */
89 typedef enum {
90   REPORT_DO_DNS,
91   REPORT_FIN_DNS,
92   REPORT_FIN_DNSC,
93   REPORT_FAIL_DNS,
94   REPORT_DO_ID,
95   REPORT_FIN_ID,
96   REPORT_FAIL_ID,
97   REPORT_IP_MISMATCH,
98   REPORT_INVAL_DNS
99 } ReportType;
100
101 /** Sends response \a r (from #ReportType) to client \a c. */
102 #define sendheader(c, r) \
103    send(cli_fd(c), HeaderMessages[(r)].message, HeaderMessages[(r)].length, 0)
104
105 static void release_auth_client(struct Client* client);
106 void free_auth_request(struct AuthRequest* auth);
107
108 /** Verify that a hostname is valid, i.e., only contains characters
109  * valid for a hostname and that a hostname is not too long.
110  * @param host Hostname to check.
111  * @param maxlen Maximum length of hostname, not including NUL terminator.
112  * @return Non-zero if the hostname is valid.
113  */
114 static int
115 auth_verify_hostname(char *host, int maxlen)
116 {
117   int i;
118
119   /* Walk through the host name */
120   for (i = 0; host[i]; i++)
121     /* If it's not a hostname character or if it's too long, return false */
122     if (!IsHostChar(host[i]) || i >= maxlen)
123       return 0;
124
125   return 1; /* it's a valid hostname */
126 }
127
128 /** Timeout a given auth request.
129  * @param ev A timer event whose associated data is the expired struct
130  * AuthRequest.
131  */
132 static void auth_timeout_callback(struct Event* ev)
133 {
134   struct AuthRequest* auth;
135
136   assert(0 != ev_timer(ev));
137   assert(0 != t_data(ev_timer(ev)));
138
139   auth = (struct AuthRequest*) t_data(ev_timer(ev));
140
141   if (ev_type(ev) == ET_DESTROY) { /* being destroyed */
142     auth->flags &= ~AM_TIMEOUT;
143
144     if (!(auth->flags & AM_FREE_MASK)) {
145       Debug((DEBUG_LIST, "Freeing auth from timeout callback; %p [%p]", auth,
146              ev_timer(ev)));
147       MyFree(auth); /* done with it, finally */
148     }
149   } else {
150     assert(ev_type(ev) == ET_EXPIRE);
151
152     destroy_auth_request(auth, 1);
153   }
154 }
155
156 /** Handle socket I/O activity.
157  * @param ev A socket event whos associated data is the active struct
158  * AuthRequest.
159  */
160 static void auth_sock_callback(struct Event* ev)
161 {
162   struct AuthRequest* auth;
163
164   assert(0 != ev_socket(ev));
165   assert(0 != s_data(ev_socket(ev)));
166
167   auth = (struct AuthRequest*) s_data(ev_socket(ev));
168
169   switch (ev_type(ev)) {
170   case ET_DESTROY: /* being destroyed */
171     auth->flags &= ~AM_SOCKET;
172
173     if (!(auth->flags & AM_FREE_MASK)) {
174       Debug((DEBUG_LIST, "Freeing auth from sock callback; %p [%p]", auth,
175              ev_socket(ev)));
176       MyFree(auth); /* done with it finally */
177     }
178     break;
179
180   case ET_CONNECT: /* socket connection completed */
181     Debug((DEBUG_LIST, "Connection completed for auth %p [%p]; sending query",
182            auth, ev_socket(ev)));
183     socket_state(&auth->socket, SS_CONNECTED);
184     send_auth_query(auth);
185     break;
186
187   case ET_READ: /* socket is readable */
188   case ET_EOF: /* end of file on socket */
189   case ET_ERROR: /* error on socket */
190     Debug((DEBUG_LIST, "Auth socket %p [%p] readable", auth, ev_socket(ev)));
191     read_auth_reply(auth);
192     break;
193
194   default:
195     assert(0 && "Unrecognized event in auth_socket_callback().");
196     break;
197   }
198 }
199
200 /** Stop an auth request completely.
201  * @param auth The struct AuthRequest to cancel.
202  * @param send_reports If non-zero, report the failure to the user and
203  * resolver log.
204  */
205 void destroy_auth_request(struct AuthRequest* auth, int send_reports)
206 {
207   if (IsDoingAuth(auth)) {
208     if (-1 < auth->fd) {
209       close(auth->fd);
210       auth->fd = -1;
211       socket_del(&auth->socket);
212     }
213
214     if (send_reports && IsUserPort(auth->client))
215       sendheader(auth->client, REPORT_FAIL_ID);
216   }
217
218   if (IsDNSPending(auth)) {
219     delete_resolver_queries(auth);
220     if (send_reports && IsUserPort(auth->client))
221       sendheader(auth->client, REPORT_FAIL_DNS);
222   }
223
224   if (send_reports) {
225     log_write(LS_RESOLVER, L_INFO, 0, "DNS/AUTH timeout %s",
226               get_client_name(auth->client, HIDE_IP));
227     release_auth_client(auth->client);
228   }
229
230   free_auth_request(auth);
231 }
232
233 /** Allocate a new auth request.
234  * @param client The client being looked up.
235  * @return The newly allocated auth request.
236  */
237 static struct AuthRequest* make_auth_request(struct Client* client)
238 {
239   struct AuthRequest* auth = 
240                (struct AuthRequest*) MyMalloc(sizeof(struct AuthRequest));
241   assert(0 != auth);
242   memset(auth, 0, sizeof(struct AuthRequest));
243   auth->flags   = AM_TIMEOUT;
244   auth->fd      = -1;
245   auth->client  = client;
246   cli_auth(client) = auth;
247   timer_add(timer_init(&auth->timeout), auth_timeout_callback, (void*) auth,
248             TT_RELATIVE, feature_int(FEAT_AUTH_TIMEOUT));
249   return auth;
250 }
251
252 /** Clean up auth request allocations (event loop objects, etc).
253  * @param auth The request to clean up.
254  */
255 void free_auth_request(struct AuthRequest* auth)
256 {
257   if (-1 < auth->fd) {
258     close(auth->fd);
259     Debug((DEBUG_LIST, "Deleting auth socket for %p", auth->client));
260     socket_del(&auth->socket);
261   }
262   Debug((DEBUG_LIST, "Deleting auth timeout timer for %p", auth->client));
263   timer_del(&auth->timeout);
264 }
265
266 /** Release auth client from auth system.  This adds the client into
267  * the local client lists so it can be read by the main io processing
268  * loop.
269  * @param client The client to release.
270  */
271 static void release_auth_client(struct Client* client)
272 {
273   assert(0 != client);
274   cli_auth(client) = 0;
275   cli_lasttime(client) = cli_since(client) = CurrentTime;
276   if (cli_fd(client) > HighestFd)
277     HighestFd = cli_fd(client);
278   LocalClientArray[cli_fd(client)] = client;
279
280   add_client_to_list(client);
281   socket_events(&(cli_socket(client)), SOCK_ACTION_SET | SOCK_EVENT_READABLE);
282   Debug((DEBUG_INFO, "Auth: release_auth_client %s@%s[%s]",
283          cli_username(client), cli_sockhost(client), cli_sock_ip(client)));
284 }
285
286 /** Terminate a client's connection due to auth failure.
287  * @param auth The client to terminate.
288  */
289 static void auth_kill_client(struct AuthRequest* auth)
290 {
291   assert(0 != auth);
292
293   if (IsDNSPending(auth))
294     delete_resolver_queries(auth);
295   IPcheck_disconnect(auth->client);
296   Count_unknowndisconnects(UserStats);
297   cli_auth(auth->client) = 0;
298   free_client(auth->client);
299   free_auth_request(auth);
300 }
301
302 /** Handle a complete DNS lookup.  Send the client on it's way to a
303  * connection completion, regardless of success or failure -- unless
304  * there was a mismatch and KILL_IPMISMATCH is set.
305  * @param vptr The pending struct AuthRequest.
306  * @param hp Pointer to the DNS reply (or NULL, if lookup failed).
307  */
308 static void auth_dns_callback(void* vptr, struct DNSReply* hp)
309 {
310   struct AuthRequest* auth = (struct AuthRequest*) vptr;
311   assert(auth);
312   /*
313    * need to do this here so auth_kill_client doesn't
314    * try have the resolver delete the query it's about
315    * to delete anyways. --Bleep
316    */
317   ClearDNSPending(auth);
318
319   if (hp) {
320     /*
321      * Verify that the host to ip mapping is correct both ways and that
322      * the ip#(s) for the socket is listed for the host.
323      */
324     if (irc_in_addr_cmp(&hp->addr, &cli_ip(auth->client))) {
325       if (IsUserPort(auth->client))
326         sendheader(auth->client, REPORT_IP_MISMATCH);
327       sendto_opmask_butone(0, SNO_IPMISMATCH, "IP# Mismatch: %s != %s[%s]",
328                            cli_sock_ip(auth->client), hp->h_name,
329                            ircd_ntoa(&hp->addr));
330       if (feature_bool(FEAT_KILL_IPMISMATCH)) {
331         auth_kill_client(auth);
332         return;
333       }
334     }
335     else if (!auth_verify_hostname(hp->h_name, HOSTLEN))
336     {
337       if (IsUserPort(auth->client))
338         sendheader(auth->client, REPORT_INVAL_DNS);
339     }
340     else
341     {
342       cli_dns_reply(auth->client) = hp;
343       ircd_strncpy(cli_sockhost(auth->client), hp->h_name, HOSTLEN);
344       if (IsUserPort(auth->client))
345         sendheader(auth->client, REPORT_FIN_DNS);
346     }
347   }
348   else {
349     /*
350      * this should have already been done by s_bsd.c in add_connection
351      *
352      * strcpy(auth->client->sockhost, auth->client->sock_ip);
353      */
354     if (IsUserPort(auth->client))
355       sendheader(auth->client, REPORT_FAIL_DNS);
356   }
357   if (!IsDoingAuth(auth)) {
358     release_auth_client(auth->client);
359     free_auth_request(auth);
360   }
361 }
362
363 /** Handle auth send errors.
364  * @param auth The request that saw the failure.
365  * @param kill If non-zero, a critical error; close the client's connection.
366  */
367 static void auth_error(struct AuthRequest* auth, int kill)
368 {
369   ++ServerStats->is_abad;
370
371   assert(0 != auth);
372   close(auth->fd);
373   auth->fd = -1;
374   socket_del(&auth->socket);
375
376   if (IsUserPort(auth->client))
377     sendheader(auth->client, REPORT_FAIL_ID);
378
379   if (kill) {
380     /*
381      * we can't read the client info from the client socket,
382      * close the client connection and free the client
383      * Need to do this before we ClearAuth(auth) so we know
384      * which list to remove the query from. --Bleep
385      */
386     auth_kill_client(auth);
387     return;
388   }
389
390   ClearAuth(auth);
391
392   if (!IsDNSPending(auth)) {
393     release_auth_client(auth->client);
394     free_auth_request(auth);
395   }
396 }
397
398 /** Flag the client to show an attempt to contact the ident server on
399  * the client's host.  Should the connect or any later phase of the
400  * identifing process fail, it is aborted and the user is given a
401  * username of "unknown".
402  * @param auth The request for which to start the ident lookup.
403  * @return Non-zero on success; zero if unable to start the lookup.
404  */
405 static int start_auth_query(struct AuthRequest* auth)
406 {
407   struct irc_sockaddr remote_addr;
408   struct irc_sockaddr local_addr;
409   int                fd;
410   IOResult           result;
411
412   assert(0 != auth);
413   assert(0 != auth->client);
414
415   /*
416    * get the local address of the client and bind to that to
417    * make the auth request.  This used to be done only for
418    * ifdef VIRTTUAL_HOST, but needs to be done for all clients
419    * since the ident request must originate from that same address--
420    * and machines with multiple IP addresses are common now
421    */
422   memset(&local_addr, 0, sizeof(local_addr));
423   os_get_sockname(cli_fd(auth->client), &local_addr);
424   local_addr.port = 0;
425   fd = os_socket(&local_addr, SOCK_STREAM, "auth query");
426   if (fd < 0)
427     return 0;
428   if (IsUserPort(auth->client))
429     sendheader(auth->client, REPORT_DO_ID);
430   memcpy(&remote_addr.addr, &cli_ip(auth->client), sizeof(remote_addr.addr));
431   remote_addr.port = 113;
432
433   if ((result = os_connect_nonb(fd, &remote_addr)) == IO_FAILURE ||
434       !socket_add(&auth->socket, auth_sock_callback, (void*) auth,
435                   result == IO_SUCCESS ? SS_CONNECTED : SS_CONNECTING,
436                   SOCK_EVENT_READABLE, fd)) {
437     ServerStats->is_abad++;
438     /*
439      * No error report from this...
440      */
441     close(fd);
442     if (IsUserPort(auth->client))
443       sendheader(auth->client, REPORT_FAIL_ID);
444     return 0;
445   }
446
447   auth->flags |= AM_SOCKET;
448   auth->fd = fd;
449
450   SetAuthConnect(auth);
451   if (result == IO_SUCCESS)
452     send_auth_query(auth); /* this does a SetAuthPending(auth) for us */
453
454   return 1;
455 }
456
457 /** Enum used to index ident reply fields in a human-readable way. */
458 enum IdentReplyFields {
459   IDENT_PORT_NUMBERS,
460   IDENT_REPLY_TYPE,
461   IDENT_OS_TYPE,
462   IDENT_INFO,
463   USERID_TOKEN_COUNT
464 };
465
466 /** Parse an ident reply line and extract the userid from it.
467  * @param reply The ident reply line.
468  * @return The userid, or NULL on parse failure.
469  */
470 static char* check_ident_reply(char* reply)
471 {
472   char* token;
473   char* end;
474   char* vector[USERID_TOKEN_COUNT];
475   int count = token_vector(reply, ':', vector, USERID_TOKEN_COUNT);
476
477   if (USERID_TOKEN_COUNT != count)
478     return 0;
479   /*
480    * second token is the reply type
481    */
482   token = vector[IDENT_REPLY_TYPE];
483   if (EmptyString(token))
484     return 0;
485
486   while (IsSpace(*token))
487     ++token;
488
489   if (0 != strncmp(token, "USERID", 6))
490     return 0;
491
492   /*
493    * third token is the os type
494    */
495   token = vector[IDENT_OS_TYPE];
496   if (EmptyString(token))
497     return 0;
498   while (IsSpace(*token))
499    ++token;
500
501   /*
502    * Unless "OTHER" is specified as the operating system
503    * type, the server is expected to return the "normal"
504    * user identification of the owner of this connection.
505    * "Normal" in this context may be taken to mean a string
506    * of characters which uniquely identifies the connection
507    * owner such as a user identifier assigned by the system
508    * administrator and used by such user as a mail
509    * identifier, or as the "user" part of a user/password
510    * pair used to gain access to system resources.  When an
511    * operating system is specified (e.g., anything but
512    * "OTHER"), the user identifier is expected to be in a
513    * more or less immediately useful form - e.g., something
514    * that could be used as an argument to "finger" or as a
515    * mail address.
516    */
517   if (0 == strncmp(token, "OTHER", 5))
518     return 0;
519   /*
520    * fourth token is the username
521    */
522   token = vector[IDENT_INFO];
523   if (EmptyString(token))
524     return 0;
525   while (IsSpace(*token))
526     ++token;
527   /*
528    * look for the end of the username, terminators are '\0, @, <SPACE>, :'
529    */
530   for (end = token; *end; ++end) {
531     if (IsSpace(*end) || '@' == *end || ':' == *end)
532       break;
533   }
534   *end = '\0'; 
535   return token;
536 }
537
538 /** Starts auth (identd) and dns queries for a client.
539  * @param client The client for which to start queries.
540  */
541 void start_auth(struct Client* client)
542 {
543   struct AuthRequest* auth = 0;
544
545   assert(0 != client);
546
547   auth = make_auth_request(client);
548   assert(0 != auth);
549
550   Debug((DEBUG_INFO, "Beginning auth request on client %p", client));
551
552   if (!feature_bool(FEAT_NODNS)) {
553     if (irc_in_addr_is_loopback(&cli_ip(client)))
554       strcpy(cli_sockhost(client), cli_name(&me));
555     else {
556       struct DNSQuery query;
557
558       query.vptr     = auth;
559       query.callback = auth_dns_callback;
560
561       if (IsUserPort(auth->client))
562         sendheader(client, REPORT_DO_DNS);
563
564       gethost_byaddr(&cli_ip(client), &query);
565       SetDNSPending(auth);
566     }
567   }
568
569   if (start_auth_query(auth)) {
570     Debug((DEBUG_LIST, "identd query for %p initiated successfully",
571            auth->client));
572   } else if (IsDNSPending(auth)) {
573     Debug((DEBUG_LIST, "identd query for %p not initiated successfully; "
574            "waiting on DNS", auth->client));
575   } else {
576     Debug((DEBUG_LIST, "identd query for %p not initiated successfully; "
577            "no DNS pending; releasing immediately", auth->client));
578     free_auth_request(auth);
579     release_auth_client(client);
580   }
581 }
582
583 /** Send the ident server a query giving "theirport , ourport". The
584  * write is only attempted *once* so it is deemed to be a fail if the
585  * entire write doesn't write all the data given.  This shouldnt be a
586  * problem since the socket should have a write buffer far greater
587  * than this message to store it in should problems arise. -avalon
588  * @param auth The request to send.
589  */
590 void send_auth_query(struct AuthRequest* auth)
591 {
592   struct irc_sockaddr us;
593   struct irc_sockaddr them;
594   char               authbuf[32];
595   unsigned int       count;
596
597   assert(0 != auth);
598   assert(0 != auth->client);
599
600   if (!os_get_sockname(cli_fd(auth->client), &us) ||
601       !os_get_peername(cli_fd(auth->client), &them)) {
602     auth_error(auth, 1);
603     return;
604   }
605   ircd_snprintf(0, authbuf, sizeof(authbuf), "%u , %u\r\n",
606                 (unsigned int) them.port,
607                 (unsigned int) us.port);
608
609   if (IO_SUCCESS == os_send_nonb(auth->fd, authbuf, strlen(authbuf), &count)) {
610     ClearAuthConnect(auth);
611     SetAuthPending(auth);
612   }
613   else
614     auth_error(auth, 0);
615 }
616
617
618 /** Read the reply (if any) from the ident server we connected to.  We
619  * only give it one shot, if the reply isn't good the first time fail
620  * the authentication entirely. --Bleep
621  * @param auth The request to read.
622  */
623 void read_auth_reply(struct AuthRequest* auth)
624 {
625   char*        username = 0;
626   unsigned int len;
627   /*
628    * rfc1453 sez we MUST accept 512 bytes
629    */
630   char   buf[BUFSIZE + 1];
631
632   assert(0 != auth);
633   assert(0 != auth->client);
634   assert(auth == cli_auth(auth->client));
635
636   if (IO_SUCCESS == os_recv_nonb(auth->fd, buf, BUFSIZE, &len)) {
637     buf[len] = '\0';
638     Debug((DEBUG_LIST, "Auth %p [%p] reply: %s", auth, &auth->socket, buf));
639     username = check_ident_reply(buf);
640     Debug((DEBUG_LIST, "Username: %s", username));
641   }
642
643   close(auth->fd);
644   auth->fd = -1;
645   Debug((DEBUG_LIST, "Deleting auth [%p] socket %p", auth, &auth->socket));
646   socket_del(&auth->socket);
647   ClearAuth(auth);
648
649   if (!EmptyString(username)) {
650     ircd_strncpy(cli_username(auth->client), username, USERLEN);
651     /*
652      * Not needed, struct is zeroed by memset
653      * auth->client->username[USERLEN] = '\0';
654      */
655     SetGotId(auth->client);
656     ++ServerStats->is_asuc;
657     if (IsUserPort(auth->client))
658       sendheader(auth->client, REPORT_FIN_ID);
659   }
660   else {
661     ++ServerStats->is_abad;
662   }
663
664   if (!IsDNSPending(auth)) {
665     release_auth_client(auth->client);
666     free_auth_request(auth);
667   }
668 }