Give iauth its full share of time to respond.
[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  *  December 26, 2005 - Rewrite the flag handling and integrate that with
29  *     an IRCnet-style IAuth protocol.
30  *     -- Michael Poole
31  */
32 /** @file
33  * @brief Implementation of DNS and ident lookups.
34  * @version $Id$
35  */
36 #include "config.h"
37
38 #include "s_auth.h"
39 #include "class.h"
40 #include "client.h"
41 #include "IPcheck.h"
42 #include "ircd.h"
43 #include "ircd_alloc.h"
44 #include "ircd_chattr.h"
45 #include "ircd_events.h"
46 #include "ircd_features.h"
47 #include "ircd_log.h"
48 #include "ircd_osdep.h"
49 #include "ircd_reply.h"
50 #include "ircd_snprintf.h"
51 #include "ircd_string.h"
52 #include "list.h"
53 #include "msg.h"        /* for MAXPARA */
54 #include "numeric.h"
55 #include "querycmds.h"
56 #include "random.h"
57 #include "res.h"
58 #include "s_bsd.h"
59 #include "s_conf.h"
60 #include "s_debug.h"
61 #include "s_misc.h"
62 #include "s_user.h"
63 #include "send.h"
64
65 #include <errno.h>
66 #include <string.h>
67 #include <stdlib.h>
68 #include <unistd.h>
69 #include <fcntl.h>
70 #include <sys/socket.h>
71 #include <sys/ioctl.h>
72
73 /** Pending operations during registration. */
74 enum AuthRequestFlag {
75     AR_AUTH_PENDING,    /**< ident connecting or waiting for response */
76     AR_DNS_PENDING,     /**< dns request sent, waiting for response */
77     AR_CAP_PENDING,     /**< in middle of CAP negotiations */
78     AR_NEEDS_PONG,      /**< user has not PONGed */
79     AR_NEEDS_USER,      /**< user must send USER command */
80     AR_NEEDS_NICK,      /**< user must send NICK command */
81     AR_LAST_SCAN = AR_NEEDS_NICK, /**< maximum flag to scan through */
82     AR_IAUTH_PENDING,   /**< iauth request sent, waiting for response */
83     AR_IAUTH_HURRY,     /**< we told iauth to hurry up */
84     AR_IAUTH_USERNAME,  /**< iauth sent a username (preferred or forced) */
85     AR_IAUTH_FUSERNAME, /**< iauth sent a forced username */
86     AR_PASSWORD_CHECKED, /**< client password already checked */
87     AR_NUM_FLAGS
88 };
89
90 DECLARE_FLAGSET(AuthRequestFlags, AR_NUM_FLAGS);
91
92 /** Stores registration state of a client. */
93 struct AuthRequest {
94   struct AuthRequest* next;       /**< linked list node ptr */
95   struct AuthRequest* prev;       /**< linked list node ptr */
96   struct Client*      client;     /**< pointer to client struct for request */
97   struct irc_sockaddr local;      /**< local endpoint address */
98   struct irc_in_addr  original;   /**< original client IP address */
99   struct Socket       socket;     /**< socket descriptor for auth queries */
100   struct Timer        timeout;    /**< timeout timer for ident and dns queries */
101   struct AuthRequestFlags flags;  /**< current state of request */
102   unsigned int        cookie;     /**< cookie the user must PONG */
103   unsigned short      port;       /**< client's remote port number */
104 };
105
106 /** Array of message text (with length) pairs for AUTH status
107  * messages.  Indexed using #ReportType.
108  */
109 static struct {
110   const char*  message;
111   unsigned int length;
112 } HeaderMessages [] = {
113 #define MSG(STR) { STR, sizeof(STR) - 1 }
114   MSG("NOTICE AUTH :*** Looking up your hostname\r\n"),
115   MSG("NOTICE AUTH :*** Found your hostname\r\n"),
116   MSG("NOTICE AUTH :*** Couldn't look up your hostname\r\n"),
117   MSG("NOTICE AUTH :*** Checking Ident\r\n"),
118   MSG("NOTICE AUTH :*** Got ident response\r\n"),
119   MSG("NOTICE AUTH :*** No ident response\r\n"),
120   MSG("NOTICE AUTH :*** \r\n"),
121   MSG("NOTICE AUTH :*** Your forward and reverse DNS do not match, "
122     "ignoring hostname.\r\n"),
123   MSG("NOTICE AUTH :*** Invalid hostname\r\n")
124 #undef MSG
125 };
126
127 /** Enum used to index messages in the HeaderMessages[] array. */
128 typedef enum {
129   REPORT_DO_DNS,
130   REPORT_FIN_DNS,
131   REPORT_FAIL_DNS,
132   REPORT_DO_ID,
133   REPORT_FIN_ID,
134   REPORT_FAIL_ID,
135   REPORT_FAIL_IAUTH,
136   REPORT_IP_MISMATCH,
137   REPORT_INVAL_DNS
138 } ReportType;
139
140 /** Sends response \a r (from #ReportType) to client \a c. */
141 #define sendheader(c, r) \
142    send(cli_fd(c), HeaderMessages[(r)].message, HeaderMessages[(r)].length, 0)
143
144 /** Enumeration of IAuth connection flags. */
145 enum IAuthFlag
146 {
147   IAUTH_BLOCKED,                        /**< socket buffer full */
148   IAUTH_CLOSING,                        /**< candidate to be disposed */
149   /* The following flags are controlled by iauth's "O" options command. */
150   IAUTH_ADDLINFO,                       /**< Send additional info
151                                          * (password and username). */
152   IAUTH_FIRST_OPTION = IAUTH_ADDLINFO,  /**< First flag that is a policy option. */
153   IAUTH_REQUIRED,                       /**< IAuth completion required for registration. */
154   IAUTH_TIMEOUT,                        /**< Refuse new connections if IAuth is behind. */
155   IAUTH_EXTRAWAIT,                      /**< Give IAuth extra time to answer. */
156   IAUTH_UNDERNET,                       /**< Enable Undernet extensions. */
157   IAUTH_LAST_FLAG                       /**< total number of flags */
158 };
159 /** Declare a bitset structure indexed by IAuthFlag. */
160 DECLARE_FLAGSET(IAuthFlags, IAUTH_LAST_FLAG);
161
162 /** Describes state of an IAuth connection. */
163 struct IAuth {
164   struct MsgQ i_sendQ;                  /**< messages queued to send */
165   struct Socket i_socket;               /**< main socket to iauth */
166   struct Socket i_stderr;               /**< error socket for iauth */
167   struct IAuthFlags i_flags;            /**< connection state/status/flags */
168   uint64_t i_recvB;                     /**< bytes received */
169   uint64_t i_sendB;                     /**< bytes sent */
170   time_t started;                       /**< time that this instance was started */
171   unsigned int i_recvM;                 /**< messages received */
172   unsigned int i_sendM;                 /**< messages sent */
173   unsigned int i_count;                 /**< characters used in i_buffer */
174   unsigned int i_errcount;              /**< characters used in i_errbuf */
175   int i_debug;                          /**< debug level */
176   char i_buffer[BUFSIZE+1];             /**< partial unprocessed line from server */
177   char i_errbuf[BUFSIZE+1];             /**< partial unprocessed error line */
178   char *i_version;                      /**< iauth version string */
179   struct SLink *i_config;               /**< configuration string list */
180   struct SLink *i_stats;                /**< statistics string list */
181   char **i_argv;                        /**< argument list */
182 };
183
184 /** Return whether flag \a flag is set on \a iauth. */
185 #define IAuthHas(iauth, flag) ((iauth) && FlagHas(&(iauth)->i_flags, flag))
186 /** Set flag \a flag on \a iauth. */
187 #define IAuthSet(iauth, flag) FlagSet(&(iauth)->i_flags, flag)
188 /** Clear flag \a flag from \a iauth. */
189 #define IAuthClr(iauth, flag) FlagClr(&(iauth)->i_flags, flag)
190 /** Get connected flag for \a iauth. */
191 #define i_GetConnected(iauth) ((iauth) && s_fd(i_socket(iauth)) > -1)
192
193 /** Return socket event generator for \a iauth. */
194 #define i_socket(iauth) (&(iauth)->i_socket)
195 /** Return stderr socket for \a iauth. */
196 #define i_stderr(iauth) (&(iauth)->i_stderr)
197 /** Return outbound message queue for \a iauth. */
198 #define i_sendQ(iauth) (&(iauth)->i_sendQ)
199 /** Return debug level for \a iauth. */
200 #define i_debug(iauth) ((iauth)->i_debug)
201
202 /** Active instance of IAuth. */
203 struct IAuth *iauth;
204
205 static void iauth_sock_callback(struct Event *ev);
206 static void iauth_stderr_callback(struct Event *ev);
207 static int sendto_iauth(struct Client *cptr, const char *format, ...);
208 static int preregister_user(struct Client *cptr);
209 typedef int (*iauth_cmd_handler)(struct IAuth *iauth, struct Client *cli,
210                                  int parc, char **params);
211
212 /** Set username for user associated with \a auth.
213  * @param[in] auth Client authorization request to work on.
214  * @return Zero if client is kept, CPTR_KILLED if client rejected.
215  */
216 static int auth_set_username(struct AuthRequest *auth)
217 {
218   struct Client *sptr = auth->client;
219   struct User   *user = cli_user(sptr);
220   char *d;
221   char *s;
222   int   rlen = USERLEN;
223   int   killreason;
224   short upper = 0;
225   short lower = 0;
226   short pos = 0;
227   short leadcaps = 0;
228   short other = 0;
229   short digits = 0;
230   short digitgroups = 0;
231   char  ch;
232   char  last;
233
234   if (FlagHas(&auth->flags, AR_IAUTH_USERNAME))
235   {
236       ircd_strncpy(cli_user(sptr)->username, cli_username(sptr), USERLEN);
237   }
238   else
239   {
240     /* Copy username from source to destination.  Since they may be the
241      * same, and we may prefix with a '~', use a buffer character (ch)
242      * to hold the next character to copy.
243      */
244     s = IsIdented(sptr) ? cli_username(sptr) : user->username;
245     last = *s++;
246     d = user->username;
247     if (HasFlag(sptr, FLAG_DOID) && !IsIdented(sptr))
248     {
249       *d++ = '~';
250       --rlen;
251     }
252     while (last && !IsCntrl(last) && rlen--)
253     {
254       ch = *s++;
255       *d++ = IsUserChar(last) ? last : '_';
256       last = (ch != '~') ? ch : '_';
257     }
258     *d = 0;
259   }
260
261   /* If username is empty or just ~, reject. */
262   if ((user->username[0] == '\0')
263       || ((user->username[0] == '~') && (user->username[1] == '\0')))
264     return exit_client(sptr, sptr, &me, "USER: Bogus userid.");
265
266   /* Check for K- or G-line. */
267   killreason = find_kill(sptr);
268   if (killreason) {
269     ServerStats->is_ref++;
270     return exit_client(sptr, sptr, &me,
271                        (killreason == -1 ? "K-lined" : "G-lined"));
272   }
273
274   if (!FlagHas(&auth->flags, AR_IAUTH_FUSERNAME))
275   {
276     /* Check for mixed case usernames, meaning probably hacked.  Jon2 3-94
277      * Explanations of rules moved to where it is checked     Entrope 2-06
278      */
279     s = d = user->username + (user->username[0] == '~');
280     for (last = '\0';
281          (ch = *d++) != '\0';
282          pos++, last = ch)
283     {
284       if (IsLower(ch))
285       {
286         lower++;
287       }
288       else if (IsUpper(ch))
289       {
290         upper++;
291         /* Accept caps as leading if we haven't seen lower case or digits yet. */
292         if ((leadcaps || pos == 0) && !lower && !digits)
293           leadcaps++;
294       }
295       else if (IsDigit(ch))
296       {
297         digits++;
298         if (pos == 0 || !IsDigit(last))
299         {
300           digitgroups++;
301           /* If more than two groups of digits, reject. */
302           if (digitgroups > 2)
303             goto badid;
304         }
305       }
306       else if (ch == '-' || ch == '_' || ch == '.')
307       {
308         other++;
309         /* If -_. exist at start, consecutively, or more than twice, reject. */
310         if (pos == 0 || last == '-' || last == '_' || last == '.' || other > 2)
311           goto badid;
312       }
313       else /* All other punctuation is rejected. */
314         goto badid;
315     }
316
317     /* If mixed case, first must be capital, but no more than three;
318      * but if three capitals, they must all be leading. */
319     if (lower && upper && (!leadcaps || leadcaps > 3 ||
320                            (upper > 2 && upper > leadcaps)))
321       goto badid;
322     /* If two different groups of digits, one must be either at the
323      * start or end. */
324     if (digitgroups == 2 && !(IsDigit(s[0]) || IsDigit(ch)))
325       goto badid;
326     /* Must have at least one letter. */
327     if (!lower && !upper)
328       goto badid;
329     /* Final character must not be punctuation. */
330     if (!IsAlnum(last))
331       goto badid;
332   }
333
334   return 0;
335
336 badid:
337   /* If we confirmed their username, and it is what they claimed,
338    * accept it. */
339   if (IsIdented(sptr) && !strcmp(cli_username(sptr), user->username))
340     return 0;
341
342   ServerStats->is_ref++;
343   send_reply(sptr, SND_EXPLICIT | ERR_INVALIDUSERNAME,
344              ":Your username is invalid.");
345   send_reply(sptr, SND_EXPLICIT | ERR_INVALIDUSERNAME,
346              ":Connect with your real username, in lowercase.");
347   send_reply(sptr, SND_EXPLICIT | ERR_INVALIDUSERNAME,
348              ":If your mail address were foo@bar.com, your username "
349              "would be foo.");
350   return exit_client(sptr, sptr, &me, "USER: Bad username");
351 }
352
353 /** Check whether an authorization request is complete.
354  * This means that no flags from 0 to #AR_LAST_SCAN are set on \a auth.
355  * If #AR_IAUTH_PENDING is set, optionally go into "hurry" state.  If
356  * 0 through #AR_LAST_SCAN and #AR_IAUTH_PENDING are all clear,
357  * destroy \a auth, clear the password, set the username, and register
358  * the client.
359  * @param[in] auth Authorization request to check.
360  * @return Zero if client is kept, CPTR_KILLED if client rejected.
361  */
362 static int check_auth_finished(struct AuthRequest *auth)
363 {
364   enum AuthRequestFlag flag;
365   int res;
366
367   /* Check non-iauth registration blocking flags. */
368   for (flag = 0; flag <= AR_LAST_SCAN; ++flag)
369     if (FlagHas(&auth->flags, flag))
370     {
371       Debug((DEBUG_INFO, "Auth %p [%d] still has flag %d", auth,
372              cli_fd(auth->client), flag));
373       return 0;
374     }
375
376   /* If appropriate, do preliminary assignment to connection class. */
377   if (IsUserPort(auth->client)
378       && !FlagHas(&auth->flags, AR_IAUTH_HURRY)
379       && preregister_user(auth->client))
380     return CPTR_KILLED;
381
382   /* If we have not done so, check client password.  Do this as soon
383    * as possible so that iauth's challenge/response (which uses PASS
384    * for responses) is not confused with the client's password.
385    */
386   if (!FlagHas(&auth->flags, AR_PASSWORD_CHECKED))
387   {
388     struct ConfItem *aconf;
389
390     aconf = cli_confs(auth->client)->value.aconf;
391     if (!EmptyString(aconf->passwd)
392         && strcmp(cli_passwd(auth->client), aconf->passwd))
393     {
394       ServerStats->is_ref++;
395       send_reply(auth->client, ERR_PASSWDMISMATCH);
396       return exit_client(auth->client, auth->client, &me, "Bad Password");
397     }
398     FlagSet(&auth->flags, AR_PASSWORD_CHECKED);
399   }
400
401   /* Check if iauth is done. */
402   if (FlagHas(&auth->flags, AR_IAUTH_PENDING))
403   {
404     /* Switch auth request to hurry-up state. */
405     if (!FlagHas(&auth->flags, AR_IAUTH_HURRY))
406     {
407       /* Set "hurry" flag in auth request. */
408       FlagSet(&auth->flags, AR_IAUTH_HURRY);
409
410       /* If iauth wants it, send notification. */
411       if (IAuthHas(iauth, IAUTH_UNDERNET))
412         sendto_iauth(auth->client, "H %s", get_client_class(auth->client));
413
414       /* If iauth wants it, give client more time. */
415       if (IAuthHas(iauth, IAUTH_EXTRAWAIT))
416         cli_firsttime(auth->client) = CurrentTime;
417     }
418
419     Debug((DEBUG_INFO, "Auth %p [%d] still has flag %d", auth,
420            cli_fd(auth->client), AR_IAUTH_PENDING));
421     return 0;
422   }
423   else
424     FlagSet(&auth->flags, AR_IAUTH_HURRY);
425
426   destroy_auth_request(auth);
427   if (!IsUserPort(auth->client))
428     return 0;
429   memset(cli_passwd(auth->client), 0, sizeof(cli_passwd(auth->client)));
430   res = auth_set_username(auth);
431   if (res == 0)
432       res = register_user(auth->client, auth->client);
433   return res;
434 }
435
436 /** Verify that a hostname is valid, i.e., only contains characters
437  * valid for a hostname and that a hostname is not too long.
438  * @param host Hostname to check.
439  * @param maxlen Maximum length of hostname, not including NUL terminator.
440  * @return Non-zero if the hostname is valid.
441  */
442 static int
443 auth_verify_hostname(const char *host, int maxlen)
444 {
445   int i;
446
447   /* Walk through the host name */
448   for (i = 0; host[i]; i++)
449     /* If it's not a hostname character or if it's too long, return false */
450     if (!IsHostChar(host[i]) || i >= maxlen)
451       return 0;
452
453   return 1; /* it's a valid hostname */
454 }
455
456 /** Assign a client to a connection class.
457  * @param[in] cptr Client to assign to a class.
458  * @return Zero if client is kept, CPTR_KILLED if rejected.
459  */
460 static int preregister_user(struct Client *cptr)
461 {
462   static time_t last_too_many1;
463   static time_t last_too_many2;
464
465   ircd_strncpy(cli_user(cptr)->host, cli_sockhost(cptr), HOSTLEN);
466   ircd_strncpy(cli_user(cptr)->realhost, cli_sockhost(cptr), HOSTLEN);
467
468   switch (conf_check_client(cptr))
469   {
470   case ACR_OK:
471     break;
472   case ACR_NO_AUTHORIZATION:
473     sendto_opmask_butone(0, SNO_UNAUTH, "Unauthorized connection from %s.",
474                          get_client_name(cptr, HIDE_IP));
475     ++ServerStats->is_ref;
476     return exit_client(cptr, cptr, &me,
477                        "No Authorization - use another server");
478   case ACR_TOO_MANY_IN_CLASS:
479     sendto_opmask_butone_ratelimited(0, SNO_TOOMANY, &last_too_many1,
480                                      "Too many connections in class %s for %s.",
481                                      get_client_class(cptr),
482                                      get_client_name(cptr, SHOW_IP));
483     ++ServerStats->is_ref;
484     return exit_client(cptr, cptr, &me,
485                        "Sorry, your connection class is full - try "
486                        "again later or try another server");
487   case ACR_TOO_MANY_FROM_IP:
488     sendto_opmask_butone_ratelimited(0, SNO_TOOMANY, &last_too_many2,
489                                      "Too many connections from same IP for %s.",
490                                      get_client_name(cptr, SHOW_IP));
491     ++ServerStats->is_ref;
492     return exit_client(cptr, cptr, &me,
493                        "Too many connections from your host");
494   case ACR_ALREADY_AUTHORIZED:
495     /* Can this ever happen? */
496   case ACR_BAD_SOCKET:
497     ++ServerStats->is_ref;
498     IPcheck_connect_fail(cptr);
499     return exit_client(cptr, cptr, &me, "Unknown error -- Try again");
500   }
501   return 0;
502 }
503
504 /** Send the ident server a query giving "theirport , ourport". The
505  * write is only attempted *once* so it is deemed to be a fail if the
506  * entire write doesn't write all the data given.  This shouldn't be a
507  * problem since the socket should have a write buffer far greater
508  * than this message to store it in should problems arise. -avalon
509  * @param[in] auth The request to send.
510  */
511 static void send_auth_query(struct AuthRequest* auth)
512 {
513   char               authbuf[32];
514   unsigned int       count;
515
516   assert(0 != auth);
517
518   ircd_snprintf(0, authbuf, sizeof(authbuf), "%hu , %hu\r\n",
519                 auth->port, auth->local.port);
520
521   if (IO_SUCCESS != os_send_nonb(s_fd(&auth->socket), authbuf, strlen(authbuf), &count)) {
522     close(s_fd(&auth->socket));
523     socket_del(&auth->socket);
524     s_fd(&auth->socket) = -1;
525     ++ServerStats->is_abad;
526     if (IsUserPort(auth->client))
527       sendheader(auth->client, REPORT_FAIL_ID);
528     FlagClr(&auth->flags, AR_AUTH_PENDING);
529     check_auth_finished(auth);
530   }
531 }
532
533 /** Enum used to index ident reply fields in a human-readable way. */
534 enum IdentReplyFields {
535   IDENT_PORT_NUMBERS,
536   IDENT_REPLY_TYPE,
537   IDENT_OS_TYPE,
538   IDENT_INFO,
539   USERID_TOKEN_COUNT
540 };
541
542 /** Parse an ident reply line and extract the userid from it.
543  * @param[in] reply The ident reply line.
544  * @return The userid, or NULL on parse failure.
545  */
546 static char* check_ident_reply(char* reply)
547 {
548   char* token;
549   char* end;
550   char* vector[USERID_TOKEN_COUNT];
551   int count = token_vector(reply, ':', vector, USERID_TOKEN_COUNT);
552
553   if (USERID_TOKEN_COUNT != count)
554     return 0;
555   /*
556    * second token is the reply type
557    */
558   token = vector[IDENT_REPLY_TYPE];
559   if (EmptyString(token))
560     return 0;
561
562   while (IsSpace(*token))
563     ++token;
564
565   if (0 != strncmp(token, "USERID", 6))
566     return 0;
567
568   /*
569    * third token is the os type
570    */
571   token = vector[IDENT_OS_TYPE];
572   if (EmptyString(token))
573     return 0;
574   while (IsSpace(*token))
575    ++token;
576
577   /*
578    * Unless "OTHER" is specified as the operating system
579    * type, the server is expected to return the "normal"
580    * user identification of the owner of this connection.
581    * "Normal" in this context may be taken to mean a string
582    * of characters which uniquely identifies the connection
583    * owner such as a user identifier assigned by the system
584    * administrator and used by such user as a mail
585    * identifier, or as the "user" part of a user/password
586    * pair used to gain access to system resources.  When an
587    * operating system is specified (e.g., anything but
588    * "OTHER"), the user identifier is expected to be in a
589    * more or less immediately useful form - e.g., something
590    * that could be used as an argument to "finger" or as a
591    * mail address.
592    */
593   if (0 == strncmp(token, "OTHER", 5))
594     return 0;
595   /*
596    * fourth token is the username
597    */
598   token = vector[IDENT_INFO];
599   if (EmptyString(token))
600     return 0;
601   while (IsSpace(*token))
602     ++token;
603   /*
604    * look for the end of the username, terminators are '\0, @, <SPACE>, :'
605    */
606   for (end = token; *end; ++end) {
607     if (IsSpace(*end) || '@' == *end || ':' == *end)
608       break;
609   }
610   *end = '\0';
611   return token;
612 }
613
614 /** Read the reply (if any) from the ident server we connected to.  We
615  * only give it one shot, if the reply isn't good the first time fail
616  * the authentication entirely. --Bleep
617  * @param[in] auth The request to read.
618  */
619 static void read_auth_reply(struct AuthRequest* auth)
620 {
621   char*        username = 0;
622   unsigned int len;
623   /*
624    * rfc1453 sez we MUST accept 512 bytes
625    */
626   char   buf[BUFSIZE + 1];
627
628   assert(0 != auth);
629   assert(0 != auth->client);
630   assert(auth == cli_auth(auth->client));
631
632   if (IO_SUCCESS == os_recv_nonb(s_fd(&auth->socket), buf, BUFSIZE, &len)) {
633     buf[len] = '\0';
634     Debug((DEBUG_INFO, "Auth %p [%d] reply: %s", auth, cli_fd(auth->client), buf));
635     username = check_ident_reply(buf);
636     Debug((DEBUG_INFO, "Username: %s", username));
637   }
638
639   Debug((DEBUG_INFO, "Deleting auth [%d] socket %p", auth, cli_fd(auth->client)));
640   close(s_fd(&auth->socket));
641   socket_del(&auth->socket);
642   s_fd(&auth->socket) = -1;
643
644   if (EmptyString(username)) {
645     if (IsUserPort(auth->client))
646       sendheader(auth->client, REPORT_FAIL_ID);
647     ++ServerStats->is_abad;
648   } else {
649     if (IsUserPort(auth->client))
650       sendheader(auth->client, REPORT_FIN_ID);
651     ++ServerStats->is_asuc;
652     if (!FlagHas(&auth->flags, AR_IAUTH_USERNAME)) {
653       ircd_strncpy(cli_username(auth->client), username, USERLEN);
654       SetGotId(auth->client);
655     }
656     if (IAuthHas(iauth, IAUTH_UNDERNET))
657       sendto_iauth(auth->client, "u %s", username);
658   }
659
660   FlagClr(&auth->flags, AR_AUTH_PENDING);
661   check_auth_finished(auth);
662 }
663
664 /** Handle socket I/O activity.
665  * @param[in] ev A socket event whos associated data is the active
666  *   struct AuthRequest.
667  */
668 static void auth_sock_callback(struct Event* ev)
669 {
670   struct AuthRequest* auth;
671
672   assert(0 != ev_socket(ev));
673   assert(0 != s_data(ev_socket(ev)));
674
675   auth = (struct AuthRequest*) s_data(ev_socket(ev));
676
677   switch (ev_type(ev)) {
678   case ET_DESTROY: /* being destroyed */
679     break;
680
681   case ET_CONNECT: /* socket connection completed */
682     Debug((DEBUG_INFO, "Connection completed for auth %p [%d]; sending query",
683            auth, cli_fd(auth->client)));
684     socket_state(&auth->socket, SS_CONNECTED);
685     send_auth_query(auth);
686     break;
687
688   case ET_READ: /* socket is readable */
689   case ET_EOF: /* end of file on socket */
690   case ET_ERROR: /* error on socket */
691     Debug((DEBUG_INFO, "Auth socket %p [%p] readable", auth, ev_socket(ev)));
692     read_auth_reply(auth);
693     break;
694
695   default:
696     assert(0 && "Unrecognized event in auth_socket_callback().");
697     break;
698   }
699 }
700
701 /** Stop an auth request completely.
702  * @param[in] auth The struct AuthRequest to cancel.
703  */
704 void destroy_auth_request(struct AuthRequest* auth)
705 {
706   Debug((DEBUG_INFO, "Deleting auth request for %p", auth->client));
707
708   if (FlagHas(&auth->flags, AR_DNS_PENDING)) {
709     delete_resolver_queries(auth);
710   }
711
712   if (-1 < s_fd(&auth->socket)) {
713     close(s_fd(&auth->socket));
714     socket_del(&auth->socket);
715     s_fd(&auth->socket) = -1;
716   }
717
718   if (t_active(&auth->timeout))
719     timer_del(&auth->timeout);
720   cli_auth(auth->client) = NULL;
721 }
722
723 /** Handle a 'ping' (authorization) timeout for a client.
724  * @param[in] cptr The client whose session authorization has timed out.
725  * @return Zero if client is kept, CPTR_KILLED if client rejected.
726  */
727 int auth_ping_timeout(struct Client *cptr)
728 {
729   struct AuthRequest *auth;
730   enum AuthRequestFlag flag;
731
732   auth = cli_auth(cptr);
733
734   /* Check for a user-controlled timeout. */
735   for (flag = 0; flag < AR_LAST_SCAN; ++flag) {
736     if (FlagHas(&auth->flags, flag)) {
737       /* Display message if they have sent a NICK and a USER but no
738        * nospoof PONG.
739        */
740       if (*(cli_name(cptr)) && cli_user(cptr) && *(cli_user(cptr))->username) {
741         send_reply(cptr, SND_EXPLICIT | ERR_BADPING,
742                    ":Your client may not be compatible with this server.");
743         send_reply(cptr, SND_EXPLICIT | ERR_BADPING,
744                    ":Compatible clients are available at %s",
745                    feature_str(FEAT_URL_CLIENTS));
746       }
747       return exit_client_msg(cptr, cptr, &me, "Registration Timeout");
748     }
749   }
750
751   /* Check for iauth timeout. */
752   if (FlagHas(&auth->flags, AR_IAUTH_PENDING)) {
753     sendto_iauth(cptr, "T");
754     if (IAuthHas(iauth, IAUTH_REQUIRED)) {
755       sendheader(cptr, REPORT_FAIL_IAUTH);
756       return exit_client_msg(cptr, cptr, &me, "Authorization Timeout");
757     }
758     FlagClr(&auth->flags, AR_IAUTH_PENDING);
759     return check_auth_finished(auth);
760   }
761
762   assert(0 && "Unexpectedly reached end of auth_ping_timeout()");
763   return 0;
764 }
765
766 /** Timeout a given auth request.
767  * @param[in] ev A timer event whose associated data is the expired
768  *   struct AuthRequest.
769  */
770 static void auth_timeout_callback(struct Event* ev)
771 {
772   struct AuthRequest* auth;
773
774   assert(0 != ev_timer(ev));
775   assert(0 != t_data(ev_timer(ev)));
776
777   auth = (struct AuthRequest*) t_data(ev_timer(ev));
778
779   if (ev_type(ev) == ET_EXPIRE) {
780     /* Report the timeout in the log. */
781     log_write(LS_RESOLVER, L_INFO, 0, "Registration timeout %s",
782               get_client_name(auth->client, HIDE_IP));
783
784     /* Notify client if ident lookup failed. */
785     if (FlagHas(&auth->flags, AR_AUTH_PENDING)) {
786       FlagClr(&auth->flags, AR_AUTH_PENDING);
787       if (IsUserPort(auth->client))
788         sendheader(auth->client, REPORT_FAIL_ID);
789     }
790
791     /* Likewise if dns lookup failed. */
792     if (FlagHas(&auth->flags, AR_DNS_PENDING)) {
793       delete_resolver_queries(auth);
794       if (IsUserPort(auth->client))
795         sendheader(auth->client, REPORT_FAIL_DNS);
796     }
797
798     /* Try to register the client. */
799     check_auth_finished(auth);
800   }
801 }
802
803 /** Handle a complete DNS lookup.  Send the client on it's way to a
804  * connection completion, regardless of success or failure -- unless
805  * there was a mismatch and KILL_IPMISMATCH is set.
806  * @param[in] vptr The pending struct AuthRequest.
807  * @param[in] addr IP address being resolved.
808  * @param[in] h_name Resolved name, or NULL if lookup failed.
809  */
810 static void auth_dns_callback(void* vptr, const struct irc_in_addr *addr, const char *h_name)
811 {
812   struct AuthRequest* auth = (struct AuthRequest*) vptr;
813   assert(0 != auth);
814
815   FlagClr(&auth->flags, AR_DNS_PENDING);
816   if (!addr) {
817     /* DNS entry was missing for the IP. */
818     if (IsUserPort(auth->client))
819       sendheader(auth->client, REPORT_FAIL_DNS);
820     sendto_iauth(auth->client, "d");
821   } else if (irc_in_addr_cmp(addr, &cli_ip(auth->client))
822              && irc_in_addr_cmp(addr, &auth->original)) {
823     /* IP for hostname did not match client's IP. */
824     sendto_opmask_butone(0, SNO_IPMISMATCH, "IP# Mismatch: %s != %s[%s]",
825                          cli_sock_ip(auth->client), h_name,
826                          ircd_ntoa(addr));
827     if (IsUserPort(auth->client))
828       sendheader(auth->client, REPORT_IP_MISMATCH);
829     /* Clear DNS pending flag so free_client doesn't ask the resolver
830      * to delete the query that just finished.
831      */
832     if (feature_bool(FEAT_KILL_IPMISMATCH)) {
833       IPcheck_disconnect(auth->client);
834       Count_unknowndisconnects(UserStats);
835       free_client(auth->client);
836     }
837   } else if (!auth_verify_hostname(h_name, HOSTLEN)) {
838     /* Hostname did not look valid. */
839     if (IsUserPort(auth->client))
840       sendheader(auth->client, REPORT_INVAL_DNS);
841     sendto_iauth(auth->client, "d");
842   } else {
843     /* Hostname and mappings checked out. */
844     if (IsUserPort(auth->client))
845       sendheader(auth->client, REPORT_FIN_DNS);
846     ircd_strncpy(cli_sockhost(auth->client), h_name, HOSTLEN);
847     sendto_iauth(auth->client, "N %s", h_name);
848   }
849   check_auth_finished(auth);
850 }
851
852 /** Flag the client to show an attempt to contact the ident server on
853  * the client's host.  Should the connect or any later phase of the
854  * identifying process fail, it is aborted and the user is given a
855  * username of "unknown".
856  * @param[in] auth The request for which to start the ident lookup.
857  */
858 static void start_auth_query(struct AuthRequest* auth)
859 {
860   struct irc_sockaddr remote_addr;
861   struct irc_sockaddr local_addr;
862   int                 fd;
863   IOResult            result;
864
865   assert(0 != auth);
866   assert(0 != auth->client);
867
868   /*
869    * get the local address of the client and bind to that to
870    * make the auth request.  This used to be done only for
871    * ifdef VIRTUAL_HOST, but needs to be done for all clients
872    * since the ident request must originate from that same address--
873    * and machines with multiple IP addresses are common now
874    */
875   memcpy(&local_addr, &auth->local, sizeof(local_addr));
876   local_addr.port = 0;
877   memcpy(&remote_addr.addr, &cli_ip(auth->client), sizeof(remote_addr.addr));
878   remote_addr.port = 113;
879   fd = os_socket(&local_addr, SOCK_STREAM, "auth query", 0);
880   if (fd < 0) {
881     ++ServerStats->is_abad;
882     if (IsUserPort(auth->client))
883       sendheader(auth->client, REPORT_FAIL_ID);
884     return;
885   }
886   if (IsUserPort(auth->client))
887     sendheader(auth->client, REPORT_DO_ID);
888
889   if ((result = os_connect_nonb(fd, &remote_addr)) == IO_FAILURE ||
890       !socket_add(&auth->socket, auth_sock_callback, (void*) auth,
891                   result == IO_SUCCESS ? SS_CONNECTED : SS_CONNECTING,
892                   SOCK_EVENT_READABLE, fd)) {
893     ++ServerStats->is_abad;
894     if (IsUserPort(auth->client))
895       sendheader(auth->client, REPORT_FAIL_ID);
896     close(fd);
897     return;
898   }
899
900   FlagSet(&auth->flags, AR_AUTH_PENDING);
901   if (result == IO_SUCCESS)
902     send_auth_query(auth);
903 }
904
905 /** Initiate DNS lookup for a client.
906  * @param[in] auth The auth request for which to start the DNS lookup.
907  */
908 static void start_dns_query(struct AuthRequest *auth)
909 {
910   if (feature_bool(FEAT_NODNS)) {
911     sendto_iauth(auth->client, "d");
912     return;
913   }
914
915   if (irc_in_addr_is_loopback(&cli_ip(auth->client))) {
916     strcpy(cli_sockhost(auth->client), cli_name(&me));
917     sendto_iauth(auth->client, "N %s", cli_sockhost(auth->client));
918     return;
919   }
920
921   if (IsUserPort(auth->client))
922     sendheader(auth->client, REPORT_DO_DNS);
923
924   FlagSet(&auth->flags, AR_DNS_PENDING);
925   gethost_byaddr(&cli_ip(auth->client), auth_dns_callback, auth);
926 }
927
928 /** Initiate IAuth check for a client.
929  * @param[in] auth The auth request for which to star the IAuth check.
930  */
931 static void start_iauth_query(struct AuthRequest *auth)
932 {
933   FlagSet(&auth->flags, AR_IAUTH_PENDING);
934   if (!sendto_iauth(auth->client, "C %s %hu %s %hu",
935                     cli_sock_ip(auth->client), auth->port,
936                     ircd_ntoa(&auth->local.addr), auth->local.port))
937     FlagClr(&auth->flags, AR_IAUTH_PENDING);
938 }
939
940 /** Starts auth (identd) and dns queries for a client.
941  * @param[in] client The client for which to start queries.
942  */
943 void start_auth(struct Client* client)
944 {
945   struct irc_sockaddr remote;
946   struct AuthRequest* auth;
947
948   assert(0 != client);
949   Debug((DEBUG_INFO, "Beginning auth request on client %p", client));
950
951   /* Register with event handlers. */
952   cli_lasttime(client) = CurrentTime;
953   cli_since(client) = CurrentTime;
954   if (cli_fd(client) > HighestFd)
955     HighestFd = cli_fd(client);
956   LocalClientArray[cli_fd(client)] = client;
957   socket_events(&(cli_socket(client)), SOCK_ACTION_SET | SOCK_EVENT_READABLE);
958
959   /* Allocate the AuthRequest. */
960   auth = MyCalloc(1, sizeof(*auth));
961   assert(0 != auth);
962   auth->client = client;
963   cli_auth(client) = auth;
964   s_fd(&auth->socket) = -1;
965   timer_add(timer_init(&auth->timeout), auth_timeout_callback, (void*) auth,
966             TT_RELATIVE, feature_int(FEAT_AUTH_TIMEOUT));
967
968   /* Try to get socket endpoint addresses. */
969   if (!os_get_sockname(cli_fd(client), &auth->local)
970       || !os_get_peername(cli_fd(client), &remote)) {
971     ++ServerStats->is_abad;
972     if (IsUserPort(auth->client))
973       sendheader(auth->client, REPORT_FAIL_ID);
974     IPcheck_disconnect(auth->client);
975     Count_unknowndisconnects(UserStats);
976     free_client(auth->client);
977     return;
978   }
979   auth->port = remote.port;
980
981   /* Try to start DNS lookup. */
982   start_dns_query(auth);
983
984   /* Try to start ident lookup. */
985   start_auth_query(auth);
986
987   /* Set required client inputs for users. */
988   if (IsUserPort(client)) {
989     cli_user(client) = make_user(client);
990     cli_user(client)->server = &me;
991     FlagSet(&auth->flags, AR_NEEDS_USER);
992     FlagSet(&auth->flags, AR_NEEDS_NICK);
993
994     /* Try to start iauth lookup. */
995     start_iauth_query(auth);
996   }
997
998   /* Add client to GlobalClientList. */
999   add_client_to_list(client);
1000
1001   /* Check which auth events remain pending. */
1002   check_auth_finished(auth);
1003 }
1004
1005 /** Mark that a user has PONGed while unregistered.
1006  * @param[in] auth Authorization request for client.
1007  * @param[in] cookie PONG cookie value sent by client.
1008  * @return Zero if client should be kept, CPTR_KILLED if rejected.
1009  */
1010 int auth_set_pong(struct AuthRequest *auth, unsigned int cookie)
1011 {
1012   assert(auth != NULL);
1013   if (!FlagHas(&auth->flags, AR_NEEDS_PONG))
1014     return 0;
1015   if (cookie != auth->cookie)
1016   {
1017     send_reply(auth->client, SND_EXPLICIT | ERR_BADPING,
1018                ":To connect, type /QUOTE PONG %u", auth->cookie);
1019     return 0;
1020   }
1021   FlagClr(&auth->flags, AR_NEEDS_PONG);
1022   return check_auth_finished(auth);
1023 }
1024
1025 /** Record a user's claimed username and userinfo.
1026  * @param[in] auth Authorization request for client.
1027  * @param[in] username Client's asserted username.
1028  * @param[in] userinfo Client's asserted self-description.
1029  * @return Zero if client should be kept, CPTR_KILLED if rejected.
1030  */
1031 int auth_set_user(struct AuthRequest *auth, const char *username, const char *userinfo)
1032 {
1033   struct Client *cptr;
1034
1035   assert(auth != NULL);
1036   if (FlagHas(&auth->flags, AR_IAUTH_HURRY))
1037     return 0;
1038   FlagClr(&auth->flags, AR_NEEDS_USER);
1039   cptr = auth->client;
1040   ircd_strncpy(cli_info(cptr), userinfo, REALLEN);
1041   ircd_strncpy(cli_user(cptr)->username, username, USERLEN);
1042   ircd_strncpy(cli_user(cptr)->host, cli_sockhost(cptr), HOSTLEN);
1043   if (IAuthHas(iauth, IAUTH_UNDERNET))
1044     sendto_iauth(cptr, "U %s :%s", username, userinfo);
1045   else if (IAuthHas(iauth, IAUTH_ADDLINFO))
1046     sendto_iauth(cptr, "U %s", username);
1047   return check_auth_finished(auth);
1048 }
1049
1050 /** Handle authorization-related aspects of initial nickname selection.
1051  * This is called after verifying that the nickname is available.
1052  * @param[in] auth Authorization request for client.
1053  * @param[in] nickname Client's requested nickname.
1054  * @return Zero if client should be kept, CPTR_KILLED if rejected.
1055  */
1056 int auth_set_nick(struct AuthRequest *auth, const char *nickname)
1057 {
1058   assert(auth != NULL);
1059   FlagClr(&auth->flags, AR_NEEDS_NICK);
1060   /*
1061    * If the client hasn't gotten a cookie-ping yet,
1062    * choose a cookie and send it. -record!jegelhof@cloud9.net
1063    */
1064   if (!auth->cookie) {
1065     do {
1066       auth->cookie = ircrandom();
1067     } while (!auth->cookie);
1068     sendrawto_one(auth->client, "PING :%u", auth->cookie);
1069     FlagSet(&auth->flags, AR_NEEDS_PONG);
1070   }
1071   if (IAuthHas(iauth, IAUTH_UNDERNET))
1072     sendto_iauth(auth->client, "n %s", nickname);
1073   return check_auth_finished(auth);
1074 }
1075
1076 /** Record a user's password.
1077  * @param[in] auth Authorization request for client.
1078  * @param[in] password Client's password.
1079  * @return Zero if client should be kept, CPTR_KILLED if rejected.
1080  */
1081 int auth_set_password(struct AuthRequest *auth, const char *password)
1082 {
1083   assert(auth != NULL);
1084   if (IAuthHas(iauth, IAUTH_ADDLINFO))
1085     sendto_iauth(auth->client, "P :%s", password);
1086   return 0;
1087 }
1088
1089 /** Send exit notification for \a cptr to iauth.
1090  * @param[in] cptr Client who is exiting.
1091  */
1092 void auth_send_exit(struct Client *cptr)
1093 {
1094   sendto_iauth(cptr, "D");
1095 }
1096
1097 /** Mark that a user has started capabilities negotiation.
1098  * This blocks authorization until auth_cap_done() is called.
1099  * @param[in] auth Authorization request for client.
1100  * @return Zero if client should be kept, CPTR_KILLED if rejected.
1101  */
1102 int auth_cap_start(struct AuthRequest *auth)
1103 {
1104   assert(auth != NULL);
1105   FlagSet(&auth->flags, AR_CAP_PENDING);
1106   return 0;
1107 }
1108
1109 /** Mark that a user has completed capabilities negotiation.
1110  * This unblocks authorization if auth_cap_start() was called.
1111  * @param[in] auth Authorization request for client.
1112  * @return Zero if client should be kept, CPTR_KILLED if rejected.
1113  */
1114 int auth_cap_done(struct AuthRequest *auth)
1115 {
1116   assert(auth != NULL);
1117   FlagClr(&auth->flags, AR_CAP_PENDING);
1118   return check_auth_finished(auth);
1119 }
1120
1121 /** Attempt to spawn the process for an IAuth instance.
1122  * @param[in] iauth IAuth descriptor.
1123  * @param[in] automatic If non-zero, apply sanity checks against
1124  *   excessive automatic restarts.
1125  * @return 0 on success, non-zero on failure.
1126  */
1127 int iauth_do_spawn(struct IAuth *iauth, int automatic)
1128 {
1129   pid_t cpid;
1130   int s_io[2];
1131   int s_err[2];
1132   int res;
1133
1134   if (automatic && CurrentTime - iauth->started < 5)
1135   {
1136     sendto_opmask_butone(NULL, SNO_AUTH, "IAuth crashed fast, leaving it dead.");
1137     return -1;
1138   }
1139
1140   /* Record time we tried to spawn the iauth process. */
1141   iauth->started = CurrentTime;
1142
1143   /* Attempt to allocate a pair of sockets. */
1144   res = os_socketpair(s_io);
1145   if (res)
1146     return errno;
1147
1148   /* Mark the parent's side of the pair (element 0) as non-blocking. */
1149   res = os_set_nonblocking(s_io[0]);
1150   if (!res) {
1151     res = errno;
1152     close(s_io[1]);
1153     close(s_io[0]);
1154     return res;
1155   }
1156
1157   /* Initialize the socket structure to talk to the child. */
1158   res = socket_add(i_socket(iauth), iauth_sock_callback, iauth,
1159                    SS_CONNECTED, SOCK_EVENT_READABLE, s_io[0]);
1160   if (!res) {
1161     res = errno;
1162     close(s_io[1]);
1163     close(s_io[0]);
1164     return res;
1165   }
1166
1167   /* Allocate another pair for stderr. */
1168   res = os_socketpair(s_err);
1169   if (res) {
1170     res = errno;
1171     socket_del(i_socket(iauth));
1172     close(s_io[1]);
1173     close(s_io[0]);
1174     return res;
1175   }
1176
1177   /* Mark parent side of this pair non-blocking, too. */
1178   res = os_set_nonblocking(s_err[0]);
1179   if (!res) {
1180     res = errno;
1181     close(s_err[1]);
1182     close(s_err[0]);
1183     socket_del(i_socket(iauth));
1184     close(s_io[1]);
1185     close(s_io[0]);
1186     return res;
1187   }
1188
1189   /* And set up i_stderr(iauth). */
1190   res = socket_add(i_stderr(iauth), iauth_stderr_callback, iauth,
1191                    SS_CONNECTED, SOCK_EVENT_READABLE, s_err[0]);
1192   if (!res) {
1193     res = errno;
1194     close(s_err[1]);
1195     close(s_err[0]);
1196     socket_del(i_socket(iauth));
1197     close(s_io[1]);
1198     close(s_io[0]);
1199     return res;
1200   }
1201
1202   /* Attempt to fork a child process. */
1203   cpid = fork();
1204   if (cpid < 0) {
1205     /* Error forking the child, still in parent. */
1206     res = errno;
1207     socket_del(i_stderr(iauth));
1208     close(s_err[1]);
1209     close(s_err[0]);
1210     socket_del(i_socket(iauth));
1211     close(s_io[1]);
1212     close(s_io[0]);
1213     return res;
1214   }
1215
1216   if (cpid > 0) {
1217     /* We are the parent process.  Close the child's sockets. */
1218     close(s_io[1]);
1219     close(s_err[1]);
1220     /* Send our server name (supposedly for proxy checking purposes)
1221      * and maximum number of connections (for allocation hints).
1222      * Need to use conf_get_local() since &me may not be fully
1223      * initialized the first time we run.
1224      */
1225     sendto_iauth(NULL, "M %s %d", conf_get_local()->name, MAXCONNECTIONS);
1226     /* Indicate success (until the child dies). */
1227     return 0;
1228   }
1229
1230   /* We are the child process.
1231    * Duplicate our end of the socket to stdin, stdout and stderr.
1232    * Then close all the higher-numbered FDs and exec the process.
1233    */
1234   if (dup2(s_io[1], 0) == 0
1235       && dup2(s_io[1], 1) == 1
1236       && dup2(s_err[1], 2) == 2) {
1237     close_connections(0);
1238     execvp(iauth->i_argv[0], iauth->i_argv);
1239   }
1240
1241   /* If we got here, something was seriously wrong. */
1242   exit(EXIT_FAILURE);
1243 }
1244
1245 /** See if an %IAuth program must be spawned.
1246  * If a process is already running with the specified options, keep it.
1247  * Otherwise spawn a new child process to perform the %IAuth function.
1248  * @param[in] argc Number of parameters to use when starting process.
1249  * @param[in] argv Array of parameters to start process.
1250  * @return 0 on failure, 1 on new process, 2 on reuse of existing process.
1251  */
1252 int auth_spawn(int argc, char *argv[])
1253 {
1254   int ii;
1255
1256   if (iauth) {
1257     int same = 1;
1258
1259     /* Check that incoming arguments all match pre-existing arguments. */
1260     for (ii = 0; same && (ii < argc); ++ii) {
1261       if (NULL == iauth->i_argv[ii]
1262           || 0 != strcmp(iauth->i_argv[ii], argv[ii]))
1263         same = 0;
1264     }
1265     /* Check that we have no more pre-existing arguments. */
1266     if (iauth->i_argv[ii])
1267       same = 0;
1268     /* If they are the same and still connected, clear the "closing" flag and exit.*/
1269     if (same && i_GetConnected(iauth)) {
1270       IAuthClr(iauth, IAUTH_CLOSING);
1271       return 2;
1272     }
1273     /* Deallocate old argv elements. */
1274     for (ii = 0; iauth->i_argv[ii]; ++ii)
1275       MyFree(iauth->i_argv[ii]);
1276     MyFree(iauth->i_argv);
1277   }
1278
1279   /* Need to initialize a new connection. */
1280   iauth = MyCalloc(1, sizeof(*iauth));
1281   msgq_init(i_sendQ(iauth));
1282   /* Populate iauth's argv array. */
1283   iauth->i_argv = MyCalloc(argc + 1, sizeof(iauth->i_argv[0]));
1284   for (ii = 0; ii < argc; ++ii)
1285     DupString(iauth->i_argv[ii], argv[ii]);
1286   iauth->i_argv[ii] = NULL;
1287   /* Try to spawn it, and handle the results. */
1288   if (iauth_do_spawn(iauth, 0))
1289     return 0;
1290   IAuthClr(iauth, IAUTH_CLOSING);
1291   return 1;
1292 }
1293
1294 /** Mark all %IAuth connections as closing. */
1295 void auth_mark_closing(void)
1296 {
1297   if (iauth)
1298     IAuthSet(iauth, IAUTH_CLOSING);
1299 }
1300
1301 /** Complete disconnection of an %IAuth connection.
1302  * @param[in] iauth %Connection to fully close.
1303  */
1304 static void iauth_disconnect(struct IAuth *iauth)
1305 {
1306   if (!i_GetConnected(iauth))
1307     return;
1308
1309   /* Close main socket. */
1310   close(s_fd(i_socket(iauth)));
1311   socket_del(i_socket(iauth));
1312   s_fd(i_socket(iauth)) = -1;
1313
1314   /* Close error socket. */
1315   close(s_fd(i_stderr(iauth)));
1316   socket_del(i_stderr(iauth));
1317   s_fd(i_stderr(iauth)) = -1;
1318 }
1319
1320 /** Close all %IAuth connections marked as closing. */
1321 void auth_close_unused(void)
1322 {
1323   if (IAuthHas(iauth, IAUTH_CLOSING)) {
1324     int ii;
1325     iauth_disconnect(iauth);
1326     if (iauth->i_argv) {
1327       for (ii = 0; iauth->i_argv[ii]; ++ii)
1328         MyFree(iauth->i_argv[ii]);
1329       MyFree(iauth->i_argv);
1330     }
1331     MyFree(iauth);
1332   }
1333 }
1334
1335 /** Send queued output to \a iauth.
1336  * @param[in] iauth Writable connection with queued data.
1337  */
1338 static void iauth_write(struct IAuth *iauth)
1339 {
1340   unsigned int bytes_tried, bytes_sent;
1341   IOResult iores;
1342
1343   if (IAuthHas(iauth, IAUTH_BLOCKED))
1344     return;
1345   while (MsgQLength(i_sendQ(iauth)) > 0) {
1346     iores = os_sendv_nonb(s_fd(i_socket(iauth)), i_sendQ(iauth), &bytes_tried, &bytes_sent);
1347     switch (iores) {
1348     case IO_SUCCESS:
1349       msgq_delete(i_sendQ(iauth), bytes_sent);
1350       iauth->i_sendB += bytes_sent;
1351       if (bytes_tried == bytes_sent)
1352         break;
1353       /* If bytes_sent < bytes_tried, fall through to IO_BLOCKED. */
1354     case IO_BLOCKED:
1355       IAuthSet(iauth, IAUTH_BLOCKED);
1356       socket_events(i_socket(iauth), SOCK_ACTION_ADD | SOCK_EVENT_WRITABLE);
1357       return;
1358     case IO_FAILURE:
1359       iauth_disconnect(iauth);
1360       return;
1361     }
1362   }
1363   /* We were able to flush all events, so remove notification. */
1364   socket_events(i_socket(iauth), SOCK_ACTION_DEL | SOCK_EVENT_WRITABLE);
1365 }
1366
1367 /** Send a message to iauth.
1368  * @param[in] cptr Optional client context for message.
1369  * @param[in] format Format string for message.
1370  * @return Non-zero on successful send or buffering, zero on failure.
1371  */
1372 static int sendto_iauth(struct Client *cptr, const char *format, ...)
1373 {
1374   struct VarData vd;
1375   struct MsgBuf *mb;
1376
1377   /* Do not send requests when we have no iauth. */
1378   if (!i_GetConnected(iauth))
1379     return 0;
1380   /* Do not send for clients in the NORMAL state. */
1381   if (cptr
1382       && (format[0] != 'D')
1383       && (!cli_auth(cptr) || !FlagHas(&cli_auth(cptr)->flags, AR_IAUTH_PENDING)))
1384     return 0;
1385
1386   /* Build the message buffer. */
1387   vd.vd_format = format;
1388   va_start(vd.vd_args, format);
1389   if (0 == cptr)
1390     mb = msgq_make(NULL, "-1 %v", &vd);
1391   else
1392     mb = msgq_make(NULL, "%d %v", cli_fd(cptr), &vd);
1393   va_end(vd.vd_args);
1394
1395   /* Tack it onto the iauth sendq and try to write it. */
1396   ++iauth->i_sendM;
1397   msgq_add(i_sendQ(iauth), mb, 0);
1398   iauth_write(iauth);
1399   return 1;
1400 }
1401
1402 /** Send text to interested operators (SNO_AUTH server notice).
1403  * @param[in] iauth Active IAuth session.
1404  * @param[in] cli Client referenced by command.
1405  * @param[in] parc Number of parameters (1).
1406  * @param[in] params Text to send.
1407  * @return Zero.
1408  */
1409 static int iauth_cmd_snotice(struct IAuth *iauth, struct Client *cli,
1410                              int parc, char **params)
1411 {
1412   sendto_opmask_butone(NULL, SNO_AUTH, "%s", params[0]);
1413   return 0;
1414 }
1415
1416 /** Set the debug level for the session.
1417  * @param[in] iauth Active IAuth session.
1418  * @param[in] cli Client referenced by command.
1419  * @param[in] parc Number of parameters (1).
1420  * @param[in] params String starting with an integer.
1421  * @return Zero.
1422  */
1423 static int iauth_cmd_debuglevel(struct IAuth *iauth, struct Client *cli,
1424                                 int parc, char **params)
1425 {
1426   int new_level;
1427
1428   new_level = parc > 0 ? atoi(params[0]) : 0;
1429   if (i_debug(iauth) > 0 || new_level > 0) {
1430     /* The "ia_dbg" name is borrowed from (IRCnet) ircd. */
1431     sendto_opmask_butone(NULL, SNO_AUTH, "ia_dbg = %d", new_level);
1432   }
1433   i_debug(iauth) = new_level;
1434   return 0;
1435 }
1436
1437 /** Set policy options for the session.
1438  * Old policy is forgotten, and any of the following characters in \a
1439  * params enable the corresponding policy:
1440  * \li A IAUTH_ADDLINFO
1441  * \li R IAUTH_REQUIRED
1442  * \li T IAUTH_TIMEOUT
1443  * \li W IAUTH_EXTRAWAIT
1444  * \li U IAUTH_UNDERNET
1445  *
1446  * @param[in] iauth Active IAuth session.
1447  * @param[in] cli Client referenced by command.
1448  * @param[in] parc Number of parameters (1).
1449  * @param[in] params Zero or more policy options.
1450  * @return Zero.
1451  */
1452 static int iauth_cmd_policy(struct IAuth *iauth, struct Client *cli,
1453                             int parc, char **params)
1454 {
1455   enum IAuthFlag flag;
1456   char *p;
1457
1458   /* Erase old policy first. */
1459   for (flag = IAUTH_FIRST_OPTION; flag < IAUTH_LAST_FLAG; ++flag)
1460     IAuthClr(iauth, flag);
1461
1462   if (parc > 0) /* only try to parse if we were given a policy string */
1463     /* Parse new policy set. */
1464     for (p = params[0]; *p; p++) switch (*p) {
1465     case 'A': IAuthSet(iauth, IAUTH_ADDLINFO); break;
1466     case 'R': IAuthSet(iauth, IAUTH_REQUIRED); break;
1467     case 'T': IAuthSet(iauth, IAUTH_TIMEOUT); break;
1468     case 'W': IAuthSet(iauth, IAUTH_EXTRAWAIT); break;
1469     case 'U': IAuthSet(iauth, IAUTH_UNDERNET); break;
1470     }
1471
1472   /* Optionally notify operators. */
1473   if (i_debug(iauth) > 0)
1474     sendto_opmask_butone(NULL, SNO_AUTH, "iauth options: %s", params[0]);
1475   return 0;
1476 }
1477
1478 /** Set the iauth program version number.
1479  * @param[in] iauth Active IAuth session.
1480  * @param[in] cli Client referenced by command.
1481  * @param[in] parc Number of parameters (1).
1482  * @param[in] params Version number or name.
1483  * @return Zero.
1484  */
1485 static int iauth_cmd_version(struct IAuth *iauth, struct Client *cli,
1486                              int parc, char **params)
1487 {
1488   MyFree(iauth->i_version);
1489   DupString(iauth->i_version, parc > 0 ? params[0] : "<NONE>");
1490   sendto_opmask_butone(NULL, SNO_AUTH, "iauth version %s running.",
1491                        iauth->i_version);
1492   return 0;
1493 }
1494
1495 /** Paste a parameter list together into a single string.
1496  * @param[in] parc Number of parameters.
1497  * @param[in] params Parameter list to paste together.
1498  * @return Pasted parameter list.
1499  */
1500 static char *paste_params(int parc, char **params)
1501 {
1502   char *str, *tmp;
1503   int len = 0, lengths[MAXPARA], i;
1504
1505   /* Compute the length... */
1506   for (i = 0; i < parc; i++)
1507     len += lengths[i] = strlen(params[i]);
1508
1509   /* Allocate memory, accounting for string lengths, spaces (parc - 1), a
1510    * sentinel, and the trailing \0
1511    */
1512   str = MyMalloc(len + parc + 1);
1513
1514   /* Build the pasted string */
1515   for (tmp = str, i = 0; i < parc; i++) {
1516     if (i) /* add space separator... */
1517       *(tmp++) = ' ';
1518     if (i == parc - 1) /* add colon sentinel */
1519       *(tmp++) = ':';
1520
1521     /* Copy string component... */
1522     memcpy(tmp, params[i], lengths[i]);
1523     tmp += lengths[i]; /* move to end of string */
1524   }
1525
1526   /* terminate the string... */
1527   *tmp = '\0';
1528
1529   return str; /* return the pasted string */
1530 }
1531
1532 /** Clear cached iauth configuration information.
1533  * @param[in] iauth Active IAuth session.
1534  * @param[in] cli Client referenced by command.
1535  * @param[in] parc Number of parameters (0).
1536  * @param[in] params Parameter list (ignored).
1537  * @return Zero.
1538  */
1539 static int iauth_cmd_newconfig(struct IAuth *iauth, struct Client *cli,
1540                                int parc, char **params)
1541 {
1542   struct SLink *head;
1543   struct SLink *next;
1544
1545   head = iauth->i_config;
1546   iauth->i_config = NULL;
1547   for (; head; head = next) {
1548     next = head->next;
1549     MyFree(head->value.cp);
1550     free_link(head);
1551   }
1552   sendto_opmask_butone(NULL, SNO_AUTH, "New iauth configuration.");
1553   return 0;
1554 }
1555
1556 /** Append iauth configuration information.
1557  * @param[in] iauth Active IAuth session.
1558  * @param[in] cli Client referenced by command.
1559  * @param[in] parc Number of parameters.
1560  * @param[in] params Description of configuration element.
1561  * @return Zero.
1562  */
1563 static int iauth_cmd_config(struct IAuth *iauth, struct Client *cli,
1564                             int parc, char **params)
1565 {
1566   struct SLink *node;
1567
1568   if (iauth->i_config) {
1569     for (node = iauth->i_config; node->next; node = node->next) ;
1570     node = node->next = make_link();
1571   } else {
1572     node = iauth->i_config = make_link();
1573   }
1574   node->value.cp = paste_params(parc, params);
1575   node->next = 0; /* must be explicitly cleared */
1576   return 0;
1577 }
1578
1579 /** Clear cached iauth configuration information.
1580  * @param[in] iauth Active IAuth session.
1581  * @param[in] cli Client referenced by command.
1582  * @param[in] parc Number of parameters (0).
1583  * @param[in] params Parameter list (ignored).
1584  * @return Zero.
1585  */
1586 static int iauth_cmd_newstats(struct IAuth *iauth, struct Client *cli,
1587                               int parc, char **params)
1588 {
1589   struct SLink *head;
1590   struct SLink *next;
1591
1592   head = iauth->i_stats;
1593   iauth->i_stats = NULL;
1594   for (; head; head = next) {
1595     next = head->next;
1596     MyFree(head->value.cp);
1597     free_link(head);
1598   }
1599   sendto_opmask_butone(NULL, SNO_AUTH, "New iauth statistics.");
1600   return 0;
1601 }
1602
1603 /** Append iauth statistics information.
1604  * @param[in] iauth Active IAuth session.
1605  * @param[in] cli Client referenced by command.
1606  * @param[in] parc Number of parameters.
1607  * @param[in] params Statistics element.
1608  * @return Zero.
1609  */
1610 static int iauth_cmd_stats(struct IAuth *iauth, struct Client *cli,
1611                            int parc, char **params)
1612 {
1613   struct SLink *node;
1614   if (iauth->i_stats) {
1615     for (node = iauth->i_stats; node->next; node = node->next) ;
1616     node = node->next = make_link();
1617   } else {
1618     node = iauth->i_stats = make_link();
1619   }
1620   node->value.cp = paste_params(parc, params);
1621   node->next = 0; /* must be explicitly cleared */
1622   return 0;
1623 }
1624
1625 /** Set client's username to a trusted string even if it breaks the rules.
1626  * @param[in] iauth Active IAuth session.
1627  * @param[in] cli Client referenced by command.
1628  * @param[in] parc Number of parameters (1).
1629  * @param[in] params Forced username.
1630  * @return One.
1631  */
1632 static int iauth_cmd_username_forced(struct IAuth *iauth, struct Client *cli,
1633                                      int parc, char **params)
1634 {
1635   assert(cli_auth(cli) != NULL);
1636   FlagClr(&cli_auth(cli)->flags, AR_AUTH_PENDING);
1637   if (!EmptyString(params[0])) {
1638     ircd_strncpy(cli_username(cli), params[0], USERLEN);
1639     SetGotId(cli);
1640     FlagSet(&cli_auth(cli)->flags, AR_IAUTH_USERNAME);
1641     FlagSet(&cli_auth(cli)->flags, AR_IAUTH_FUSERNAME);
1642   }
1643   return 1;
1644 }
1645
1646 /** Set client's username to a trusted string.
1647  * @param[in] iauth Active IAuth session.
1648  * @param[in] cli Client referenced by command.
1649  * @param[in] parc Number of parameters (1).
1650  * @param[in] params Trusted username.
1651  * @return One.
1652  */
1653 static int iauth_cmd_username_good(struct IAuth *iauth, struct Client *cli,
1654                                    int parc, char **params)
1655 {
1656   assert(cli_auth(cli) != NULL);
1657   FlagClr(&cli_auth(cli)->flags, AR_AUTH_PENDING);
1658   if (!EmptyString(params[0])) {
1659     ircd_strncpy(cli_username(cli), params[0], USERLEN);
1660     SetGotId(cli);
1661     FlagSet(&cli_auth(cli)->flags, AR_IAUTH_USERNAME);
1662   }
1663   return 1;
1664 }
1665
1666 /** Set client's username to an untrusted string.
1667  * @param[in] iauth Active IAuth session.
1668  * @param[in] cli Client referenced by command.
1669  * @param[in] parc Number of parameters (1).
1670  * @param[in] params Untrusted username.
1671  * @return One.
1672  */
1673 static int iauth_cmd_username_bad(struct IAuth *iauth, struct Client *cli,
1674                                   int parc, char **params)
1675 {
1676   assert(cli_auth(cli) != NULL);
1677   FlagClr(&cli_auth(cli)->flags, AR_AUTH_PENDING);
1678   if (!EmptyString(params[0]))
1679     ircd_strncpy(cli_user(cli)->username, params[0], USERLEN);
1680   return 1;
1681 }
1682
1683 /** Set client's hostname.
1684  * @param[in] iauth Active IAuth session.
1685  * @param[in] cli Client referenced by command.
1686  * @param[in] parc Number of parameters (1).
1687  * @param[in] params New hostname for client.
1688  * @return Non-zero if \a cli authorization should be checked for completion.
1689  */
1690 static int iauth_cmd_hostname(struct IAuth *iauth, struct Client *cli,
1691                               int parc, char **params)
1692 {
1693   struct AuthRequest *auth;
1694
1695   if (EmptyString(params[0])) {
1696     sendto_iauth(cli, "E Missing :Missing hostname parameter");
1697     return 0;
1698   }
1699
1700   auth = cli_auth(cli);
1701   assert(auth != NULL);
1702
1703   /* If a DNS request is pending, abort it. */
1704   if (FlagHas(&auth->flags, AR_DNS_PENDING)) {
1705     FlagClr(&auth->flags, AR_DNS_PENDING);
1706     delete_resolver_queries(auth);
1707     if (IsUserPort(cli))
1708       sendheader(cli, REPORT_FIN_DNS);
1709   }
1710   /* Set hostname from params. */
1711   ircd_strncpy(cli_sockhost(cli), params[0], HOSTLEN);
1712   return 1;
1713 }
1714
1715 /** Set client's IP address.
1716  * @param[in] iauth Active IAuth session.
1717  * @param[in] cli Client referenced by command.
1718  * @param[in] parc Number of parameters (1).
1719  * @param[in] params New IP address for client in dotted quad or
1720  *   standard IPv6 format.
1721  * @return Zero.
1722  */
1723 static int iauth_cmd_ip_address(struct IAuth *iauth, struct Client *cli,
1724                                 int parc, char **params)
1725 {
1726   struct irc_in_addr addr;
1727   struct AuthRequest *auth;
1728
1729   if (EmptyString(params[0])) {
1730     sendto_iauth(cli, "E Missing :Missing IP address parameter");
1731     return 0;
1732   }
1733
1734   /* Get AuthRequest for client. */
1735   auth = cli_auth(cli);
1736   assert(auth != NULL);
1737
1738   /* Parse the client's new IP address. */
1739   if (!ircd_aton(&addr, params[0])) {
1740     sendto_iauth(cli, "E Invalid :Unable to parse IP address [%s]", params[0]);
1741     return 0;
1742   }
1743
1744   /* If this is the first IP override, save the client's original
1745    * address in case we get a DNS response later.
1746    */
1747   if (!irc_in_addr_valid(&auth->original))
1748     memcpy(&auth->original, &cli_ip(cli), sizeof(auth->original));
1749
1750   /* Undo original IP connection in IPcheck. */
1751   IPcheck_connect_fail(cli);
1752   ClearIPChecked(cli);
1753
1754   /* Update the IP and charge them as a remote connect. */
1755   memcpy(&cli_ip(cli), &addr, sizeof(cli_ip(cli)));
1756   IPcheck_remote_connect(cli, 0);
1757
1758   return 0;
1759 }
1760
1761 /** Find a ConfItem structure for a named connection class.
1762  * @param[in] class_name Name of configuration class to find.
1763  * @return A ConfItem of type CONF_CLIENT for the class, or NULL on failure.
1764  */
1765 static struct ConfItem *auth_find_class_conf(const char *class_name)
1766 {
1767   static struct ConfItem *aconf_list;
1768   struct ConnectionClass *class;
1769   struct ConfItem *aconf;
1770
1771   /* Make sure the configuration class is valid. */
1772   class = find_class(class_name);
1773   if (!class)
1774     return NULL;
1775
1776   /* Look for an existing ConfItem for the class. */
1777   for (aconf = aconf_list; aconf; aconf = aconf->next)
1778     if (aconf->conn_class == class)
1779       break;
1780
1781   /* If no ConfItem, create one. */
1782   if (!aconf) {
1783     aconf = make_conf(CONF_CLIENT);
1784     if (!aconf) {
1785       sendto_opmask_butone(NULL, SNO_AUTH,
1786                            "Unable to allocate ConfItem for class %s!",
1787                            ConClass(class));
1788       return NULL;
1789     }
1790     aconf->conn_class = class;
1791     aconf->next = aconf_list;
1792     aconf_list = aconf;
1793   }
1794
1795   return aconf;
1796 }
1797
1798 /** Accept a client in IAuth.
1799  * @param[in] iauth Active IAuth session.
1800  * @param[in] cli Client referenced by command.
1801  * @param[in] parc Number of parameters.
1802  * @param[in] params Optional class name for client.
1803  * @return One.
1804  */
1805 static int iauth_cmd_done_client(struct IAuth *iauth, struct Client *cli,
1806                                  int parc, char **params)
1807 {
1808   static time_t warn_time;
1809
1810   /* Clear iauth pending flag. */
1811   assert(cli_auth(cli) != NULL);
1812   FlagClr(&cli_auth(cli)->flags, AR_IAUTH_PENDING);
1813
1814   /* If a connection class was specified (and usable), assign the client to it. */
1815   if (!EmptyString(params[0])) {
1816     struct ConfItem *aconf;
1817
1818     aconf = auth_find_class_conf(params[0]);
1819     if (aconf)
1820       attach_conf(cli, aconf);
1821     else
1822       sendto_opmask_butone_ratelimited(NULL, SNO_AUTH, &warn_time,
1823                                        "iauth tried to use undefined class [%s]",
1824                                        params[0]);
1825   }
1826
1827   return 1;
1828 }
1829
1830 /** Accept a client in IAuth and assign them to an account.
1831  * @param[in] iauth Active IAuth session.
1832  * @param[in] cli Client referenced by command.
1833  * @param[in] parc Number of parameters.
1834  * @param[in] params Account name and optional class name for client.
1835  * @return Non-zero if \a cli authorization should be checked for completion.
1836  */
1837 static int iauth_cmd_done_account(struct IAuth *iauth, struct Client *cli,
1838                                   int parc, char **params)
1839 {
1840   size_t len;
1841
1842   /* Sanity check. */
1843   if (EmptyString(params[0])) {
1844     sendto_iauth(cli, "E Missing :Missing account parameter");
1845     return 0;
1846   }
1847   /* Check length of account name. */
1848   len = strcspn(params[0], ": ");
1849   if (len > ACCOUNTLEN) {
1850     sendto_iauth(cli, "E Invalid :Account parameter too long");
1851     return 0;
1852   }
1853   /* If account has a creation timestamp, use it. */
1854   assert(cli_user(cli) != NULL);
1855   if (params[0][len] == ':')
1856     cli_user(cli)->acc_create = strtoul(params[0] + len + 1, NULL, 10);
1857
1858   /* Copy account name to User structure. */
1859   ircd_strncpy(cli_user(cli)->account, params[0], ACCOUNTLEN);
1860   SetAccount(cli);
1861
1862   /* Fall through to the normal "done" handler. */
1863   return iauth_cmd_done_client(iauth, cli, parc - 1, params + 1);
1864 }
1865
1866 /** Reject a client's connection.
1867  * @param[in] iauth Active IAuth session.
1868  * @param[in] cli Client referenced by command.
1869  * @param[in] parc Number of parameters (1).
1870  * @param[in] params Optional kill message.
1871  * @return Zero.
1872  */
1873 static int iauth_cmd_kill(struct IAuth *iauth, struct Client *cli,
1874                           int parc, char **params)
1875 {
1876   if (cli_auth(cli))
1877     FlagClr(&cli_auth(cli)->flags, AR_IAUTH_PENDING);
1878   if (EmptyString(params[0]))
1879     params[0] = "Access denied";
1880   exit_client(cli, cli, &me, params[0]);
1881   return 0;
1882 }
1883
1884 /** Send a challenge string to the client.
1885  * @param[in] iauth Active IAuth session.
1886  * @param[in] cli Client referenced by command.
1887  * @param[in] parc Number of parameters (1).
1888  * @param[in] params Challenge message for client.
1889  * @return Zero.
1890  */
1891 static int iauth_cmd_challenge(struct IAuth *iauth, struct Client *cli,
1892                                int parc, char **params)
1893 {
1894   if (!EmptyString(params[0]))
1895     sendrawto_one(cli, "NOTICE AUTH :*** %s", params[0]);
1896   return 0;
1897 }
1898
1899 /** Parse a \a message from \a iauth.
1900  * @param[in] iauth Active IAuth session.
1901  * @param[in] message Message to be parsed.
1902  */
1903 static void iauth_parse(struct IAuth *iauth, char *message)
1904 {
1905   char *params[MAXPARA + 1]; /* leave space for NULL */
1906   int parc = 0;
1907   iauth_cmd_handler handler;
1908   struct AuthRequest *auth;
1909   struct Client *cli;
1910   int has_cli;
1911   int id;
1912
1913   /* Find command handler... */
1914   switch (*(message++)) {
1915   case '>': handler = iauth_cmd_snotice; has_cli = 0; break;
1916   case 'G': handler = iauth_cmd_debuglevel; has_cli = 0; break;
1917   case 'O': handler = iauth_cmd_policy; has_cli = 0; break;
1918   case 'V': handler = iauth_cmd_version; has_cli = 0; break;
1919   case 'a': handler = iauth_cmd_newconfig; has_cli = 0; break;
1920   case 'A': handler = iauth_cmd_config; has_cli = 0; break;
1921   case 's': handler = iauth_cmd_newstats; has_cli = 0; break;
1922   case 'S': handler = iauth_cmd_stats; has_cli = 0; break;
1923   case 'o': handler = iauth_cmd_username_forced; has_cli = 1; break;
1924   case 'U': handler = iauth_cmd_username_good; has_cli = 1; break;
1925   case 'u': handler = iauth_cmd_username_bad; has_cli = 1; break;
1926   case 'N': handler = iauth_cmd_hostname; has_cli = 1; break;
1927   case 'I': handler = iauth_cmd_ip_address; has_cli = 1; break;
1928   case 'C': handler = iauth_cmd_challenge; has_cli = 1; break;
1929   case 'D': handler = iauth_cmd_done_client; has_cli = 1; break;
1930   case 'R': handler = iauth_cmd_done_account; has_cli = 1; break;
1931   case 'k': /* The 'k' command indicates the user should be booted
1932              * off without telling opers.  There is no way to
1933              * signal that to exit_client(), so we fall through to
1934              * the case that we do implement.
1935              */
1936   case 'K': handler = iauth_cmd_kill; has_cli = 2; break;
1937   case 'r': /* we handle termination directly */ return;
1938   default:  sendto_iauth(NULL, "E Garbage :[%s]", message); return;
1939   }
1940
1941   while (parc < MAXPARA) {
1942     while (IsSpace(*message)) /* skip leading whitespace */
1943       message++;
1944
1945     if (!*message) /* hit the end of the string, break out */
1946       break;
1947
1948     if (*message == ':') { /* found sentinel... */
1949       params[parc++] = message + 1;
1950       break; /* it's the last parameter anyway */
1951     }
1952
1953     params[parc++] = message; /* save the parameter */
1954     while (*message && !IsSpace(*message))
1955       message++; /* find the end of the parameter */
1956
1957     if (*message) /* terminate the parameter */
1958       *(message++) = '\0';
1959   }
1960
1961   params[parc] = NULL; /* terminate the parameter list */
1962
1963   /* Check to see if the command specifies a client... */
1964   if (!has_cli) {
1965     /* Handler does not need a client. */
1966     handler(iauth, NULL, parc, params);
1967   } else {
1968     /* Try to find the client associated with the request. */
1969     id = strtol(params[0], NULL, 10);
1970     if (id < 0 || id > HighestFd || !(cli = LocalClientArray[id]))
1971       /* Client no longer exists (or never existed). */
1972       sendto_iauth(NULL, "E Gone :[%s %s %s]", params[0], params[1],
1973                    params[2]);
1974     else if ((!(auth = cli_auth(cli)) ||
1975               !FlagHas(&auth->flags, AR_IAUTH_PENDING)) &&
1976              has_cli == 1)
1977       /* Client is done with IAuth checks. */
1978       sendto_iauth(cli, "E Done :[%s %s %s]", params[0], params[1], params[2]);
1979     else {
1980       struct irc_sockaddr addr;
1981       int res;
1982
1983       /* Parse IP address and port number from parameters */
1984       res = ipmask_parse(params[1], &addr.addr, NULL);
1985       addr.port = strtol(params[2], NULL, 10);
1986
1987       /* Check IP address and port number against expected. */
1988       if (0 == res ||
1989           irc_in_addr_cmp(&addr.addr, &cli_ip(cli)) ||
1990           (auth && addr.port != auth->port))
1991         /* Report mismatch to iauth. */
1992         sendto_iauth(cli, "E Mismatch :[%s] != [%s]", params[1],
1993                      ircd_ntoa(&cli_ip(cli)));
1994       else if (handler(iauth, cli, parc - 3, params + 3))
1995         /* Handler indicated a possible state change. */
1996         check_auth_finished(auth);
1997     }
1998   }
1999 }
2000
2001 /** Read input from \a iauth.
2002  * Reads up to SERVER_TCP_WINDOW bytes per pass.
2003  * @param[in] iauth Readable connection.
2004  */
2005 static void iauth_read(struct IAuth *iauth)
2006 {
2007   static char readbuf[SERVER_TCP_WINDOW];
2008   unsigned int length, count;
2009   char *sol;
2010   char *eol;
2011
2012   /* Copy partial data to readbuf, append new data. */
2013   length = iauth->i_count;
2014   memcpy(readbuf, iauth->i_buffer, length);
2015   if (IO_SUCCESS != os_recv_nonb(s_fd(i_socket(iauth)),
2016                                  readbuf + length,
2017                                  sizeof(readbuf) - length - 1,
2018                                  &count))
2019     return;
2020   readbuf[length += count] = '\0';
2021
2022   /* Parse each complete line. */
2023   for (sol = readbuf; (eol = strchr(sol, '\n')) != NULL; sol = eol + 1) {
2024     *eol = '\0';
2025     if (*(eol - 1) == '\r') /* take out carriage returns, too... */
2026       *(eol - 1) = '\0';
2027
2028     /* If spammy debug, send the message to opers. */
2029     if (i_debug(iauth) > 1)
2030       sendto_opmask_butone(NULL, SNO_AUTH, "Parsing: \"%s\"", sol);
2031
2032     /* Parse the line... */
2033     iauth_parse(iauth, sol);
2034   }
2035
2036   /* Put unused data back into connection's buffer. */
2037   iauth->i_count = strlen(sol);
2038   if (iauth->i_count > BUFSIZE)
2039     iauth->i_count = BUFSIZE;
2040   memcpy(iauth->i_buffer, sol, iauth->i_count);
2041 }
2042
2043 /** Handle socket activity for an %IAuth connection.
2044  * @param[in] ev &Socket event; the IAuth connection is the user data
2045  *   pointer for the socket.
2046  */
2047 static void iauth_sock_callback(struct Event *ev)
2048 {
2049   struct IAuth *iauth;
2050
2051   assert(0 != ev_socket(ev));
2052   iauth = (struct IAuth*) s_data(ev_socket(ev));
2053   assert(0 != iauth);
2054
2055   switch (ev_type(ev)) {
2056   case ET_DESTROY:
2057     /* Hm, what happened here? */
2058     if (!IAuthHas(iauth, IAUTH_CLOSING))
2059       iauth_do_spawn(iauth, 1);
2060     break;
2061   case ET_READ:
2062     iauth_read(iauth);
2063     break;
2064   case ET_WRITE:
2065     IAuthClr(iauth, IAUTH_BLOCKED);
2066     iauth_write(iauth);
2067     break;
2068   case ET_ERROR:
2069     log_write(LS_IAUTH, L_ERROR, 0, "IAuth socket error: %s", strerror(ev_data(ev)));
2070     /* and fall through to the ET_EOF case */
2071   case ET_EOF:
2072     iauth_disconnect(iauth);
2073     break;
2074   default:
2075     assert(0 && "Unrecognized event type");
2076     break;
2077   }
2078 }
2079
2080 /** Read error input from \a iauth.
2081  * @param[in] iauth Readable connection.
2082  */
2083 static void iauth_read_stderr(struct IAuth *iauth)
2084 {
2085   static char readbuf[SERVER_TCP_WINDOW];
2086   unsigned int length, count;
2087   char *sol;
2088   char *eol;
2089
2090   /* Copy partial data to readbuf, append new data. */
2091   length = iauth->i_errcount;
2092   memcpy(readbuf, iauth->i_errbuf, length);
2093   if (IO_SUCCESS != os_recv_nonb(s_fd(i_stderr(iauth)),
2094                                  readbuf + length,
2095                                  sizeof(readbuf) - length - 1,
2096                                  &count))
2097     return;
2098   readbuf[length += count] = '\0';
2099
2100   /* Send each complete line to SNO_AUTH. */
2101   for (sol = readbuf; (eol = strchr(sol, '\n')) != NULL; sol = eol + 1) {
2102     *eol = '\0';
2103     if (*(eol - 1) == '\r') /* take out carriage returns, too... */
2104       *(eol - 1) = '\0';
2105     Debug((DEBUG_ERROR, "IAuth error: %s", sol));
2106     log_write(LS_IAUTH, L_ERROR, 0, "IAuth error: %s", sol);
2107     sendto_opmask_butone(NULL, SNO_AUTH, "%s", sol);
2108   }
2109
2110   /* Put unused data back into connection's buffer. */
2111   iauth->i_errcount = strlen(sol);
2112   if (iauth->i_errcount > BUFSIZE)
2113     iauth->i_errcount = BUFSIZE;
2114   memcpy(iauth->i_errbuf, sol, iauth->i_errcount);
2115 }
2116
2117 /** Handle error socket activity for an %IAuth connection.
2118  * @param[in] ev &Socket event; the IAuth connection is the user data
2119  *   pointer for the socket.
2120  */
2121 static void iauth_stderr_callback(struct Event *ev)
2122 {
2123   struct IAuth *iauth;
2124
2125   assert(0 != ev_socket(ev));
2126   iauth = (struct IAuth*) s_data(ev_socket(ev));
2127   assert(0 != iauth);
2128
2129   switch (ev_type(ev)) {
2130   case ET_READ:
2131     iauth_read_stderr(iauth);
2132     break;
2133   case ET_ERROR:
2134     log_write(LS_IAUTH, L_ERROR, 0, "IAuth stderr error: %s", strerror(ev_data(ev)));
2135     /* and fall through to the ET_EOF/ET_DESTROY case */
2136   case ET_DESTROY:
2137   case ET_EOF:
2138     break;
2139   default:
2140     assert(0 && "Unrecognized event type");
2141     break;
2142   }
2143 }
2144
2145 /** Report active iauth's configuration to \a cptr.
2146  * @param[in] cptr Client requesting statistics.
2147  * @param[in] sd Stats descriptor for request.
2148  * @param[in] param Extra parameter from user (may be NULL).
2149  */
2150 void report_iauth_conf(struct Client *cptr, const struct StatDesc *sd, char *param)
2151 {
2152     struct SLink *link;
2153
2154     if (iauth) for (link = iauth->i_config; link; link = link->next)
2155     {
2156         send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":%s",
2157                    link->value.cp);
2158     }
2159     send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":End of IAuth configuration.");
2160 }
2161
2162 /** Report active iauth's statistics to \a cptr.
2163  * @param[in] cptr Client requesting statistics.
2164  * @param[in] sd Stats descriptor for request.
2165  * @param[in] param Extra parameter from user (may be NULL).
2166  */
2167  void report_iauth_stats(struct Client *cptr, const struct StatDesc *sd, char *param)
2168 {
2169     struct SLink *link;
2170
2171     if (iauth) for (link = iauth->i_stats; link; link = link->next)
2172     {
2173         send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":%s",
2174                    link->value.cp);
2175     }
2176     send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":End of IAuth statistics.");
2177 }