newio/include/client.h

/*
 *  ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
 *
 *  Copyright (C) 2002 by the past and present ircd coders, and others.
 *
 *  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.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 *  USA
 */

/*! \file client.h
 * \brief Header including structures, macros and prototypes for client handling
 * \version $Id$
 */


#ifndef INCLUDED_client_h
#define INCLUDED_client_h

#include "list.h"
#include "fdlist.h"
#include "config.h"
#include "ircd_defs.h"
#include "dbuf.h"
#include "channel.h"

/*
 * status macros.
 */
#define STAT_CONNECTING         0x01
#define STAT_HANDSHAKE          0x02
#define STAT_ME                 0x04
#define STAT_UNKNOWN            0x08
#define STAT_SERVER             0x10
#define STAT_CLIENT             0x20

#define REG_NEED_USER 0x1
#define REG_NEED_NICK 0x2
#define REG_NEED_CAP  0x4
#define REG_INIT (REG_NEED_USER|REG_NEED_NICK)

#define HasID(x)                ((x)->id[0] != '\0')
#define ID(x)                   (HasID(x) ? (x)->id : (x)->name)
#define ID_or_name(x,client_p)  ((IsCapable(client_p, CAP_TS6) && HasID(x)) ? (x)->id : (x)->name)

#define IsRegistered(x)         ((x)->status  > STAT_UNKNOWN)
#define IsConnecting(x)         ((x)->status == STAT_CONNECTING)
#define IsHandshake(x)          ((x)->status == STAT_HANDSHAKE)
#define IsMe(x)                 ((x)->status == STAT_ME)
#define IsUnknown(x)            ((x)->status == STAT_UNKNOWN)
#define IsServer(x)             ((x)->status == STAT_SERVER)
#define IsClient(x)             ((x)->status == STAT_CLIENT)

#define SetConnecting(x)        {(x)->status = STAT_CONNECTING; \
                                 (x)->handler = UNREGISTERED_HANDLER; }

#define SetHandshake(x)         {(x)->status = STAT_HANDSHAKE; \
                                 (x)->handler = UNREGISTERED_HANDLER; }

#define SetMe(x)                {(x)->status = STAT_ME; \
                                 (x)->handler = UNREGISTERED_HANDLER; }

#define SetUnknown(x)           {(x)->status = STAT_UNKNOWN; \
                                 (x)->handler = UNREGISTERED_HANDLER; }

#define SetServer(x)            {(x)->status = STAT_SERVER; \
                                 (x)->handler = SERVER_HANDLER; }

#define SetClient(x)            {(x)->status = STAT_CLIENT; \
                                 (x)->handler = HasUMode(x, UMODE_OPER) ? \
                                        OPER_HANDLER : CLIENT_HANDLER; }

#define MyConnect(x)            ((x)->localClient != NULL)
#define MyClient(x)             (MyConnect(x) && IsClient(x))

/*
 * ts stuff
 */
#define TS_CURRENT      6       /**< current TS protocol version */
#define TS_MIN          5       /**< minimum supported TS protocol version */
#define TS_DOESTS       0x20000000
#define DoesTS(x)       ((x)->tsinfo == TS_DOESTS)


#define CAP_MULTI_PREFIX  0x00000001
#define CAP_AWAY_NOTIFY   0x00000002

#define HasCap(x, y) ((x)->localClient->cap_active & (y))

/* housekeeping flags */
#define FLAGS_PINGSENT      0x00000001 /**< Unreplied ping sent */
#define FLAGS_DEADSOCKET    0x00000002 /**< Local socket is dead--Exiting soon */
#define FLAGS_KILLED        0x00000004 /**< Prevents "QUIT" from being sent for this */
#define FLAGS_CLOSING       0x00000008 /**< set when closing to suppress errors */
#define FLAGS_GOTID         0x00000010 /**< successful ident lookup achieved */
#define FLAGS_NEEDID        0x00000020 /**< auth{} block say must use ident return */
#define FLAGS_SENDQEX       0x00000040 /**< Sendq exceeded */
#define FLAGS_IPHASH        0x00000080 /**< iphashed this client */
#define FLAGS_MARK          0x00000100 /**< marked client */
#define FLAGS_CANFLOOD      0x00000200 /**< client has the ability to flood */
#define FLAGS_EXEMPTGLINE   0x00000400 /**< client can't be G-lined */
#define FLAGS_EXEMPTKLINE   0x00000800 /**< client is exempt from kline */
#define FLAGS_NOLIMIT       0x00001000 /**< client is exempt from limits */
#define FLAGS_PING_COOKIE   0x00002000 /**< PING Cookie */
#define FLAGS_IP_SPOOFING   0x00004000 /**< client IP is spoofed */
#define FLAGS_FLOODDONE     0x00008000 /**< Flood grace period has been ended. */
#define FLAGS_EOB           0x00010000 /**< server has sent us an EOB */
#define FLAGS_HIDDEN        0x00020000 /**< a hidden server. not shown in /links */
#define FLAGS_BLOCKED       0x00040000 /**< must wait for COMM_SELECT_WRITE */
#define FLAGS_USERHOST      0x00080000 /**< client is in userhost hash */
#define FLAGS_BURSTED       0x00100000 /**< user was already bursted */
#define FLAGS_EXEMPTRESV    0x00200000 /**< client is exempt from RESV */
#define FLAGS_GOTUSER       0x00400000 /**< if we received a USER command */
#define FLAGS_FINISHED_AUTH 0x00800000 /**< Client has been released from auth */
#define FLAGS_FLOOD_NOTICED 0x01000000 /**< Notice to opers about this flooder has been sent */
#define FLAGS_SERVICE       0x02000000 /**< Client/server is a network service */

#define HasFlag(x, y) ((x)->flags &   (y))
#define AddFlag(x, y) ((x)->flags |=  (y))
#define DelFlag(x, y) ((x)->flags &= ~(y))


/* umodes, settable flags */
#define UMODE_SERVNOTICE   0x00000001 /**< server notices such as kill */
#define UMODE_CCONN        0x00000002 /**< Client Connections */
#define UMODE_REJ          0x00000004 /**< Bot Rejections */
#define UMODE_SKILL        0x00000008 /**< Server Killed */
#define UMODE_FULL         0x00000010 /**< Full messages */
#define UMODE_SPY          0x00000020 /**< see STATS / LINKS */
#define UMODE_DEBUG        0x00000040 /**< 'debugging' info */
#define UMODE_NCHANGE      0x00000080 /**< Nick change notice */
#define UMODE_WALLOP       0x00000100 /**< send wallops to them */
#define UMODE_OPERWALL     0x00000200 /**< Operwalls */
#define UMODE_INVISIBLE    0x00000400 /**< makes user invisible */
#define UMODE_BOTS         0x00000800 /**< shows bots */
#define UMODE_EXTERNAL     0x00001000 /**< show servers introduced and splitting */
#define UMODE_CALLERID     0x00002000 /**< block unless caller id's */
#define UMODE_SOFTCALLERID 0x00004000 /**< block unless on common channel */
#define UMODE_UNAUTH       0x00008000 /**< show unauth connects here */
#define UMODE_LOCOPS       0x00010000 /**< show locops */
#define UMODE_DEAF         0x00020000 /**< don't receive channel messages */
#define UMODE_CCONN_FULL   0x00040000 /**< add unused fields to connection monitoring */
#define UMODE_REGISTERED   0x00080000 /**< User has identified for that nick. */
#define UMODE_REGONLY      0x00100000 /**< Only registered nicks may PM */
#define UMODE_HIDDEN       0x00200000 /**< Operator status is hidden */
#define UMODE_OPER         0x00400000 /**< Operator */
#define UMODE_ADMIN        0x00800000 /**< Admin on server */ 

#define UMODE_ALL          UMODE_SERVNOTICE

#define HasUMode(x, y) ((x)->umodes &   (y))
#define AddUMode(x, y) ((x)->umodes |=  (y))
#define DelUMode(x, y) ((x)->umodes &= ~(y))

#define SEND_UMODES  (UMODE_INVISIBLE | UMODE_OPER | UMODE_WALLOP |\
                      UMODE_REGONLY | UMODE_REGISTERED | UMODE_ADMIN |\
                      UMODE_HIDDEN)


/* oper priv flags */
#define OPER_FLAG_GLOBAL_KILL  0x00000001 /**< Oper can global kill        */
#define OPER_FLAG_REMOTE       0x00000002 /**> Oper can do squits/connects */
#define OPER_FLAG_UNKLINE      0x00000004 /**< Oper can use unkline        */
#define OPER_FLAG_GLINE        0x00000008 /**< Oper can use gline          */
#define OPER_FLAG_N            0x00000010 /**< Oper can umode n            */
#define OPER_FLAG_K            0x00000020 /**< Oper can kill/kline         */
#define OPER_FLAG_X            0x00000040 /**< Oper can xline              */
#define OPER_FLAG_DIE          0x00000080 /**< Oper can die                */
#define OPER_FLAG_REHASH       0x00000100 /**< Oper can rehash             */
#define OPER_FLAG_ADMIN        0x00000200 /**< Oper can set umode +a       */
#define OPER_FLAG_OPERWALL     0x00000400 /**< Oper can use OPERWALL command */
#define OPER_FLAG_OPER_SPY     0x00000800 /* */
#define OPER_FLAG_REMOTEBAN    0x00001000 /**< Oper can set remote bans */
#define OPER_FLAG_GLOBOPS      0x00002000 /**< Oper can use GLOBOPS command */
#define OPER_FLAG_MODULE       0x00004000 /**< Oper can use MODULE commands */
#define OPER_FLAG_RESTART      0x00008000 /**< Oper can use RESTART command */
#define OPER_FLAG_DLINE        0x00010000 /**< Oper can use DLINE command   */
#define OPER_FLAG_UNDLINE      0x00020000 /**< Oper can use UNDLINE command */
#define OPER_FLAG_SET          0x00040000 /**< Oper can use SET command */

#define HasOFlag(x, y) (MyConnect(x) ? (x)->localClient->operflags & (y) : 0)
#define AddOFlag(x, y) ((x)->localClient->operflags |=  (y))
#define DelOFlag(x, y) ((x)->localClient->operflags &= ~(y))
#define ClrOFlag(x)    ((x)->localClient->operflags = 0)


/* flags macros. */
#define IsAuthFinished(x)       ((x)->flags & FLAGS_FINISHED_AUTH)
#define IsDead(x)               ((x)->flags & FLAGS_DEADSOCKET)
#define SetDead(x)              ((x)->flags |= FLAGS_DEADSOCKET)
#define IsClosing(x)            ((x)->flags & FLAGS_CLOSING)
#define SetClosing(x)           ((x)->flags |= FLAGS_CLOSING)
#define SetCanFlood(x)          ((x)->flags |= FLAGS_CANFLOOD)
#define IsCanFlood(x)           ((x)->flags & FLAGS_CANFLOOD)
#define IsDefunct(x)            ((x)->flags & (FLAGS_DEADSOCKET|FLAGS_CLOSING| \
                                               FLAGS_KILLED))

/* oper flags */
#define MyOper(x)               (MyConnect(x) && HasUMode(x, UMODE_OPER))

#define SetOper(x)              {(x)->umodes |= UMODE_OPER; \
                                 if (!IsServer((x))) (x)->handler = OPER_HANDLER;}

#define ClearOper(x)            {(x)->umodes &= ~(UMODE_OPER|UMODE_ADMIN); \
                                 if (!HasUMode(x, UMODE_OPER) && !IsServer((x))) \
                                  (x)->handler = CLIENT_HANDLER; }

#define SetSendQExceeded(x)     ((x)->flags |= FLAGS_SENDQEX)
#define IsSendQExceeded(x)      ((x)->flags &  FLAGS_SENDQEX)

#define SetIpHash(x)            ((x)->flags |= FLAGS_IPHASH)
#define ClearIpHash(x)          ((x)->flags &= ~FLAGS_IPHASH)
#define IsIpHash(x)             ((x)->flags & FLAGS_IPHASH)

#define SetUserHost(x)          ((x)->flags |= FLAGS_USERHOST)
#define ClearUserHost(x)        ((x)->flags &= ~FLAGS_USERHOST)
#define IsUserHostIp(x)         ((x)->flags & FLAGS_USERHOST)

#define SetPingSent(x)          ((x)->flags |= FLAGS_PINGSENT)
#define IsPingSent(x)           ((x)->flags & FLAGS_PINGSENT)
#define ClearPingSent(x)        ((x)->flags &= ~FLAGS_PINGSENT)

#define SetNeedId(x)            ((x)->flags |= FLAGS_NEEDID)
#define IsNeedId(x)             ((x)->flags & FLAGS_NEEDID)

#define SetGotId(x)             ((x)->flags |= FLAGS_GOTID)
#define IsGotId(x)              ((x)->flags & FLAGS_GOTID)

#define IsExemptKline(x)        ((x)->flags & FLAGS_EXEMPTKLINE)
#define SetExemptKline(x)       ((x)->flags |= FLAGS_EXEMPTKLINE)
#define IsExemptLimits(x)       ((x)->flags & FLAGS_NOLIMIT)
#define SetExemptLimits(x)      ((x)->flags |= FLAGS_NOLIMIT)
#define IsExemptGline(x)        ((x)->flags & FLAGS_EXEMPTGLINE)
#define SetExemptGline(x)       ((x)->flags |= FLAGS_EXEMPTGLINE)
#define IsExemptResv(x)         ((x)->flags & FLAGS_EXEMPTRESV)
#define SetExemptResv(x)        ((x)->flags |= FLAGS_EXEMPTRESV)
#define SetIPSpoof(x)           ((x)->flags |= FLAGS_IP_SPOOFING)
#define IsIPSpoof(x)            ((x)->flags & FLAGS_IP_SPOOFING)

#define IsFloodDone(x)          ((x)->flags &  FLAGS_FLOODDONE)
#define SetFloodDone(x)         ((x)->flags |= FLAGS_FLOODDONE)
#define HasPingCookie(x)        ((x)->flags & FLAGS_PING_COOKIE)
#define SetPingCookie(x)        ((x)->flags |= FLAGS_PING_COOKIE)
#define IsHidden(x)             ((x)->flags &  FLAGS_HIDDEN)
#define SetHidden(x)            ((x)->flags |= FLAGS_HIDDEN)

#define IsSendqBlocked(x)       ((x)->flags &  FLAGS_BLOCKED)
#define SetSendqBlocked(x)      ((x)->flags |= FLAGS_BLOCKED)
#define ClearSendqBlocked(x)    ((x)->flags &= ~FLAGS_BLOCKED)


/*! \brief addr_mask_type enumeration */
enum addr_mask_type
{
  HIDE_IP, /**< IP is hidden. Resolved hostname is shown instead */
  SHOW_IP, /**< IP is shown. No parts of it are hidden or masked */
  MASK_IP  /**< IP is masked. 255.255.255.255 is shown instead */
};

/*! \brief Server structure */
struct Server
{
  dlink_list server_list; /**< Servers on this server */
  dlink_list client_list; /**< Clients on this server */
  char by[NICKLEN + 1];   /**< who activated this connection */
};

/*! \brief ListTask structure */
struct ListTask
{
  dlink_list show_mask; /**< show these channels.. */
  dlink_list hide_mask; /**< ..and hide these ones */

  unsigned int hash_index; /**< the bucket we are currently in */
  unsigned int users_min;
  unsigned int users_max;
  unsigned int created_min;
  unsigned int created_max;
  unsigned int topicts_min;
  unsigned int topicts_max;
};

/*! \brief LocalUser structure
 *
 * Allocated only for local clients, that are directly connected
 * to \b this server with a socket.
 */
struct LocalUser
{
  dlink_node   lclient_node;

  char         client_host[HOSTLEN + 1];
  char         client_server[HOSTLEN + 1];

  unsigned int registration;
  unsigned int cap_client;    /**< Client capabilities (from us) */
  unsigned int cap_active;    /**< Active capabilities (to us) */
  unsigned int       caps;       /**< capabilities bit-field */

  unsigned int operflags;     /**< IRC Operator privilege flags */
  unsigned int random_ping; /**< Holding a 32bit value used for PING cookies */

  unsigned int serial;     /**< used to enforce 1 send per nick */

  time_t       lasttime;   /**< ...should be only LOCAL clients? --msa */
  time_t       firsttime;  /**< time client was created */
  time_t       since;      /**< last time we parsed something */
  time_t       last_knock;    /**< time of last knock */
  time_t       last_join_time;   /**< when this client last 
                                    joined a channel */
  time_t       last_leave_time;  /**< when this client last 
                                       * left a channel */
  int          join_leave_count; /**< count of JOIN/LEAVE in less than 
                                         MIN_JOIN_LEAVE_TIME seconds */
  int          oper_warn_count_down; /**< warn opers of this possible 
                                          spambot every time this gets to 0 */
  time_t       last_caller_id_time;
  time_t       first_received_message_time;
  time_t       last_nick_change;
  time_t       last_privmsg; /**< Last time we got a PRIVMSG */
  time_t       last_away; /**< Away since... */

  int          received_number_of_privmsgs;
  unsigned int number_of_nick_changes;

  struct ListTask  *list_task;

  struct dbuf_queue buf_sendq;
  struct dbuf_queue buf_recvq;

  struct {
    unsigned int messages;      /**< Statistics: protocol messages sent/received */
    uint64_t bytes;             /**< Statistics: total bytes sent/received */
  } recv, send;

  struct AuthRequest *auth;
  struct Listener *listener;   /**< listener accepted from */
  dlink_list        acceptlist; /**< clients I'll allow to talk to me */
  dlink_list        watches;   /**< chain of Watch pointer blocks */
  dlink_list        confs;     /**< Configuration record associated */
  dlink_list        invited;   /**< chain of invite pointer blocks */
  struct irc_ssaddr ip;
  int               aftype;    /**< Makes life easier for DNS res in IPV6 */
  int               country_id; /**< ID corresponding to a ISO 3166 country code */

  char              *passwd;
  fde_t             fd;
  /* Anti-flood stuff. We track how many messages were parsed and how
   * many we were allowed in the current second, and apply a simple
   * decay to avoid flooding.
   *   -- adrian
   */
  int allow_read;       /**< how many we're allowed to read in this second */
  int sent_parsed;      /**< how many messages we've parsed in this second */

  char*          response;  /**< expected response from client */
  char*          auth_oper; /**< Operator to become if they supply the response.*/
};

/*! \brief Client structure */
struct Client
{
  dlink_node node;
  dlink_node lnode;             /**< Used for Server->servers/users */

  struct LocalUser *localClient;
  struct Client    *hnext;      /**< For client hash table lookups by name */
  struct Client    *idhnext;    /**< For SID hash table lookups by sid */
  struct Server    *serv;       /**< ...defined, if this is a server */
  struct Client    *servptr;    /**< Points to server this Client is on */
  struct Client    *from;       /**< == self, if Local Client, *NEVER* NULL! */

  time_t            tsinfo;     /**< TS on the nick, SVINFO on server */

  unsigned int      flags;      /**< client flags */
  unsigned int      umodes;     /**< opers, normal users subset */
  unsigned int      hopcount;   /**< number of servers to this 0 = local */
  unsigned int      status;     /**< Client type */
  unsigned int      handler;    /**< Handler index */

  dlink_list        whowas;
  dlink_list        channel;   /**< chain of channel pointer blocks */

  char away[AWAYLEN + 1]; /**< Client's AWAY message. Can be set/unset via AWAY command */
  char name[HOSTLEN + 1]; /**< unique name for a client nick or host */
  char svid[HOSTLEN + 1]; /**< Services ID. XXX: Going with HOSTLEN for now. NICKLEN might be too small
                                if dealing with timestamps */
  char id[IDLEN + 1];       /**< client ID, unique ID per client */
  /* 
   * client->username is the username from ident or the USER message, 
   * If the client is idented the USER message is ignored, otherwise 
   * the username part of the USER message is put here prefixed with a 
   * tilde depending on the auth{} block. Once a client has registered,
   * this field should be considered read-only.
   */
  char              username[USERLEN + 1]; /* client's username */
  /*
   * client->host contains the resolved name or ip address
   * as a string for the user, it may be fiddled with for oper spoofing etc.
   * once it's changed the *real* address goes away. This should be
   * considered a read-only field after the client has registered.
   */
  char              host[HOSTLEN + 1];     /* client's hostname */

  /*
   * client->info for unix clients will normally contain the info from the 
   * gcos field in /etc/passwd but anything can go here.
   */
  char              info[REALLEN + 1]; /* Free form additional client info */

  /*
   * client->sockhost contains the ip address gotten from the socket as a
   * string, this field should be considered read-only once the connection
   * has been made. (set in s_bsd.c only)
   */
  char              sockhost[HOSTIPLEN + 1]; /* This is the host name from the 
                                                socket ip address as string */
};


extern struct Client me;
extern dlink_list listing_client_list;
extern dlink_list global_client_list;
extern dlink_list unknown_list;       /* unknown clients ON this server only        */
extern dlink_list local_client_list;  /* local clients only ON this server          */
extern dlink_list serv_list;          /* local servers to this server ONLY          */
extern dlink_list global_serv_list;   /* global servers on the network              */
extern dlink_list oper_list;          /* our opers, duplicated in local_client_list */

extern int accept_message(struct Client *, struct Client *);
extern unsigned int idle_time_get(const struct Client *, const struct Client *);
extern struct split_nuh_item *find_accept(const char *, const char *,
                                          const char *, struct Client *, int);
extern void del_accept(struct split_nuh_item *, struct Client *);
extern void del_all_accepts(struct Client *);
extern void exit_client(struct Client *, struct Client *, const char *);
extern void check_conf_klines(void);
extern void client_init(void);
extern void dead_link_on_write(struct Client *, int);
extern void dead_link_on_read(struct Client *, int);
extern void exit_aborted_clients(void);
extern void free_exited_clients(void);
extern struct Client *make_client(struct Client *);
extern struct Client *find_chasing(struct Client *, struct Client *, const char *, int *);
extern struct Client *find_person(const struct Client *const, const char *);
extern const char *get_client_name(const struct Client *, enum addr_mask_type);

#endif /* INCLUDED_client_h */
Revision:	1858
Committed:	Thu Apr 25 15:00:52 2013 UTC (10 years, 11 months ago) by michael
Content type:	text/x-chdr
Original Path:	*ircd-hybrid/trunk/include/client.h*
File size:	20770 byte(s)
Log Message:	- Added basic support for libGeoIP - Added exempt configuration option to resv{} blocks
#	User	Rev	Content
1	adx	30	/*
2			* ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
3			*
4			* Copyright (C) 2002 by the past and present ircd coders, and others.
5			*
6			* This program is free software; you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation; either version 2 of the License, or
9			* (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License
17			* along with this program; if not, write to the Free Software
18			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19			* USA
20			*/
21
22	michael	1220	/*! \file client.h
23			* \brief Header including structures, macros and prototypes for client handling
24			* \version $Id$
25			*/
26
27
28	adx	30	#ifndef INCLUDED_client_h
29			#define INCLUDED_client_h
30
31	michael	1011	#include "list.h"
32	adx	30	#include "fdlist.h"
33	michael	912	#include "config.h"
34	adx	30	#include "ircd_defs.h"
35			#include "dbuf.h"
36			#include "channel.h"
37
38			/*
39			* status macros.
40			*/
41			#define STAT_CONNECTING 0x01
42			#define STAT_HANDSHAKE 0x02
43			#define STAT_ME 0x04
44			#define STAT_UNKNOWN 0x08
45			#define STAT_SERVER 0x10
46			#define STAT_CLIENT 0x20
47
48	michael	503	#define REG_NEED_USER 0x1
49			#define REG_NEED_NICK 0x2
50			#define REG_NEED_CAP 0x4
51			#define REG_INIT (REG_NEED_USER\|REG_NEED_NICK)
52
53	adx	30	#define HasID(x) ((x)->id[0] != '\0')
54			#define ID(x) (HasID(x) ? (x)->id : (x)->name)
55			#define ID_or_name(x,client_p) ((IsCapable(client_p, CAP_TS6) && HasID(x)) ? (x)->id : (x)->name)
56
57			#define IsRegistered(x) ((x)->status > STAT_UNKNOWN)
58			#define IsConnecting(x) ((x)->status == STAT_CONNECTING)
59			#define IsHandshake(x) ((x)->status == STAT_HANDSHAKE)
60			#define IsMe(x) ((x)->status == STAT_ME)
61			#define IsUnknown(x) ((x)->status == STAT_UNKNOWN)
62			#define IsServer(x) ((x)->status == STAT_SERVER)
63			#define IsClient(x) ((x)->status == STAT_CLIENT)
64
65			#define SetConnecting(x) {(x)->status = STAT_CONNECTING; \
66			(x)->handler = UNREGISTERED_HANDLER; }
67
68			#define SetHandshake(x) {(x)->status = STAT_HANDSHAKE; \
69			(x)->handler = UNREGISTERED_HANDLER; }
70
71			#define SetMe(x) {(x)->status = STAT_ME; \
72			(x)->handler = UNREGISTERED_HANDLER; }
73
74			#define SetUnknown(x) {(x)->status = STAT_UNKNOWN; \
75			(x)->handler = UNREGISTERED_HANDLER; }
76
77			#define SetServer(x) {(x)->status = STAT_SERVER; \
78			(x)->handler = SERVER_HANDLER; }
79
80			#define SetClient(x) {(x)->status = STAT_CLIENT; \
81	michael	1219	(x)->handler = HasUMode(x, UMODE_OPER) ? \
82	adx	30	OPER_HANDLER : CLIENT_HANDLER; }
83
84	michael	1219	#define MyConnect(x) ((x)->localClient != NULL)
85			#define MyClient(x) (MyConnect(x) && IsClient(x))
86	adx	30
87			/*
88			* ts stuff
89			*/
90	michael	1220	#define TS_CURRENT 6 /*< current TS protocol version /
91			#define TS_MIN 5 /*< minimum supported TS protocol version /
92	adx	30	#define TS_DOESTS 0x20000000
93			#define DoesTS(x) ((x)->tsinfo == TS_DOESTS)
94
95
96	michael	503
97			#define CAP_MULTI_PREFIX 0x00000001
98	michael	1734	#define CAP_AWAY_NOTIFY 0x00000002
99	michael	503
100	michael	1146	#define HasCap(x, y) ((x)->localClient->cap_active & (y))
101
102	adx	30	/* housekeeping flags */
103	michael	1331	#define FLAGS_PINGSENT 0x00000001 /*< Unreplied ping sent /
104			#define FLAGS_DEADSOCKET 0x00000002 /*< Local socket is dead--Exiting soon /
105			#define FLAGS_KILLED 0x00000004 /*< Prevents "QUIT" from being sent for this /
106			#define FLAGS_CLOSING 0x00000008 /*< set when closing to suppress errors /
107			#define FLAGS_GOTID 0x00000010 /*< successful ident lookup achieved /
108			#define FLAGS_NEEDID 0x00000020 /*< auth{} block say must use ident return /
109			#define FLAGS_SENDQEX 0x00000040 /*< Sendq exceeded /
110			#define FLAGS_IPHASH 0x00000080 /*< iphashed this client /
111			#define FLAGS_MARK 0x00000100 /*< marked client /
112			#define FLAGS_CANFLOOD 0x00000200 /*< client has the ability to flood /
113			#define FLAGS_EXEMPTGLINE 0x00000400 /*< client can't be G-lined /
114			#define FLAGS_EXEMPTKLINE 0x00000800 /*< client is exempt from kline /
115			#define FLAGS_NOLIMIT 0x00001000 /*< client is exempt from limits /
116			#define FLAGS_PING_COOKIE 0x00002000 /*< PING Cookie /
117			#define FLAGS_IP_SPOOFING 0x00004000 /*< client IP is spoofed /
118			#define FLAGS_FLOODDONE 0x00008000 /*< Flood grace period has been ended. /
119			#define FLAGS_EOB 0x00010000 /*< server has sent us an EOB /
120			#define FLAGS_HIDDEN 0x00020000 /*< a hidden server. not shown in /links /
121			#define FLAGS_BLOCKED 0x00040000 /*< must wait for COMM_SELECT_WRITE /
122			#define FLAGS_USERHOST 0x00080000 /*< client is in userhost hash /
123			#define FLAGS_BURSTED 0x00100000 /*< user was already bursted /
124			#define FLAGS_EXEMPTRESV 0x00200000 /*< client is exempt from RESV /
125			#define FLAGS_GOTUSER 0x00400000 /*< if we received a USER command /
126	michael	1644	#define FLAGS_FINISHED_AUTH 0x00800000 /*< Client has been released from auth /
127			#define FLAGS_FLOOD_NOTICED 0x01000000 /*< Notice to opers about this flooder has been sent /
128			#define FLAGS_SERVICE 0x02000000 /*< Client/server is a network service /
129	adx	30
130	michael	1219	#define HasFlag(x, y) ((x)->flags & (y))
131			#define AddFlag(x, y) ((x)->flags \|= (y))
132			#define DelFlag(x, y) ((x)->flags &= ~(y))
133	adx	30
134	michael	1219
135
136	adx	30	/* umodes, settable flags */
137	michael	1220	#define UMODE_SERVNOTICE 0x00000001 /*< server notices such as kill /
138			#define UMODE_CCONN 0x00000002 /*< Client Connections /
139			#define UMODE_REJ 0x00000004 /*< Bot Rejections /
140			#define UMODE_SKILL 0x00000008 /*< Server Killed /
141			#define UMODE_FULL 0x00000010 /*< Full messages /
142			#define UMODE_SPY 0x00000020 /*< see STATS / LINKS /
143			#define UMODE_DEBUG 0x00000040 /*< 'debugging' info /
144			#define UMODE_NCHANGE 0x00000080 /*< Nick change notice /
145			#define UMODE_WALLOP 0x00000100 /*< send wallops to them /
146			#define UMODE_OPERWALL 0x00000200 /*< Operwalls /
147			#define UMODE_INVISIBLE 0x00000400 /*< makes user invisible /
148			#define UMODE_BOTS 0x00000800 /*< shows bots /
149			#define UMODE_EXTERNAL 0x00001000 /*< show servers introduced and splitting /
150			#define UMODE_CALLERID 0x00002000 /*< block unless caller id's /
151			#define UMODE_SOFTCALLERID 0x00004000 /*< block unless on common channel /
152			#define UMODE_UNAUTH 0x00008000 /*< show unauth connects here /
153			#define UMODE_LOCOPS 0x00010000 /*< show locops /
154			#define UMODE_DEAF 0x00020000 /*< don't receive channel messages /
155			#define UMODE_CCONN_FULL 0x00040000 /*< add unused fields to connection monitoring /
156			#define UMODE_REGISTERED 0x00080000 /*< User has identified for that nick. /
157			#define UMODE_REGONLY 0x00100000 /*< Only registered nicks may PM /
158	michael	1294	#define UMODE_HIDDEN 0x00200000 /*< Operator status is hidden /
159	michael	1331	#define UMODE_OPER 0x00400000 /*< Operator /
160			#define UMODE_ADMIN 0x00800000 /*< Admin on server /
161	db	849
162	michael	1220	#define UMODE_ALL UMODE_SERVNOTICE
163	adx	30
164	michael	1158	#define HasUMode(x, y) ((x)->umodes & (y))
165			#define AddUMode(x, y) ((x)->umodes \|= (y))
166			#define DelUMode(x, y) ((x)->umodes &= ~(y))
167
168	michael	1468	#define SEND_UMODES (UMODE_INVISIBLE \| UMODE_OPER \| UMODE_WALLOP \|\
169			UMODE_REGONLY \| UMODE_REGISTERED \| UMODE_ADMIN \|\
170			UMODE_HIDDEN)
171	adx	30
172
173	michael	1158
174	adx	30	/* oper priv flags */
175	michael	1294	#define OPER_FLAG_GLOBAL_KILL 0x00000001 /*< Oper can global kill /
176			#define OPER_FLAG_REMOTE 0x00000002 /*> Oper can do squits/connects /
177			#define OPER_FLAG_UNKLINE 0x00000004 /*< Oper can use unkline /
178			#define OPER_FLAG_GLINE 0x00000008 /*< Oper can use gline /
179			#define OPER_FLAG_N 0x00000010 /*< Oper can umode n /
180			#define OPER_FLAG_K 0x00000020 /*< Oper can kill/kline /
181			#define OPER_FLAG_X 0x00000040 /*< Oper can xline /
182			#define OPER_FLAG_DIE 0x00000080 /*< Oper can die /
183			#define OPER_FLAG_REHASH 0x00000100 /*< Oper can rehash /
184			#define OPER_FLAG_ADMIN 0x00000200 /*< Oper can set umode +a /
185			#define OPER_FLAG_OPERWALL 0x00000400 /*< Oper can use OPERWALL command /
186			#define OPER_FLAG_OPER_SPY 0x00000800 /* */
187			#define OPER_FLAG_REMOTEBAN 0x00001000 /*< Oper can set remote bans /
188			#define OPER_FLAG_GLOBOPS 0x00002000 /*< Oper can use GLOBOPS command /
189			#define OPER_FLAG_MODULE 0x00004000 /*< Oper can use MODULE commands /
190			#define OPER_FLAG_RESTART 0x00008000 /*< Oper can use RESTART command /
191	michael	1301	#define OPER_FLAG_DLINE 0x00010000 /*< Oper can use DLINE command /
192			#define OPER_FLAG_UNDLINE 0x00020000 /*< Oper can use UNDLINE command /
193	michael	1460	#define OPER_FLAG_SET 0x00040000 /*< Oper can use SET command /
194	adx	30
195	michael	1219	#define HasOFlag(x, y) (MyConnect(x) ? (x)->localClient->operflags & (y) : 0)
196			#define AddOFlag(x, y) ((x)->localClient->operflags \|= (y))
197			#define DelOFlag(x, y) ((x)->localClient->operflags &= ~(y))
198			#define ClrOFlag(x) ((x)->localClient->operflags = 0)
199	adx	30
200
201	michael	1219
202	adx	30	/* flags macros. */
203	michael	650	#define IsAuthFinished(x) ((x)->flags & FLAGS_FINISHED_AUTH)
204	adx	30	#define IsDead(x) ((x)->flags & FLAGS_DEADSOCKET)
205			#define SetDead(x) ((x)->flags \|= FLAGS_DEADSOCKET)
206			#define IsClosing(x) ((x)->flags & FLAGS_CLOSING)
207			#define SetClosing(x) ((x)->flags \|= FLAGS_CLOSING)
208			#define SetCanFlood(x) ((x)->flags \|= FLAGS_CANFLOOD)
209			#define IsCanFlood(x) ((x)->flags & FLAGS_CANFLOOD)
210			#define IsDefunct(x) ((x)->flags & (FLAGS_DEADSOCKET\|FLAGS_CLOSING\| \
211			FLAGS_KILLED))
212
213			/* oper flags */
214	michael	1219	#define MyOper(x) (MyConnect(x) && HasUMode(x, UMODE_OPER))
215	adx	30
216			#define SetOper(x) {(x)->umodes \|= UMODE_OPER; \
217			if (!IsServer((x))) (x)->handler = OPER_HANDLER;}
218
219			#define ClearOper(x) {(x)->umodes &= ~(UMODE_OPER\|UMODE_ADMIN); \
220	michael	1219	if (!HasUMode(x, UMODE_OPER) && !IsServer((x))) \
221	adx	30	(x)->handler = CLIENT_HANDLER; }
222
223			#define SetSendQExceeded(x) ((x)->flags \|= FLAGS_SENDQEX)
224			#define IsSendQExceeded(x) ((x)->flags & FLAGS_SENDQEX)
225
226			#define SetIpHash(x) ((x)->flags \|= FLAGS_IPHASH)
227			#define ClearIpHash(x) ((x)->flags &= ~FLAGS_IPHASH)
228			#define IsIpHash(x) ((x)->flags & FLAGS_IPHASH)
229
230			#define SetUserHost(x) ((x)->flags \|= FLAGS_USERHOST)
231			#define ClearUserHost(x) ((x)->flags &= ~FLAGS_USERHOST)
232			#define IsUserHostIp(x) ((x)->flags & FLAGS_USERHOST)
233
234			#define SetPingSent(x) ((x)->flags \|= FLAGS_PINGSENT)
235			#define IsPingSent(x) ((x)->flags & FLAGS_PINGSENT)
236			#define ClearPingSent(x) ((x)->flags &= ~FLAGS_PINGSENT)
237
238			#define SetNeedId(x) ((x)->flags \|= FLAGS_NEEDID)
239			#define IsNeedId(x) ((x)->flags & FLAGS_NEEDID)
240
241			#define SetGotId(x) ((x)->flags \|= FLAGS_GOTID)
242			#define IsGotId(x) ((x)->flags & FLAGS_GOTID)
243
244			#define IsExemptKline(x) ((x)->flags & FLAGS_EXEMPTKLINE)
245			#define SetExemptKline(x) ((x)->flags \|= FLAGS_EXEMPTKLINE)
246			#define IsExemptLimits(x) ((x)->flags & FLAGS_NOLIMIT)
247			#define SetExemptLimits(x) ((x)->flags \|= FLAGS_NOLIMIT)
248			#define IsExemptGline(x) ((x)->flags & FLAGS_EXEMPTGLINE)
249			#define SetExemptGline(x) ((x)->flags \|= FLAGS_EXEMPTGLINE)
250			#define IsExemptResv(x) ((x)->flags & FLAGS_EXEMPTRESV)
251			#define SetExemptResv(x) ((x)->flags \|= FLAGS_EXEMPTRESV)
252			#define SetIPSpoof(x) ((x)->flags \|= FLAGS_IP_SPOOFING)
253			#define IsIPSpoof(x) ((x)->flags & FLAGS_IP_SPOOFING)
254
255			#define IsFloodDone(x) ((x)->flags & FLAGS_FLOODDONE)
256			#define SetFloodDone(x) ((x)->flags \|= FLAGS_FLOODDONE)
257			#define HasPingCookie(x) ((x)->flags & FLAGS_PING_COOKIE)
258			#define SetPingCookie(x) ((x)->flags \|= FLAGS_PING_COOKIE)
259			#define IsHidden(x) ((x)->flags & FLAGS_HIDDEN)
260			#define SetHidden(x) ((x)->flags \|= FLAGS_HIDDEN)
261
262			#define IsSendqBlocked(x) ((x)->flags & FLAGS_BLOCKED)
263			#define SetSendqBlocked(x) ((x)->flags \|= FLAGS_BLOCKED)
264			#define ClearSendqBlocked(x) ((x)->flags &= ~FLAGS_BLOCKED)
265
266
267	michael	1798	/! \brief addr_mask_type enumeration /
268			enum addr_mask_type
269			{
270			HIDE_IP, /*< IP is hidden. Resolved hostname is shown instead /
271			SHOW_IP, /*< IP is shown. No parts of it are hidden or masked /
272			MASK_IP /*< IP is masked. 255.255.255.255 is shown instead /
273			};
274
275			/! \brief Server structure /
276			struct Server
277			{
278			dlink_list server_list; /*< Servers on this server /
279			dlink_list client_list; /*< Clients on this server /
280			char by[NICKLEN + 1]; /*< who activated this connection /
281			};
282
283			/! \brief ListTask structure /
284			struct ListTask
285			{
286			dlink_list show_mask; /*< show these channels.. /
287			dlink_list hide_mask; /*< ..and hide these ones /
288
289			unsigned int hash_index; /*< the bucket we are currently in /
290			unsigned int users_min;
291			unsigned int users_max;
292			unsigned int created_min;
293			unsigned int created_max;
294			unsigned int topicts_min;
295			unsigned int topicts_max;
296			};
297
298			/*! \brief LocalUser structure
299			*
300			* Allocated only for local clients, that are directly connected
301			* to \b this server with a socket.
302			*/
303			struct LocalUser
304			{
305			dlink_node lclient_node;
306
307			char client_host[HOSTLEN + 1];
308			char client_server[HOSTLEN + 1];
309
310			unsigned int registration;
311			unsigned int cap_client; /*< Client capabilities (from us) /
312			unsigned int cap_active; /*< Active capabilities (to us) /
313			unsigned int caps; /*< capabilities bit-field /
314
315			unsigned int operflags; /*< IRC Operator privilege flags /
316			unsigned int random_ping; /*< Holding a 32bit value used for PING cookies /
317
318			unsigned int serial; /*< used to enforce 1 send per nick /
319
320			time_t lasttime; /*< ...should be only LOCAL clients? --msa /
321			time_t firsttime; /*< time client was created /
322			time_t since; /*< last time we parsed something /
323			time_t last_knock; /*< time of last knock /
324			time_t last_join_time; /**< when this client last
325			joined a channel */
326			time_t last_leave_time; /**< when this client last
327			* left a channel */
328			int join_leave_count; /**< count of JOIN/LEAVE in less than
329			MIN_JOIN_LEAVE_TIME seconds */
330			int oper_warn_count_down; /**< warn opers of this possible
331			spambot every time this gets to 0 */
332			time_t last_caller_id_time;
333			time_t first_received_message_time;
334			time_t last_nick_change;
335			time_t last_privmsg; /*< Last time we got a PRIVMSG /
336			time_t last_away; /*< Away since... /
337
338			int received_number_of_privmsgs;
339			unsigned int number_of_nick_changes;
340
341			struct ListTask *list_task;
342
343			struct dbuf_queue buf_sendq;
344			struct dbuf_queue buf_recvq;
345
346			struct {
347			unsigned int messages; /*< Statistics: protocol messages sent/received /
348			uint64_t bytes; /*< Statistics: total bytes sent/received /
349			} recv, send;
350
351			struct AuthRequest *auth;
352			struct Listener listener; /< listener accepted from /
353			dlink_list acceptlist; /*< clients I'll allow to talk to me /
354			dlink_list watches; /*< chain of Watch pointer blocks /
355			dlink_list confs; /*< Configuration record associated /
356			dlink_list invited; /*< chain of invite pointer blocks /
357			struct irc_ssaddr ip;
358			int aftype; /*< Makes life easier for DNS res in IPV6 /
359	michael	1858	int country_id; /*< ID corresponding to a ISO 3166 country code /
360	michael	1798
361			char *passwd;
362			fde_t fd;
363			/* Anti-flood stuff. We track how many messages were parsed and how
364			* many we were allowed in the current second, and apply a simple
365			* decay to avoid flooding.
366			* -- adrian
367			*/
368			int allow_read; /*< how many we're allowed to read in this second /
369			int sent_parsed; /*< how many messages we've parsed in this second /
370
371			char* response; /*< expected response from client /
372			char* auth_oper; /*< Operator to become if they supply the response./
373			};
374
375			/! \brief Client structure /
376			struct Client
377			{
378			dlink_node node;
379			dlink_node lnode; /*< Used for Server->servers/users /
380
381			struct LocalUser *localClient;
382			struct Client hnext; /< For client hash table lookups by name /
383			struct Client idhnext; /< For SID hash table lookups by sid /
384			struct Server serv; /< ...defined, if this is a server /
385			struct Client servptr; /< Points to server this Client is on /
386			struct Client from; /< == self, if Local Client, NEVER* NULL! */
387
388			time_t tsinfo; /*< TS on the nick, SVINFO on server /
389
390			unsigned int flags; /*< client flags /
391			unsigned int umodes; /*< opers, normal users subset /
392			unsigned int hopcount; /*< number of servers to this 0 = local /
393			unsigned int status; /*< Client type /
394			unsigned int handler; /*< Handler index /
395
396			dlink_list whowas;
397			dlink_list channel; /*< chain of channel pointer blocks /
398
399			char away[AWAYLEN + 1]; /*< Client's AWAY message. Can be set/unset via AWAY command /
400			char name[HOSTLEN + 1]; /*< unique name for a client nick or host /
401			char svid[HOSTLEN + 1]; /**< Services ID. XXX: Going with HOSTLEN for now. NICKLEN might be too small
402			if dealing with timestamps */
403			char id[IDLEN + 1]; /*< client ID, unique ID per client /
404			/*
405			* client->username is the username from ident or the USER message,
406			* If the client is idented the USER message is ignored, otherwise
407			* the username part of the USER message is put here prefixed with a
408			* tilde depending on the auth{} block. Once a client has registered,
409			* this field should be considered read-only.
410			*/
411			char username[USERLEN + 1]; /* client's username */
412			/*
413			* client->host contains the resolved name or ip address
414			* as a string for the user, it may be fiddled with for oper spoofing etc.
415			* once it's changed the real address goes away. This should be
416			* considered a read-only field after the client has registered.
417			*/
418			char host[HOSTLEN + 1]; /* client's hostname */
419
420			/*
421			* client->info for unix clients will normally contain the info from the
422			* gcos field in /etc/passwd but anything can go here.
423			*/
424			char info[REALLEN + 1]; /* Free form additional client info */
425
426			/*
427			* client->sockhost contains the ip address gotten from the socket as a
428			* string, this field should be considered read-only once the connection
429			* has been made. (set in s_bsd.c only)
430			*/
431			char sockhost[HOSTIPLEN + 1]; /* This is the host name from the
432			socket ip address as string */
433			};
434
435
436	adx	30	extern struct Client me;
437			extern dlink_list listing_client_list;
438			extern dlink_list global_client_list;
439	michael	1666	extern dlink_list unknown_list; /* unknown clients ON this server only */
440			extern dlink_list local_client_list; /* local clients only ON this server */
441			extern dlink_list serv_list; /* local servers to this server ONLY */
442			extern dlink_list global_serv_list; /* global servers on the network */
443			extern dlink_list oper_list; /* our opers, duplicated in local_client_list */
444	adx	30
445			extern int accept_message(struct Client , struct Client );
446	michael	1783	extern unsigned int idle_time_get(const struct Client , const struct Client );
447	michael	887	extern struct split_nuh_item find_accept(const char , const char *,
448			const char , struct Client , int);
449			extern void del_accept(struct split_nuh_item , struct Client );
450			extern void del_all_accepts(struct Client *);
451	adx	30	extern void exit_client(struct Client , struct Client , const char *);
452			extern void check_conf_klines(void);
453	michael	1798	extern void client_init(void);
454	adx	30	extern void dead_link_on_write(struct Client *, int);
455			extern void dead_link_on_read(struct Client *, int);
456			extern void exit_aborted_clients(void);
457			extern void free_exited_clients(void);
458			extern struct Client make_client(struct Client );
459			extern struct Client find_chasing(struct Client , struct Client , const char , int *);
460			extern struct Client find_person(const struct Client const, const char *);
461	michael	1328	extern const char get_client_name(const struct Client , enum addr_mask_type);
462	adx	30
463			#endif /* INCLUDED_client_h */