ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/branches/8.2.x/include/client.h
Revision: 9833
Committed: Fri Dec 25 10:09:43 2020 UTC (5 years, 7 months ago) by michael
Content type: text/x-chdr
File size: 19604 byte(s)
Log Message:
- Stylistical changes

File Contents

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

Properties

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