]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/irc-login.c
Merge branches 'CloakUserHost', 'QuitOnHTTP' and 'bug72-WHOIS-List'
[ngircd-alex.git] / src / ngircd / irc-login.c
index 8ac5471ad488bfd36eaf1067969263ff6aa5778f..92d54ab15e42ad64d2e7d05bd605bccc1cd7f734 100644 (file)
@@ -7,13 +7,15 @@
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  * Please read the file COPYING, README and AUTHORS for more information.
- *
- * Login and logout
  */
 
-
 #include "portab.h"
 
+/**
+ * @file
+ * Login and logout
+ */
+
 #include "imp.h"
 #include <assert.h>
 #include <stdio.h>
@@ -54,8 +56,13 @@ static void cb_Read_Auth_Result PARAMS((int r_fd, UNUSED short events));
 #endif
 
 /**
- * Handler for the IRC command "PASS".
+ * Handler for the IRC "PASS" command.
+ *
  * See RFC 2813 section 4.1.1, and RFC 2812 section 3.1.1.
+ *
+ * @param Client       The client from which this command has been received.
+ * @param Req          Request structure with prefix and all parameters.
+ * @returns            CONNECTED or DISCONNECTED.
  */
 GLOBAL bool
 IRC_PASS( CLIENT *Client, REQUEST *Req )
@@ -143,16 +150,17 @@ IRC_PASS( CLIENT *Client, REQUEST *Req )
                if (type && strcmp(type, PROTOIRCPLUS) == 0) {
                        /* The peer seems to be a server which supports the
                         * IRC+ protocol (see doc/Protocol.txt). */
-                       serverver = ptr + 1;
-                       flags = strchr(serverver, ':');
+                       serverver = ptr ? ptr + 1 : "?";
+                       flags = strchr(ptr ? serverver : impl, ':');
                        if (flags) {
                                *flags = '\0';
                                flags++;
                        } else
                                flags = "";
                        Log(LOG_INFO,
-                           "Peer announces itself as %s-%s using protocol %d.%d/IRC+ (flags: \"%s\").",
-                           impl, serverver, protohigh, protolow, flags);
+                           "Peer on conenction %d announces itself as %s-%s using protocol %d.%d/IRC+ (flags: \"%s\").",
+                           Client_Conn(Client), impl, serverver,
+                           protohigh, protolow, flags);
                } else {
                        /* The peer seems to be a server supporting the
                         * "original" IRC protocol (RFC 2813). */
@@ -161,8 +169,9 @@ IRC_PASS( CLIENT *Client, REQUEST *Req )
                        else
                                flags = "";
                        Log(LOG_INFO,
-                           "Peer announces itself as \"%s\" using protocol %d.%d (flags: \"%s\").",
-                           impl, protohigh, protolow, flags);
+                           "Peer on connection %d announces itself as \"%s\" using protocol %d.%d (flags: \"%s\").",
+                           Client_Conn(Client), impl,
+                           protohigh, protolow, flags);
                }
                Client_SetFlags(Client, flags);
        }
@@ -172,10 +181,17 @@ IRC_PASS( CLIENT *Client, REQUEST *Req )
 
 
 /**
- * IRC "NICK" command.
+ * Handler for the IRC "NICK" command.
+ *
+ * See RFC 2812, 3.1.2 "Nick message", and RFC 2813, 4.1.3 "Nick".
+ *
  * This function implements the IRC command "NICK" which is used to register
  * with the server, to change already registered nicknames and to introduce
  * new users which are connected to other servers.
+ *
+ * @param Client       The client from which this command has been received.
+ * @param Req          Request structure with prefix and all parameters.
+ * @returns            CONNECTED or DISCONNECTED.
  */
 GLOBAL bool
 IRC_NICK( CLIENT *Client, REQUEST *Req )
@@ -377,7 +393,13 @@ IRC_NICK( CLIENT *Client, REQUEST *Req )
 
 
 /**
- * Handler for the IRC command "USER".
+ * Handler for the IRC "USER" command.
+ *
+ * See RFC 2812, 3.1.3 "User message".
+ *
+ * @param Client       The client from which this command has been received.
+ * @param Req          Request structure with prefix and all parameters.
+ * @returns            CONNECTED or DISCONNECTED.
  */
 GLOBAL bool
 IRC_USER(CLIENT * Client, REQUEST * Req)
@@ -470,12 +492,18 @@ IRC_USER(CLIENT * Client, REQUEST * Req)
 
 
 /**
- * Handler for the IRC command "SERVICE".
+ * Handler for the IRC "SERVICE" command.
+ *
  * This function implements IRC Services registration using the SERVICE command
  * defined in RFC 2812 3.1.6 and RFC 2813 4.1.4.
+ *
  * At the moment ngIRCd doesn't support directly linked services, so this
  * function returns ERR_ERRONEUSNICKNAME when the SERVICE command has not been
  * received from a peer server.
+ *
+ * @param Client       The client from which this command has been received.
+ * @param Req          Request structure with prefix and all parameters.
+ * @returns            CONNECTED or DISCONNECTED..
  */
 GLOBAL bool
 IRC_SERVICE(CLIENT *Client, REQUEST *Req)
@@ -568,8 +596,14 @@ IRC_SERVICE(CLIENT *Client, REQUEST *Req)
 
 
 /**
- * Handler for the IRC command "WEBIRC".
- * Syntax: WEBIRC <password> <username> <real-hostname> <real-IP-address>
+ * Handler for the IRC "WEBIRC" command.
+ *
+ * See doc/Protocol.txt, section II.4:
+ * "Update webchat/proxy client information".
+ *
+ * @param Client       The client from which this command has been received.
+ * @param Req          Request structure with prefix and all parameters.
+ * @returns            CONNECTED or DISCONNECTED.
  */
 GLOBAL bool
 IRC_WEBIRC(CLIENT *Client, REQUEST *Req)
@@ -593,6 +627,15 @@ IRC_WEBIRC(CLIENT *Client, REQUEST *Req)
 } /* IRC_WEBIRC */
 
 
+/**
+ * Handler for the IRC "QUIT" command.
+ *
+ * See RFC 2812, 3.1.7 "Quit", and RFC 2813, 4.1.5 "Quit".
+ *
+ * @param Client       The client from which this command has been received.
+ * @param Req          Request structure with prefix and all parameters.
+ * @returns            CONNECTED or DISCONNECTED.
+ */
 GLOBAL bool
 IRC_QUIT( CLIENT *Client, REQUEST *Req )
 {
@@ -640,6 +683,38 @@ IRC_QUIT( CLIENT *Client, REQUEST *Req )
 } /* IRC_QUIT */
 
 
+#ifndef STRICT_RFC
+
+/**
+ * Handler for HTTP command, e.g. GET and POST
+ *
+ * We handle these commands here to avoid the quite long timeout when
+ * some user tries to access this IRC daemon using an web browser ...
+ *
+ * @param Client       The client from which this command has been received.
+ * @param Req          Request structure with prefix and all parameters.
+ * @returns            CONNECTED or DISCONNECTED.
+ */
+GLOBAL bool
+IRC_QUIT_HTTP( CLIENT *Client, REQUEST *Req )
+{
+       Req->argc = 1;
+       Req->argv[0] = "Oops, HTTP request received? This is IRC!";
+       return IRC_QUIT(Client, Req);
+} /* IRC_QUIT_HTTP */
+
+#endif
+
+
+/**
+ * Handler for the IRC "PING" command.
+ *
+ * See RFC 2812, 3.7.2 "Ping message".
+ *
+ * @param Client       The client from which this command has been received.
+ * @param Req          Request structure with prefix and all parameters.
+ * @returns            CONNECTED or DISCONNECTED.
+ */
 GLOBAL bool
 IRC_PING(CLIENT *Client, REQUEST *Req)
 {
@@ -709,6 +784,15 @@ IRC_PING(CLIENT *Client, REQUEST *Req)
 } /* IRC_PING */
 
 
+/**
+ * Handler for the IRC "PONG" command.
+ *
+ * See RFC 2812, 3.7.3 "Pong message".
+ *
+ * @param Client       The client from which this command has been received.
+ * @param Req          Request structure with prefix and all parameters.
+ * @returns            CONNECTED or DISCONNECTED.
+ */
 GLOBAL bool
 IRC_PONG(CLIENT *Client, REQUEST *Req)
 {
@@ -767,6 +851,17 @@ IRC_PONG(CLIENT *Client, REQUEST *Req)
 } /* IRC_PONG */
 
 
+/**
+ * Initiate client registration.
+ *
+ * This function is called after the daemon received the required NICK and
+ * USER commands of a new client. If the daemon is compiled with support for
+ * PAM, the authentication sub-processs is forked; otherwise the global server
+ * password is checked.
+ *
+ * @param Client       The client logging in.
+ * @returns            CONNECTED or DISCONNECTED.
+ */
 static bool
 Hello_User(CLIENT * Client)
 {
@@ -778,7 +873,7 @@ Hello_User(CLIENT * Client)
        assert(Client != NULL);
        conn = Client_Conn(Client);
 
-       if (Conf_NoPAM) {
+       if (!Conf_PAM) {
                /* Don't do any PAM authentication at all, instead emulate
                 * the beahiour of the daemon compiled without PAM support:
                 * because there can't be any "server password", all
@@ -789,7 +884,10 @@ Hello_User(CLIENT * Client)
                return DISCONNECTED;
        }
 
-       pid = Proc_Fork(Conn_GetProcStat(conn), pipefd, cb_Read_Auth_Result);
+       /* Fork child process for PAM authentication; and make sure that the
+        * process timeout is set higher than the login timeout! */
+       pid = Proc_Fork(Conn_GetProcStat(conn), pipefd,
+                       cb_Read_Auth_Result, Conf_PongTimeout + 1);
        if (pid > 0) {
                LogDebug("Authenticator for connection %d created (PID %d).",
                         conn, pid);
@@ -798,7 +896,9 @@ Hello_User(CLIENT * Client)
                /* Sub process */
                Log_Init_Subprocess("Auth");
                result = PAM_Authenticate(Client);
-               write(pipefd[1], &result, sizeof(result));
+               if (write(pipefd[1], &result, sizeof(result)) != sizeof(result))
+                       Log_Subprocess(LOG_ERR,
+                                      "Failed to pipe result to parent!");
                Log_Exit_Subprocess("Auth");
                exit(0);
        }
@@ -820,6 +920,9 @@ Hello_User(CLIENT * Client)
 
 /**
  * Read result of the authenticatior sub-process from pipe
+ *
+ * @param r_fd         File descriptor of the pipe.
+ * @param events       (ignored IO specification)
  */
 static void
 cb_Read_Auth_Result(int r_fd, UNUSED short events)
@@ -847,24 +950,30 @@ cb_Read_Auth_Result(int r_fd, UNUSED short events)
        if (len == 0)
                return;
 
-       /* Make sure authenticator sub-process is dead now ... */
-       Proc_Kill(proc);
-
        if (len != sizeof(result)) {
                Log(LOG_CRIT, "Auth: Got malformed result!");
                Reject_Client(client);
                return;
        }
 
-       if (result == true)
+       if (result == true) {
+               Client_SetUser(client, Client_OrigUser(client), true);
                (void)Hello_User_PostAuth(client);
-       else
+       else
                Reject_Client(client);
 }
 
 #endif
 
 
+/**
+ * Reject a client because of wrong password.
+ *
+ * This function is called either when the global server password or a password
+ * checked using PAM has been wrong.
+ *
+ * @param Client       The client to reject.
+ */
 static void
 Reject_Client(CLIENT *Client)
 {
@@ -876,6 +985,15 @@ Reject_Client(CLIENT *Client)
 }
 
 
+/**
+ * Finish client registration.
+ *
+ * Introduce the new client to the network and send all "hello messages"
+ * to it after authentication has been succeeded.
+ *
+ * @param Client       The client logging in.
+ * @returns            CONNECTED or DISCONNECTED.
+ */
 static bool
 Hello_User_PostAuth(CLIENT *Client)
 {
@@ -915,6 +1033,12 @@ Hello_User_PostAuth(CLIENT *Client)
 }
 
 
+/**
+ * Kill all users with a specific nick name in the network.
+ *
+ * @param Nick         Nick name.
+ * @param Reason       Reason for the KILL.
+ */
 static void
 Kill_Nick( char *Nick, char *Reason )
 {
@@ -933,6 +1057,13 @@ Kill_Nick( char *Nick, char *Reason )
 } /* Kill_Nick */
 
 
+/**
+ * Introduce a new user or service client in the network.
+ *
+ * @param From         Remote server introducing the client or NULL (local).
+ * @param Client       New client.
+ * @param Type         Type of the client (CLIENT_USER or CLIENT_SERVICE).
+ */
 static void
 Introduce_Client(CLIENT *From, CLIENT *Client, int Type)
 {
@@ -966,6 +1097,16 @@ Introduce_Client(CLIENT *From, CLIENT *Client, int Type)
 } /* Introduce_Client */
 
 
+/**
+ * Introduce a new user or service client to a remote server.
+ *
+ * This function differentiates between RFC1459 and RFC2813 server links and
+ * generates the appropriate commands to register the new user or service.
+ *
+ * @param To           The remote server to inform.
+ * @param Prefix       Prefix for the generated commands.
+ * @param data         CLIENT structure of the new client.
+ */
 static void
 cb_introduceClient(CLIENT *To, CLIENT *Prefix, void *data)
 {