ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/branches/8.2.x/include/client.h
Revision: 5346
Committed: Sun Jan 11 12:41:14 2015 UTC (9 years, 2 months ago) by michael
Content type: text/x-chdr
File size: 21266 byte(s)
Log Message:
- Update copyright years

File Contents

# Content
1 /*
2 * ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
3 *
4 * Copyright (c) 1997-2015 ircd-hybrid development team
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
19 * USA
20 */
21
22 /*! \file client.h
23 * \brief Header including structures, macros and prototypes for client handling
24 * \version $Id$
25 */
26
27
28 #ifndef INCLUDED_client_h
29 #define INCLUDED_client_h
30
31 #include "list.h"
32 #include "fdlist.h"
33 #include "config.h"
34 #include "ircd_defs.h"
35 #include "dbuf.h"
36 #include "channel.h"
37 #include "auth.h"
38
39 struct MaskItem;
40
41 /*
42 * status macros.
43 */
44 #define STAT_CONNECTING 0x00000001U
45 #define STAT_HANDSHAKE 0x00000002U
46 #define STAT_ME 0x00000004U
47 #define STAT_UNKNOWN 0x00000008U
48 #define STAT_SERVER 0x00000010U
49 #define STAT_CLIENT 0x00000020U
50
51 #define REG_NEED_USER 0x00000001U /**< User must send USER command */
52 #define REG_NEED_NICK 0x00000002U /**< User must send NICK command */
53 #define REG_NEED_CAP 0x00000004U /**< In middle of CAP negotiations */
54 #define REG_INIT (REG_NEED_USER|REG_NEED_NICK)
55
56 #define ID_or_name(x,client_p) ((IsCapable(client_p->from, CAP_TS6) && (x)->id[0]) ? (x)->id : (x)->name)
57
58 #define IsRegistered(x) ((x)->status > STAT_UNKNOWN)
59 #define IsConnecting(x) ((x)->status == STAT_CONNECTING)
60 #define IsHandshake(x) ((x)->status == STAT_HANDSHAKE)
61 #define IsMe(x) ((x)->status == STAT_ME)
62 #define IsUnknown(x) ((x)->status == STAT_UNKNOWN)
63 #define IsServer(x) ((x)->status == STAT_SERVER)
64 #define IsClient(x) ((x)->status == STAT_CLIENT)
65
66 #define SetConnecting(x) {(x)->status = STAT_CONNECTING; \
67 (x)->handler = UNREGISTERED_HANDLER; }
68
69 #define SetHandshake(x) {(x)->status = STAT_HANDSHAKE; \
70 (x)->handler = UNREGISTERED_HANDLER; }
71
72 #define SetMe(x) {(x)->status = STAT_ME; \
73 (x)->handler = UNREGISTERED_HANDLER; }
74
75 #define SetUnknown(x) {(x)->status = STAT_UNKNOWN; \
76 (x)->handler = UNREGISTERED_HANDLER; }
77
78 #define SetServer(x) {(x)->status = STAT_SERVER; \
79 (x)->handler = SERVER_HANDLER; }
80
81 #define SetClient(x) {(x)->status = STAT_CLIENT; \
82 (x)->handler = HasUMode(x, UMODE_OPER) ? \
83 OPER_HANDLER : CLIENT_HANDLER; }
84
85 #define MyConnect(x) ((x)->connection != NULL)
86 #define MyClient(x) (MyConnect(x) && IsClient(x))
87
88 /*
89 * ts stuff
90 */
91 #define TS_CURRENT 6 /**< Current TS protocol version */
92 #define TS_MIN 6 /**< Minimum supported TS protocol version */
93 #define TS_DOESTS 0x20000000
94 #define DoesTS(x) ((x)->tsinfo == TS_DOESTS)
95
96
97
98 #define CAP_MULTI_PREFIX 0x00000001U
99 #define CAP_AWAY_NOTIFY 0x00000002U
100 #define CAP_UHNAMES 0x00000004U
101 #define CAP_EXTENDED_JOIN 0x00000008U
102
103 #define HasCap(x, y) ((x)->connection->cap_active & (y))
104
105
106 /* housekeeping flags */
107 #define FLAGS_PINGSENT 0x00000001U /**< Unreplied ping sent */
108 #define FLAGS_DEADSOCKET 0x00000002U /**< Local socket is dead--Exiting soon */
109 #define FLAGS_KILLED 0x00000004U /**< Prevents "QUIT" from being sent for this */
110 #define FLAGS_CLOSING 0x00000008U /**< Set when closing to suppress errors */
111 #define FLAGS_GOTID 0x00000010U /**< Successful ident lookup achieved */
112 #define FLAGS_SENDQEX 0x00000020U /**< Sendq exceeded */
113 #define FLAGS_IPHASH 0x00000040U /**< Iphashed this client */
114 #define FLAGS_MARK 0x00000080U /**< Marked client */
115 #define FLAGS_CANFLOOD 0x00000100U /**< Client has the ability to flood */
116 #define FLAGS_EXEMPTGLINE 0x00000200U /**< Client can't be G-lined */
117 #define FLAGS_EXEMPTKLINE 0x00000400U /**< Client is exempt from kline */
118 #define FLAGS_NOLIMIT 0x00000800U /**< Client is exempt from limits */
119 #define FLAGS_PING_COOKIE 0x00001000U /**< PING Cookie */
120 #define FLAGS_FLOODDONE 0x00002000U /**< Flood grace period has been ended. */
121 #define FLAGS_EOB 0x00004000U /**< Server has sent us an EOB */
122 #define FLAGS_HIDDEN 0x00008000U /**< A hidden server. Not shown in /links */
123 #define FLAGS_BLOCKED 0x00010000U /**< Must wait for COMM_SELECT_WRITE */
124 #define FLAGS_USERHOST 0x00020000U /**< Client is in userhost hash */
125 #define FLAGS_BURSTED 0x00040000U /**< User was already bursted */
126 #define FLAGS_EXEMPTRESV 0x00080000U /**< Client is exempt from RESV */
127 #define FLAGS_GOTUSER 0x00100000U /**< If we received a USER command */
128 #define FLAGS_FINISHED_AUTH 0x00200000U /**< Client has been released from auth */
129 #define FLAGS_FLOOD_NOTICED 0x00400000U /**< Notice to opers about this flooder has been sent */
130 #define FLAGS_SERVICE 0x00800000U /**< Client/server is a network service */
131 #define FLAGS_SSL 0x01000000U /**< User is connected via TLS/SSL */
132 #define FLAGS_SQUIT 0x02000000U
133
134 #define HasFlag(x, y) ((x)->flags & (y))
135 #define AddFlag(x, y) ((x)->flags |= (y))
136 #define DelFlag(x, y) ((x)->flags &= ~(y))
137
138
139
140 /* umodes, settable flags */
141 #define UMODE_SERVNOTICE 0x00000001U /**< Server notices such as kill */
142 #define UMODE_CCONN 0x00000002U /**< Client Connections */
143 #define UMODE_REJ 0x00000004U /**< Bot Rejections */
144 #define UMODE_SKILL 0x00000008U /**< Server Killed */
145 #define UMODE_FULL 0x00000010U /**< Full messages */
146 #define UMODE_SPY 0x00000020U /**< See STATS / LINKS */
147 #define UMODE_DEBUG 0x00000040U /**< 'debugging' info */
148 #define UMODE_NCHANGE 0x00000080U /**< Nick change notice */
149 #define UMODE_WALLOP 0x00000100U /**< Send wallops to them */
150 #define UMODE_INVISIBLE 0x00000200U /**< Makes user invisible */
151 #define UMODE_BOTS 0x00000400U /**< Shows bots */
152 #define UMODE_EXTERNAL 0x00000800U /**< Show servers introduced and splitting */
153 #define UMODE_CALLERID 0x00001000U /**< Block unless caller id's */
154 #define UMODE_SOFTCALLERID 0x00002000U /**< Block unless on common channel */
155 #define UMODE_UNAUTH 0x00004000U /**< Show unauth connects here */
156 #define UMODE_LOCOPS 0x00008000U /**< Show locops */
157 #define UMODE_DEAF 0x00010000U /**< Don't receive channel messages */
158 #define UMODE_REGISTERED 0x00020000U /**< User has identified for that nick. */
159 #define UMODE_REGONLY 0x00040000U /**< Only registered nicks may PM */
160 #define UMODE_HIDDEN 0x00080000U /**< Operator status is hidden */
161 #define UMODE_OPER 0x00100000U /**< Operator */
162 #define UMODE_ADMIN 0x00200000U /**< Admin on server */
163 #define UMODE_FARCONNECT 0x00400000U /**< Can see remote client connects/exits */
164 #define UMODE_HIDDENHOST 0x00800000U /**< User's host is hidden */
165 #define UMODE_SSL 0x01000000U /**< User is connected via TLS/SSL */
166 #define UMODE_WEBIRC 0x02000000U /**< User connected via a webirc gateway */
167 #define UMODE_HIDEIDLE 0x04000000U /**< Hides idle and signon time in WHOIS */
168 #define UMODE_HIDECHANS 0x08000000U /**< Hides channel list in WHOIS */
169
170 #define UMODE_ALL UMODE_SERVNOTICE
171
172 #define HasUMode(x, y) ((x)->umodes & (y))
173 #define AddUMode(x, y) ((x)->umodes |= (y))
174 #define DelUMode(x, y) ((x)->umodes &= ~(y))
175
176
177 /* oper priv flags */
178 #define OPER_FLAG_KILL_REMOTE 0x00000001U /**< Oper can KILL remote users */
179 #define OPER_FLAG_KILL 0x00000002U /**< Oper can KILL local users */
180 #define OPER_FLAG_UNKLINE 0x00000004U /**< Oper can use UNKLINE command */
181 #define OPER_FLAG_GLINE 0x00000008U /**< Oper can use GLINE command */
182 #define OPER_FLAG_KLINE 0x00000010U /**< Oper can use KLINE command */
183 #define OPER_FLAG_XLINE 0x00000020U /**< Oper can use XLINE command */
184 #define OPER_FLAG_DIE 0x00000040U /**< Oper can use DIE command */
185 #define OPER_FLAG_REHASH 0x00000080U /**< Oper can use REHASH command */
186 #define OPER_FLAG_ADMIN 0x00000100U /**< Oper can set user mode +a */
187 #define OPER_FLAG_REMOTEBAN 0x00000200U /**< Oper can set remote bans */
188 #define OPER_FLAG_GLOBOPS 0x00000400U /**< Oper can use GLOBOPS command */
189 #define OPER_FLAG_MODULE 0x00000800U /**< Oper can use MODULE command */
190 #define OPER_FLAG_RESTART 0x00001000U /**< Oper can use RESTART command */
191 #define OPER_FLAG_DLINE 0x00002000U /**< Oper can use DLINE command */
192 #define OPER_FLAG_UNDLINE 0x00004000U /**< Oper can use UNDLINE command */
193 #define OPER_FLAG_SET 0x00008000U /**< Oper can use SET command */
194 #define OPER_FLAG_SQUIT 0x00010000U /**< Oper can do local SQUIT */
195 #define OPER_FLAG_SQUIT_REMOTE 0x00020000U /**< Oper can do remote SQUIT */
196 #define OPER_FLAG_CONNECT 0x00040000U /**< Oper can do local CONNECT */
197 #define OPER_FLAG_CONNECT_REMOTE 0x00080000U /**< Oper can do remote CONNECT */
198 #define OPER_FLAG_WALLOPS 0x00100000U /**< Oper can use WALLOPS command */
199 #define OPER_FLAG_LOCOPS 0x00200000U /**< Oper can use LOCOPS command */
200 #define OPER_FLAG_UNXLINE 0x00400000U /**< Oper can use UNXLINE command */
201 #define OPER_FLAG_OPME 0x00800000U /**< Oper can use OPME command */
202
203
204 #define HasOFlag(x, y) (MyConnect(x) ? (x)->connection->operflags & (y) : 0)
205 #define AddOFlag(x, y) ((x)->connection->operflags |= (y))
206 #define DelOFlag(x, y) ((x)->connection->operflags &= ~(y))
207 #define ClrOFlag(x) ((x)->connection->operflags = 0)
208
209
210
211 /* flags macros. */
212 #define IsAuthFinished(x) ((x)->flags & FLAGS_FINISHED_AUTH)
213 #define IsDead(x) ((x)->flags & FLAGS_DEADSOCKET)
214 #define SetDead(x) ((x)->flags |= FLAGS_DEADSOCKET)
215 #define IsClosing(x) ((x)->flags & FLAGS_CLOSING)
216 #define SetClosing(x) ((x)->flags |= FLAGS_CLOSING)
217 #define SetCanFlood(x) ((x)->flags |= FLAGS_CANFLOOD)
218 #define IsCanFlood(x) ((x)->flags & FLAGS_CANFLOOD)
219 #define IsDefunct(x) ((x)->flags & (FLAGS_DEADSOCKET|FLAGS_CLOSING|FLAGS_KILLED))
220
221 /* oper flags */
222 #define MyOper(x) (MyConnect(x) && HasUMode(x, UMODE_OPER))
223
224 #define SetOper(x) {(x)->umodes |= UMODE_OPER; \
225 if (!IsServer((x))) (x)->handler = OPER_HANDLER;}
226
227 #define ClearOper(x) {(x)->umodes &= ~(UMODE_OPER|UMODE_ADMIN); \
228 if (!HasUMode(x, UMODE_OPER) && !IsServer((x))) \
229 (x)->handler = CLIENT_HANDLER; }
230
231 #define SetSendQExceeded(x) ((x)->flags |= FLAGS_SENDQEX)
232 #define IsSendQExceeded(x) ((x)->flags & FLAGS_SENDQEX)
233
234 #define SetUserHost(x) ((x)->flags |= FLAGS_USERHOST)
235 #define IsUserHostIp(x) ((x)->flags & FLAGS_USERHOST)
236
237 #define SetPingSent(x) ((x)->flags |= FLAGS_PINGSENT)
238 #define IsPingSent(x) ((x)->flags & FLAGS_PINGSENT)
239 #define ClearPingSent(x) ((x)->flags &= ~FLAGS_PINGSENT)
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
253 #define IsFloodDone(x) ((x)->flags & FLAGS_FLOODDONE)
254 #define SetFloodDone(x) ((x)->flags |= FLAGS_FLOODDONE)
255 #define HasPingCookie(x) ((x)->flags & FLAGS_PING_COOKIE)
256 #define SetPingCookie(x) ((x)->flags |= FLAGS_PING_COOKIE)
257 #define IsHidden(x) ((x)->flags & FLAGS_HIDDEN)
258 #define SetHidden(x) ((x)->flags |= FLAGS_HIDDEN)
259
260
261 /*! \brief addr_mask_type enumeration */
262 enum addr_mask_type
263 {
264 HIDE_IP, /**< IP is hidden. Resolved hostname is shown instead */
265 SHOW_IP, /**< IP is shown. No parts of it are hidden or masked */
266 MASK_IP /**< IP is masked. 255.255.255.255 is shown instead */
267 };
268
269 /*! \brief Server structure */
270 struct Server
271 {
272 dlink_list server_list; /**< Servers on this server */
273 dlink_list client_list; /**< Clients on this server */
274 char by[NICKLEN + 1]; /**< Who activated this connection */
275 };
276
277 /*! \brief ListTask structure */
278 struct ListTask
279 {
280 dlink_list show_mask; /**< Channels to show */
281 dlink_list hide_mask; /**< Channels to hide */
282
283 unsigned int hash_index; /**< The hash bucket we are currently in */
284 unsigned int users_min;
285 unsigned int users_max;
286 unsigned int created_min;
287 unsigned int created_max;
288 unsigned int topicts_min;
289 unsigned int topicts_max;
290 char topic[TOPICLEN + 1];
291 };
292
293 /*! \brief Connection structure
294 *
295 * Allocated only for local clients, that are directly connected
296 * to \b this server with a socket.
297 */
298 struct Connection
299 {
300 dlink_node lclient_node;
301
302 unsigned int registration;
303 unsigned int cap_client; /**< Client capabilities (from us) */
304 unsigned int cap_active; /**< Active capabilities (to us) */
305 unsigned int caps; /**< Capabilities bit-field */
306
307 unsigned int operflags; /**< IRC Operator privilege flags */
308 unsigned int random_ping; /**< Holding a 32bit value used for PING cookies */
309
310 uint64_t serial; /**< Used to enforce 1 send per nick */
311
312 time_t lasttime; /**< ...should be only LOCAL clients? --msa */
313 time_t firsttime; /**< Time client was created */
314 time_t since; /**< Last time we parsed something */
315 time_t last_join_time; /**< When this client last joined a channel */
316 time_t last_leave_time; /**< When this client last left a channel */
317 int join_leave_count; /**< Count of JOIN/LEAVE in less than
318 MIN_JOIN_LEAVE_TIME seconds */
319 int oper_warn_count_down; /**< Warn opers of this possible
320 spambot every time this gets to 0 */
321 time_t last_caller_id_time;
322 time_t first_received_message_time;
323 time_t last_privmsg; /**< Last time we got a PRIVMSG */
324
325 int received_number_of_privmsgs;
326
327 struct ListTask *list_task;
328
329 struct dbuf_queue buf_sendq;
330 struct dbuf_queue buf_recvq;
331
332 struct
333 {
334 unsigned int messages; /**< Statistics: protocol messages sent/received */
335 uint64_t bytes; /**< Statistics: total bytes sent/received */
336 } recv, send;
337
338 struct
339 {
340 unsigned int count; /**< How many AWAY/INVITE/KNOCK/NICK requests client has sent */
341 time_t last_attempt; /**< Last time the AWAY/INVITE/KNOCK/NICK request was issued */
342 } away, invite, knock, nick;
343
344 struct AuthRequest auth;
345 struct Listener *listener; /**< Listener accepted from */
346 dlink_list acceptlist; /**< Clients I'll allow to talk to me */
347 dlink_list watches; /**< Chain of Watch pointer blocks */
348 dlink_list confs; /**< Configuration record associated */
349 dlink_list invited; /**< Chain of invite pointer blocks */
350 struct irc_ssaddr ip;
351 int aftype; /**< Makes life easier for DNS res in IPV6 */
352 int country_id; /**< ID corresponding to a ISO 3166 country code */
353
354 fde_t fd;
355
356 /* Anti-flood stuff. We track how many messages were parsed and how
357 * many we were allowed in the current second, and apply a simple
358 * decay to avoid flooding.
359 * -- adrian
360 */
361 int allow_read; /**< How many we're allowed to read in this second */
362 int sent_parsed; /**< How many messages we've parsed in this second */
363
364 char *password; /**< Password supplied by the client/server */
365 char *challenge_response; /**< Expected CHALLENGE response from client */
366 char *challenge_operator; /**< Operator to become if they supply the response */
367 };
368
369 /*! \brief Client structure */
370 struct Client
371 {
372 dlink_node node;
373 dlink_node lnode; /**< Used for Server->servers/users */
374
375 struct Connection *connection;
376 struct Client *hnext; /**< For client hash table lookups by name */
377 struct Client *idhnext; /**< For SID hash table lookups by sid */
378 struct Server *serv; /**< ...defined, if this is a server */
379 struct Client *servptr; /**< Points to server this Client is on */
380 struct Client *from; /**< == self, if Local Client, *NEVER* NULL! */
381
382 time_t tsinfo; /**< TS on the nick, SVINFO on server */
383
384 unsigned int flags; /**< Client flags */
385 unsigned int umodes; /**< Opers, normal users subset */
386 unsigned int hopcount; /**< Number of servers to this 0 = local */
387 unsigned int status; /**< Client type */
388 unsigned int handler; /**< Handler index */
389
390 dlink_list whowas;
391 dlink_list channel; /**< Chain of channel pointer blocks */
392
393 char away[AWAYLEN + 1]; /**< Client's AWAY message. Can be set/unset via AWAY command */
394 char name[HOSTLEN + 1]; /**< Unique name for a client nick or host */
395 char id[IDLEN + 1]; /**< Client ID, unique ID per client */
396 char account[SVIDLEN + 1]; /**< Services account */
397
398 /*
399 * client->username is the username from ident or the USER message,
400 * If the client is idented the USER message is ignored, otherwise
401 * the username part of the USER message is put here prefixed with a
402 * tilde depending on the auth{} block. Once a client has registered,
403 * this field should be considered read-only.
404 */
405 char username[USERLEN + 1]; /* client's username */
406
407 /*
408 * client->host contains the resolved name or ip address
409 * as a string for the user, it may be fiddled with for oper spoofing etc.
410 * once it's changed the *real* address goes away. This should be
411 * considered a read-only field after the client has registered.
412 */
413 char host[HOSTLEN + 1]; /* client's hostname */
414
415 /*
416 * client->info for unix clients will normally contain the info from the
417 * gcos field in /etc/passwd but anything can go here.
418 */
419 char info[REALLEN + 1]; /* Free form additional client info */
420
421 /*
422 * client->sockhost contains the ip address gotten from the socket as a
423 * string, this field should be considered read-only once the connection
424 * has been made. (set in s_bsd.c only)
425 */
426 char sockhost[HOSTIPLEN + 1]; /* This is the host name from the
427 socket ip address as string */
428 char *certfp;
429 };
430
431
432 extern struct Client me;
433 extern dlink_list listing_client_list;
434 extern dlink_list global_client_list;
435 extern dlink_list global_server_list; /* global servers on the network */
436 extern dlink_list local_client_list; /* local clients only ON this server */
437 extern dlink_list local_server_list; /* local servers to this server ONLY */
438 extern dlink_list unknown_list; /* unknown clients ON this server only */
439 extern dlink_list oper_list; /* our opers, duplicated in local_client_list */
440
441 extern int accept_message(struct Client *, struct Client *);
442 extern unsigned int idle_time_get(const struct Client *, const struct Client *);
443 extern struct split_nuh_item *find_accept(const char *, const char *,
444 const char *, struct Client *,
445 int (*)(const char *, const char *));
446 extern void del_accept(struct split_nuh_item *, struct Client *);
447 extern void del_all_accepts(struct Client *);
448 extern void exit_client(struct Client *, const char *);
449 extern void conf_try_ban(struct Client *, struct MaskItem *);
450 extern void check_conf_klines(void);
451 extern void client_init(void);
452 extern void dead_link_on_write(struct Client *, int);
453 extern void dead_link_on_read(struct Client *, int);
454 extern void exit_aborted_clients(void);
455 extern void free_exited_clients(void);
456 extern struct Client *make_client(struct Client *);
457 extern struct Client *find_chasing(struct Client *, const char *);
458 extern struct Client *find_person(const struct Client *const, const char *);
459 extern const char *get_client_name(const struct Client *, enum addr_mask_type);
460
461 #endif /* INCLUDED_client_h */

Properties

Name Value
svn:eol-style native
svn:keywords Id Revision