/[svn]/ircd-hybrid/trunk/include/client.h
ViewVC logotype

Contents of /ircd-hybrid/trunk/include/client.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 8917 - (show annotations)
Sun Apr 21 22:50:42 2019 UTC (3 years, 7 months ago) by michael
File MIME type: text/x-csrc
File size: 19206 byte(s)
- Update documentation in some files

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

Properties

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

svnadmin@ircd-hybrid.org
ViewVC Help
Powered by ViewVC 1.1.28