/*
* ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001-2008 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>
#include <imp.h>
#include "ngircd.h"
#include "channel.h"
-#include "resolve.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];
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 )
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));
}
*/
static CLIENT *
Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
- int Type, const char *ID, const char *User, const char *Hostname, const char *Info, int Hops,
- int Token, const char *Modes, bool Idented)
+ int Type, const char *ID, const char *User, const char *Hostname,
+ const char *Info, int Hops, int Token, const char *Modes, bool Idented)
{
CLIENT *client;
- assert( Idx >= NONE );
- assert( Introducer != NULL );
- assert( Hostname != NULL );
+ assert(Idx >= NONE);
+ assert(Introducer != NULL);
- client = New_Client_Struct( );
- if( ! client ) return NULL;
+ client = New_Client_Struct();
+ if (!client)
+ return NULL;
client->starttime = time(NULL);
client->conn_id = Idx;
client->introducer = Introducer;
client->topserver = TopServer;
client->type = Type;
- if( ID ) Client_SetID( client, ID );
- if( User ) Client_SetUser( client, User, Idented );
- if( Hostname ) Client_SetHostname( client, Hostname );
- if( Info ) Client_SetInfo( client, Info );
+ if (ID)
+ Client_SetID(client, ID);
+ if (User) {
+ Client_SetUser(client, User, Idented);
+ Client_SetOrigUser(client, User);
+ }
+ if (Hostname)
+ Client_SetHostname(client, Hostname);
+ if (Info)
+ Client_SetInfo(client, Info);
client->hops = Hops;
client->token = Token;
- if( Modes ) Client_SetModes( client, Modes );
- if( Type == CLIENT_SERVER ) Generate_MyToken( client );
+ if (Modes)
+ Client_SetModes(client, Modes);
+ if (Type == CLIENT_SERVER)
+ Generate_MyToken(client);
- if( strchr( client->modes, 'a' ))
- strlcpy( client->away, DEFAULT_AWAY_MSG, sizeof( client->away ));
+ if (strchr(client->modes, 'a'))
+ strlcpy(client->away, DEFAULT_AWAY_MSG, sizeof(client->away));
client->next = (POINTER *)My_Clients;
My_Clients = client;
- Adjust_Counters( client );
+ Adjust_Counters(client);
return client;
} /* Init_New_Client */
} /* 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(cloak, Hostname, GETID_LEN);
+ strlcat(cloak, Conf_CloakHostSalt, GETID_LEN);
+ snprintf(cloak, GETID_LEN, Conf_CloakHost, Hash(cloak));
- strlcpy( Client->host, Hostname, sizeof( Client->host ));
+ 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 */
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 */
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] = '~';
} /* 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 )
{
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 */
} /* 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) {
} /* 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.
+ * @param Client Pointer to client structure
+ * @return Pointer to client hostname
+ */
+GLOBAL char *
+Client_HostnameCloaked(CLIENT *Client)
+{
+ assert(Client != NULL);
+ if (Client_HasMode(Client, 'x'))
+ return Client_ID(Client->introducer);
+ else
+ return Client_Hostname(Client);
+} /* Client_HostnameCloaked */
+
+
GLOBAL char *
Client_Password( 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];
+ char Cloak_Buffer[GETID_LEN];
+
+ assert (Client != NULL);
+
+ /* Is the client using cloaking at all? */
+ if (!Client_HasMode(Client, 'x'))
+ return Client_Mask(Client);
+
+ if(*Conf_CloakHostModeX) {
+ strlcpy(Cloak_Buffer, Client->host, GETID_LEN);
+ strlcat(Cloak_Buffer, Conf_CloakHostSalt, GETID_LEN);
+ snprintf(Cloak_Buffer, GETID_LEN, Conf_CloakHostModeX, Hash(Cloak_Buffer));
+ } else {
+ strncpy(Cloak_Buffer, Client_ID(Client->introducer), GETID_LEN);
+ }
+
+ snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s",
+ Client->id, Client->user, Cloak_Buffer);
+
+ return Mask_Buffer;
+} /* Client_MaskCloaked */
+
+
GLOBAL CLIENT *
Client_Introducer( 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 );
+ /* Nickname already registered? */
+ if (Client_Search(Nick)) {
+ IRC_WriteStrClient(Client, ERR_NICKNAMEINUSE_MSG,
+ Client_ID(Client), Nick);
return false;
}
} /* 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++;
}
} /* 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 )
{
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 )
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 ));
} /* Client_RegisterWhowas */
-GLOBAL char *
+GLOBAL const char *
Client_TypeText(CLIENT *Client)
{
assert(Client != NULL);
"%s \"%s\" unregistered (connection %d): %s",
Client_TypeText(Client), Client_Mask(Client),
Client->conn_id, Txt);
+ Log_ServerNotice('c', "Client exiting: %s (%s@%s) [%s]",
+ Client_ID(Client), Client_User(Client),
+ Client_Hostname(Client), Txt);
if (SendQuit) {
/* Inforam all the other servers */
} /* 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- */