]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/client.c
Always cloak client hostname, if needed
[ngircd-alex.git] / src / ngircd / client.c
index e6dbf1563c78e1f919954b91400a040d8b997d73..4728c7a4672ac802d944dc599d23031f75e50d60 100644 (file)
@@ -1,22 +1,23 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001-2010 Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2012 Alexander Barton (alex@barton.de)
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * 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.
- *
- * Client management.
  */
 
-
 #define __client_c__
 
-
 #include "portab.h"
 
+/**
+ * @file
+ * Client management.
+ */
+
 #include "imp.h"
 #include <assert.h>
 #include <unistd.h>
@@ -36,6 +37,7 @@
 #include "ngircd.h"
 #include "channel.h"
 #include "conf.h"
+#include "conn-func.h"
 #include "hash.h"
 #include "irc-write.h"
 #include "log.h"
 
 #include <exp.h>
 
-
 #define GETID_LEN (CLIENT_NICK_LEN-1) + 1 + (CLIENT_USER_LEN-1) + 1 + (CLIENT_HOST_LEN-1) + 1
 
-
 static CLIENT *This_Server, *My_Clients;
 
 static WHOWAS My_Whowas[MAX_WHOWAS];
@@ -70,6 +70,8 @@ static CLIENT *Init_New_Client PARAMS((CONN_ID Idx, CLIENT *Introducer,
 static void Destroy_UserOrService PARAMS((CLIENT *Client,const char *Txt, const char *FwdMsg,
                                        bool SendQuit));
 
+static void cb_introduceClient PARAMS((CLIENT *Client, CLIENT *Prefix,
+                                      void *i));
 
 GLOBAL void
 Client_Init( void )
@@ -93,7 +95,7 @@ Client_Init( void )
        This_Server->hops = 0;
 
        gethostname( This_Server->host, CLIENT_HOST_LEN );
-       if (!Conf_NoDNS) {
+       if (Conf_DNS) {
                h = gethostbyname( This_Server->host );
                if (h) strlcpy(This_Server->host, h->h_name, sizeof(This_Server->host));
        }
@@ -187,7 +189,6 @@ Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
 
        assert(Idx >= NONE);
        assert(Introducer != NULL);
-       assert(Hostname != NULL);
 
        client = New_Client_Struct();
        if (!client)
@@ -200,8 +201,10 @@ Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
        client->type = Type;
        if (ID)
                Client_SetID(client, ID);
-       if (User)
+       if (User) {
                Client_SetUser(client, User, Idented);
+               Client_SetOrigUser(client, User);
+       }
        if (Hostname)
                Client_SetHostname(client, Hostname);
        if (Info)
@@ -312,13 +315,36 @@ Client_Destroy( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool Sen
 } /* Client_Destroy */
 
 
+/**
+ * Set client hostname.
+ *
+ * If global hostname cloaking is in effect, don't set the real hostname
+ * but the configured one.
+ *
+ * @param Client The client of which the hostname should be set.
+ * @param Hostname The new hostname.
+ */
 GLOBAL void
 Client_SetHostname( CLIENT *Client, const char *Hostname )
 {
-       assert( Client != NULL );
-       assert( Hostname != NULL );
+       assert(Client != NULL);
+       assert(Hostname != NULL);
+
+       if (strlen(Conf_CloakHost)) {
+               char cloak[GETID_LEN];
 
-       strlcpy( Client->host, Hostname, sizeof( Client->host ));
+               strlcpy(cloak, Hostname, GETID_LEN);
+               strlcat(cloak, Conf_CloakHostSalt, GETID_LEN);
+               snprintf(cloak, GETID_LEN, Conf_CloakHost, Hash(cloak));
+
+               LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
+                       Client_ID(Client), Client->host, cloak);
+               strlcpy(Client->host, cloak, sizeof(Client->host));
+       } else {
+               LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
+                        Client_ID(Client), Client->host, Hostname);
+               strlcpy(Client->host, Hostname, sizeof(Client->host));
+       }
 } /* Client_SetHostname */
 
 
@@ -330,6 +356,11 @@ Client_SetID( CLIENT *Client, const char *ID )
        
        strlcpy( Client->id, ID, sizeof( Client->id ));
 
+       if (Conf_CloakUserToNick) {
+               strlcpy( Client->user, ID, sizeof( Client->user ));
+               strlcpy( Client->info, ID, sizeof( Client->info ));
+       }
+
        /* Hash */
        Client->hash = Hash( Client->id );
 } /* Client_SetID */
@@ -343,7 +374,9 @@ Client_SetUser( CLIENT *Client, const char *User, bool Idented )
        assert( Client != NULL );
        assert( User != NULL );
 
-       if (Idented) {
+       if (Conf_CloakUserToNick) {
+               strlcpy(Client->user, Client->id, sizeof(Client->user));
+       } else if (Idented) {
                strlcpy(Client->user, User, sizeof(Client->user));
        } else {
                Client->user[0] = '~';
@@ -352,6 +385,26 @@ Client_SetUser( CLIENT *Client, const char *User, bool Idented )
 } /* Client_SetUser */
 
 
+/**
+ * Set "original" user name of a client.
+ * This function saves the "original" user name, the user name specified by
+ * the peer using the USER command, into the CLIENT structure. This user
+ * name may be used for authentication, for example.
+ * @param Client The client.
+ * @param User User name to set.
+ */
+GLOBAL void
+Client_SetOrigUser(CLIENT UNUSED *Client, const char UNUSED *User)
+{
+       assert(Client != NULL);
+       assert(User != NULL);
+
+#if defined(PAM) && defined(IDENTAUTH)
+       strlcpy(Client->orig_user, User, sizeof(Client->orig_user));
+#endif
+} /* Client_SetOrigUser */
+
+
 GLOBAL void
 Client_SetInfo( CLIENT *Client, const char *Info )
 {
@@ -360,7 +413,10 @@ Client_SetInfo( CLIENT *Client, const char *Info )
        assert( Client != NULL );
        assert( Info != NULL );
 
-       strlcpy(Client->info, Info, sizeof(Client->info));
+       if (Conf_CloakUserToNick)
+               strlcpy(Client->info, Client->id, sizeof(Client->info));
+       else
+               strlcpy(Client->info, Info, sizeof(Client->info));
 } /* Client_SetInfo */
 
 
@@ -384,18 +440,6 @@ Client_SetFlags( CLIENT *Client, const char *Flags )
 } /* Client_SetFlags */
 
 
-GLOBAL void
-Client_SetPassword( CLIENT *Client, const char *Pwd )
-{
-       /* set password sent by client */
-
-       assert( Client != NULL );
-       assert( Pwd != NULL );
-
-       strlcpy(Client->pwd, Pwd, sizeof(Client->pwd));
-} /* Client_SetPassword */
-
-
 GLOBAL void
 Client_SetAway( CLIENT *Client, const char *Txt )
 {
@@ -531,17 +575,19 @@ Client_Search( const char *Nick )
 } /* Client_Search */
 
 
+/**
+ * Get client structure ("introducer") identfied by a server token.
+ * @return CLIENT structure or NULL if none could be found.
+ */
 GLOBAL CLIENT *
 Client_GetFromToken( CLIENT *Client, int Token )
 {
-       /* Client-Struktur, die den entsprechenden Introducer (=Client)
-        * und das gegebene Token hat, liefern. Wird keine gefunden,
-        * so wird NULL geliefert. */
-
        CLIENT *c;
 
        assert( Client != NULL );
-       assert( Token > 0 );
+
+       if (!Token)
+               return NULL;
 
        c = My_Clients;
        while (c) {
@@ -601,20 +647,76 @@ Client_User( CLIENT *Client )
 } /* Client_User */
 
 
+#ifdef PAM
+
+/**
+ * Get the "original" user name as supplied by the USER command.
+ * The user name as given by the client is used for authentication instead
+ * of the one detected using IDENT requests.
+ * @param Client The client.
+ * @return Original user name.
+ */
+GLOBAL char *
+Client_OrigUser(CLIENT *Client) {
+#ifndef IDENTAUTH
+       char *user = Client->user;
+
+       if (user[0] == '~')
+               user++;
+       return user;
+#else
+       return Client->orig_user;
+#endif
+} /* Client_OrigUser */
+
+#endif
+
+
+/**
+ * Return the hostname of a client.
+ * @param Client Pointer to client structure
+ * @return Pointer to client hostname
+ */
 GLOBAL char *
-Client_Hostname( CLIENT *Client )
+Client_Hostname(CLIENT *Client)
 {
-       assert( Client != NULL );
+       assert (Client != NULL);
        return Client->host;
 } /* Client_Hostname */
 
 
+/**
+ * Get potentially cloaked hostname of a client.
+ *
+ * If the client has not enabled cloaking, the real hostname is used.
+ * Please note that this function uses a global static buffer, so you can't
+ * nest invocations without overwriting earlier results!
+ *
+ * @param Client Pointer to client structure
+ * @return Pointer to client hostname
+ */
 GLOBAL char *
-Client_Password( CLIENT *Client )
+Client_HostnameCloaked(CLIENT *Client)
 {
-       assert( Client != NULL );
-       return Client->pwd;
-} /* Client_Password */
+       static char Cloak_Buffer[CLIENT_HOST_LEN];
+
+       assert(Client != NULL);
+
+       if (!Client_HasMode(Client, 'x'))
+               return Client_Hostname(Client);
+
+       /* Do simple mapping to the server ID? */
+       if (!*Conf_CloakHostModeX)
+               return Client_ID(Client->introducer);
+
+       strlcpy(Cloak_Buffer, Client->host, CLIENT_HOST_LEN);
+       strlcat(Cloak_Buffer, Conf_CloakHostSalt, CLIENT_HOST_LEN);
+
+       snprintf(Cloak_Buffer, CLIENT_HOST_LEN, Conf_CloakHostModeX,
+                Hash(Cloak_Buffer));
+
+       return Cloak_Buffer;
+} /* Client_HostnameCloaked */
 
 
 GLOBAL char *
@@ -681,23 +783,59 @@ Client_NextHop( CLIENT *Client )
 
 
 /**
- * return Client-ID ("client!user@host"), this ID is needed for e.g.
- * prefixes.  Returnes pointer to static buffer.
+ * Return ID of a client: "client!user@host"
+ * This client ID is used for IRC prefixes, for example.
+ * Please note that this function uses a global static buffer, so you can't
+ * nest invocations without overwriting earlier results!
+ * @param Client Pointer to client structure
+ * @return Pointer to global buffer containing the client ID
  */
 GLOBAL char *
 Client_Mask( CLIENT *Client )
 {
-       static char GetID_Buffer[GETID_LEN];
+       static char Mask_Buffer[GETID_LEN];
 
-       assert( Client != NULL );
+       assert (Client != NULL);
 
-       if( Client->type == CLIENT_SERVER ) return Client->id;
+       /* Servers: return name only, there is no "mask" */
+       if (Client->type == CLIENT_SERVER)
+               return Client->id;
 
-       snprintf(GetID_Buffer, GETID_LEN, "%s!%s@%s", Client->id, Client->user, Client->host);
-       return GetID_Buffer;
+       snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s",
+                Client->id, Client->user, Client->host);
+       return Mask_Buffer;
 } /* Client_Mask */
 
 
+/**
+ * Return ID of a client with cloaked hostname: "client!user@server-name"
+ *
+ * This client ID is used for IRC prefixes, for example.
+ * Please note that this function uses a global static buffer, so you can't
+ * nest invocations without overwriting earlier results!
+ * If the client has not enabled cloaking, the real hostname is used.
+ *
+ * @param Client Pointer to client structure
+ * @return Pointer to global buffer containing the client ID
+ */
+GLOBAL char *
+Client_MaskCloaked(CLIENT *Client)
+{
+       static char Mask_Buffer[GETID_LEN];
+
+       assert (Client != NULL);
+
+       /* Is the client using cloaking at all? */
+       if (!Client_HasMode(Client, 'x'))
+               return Client_Mask(Client);
+
+       snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s", Client->id, Client->user,
+                Client_HostnameCloaked(Client));
+
+       return Mask_Buffer;
+} /* Client_MaskCloaked */
+
+
 GLOBAL CLIENT *
 Client_Introducer( CLIENT *Client )
 {
@@ -730,23 +868,47 @@ Client_Away( CLIENT *Client )
 } /* Client_Away */
 
 
+/**
+ * Make sure that a given nickname is valid.
+ *
+ * If the nickname is not valid for the given client, this function sends back
+ * the appropriate error messages.
+ *
+ * @param      Client Client that wants to change the nickname.
+ * @param      Nick New nick name.
+ * @returns    true if nickname is valid, false otherwise.
+ */
 GLOBAL bool
-Client_CheckNick( CLIENT *Client, char *Nick )
+Client_CheckNick(CLIENT *Client, char *Nick)
 {
-       assert( Client != NULL );
-       assert( Nick != NULL );
-
-       if (! Client_IsValidNick( Nick ))
-       {
-               IRC_WriteStrClient( Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID( Client ), Nick );
+       assert(Client != NULL);
+       assert(Nick != NULL);
+
+       if (!Client_IsValidNick(Nick)) {
+               if (strlen(Nick ) >= Conf_MaxNickLength)
+                       IRC_WriteStrClient(Client, ERR_NICKNAMETOOLONG_MSG,
+                                          Client_ID(Client), Nick,
+                                          Conf_MaxNickLength - 1);
+               else
+                       IRC_WriteStrClient(Client, ERR_ERRONEUSNICKNAME_MSG,
+                                          Client_ID(Client), Nick);
                return false;
        }
 
-       /* Nick bereits vergeben? */
-       if( Client_Search( Nick ))
-       {
-               /* den Nick gibt es bereits */
-               IRC_WriteStrClient( Client, ERR_NICKNAMEINUSE_MSG, Client_ID( Client ), Nick );
+       if (Client_Type(Client) != CLIENT_SERVER
+           && Client_Type(Client) != CLIENT_SERVICE) {
+               /* Make sure that this isn't a restricted/forbidden nick name */
+               if (Conf_NickIsBlocked(Nick)) {
+                       IRC_WriteStrClient(Client, ERR_FORBIDDENNICKNAME_MSG,
+                                          Client_ID(Client), Nick);
+                       return false;
+               }
+       }
+
+       /* Nickname already registered? */
+       if (Client_Search(Nick)) {
+               IRC_WriteStrClient(Client, ERR_NICKNAMEINUSE_MSG,
+                       Client_ID(Client), Nick);
                return false;
        }
 
@@ -902,23 +1064,31 @@ Client_MyMaxUserCount( void )
 } /* Client_MyMaxUserCount */
 
 
+/**
+ * Check that a given nickname is valid.
+ *
+ * @param      Nick the nickname to check.
+ * @returns    true if nickname is valid, false otherwise.
+ */
 GLOBAL bool
-Client_IsValidNick( const char *Nick )
+Client_IsValidNick(const char *Nick)
 {
        const char *ptr;
        static const char goodchars[] = ";0123456789-";
 
-       assert( Nick != NULL );
+       assert (Nick != NULL);
 
-       if( Nick[0] == '#' ) return false;
-       if( strchr( goodchars, Nick[0] )) return false;
-       if( strlen( Nick ) >= Conf_MaxNickLength) return false;
+       if (strchr(goodchars, Nick[0]))
+               return false;
+       if (strlen(Nick ) >= Conf_MaxNickLength)
+               return false;
 
        ptr = Nick;
-       while( *ptr )
-       {
-               if (( *ptr < 'A' ) && ( ! strchr( goodchars, *ptr ))) return false;
-               if ( *ptr > '}' ) return false;
+       while (*ptr) {
+               if (*ptr < 'A' && !strchr(goodchars, *ptr ))
+                       return false;
+               if (*ptr > '}')
+                       return false;
                ptr++;
        }
 
@@ -958,6 +1128,79 @@ Client_StartTime(CLIENT *Client)
 } /* Client_Uptime */
 
 
+/**
+ * Reject a client when logging in.
+ *
+ * This function is called when a client isn't allowed to connect to this
+ * server. Possible reasons are bad server password, bad PAM password,
+ * or that the client is G/K-Line'd.
+ *
+ * After calling this function, the client isn't connected any more.
+ *
+ * @param Client The client to reject.
+ * @param Reason The reason why the client has been rejected.
+ * @param InformClient If true, send the exact reason to the client.
+ */
+GLOBAL void
+Client_Reject(CLIENT *Client, const char *Reason, bool InformClient)
+{
+       char info[COMMAND_LEN];
+
+       assert(Client != NULL);
+       assert(Reason != NULL);
+
+       if (InformClient)
+               snprintf(info, sizeof(info), "Access denied: %s", Reason);
+       else
+               strcpy(info, "Access denied: Bad password?");
+
+       Log(LOG_ERR,
+           "User \"%s\" rejected (connection %d): %s!",
+           Client_Mask(Client), Client_Conn(Client), Reason);
+       Conn_Close(Client_Conn(Client), Reason, info, true);
+}
+
+
+/**
+ * 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).
+ */
+GLOBAL void
+Client_Introduce(CLIENT *From, CLIENT *Client, int Type)
+{
+       /* Set client type (user or service) */
+       Client_SetType(Client, Type);
+
+       if (From) {
+               if (Conf_NickIsService(Conf_GetServer(Client_Conn(From)),
+                                  Client_ID(Client)))
+                       Client_SetType(Client, CLIENT_SERVICE);
+               LogDebug("%s \"%s\" (+%s) registered (via %s, on %s, %d hop%s).",
+                        Client_TypeText(Client), Client_Mask(Client),
+                        Client_Modes(Client), Client_ID(From),
+                        Client_ID(Client_Introducer(Client)),
+                        Client_Hops(Client), Client_Hops(Client) > 1 ? "s": "");
+       } else {
+               Log(LOG_NOTICE, "%s \"%s\" registered (connection %d).",
+                   Client_TypeText(Client), Client_Mask(Client),
+                   Client_Conn(Client));
+               Log_ServerNotice('c', "Client connecting: %s (%s@%s) [%s] - %s",
+                                Client_ID(Client), Client_User(Client),
+                                Client_Hostname(Client),
+                                Conn_IPA(Client_Conn(Client)),
+                                Client_TypeText(Client));
+       }
+
+       /* Inform other servers */
+       IRC_WriteStrServersPrefixFlag_CB(From,
+                               From != NULL ? From : Client_ThisServer(),
+                               '\0', cb_introduceClient, (void *)Client);
+} /* Client_Introduce */
+
+
 static unsigned long
 Count( CLIENT_TYPE Type )
 {
@@ -1075,6 +1318,10 @@ Client_RegisterWhowas( CLIENT *Client )
 
        assert( Client != NULL );
 
+       /* Don't register WHOWAS information when "MorePrivacy" is enabled. */
+       if (Conf_MorePrivacy)
+               return;
+
        now = time(NULL);
        /* Don't register clients that were connected less than 30 seconds. */
        if( now - Client->starttime < 30 )
@@ -1092,7 +1339,7 @@ Client_RegisterWhowas( CLIENT *Client )
                 sizeof( My_Whowas[slot].id ));
        strlcpy( My_Whowas[slot].user, Client_User( Client ),
                 sizeof( My_Whowas[slot].user ));
-       strlcpy( My_Whowas[slot].host, Client_Hostname( Client ),
+       strlcpy( My_Whowas[slot].host, Client_HostnameCloaked( Client ),
                 sizeof( My_Whowas[slot].host ));
        strlcpy( My_Whowas[slot].info, Client_Info( Client ),
                 sizeof( My_Whowas[slot].info ));
@@ -1173,4 +1420,79 @@ Destroy_UserOrService(CLIENT *Client, const char *Txt, const char *FwdMsg, bool
 } /* Destroy_UserOrService */
 
 
+/**
+ * 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)
+{
+       CLIENT *c = (CLIENT *)data;
+       CONN_ID conn;
+       char *modes, *user, *host;
+
+       modes = Client_Modes(c);
+       user = Client_User(c) ? Client_User(c) : "-";
+       host = Client_Hostname(c) ? Client_Hostname(c) : "-";
+
+       conn = Client_Conn(To);
+       if (Conn_Options(conn) & CONN_RFC1459) {
+               /* RFC 1459 mode: separate NICK and USER commands */
+               Conn_WriteStr(conn, "NICK %s :%d", Client_ID(c),
+                             Client_Hops(c) + 1);
+               Conn_WriteStr(conn, ":%s USER %s %s %s :%s",
+                             Client_ID(c), user, host,
+                             Client_ID(Client_Introducer(c)), Client_Info(c));
+               if (modes[0])
+                       Conn_WriteStr(conn, ":%s MODE %s +%s",
+                                     Client_ID(c), Client_ID(c), modes);
+       } else {
+               /* RFC 2813 mode: one combined NICK or SERVICE command */
+               if (Client_Type(c) == CLIENT_SERVICE
+                   && strchr(Client_Flags(To), 'S'))
+                       IRC_WriteStrClientPrefix(To, Prefix,
+                                                "SERVICE %s %d * +%s %d :%s",
+                                                Client_Mask(c),
+                                                Client_MyToken(Client_Introducer(c)),
+                                                Client_Modes(c), Client_Hops(c) + 1,
+                                                Client_Info(c));
+               else
+                       IRC_WriteStrClientPrefix(To, Prefix,
+                                                "NICK %s %d %s %s %d +%s :%s",
+                                                Client_ID(c), Client_Hops(c) + 1,
+                                                user, host,
+                                                Client_MyToken(Client_Introducer(c)),
+                                                modes, Client_Info(c));
+       }
+} /* cb_introduceClient */
+
+
+#ifdef DEBUG
+
+GLOBAL void
+Client_DebugDump(void)
+{
+       CLIENT *c;
+
+       Log(LOG_DEBUG, "Client status:");
+       c = My_Clients;
+       while (c) {
+               Log(LOG_DEBUG,
+                   " - %s: type=%d, host=%s, user=%s, conn=%d, start=%ld, flags=%s",
+                   Client_ID(c), Client_Type(c), Client_Hostname(c),
+                   Client_User(c), Client_Conn(c), Client_StartTime(c),
+                   Client_Flags(c));
+               c = (CLIENT *)c->next;
+       }
+} /* Client_DumpClients */
+
+#endif
+
+
 /* -eof- */