5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2005, 2007 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
24 #include "serverconfig.h"
26 /* Context for holding cache information to periodically purge
33 /* Channel key re-key context. */
35 SilcChannelEntry channel;
38 } *SilcServerChannelRekey;
40 /* ID List Entry status flags. */
41 typedef SilcUInt8 SilcIDListStatus;
42 #define SILC_IDLIST_STATUS_NONE 0x00 /* No status */
43 #define SILC_IDLIST_STATUS_REGISTERED 0x01 /* Entry is registered */
44 #define SILC_IDLIST_STATUS_RESOLVED 0x02 /* Entry info is resolved */
45 #define SILC_IDLIST_STATUS_RESOLVING 0x04 /* Entry is being resolved
46 with WHOIS or IDENTIFY */
47 #define SILC_IDLIST_STATUS_DISABLED 0x08 /* Entry is disabled */
48 #define SILC_IDLIST_STATUS_RESUMED 0x10 /* Entry is resumed */
49 #define SILC_IDLIST_STATUS_LOCAL 0x20 /* Entry locally connected */
50 #define SILC_IDLIST_STATUS_RESUME_RES 0x40 /* Entry resolved while
52 #define SILC_IDLIST_STATUS_NOATTR 0x80 /* Entry does not support
53 attributes in WHOIS */
56 Generic ID list data structure.
58 This structure is included in all ID list entries and it includes data
59 pointers that are common to all ID entries. This structure is always
60 defined to the first field in the ID entries and is used to explicitly
61 type cast to this type without first explicitly casting to correct ID
62 entry type. Hence, the ID list entry is type casted to this type to
63 get this data from the ID entry (which is usually opaque pointer).
65 Note that some of the fields may be NULL.
68 struct SilcIDListDataObject {
69 SilcConnectionType conn_type; /* Connection type */
70 SilcServerConnection sconn; /* Connection context */
71 SilcSKERekeyMaterial rekey; /* Rekey material */
75 SilcPublicKey public_key;
76 unsigned char fingerprint[20];
78 long last_receive; /* Time last received data */
79 long last_sent; /* Time last sent data */
81 unsigned long created; /* Time when entry was created */
83 SilcIDListStatus status; /* Status mask of the entry */
87 SILC Server entry object.
89 This entry holds information about servers in SILC network. However,
90 contents of this entry is highly dependent of what kind of server we are
91 (normal server or router server) and whether the entry is used as a local
92 list or a global list. These factors dictates the contents of this entry.
94 This entry is defined as follows:
96 Server type List type Contents
97 =======================================================================
98 server local list Server itself
99 server global list NULL
100 router local list All servers is the cell
101 router global list All servers in the SILC network
103 Following short description of the fields:
105 SilcIDListDataStruct data
107 Generic data structure to hold data common to all ID entries.
111 Logical name of the server. There is no limit of the length of the
112 server name. This is usually the same name as defined in DNS.
114 SilcUInt8 server_type
116 Type of the server. SILC_SERVER or SILC_ROUTER are the possible
121 ID of the server. This includes all the relevant information about
122 the server SILC will ever need. These are also the informations
123 that is broadcasted between servers and routers in the SILC network.
128 Server info (from INFO command) saved temporarily and motd (from
129 MOTD command) saved temporarily.
131 SilcServerEntry router
133 This is a pointer back to the server list. This is the router server
134 where this server is connected to. If this is the router itself and
135 it doesn't have a route this is NULL.
138 SilcCipher receive_key
140 Data sending and receiving keys.
144 A pointer, usually, to the socket list for fast referencing to
145 the data used in connection with this server. This may be anything
146 but as just said, this is usually pointer to the socket connection
150 struct SilcServerEntryStruct {
151 /* Generic data structure. DO NOT add anything before this! */
152 SilcIDListDataStruct data;
155 SilcUInt8 server_type;
160 /* Pointer to the router */
161 SilcServerEntry router;
163 /* Connection data */
167 unsigned int backup : 1; /* Set when executing backup protocol */
171 SILC Channel Client entry structure.
173 This entry used only by the SilcChannelEntry object and it holds
174 information about current clients (ie. users) on channel. Following
175 short description of the fields:
177 SilcClientEntry client
179 Pointer to the client list. This is the client currently on channel.
183 Client's current mode on the channel.
185 SilcChannelEntry channel
187 Back pointer back to channel. As this structure is also used by
188 SilcClientEntry we have this here for fast access to the channel when
189 used by SilcClientEntry.
192 typedef struct SilcChannelClientEntryStruct {
193 SilcClientEntry client;
195 SilcChannelEntry channel;
196 } *SilcChannelClientEntry;
199 SILC Client entry object.
201 This entry holds information about connected clients ie. users in the SILC
202 network. The contents of this entrt is depended on whether we are normal
203 server or router server and whether the list is a local or global list.
205 This entry is defined as follows:
207 Server type List type Contents
208 =======================================================================
209 server local list All clients in server
210 server global list NULL
211 router local list All clients in cell
212 router global list All clients in SILC
214 Following short description of the fields:
216 SilcIDListDataStruct data
218 Generic data structure to hold data common to all ID entries.
220 unsigned char *nickname
222 The nickname of the client. This is nickname in original format,
223 not casefolded or normalized. However, it is checked to assure
224 that prohibited characters do not exist. The casefolded version
229 The name of the server where the client is from. MAy be NULL.
233 Client's usename. This is defined in the following manner:
235 Server type List type Contents
236 ====================================================
237 server local list User's name
238 router local list NULL
239 router global list NULL
241 Router doesn't hold this information since it is not vital data
242 for the router. If this information is needed by the client it is
243 fetched when it is needed.
247 Information about user. This is free information and can be virtually
248 anything. This is defined in following manner:
250 Server type List type Contents
251 ====================================================
252 server local list User's information
253 router local list NULL
254 router global list NULL
256 Router doesn't hold this information since it is not vital data
257 for the router. If this information is needed by the client it is
258 fetched when it is needed.
262 ID of the client. This includes all the information SILC will ever
263 need. Notice that no nickname of the user is saved anywhere. This is
264 beacuse of SilcClientID includes 88 bit hash value of the user's
265 nickname which can be used to track down specific user by their
266 nickname. Nickname is not relevant information that would need to be
271 Client's mode. Client maybe for example server operator or
272 router operator (SILC operator).
276 Time of last time client executed command. We are strict and will
277 not allow any command to be exeucted more than once in about
278 2 seconds. This is result of normal time().
280 SilcUInt8 fast_command
282 Counter to check command bursts. By default, up to 5 commands
283 are allowed before limiting the execution. See command flags
286 SilcServerEntry router
288 This is a pointer to the server list. This is the router server whose
289 cell this client is coming from. This is used to route messages to
292 SilcHashTable channels;
294 All the channels this client has joined. The context saved in the
295 hash table shares memory with the channel entrys `user_list' hash
300 A pointer, usually, to the socket list for fast referencing to
301 the data used in connection with this client. This may be anything
302 but as just said, this is usually pointer to the socket connection
305 SilcUInt16 resolve_cmd_ident
307 Command identifier for the entry when the entry's data.status
308 is SILC_IDLIST_STATUS_RESOLVING. If this entry is asked to be
309 resolved when the status is set then the resolver may attach to
310 this command identifier and handle the process after the resolving
314 struct SilcClientEntryStruct {
315 /* Generic data structure. DO NOT add anything before this! */
316 SilcIDListDataStruct data;
318 unsigned char *nickname;
326 SilcUInt8 fast_command;
328 /* Requested Attributes */
329 unsigned char *attrs;
330 SilcUInt16 attrs_len;
332 /* Pointer to the router */
333 SilcServerEntry router;
335 /* All channels this client has joined */
336 SilcHashTable channels;
338 /* Connection data */
341 /* Last time updated/accessed */
342 unsigned long updated;
344 /* data.status is RESOLVING and this includes the resolving command
346 SilcUInt16 resolve_cmd_ident;
348 /* we need this so nobody can resume more than once at the same time -
349 * server crashes, really odd behaviour, ... */
350 SilcClientEntry resuming_client;
354 SILC Channel entry object.
356 This entry holds information about channels in SILC network. The contents
357 of this entry is depended on whether we are normal server or router server
358 and whether the list is a local or global list.
360 This entry is defined as follows:
362 Server type List type Contents
363 =======================================================================
364 server local list All channels in server
365 server global list NULL
366 router local list All channels in cell
367 router global list All channels in SILC
369 Following short description of the fields:
373 Logical name of the channel. This is the original format, not
374 the casefolded or normalized. However, this is checked to assure
375 that prohibited characters do not exist. The casefolded version
380 Current mode of the channel. See lib/silccore/silcchannel.h for
385 ID of the channel. This includes all the information SILC will ever
388 SilcBool global_users
390 Boolean value to tell whether there are users outside this server
391 on this channel. This is set to TRUE if router sends message to
392 the server that there are users outside your server on your
393 channel as well. This way server knows that messages needs to be
394 sent to the router for further routing. If this is a normal
395 server and this channel is not created on this server this field
396 is always TRUE. If this server is a router this field is ignored.
400 Current topic of the channel.
404 Default cipher of the channel. If this is NULL then server picks
405 the cipher to be used. This can be set at SILC_COMMAND_JOIN.
409 Default hmac of the channel. If this is NULL then server picks
410 the cipher to be used. This can be set at SILC_COMMAND_JOIN.
412 SilcPublicKey founder_key
414 If the SILC_CMODE_FOUNDER_AUTH has been set then this will include
415 the founder's public key. When the mode and this key is set the
416 channel is also permanent channel and cannot be destroyed.
418 SilcHashTable user_list
420 All users joined on this channel. Note that the context saved to
421 this entry shares memory with the client entrys `channels' hash
424 SilcServerEntry router
426 This is a pointer to the server list. This is the router server
427 whose cell this channel belongs to. This is used to route messages
431 SilcCipher receive_key
433 The key of the channel (the cipher actually).
438 Raw key data of the channel key.
440 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]
442 Current initial vector. Initial vector is received always along
443 with the channel packet. By default this is filled with NULL.
449 SilcServerChannelRekey rekey
451 Channel key re-key context.
454 struct SilcChannelEntryStruct {
461 SilcPublicKey founder_key;
462 SilcHashTable channel_pubkeys;
464 SilcUInt32 user_limit;
465 unsigned char *passphrase;
466 SilcHashTable invite_list;
467 SilcHashTable ban_list;
469 /* All users on this channel */
470 SilcHashTable user_list;
471 SilcUInt32 user_count;
473 /* Pointer to the router */
474 SilcServerEntry router;
478 SilcCipher receive_key;
483 SilcServerChannelRekey rekey;
484 unsigned long created;
485 unsigned long updated;
488 unsigned int global_users : 1;
489 unsigned int disabled : 1;
490 unsigned int users_resolved : 1;
496 As for remainder these lists are defined as follows:
498 Entry list (cache) Server type List type Contents
499 =======================================================================
500 servers server local list Server itself
501 servers server global list NULL
502 servers router local list All servers in cell
503 servers router global list All servers in SILC
505 clients server local list All clients in server
506 clients server global list NULL
507 clients router local list All clients in cell
508 clients router global list All clients in SILC
510 channels server local list All channels in server
511 channels server global list NULL
512 channels router local list All channels in cell
513 channels router global list All channels in SILC
515 As seen on the list normal server never defines a global list. This is
516 because of normal server don't know anything about anything global data,
517 they get it from the router if and when they need it. Routers, on the
518 other hand, always define local and global lists because routers really
519 know all the relevant data in the SILC network.
521 This object is used as local and global list by the server/router.
522 Above table shows how this is defined on different conditions.
524 This object holds pointers to the ID cache system. Every ID cache entry
525 has a specific context pointer to allocated entry (server, client or
529 struct SilcIDListStruct {
532 SilcIDCache channels;
536 ID Entry for Unknown connections.
538 This is used during authentication phases where we still don't know
539 what kind of connection remote connection is, hence, we will use this
540 structure instead until we know what type of connection remote end is.
542 This is not in any list. This is always individually allocated and
547 /* Generic data structure. DO NOT add anything before this! */
548 SilcIDListDataStruct data;
549 SilcAsyncOperation op;
550 SilcServerConfigRef cconfig;
551 SilcServerConfigRef sconfig;
552 SilcServerConfigRef rconfig;
554 const char *hostname;
560 void silc_idlist_add_data(void *entry, SilcIDListData idata);
561 void silc_idlist_del_data(void *entry);
562 SILC_TASK_CALLBACK(silc_idlist_purge);
564 silc_idlist_add_server(SilcIDList id_list,
565 char *server_name, int server_type,
566 SilcServerID *id, SilcServerEntry router,
569 silc_idlist_find_server_by_id(SilcIDList id_list, SilcServerID *id,
570 SilcBool registered, SilcIDCacheEntry *ret_entry);
572 silc_idlist_find_server_by_name(SilcIDList id_list, char *name,
573 SilcBool registered, SilcIDCacheEntry *ret_entry);
575 silc_idlist_find_server_by_conn(SilcIDList id_list, char *hostname,
576 int port, SilcBool registered,
577 SilcIDCacheEntry *ret_entry);
579 silc_idlist_replace_server_id(SilcIDList id_list, SilcServerID *old_id,
580 SilcServerID *new_id);
581 int silc_idlist_del_server(SilcIDList id_list, SilcServerEntry entry);
582 void silc_idlist_server_destructor(SilcIDCache cache,
583 SilcIDCacheEntry entry,
587 silc_idlist_add_client(SilcIDList id_list, char *nickname, char *username,
588 char *userinfo, SilcClientID *id,
589 SilcServerEntry router, void *connection);
590 int silc_idlist_del_client(SilcIDList id_list, SilcClientEntry entry);
591 int silc_idlist_get_clients_by_nickname(SilcIDList id_list, char *nickname,
593 SilcClientEntry **clients,
594 SilcUInt32 *clients_count);
595 int silc_idlist_get_clients_by_hash(SilcIDList id_list,
596 char *nickname, char *server,
598 SilcClientEntry **clients,
599 SilcUInt32 *clients_count);
601 silc_idlist_find_client_by_id(SilcIDList id_list, SilcClientID *id,
602 SilcBool registered, SilcIDCacheEntry *ret_entry);
604 silc_idlist_replace_client_id(SilcServer server,
605 SilcIDList id_list, SilcClientID *old_id,
606 SilcClientID *new_id, const char *nickname);
607 void silc_idlist_client_destructor(SilcIDCache cache,
608 SilcIDCacheEntry entry,
612 silc_idlist_add_channel(SilcIDList id_list, char *channel_name, int mode,
613 SilcChannelID *id, SilcServerEntry router,
614 SilcCipher send_key, SilcCipher receive_key,
616 void silc_idlist_channel_destructor(SilcIDCache cache,
617 SilcIDCacheEntry entry,
620 int silc_idlist_del_channel(SilcIDList id_list, SilcChannelEntry entry);
622 silc_idlist_find_channel_by_name(SilcIDList id_list, char *name,
623 SilcIDCacheEntry *ret_entry);
625 silc_idlist_find_channel_by_id(SilcIDList id_list, SilcChannelID *id,
626 SilcIDCacheEntry *ret_entry);
628 silc_idlist_replace_channel_id(SilcIDList id_list, SilcChannelID *old_id,
629 SilcChannelID *new_id);
631 silc_idlist_get_channels(SilcIDList id_list, SilcChannelID *channel_id,
632 SilcUInt32 *channels_count);