ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/trunk/include/client.h
Revision: 5774
Committed: Sat Apr 4 15:43:29 2015 UTC (10 years, 4 months ago) by michael
Content type: text/x-chdr
File size: 21532 byte(s)
Log Message:
- Removed TS_DOESTS, DoesTS, and related code

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

Properties

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