5 Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
7 Copyright (C) 1997 - 2001 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 /* Forward declarations */
25 typedef struct SilcServerEntryStruct *SilcServerEntry;
26 typedef struct SilcClientEntryStruct *SilcClientEntry;
27 typedef struct SilcChannelEntryStruct *SilcChannelEntry;
29 /* Context for holding cache information to periodically purge
37 Generic ID list data structure.
39 This structure is included in all ID list entries and it includes data
40 pointers that are common to all ID entries. This structure is always
41 defined to the first field in the ID entries and is used to explicitly
42 cast to this type without first explicitly casting to correct ID entry
43 type. Hence, the ID list entry is casted to this type to get this data
44 from the ID entry (which is usually opaque pointer).
46 Note that some of the fields may be NULL.
50 /* Send and receive symmetric keys */
52 SilcCipher receive_key;
54 /* Hash selected in the SKE protocol, NULL if not needed at all */
57 /* HMAC and raw key data */
59 unsigned char *hmac_key;
60 unsigned int hmac_key_len;
62 /* PKCS and public key */
64 SilcPublicKey public_key;
66 long last_receive; /* Time last received data */
67 long last_sent; /* Time last sent data */
68 unsigned char registered; /* Boolean whether connection is registered */
69 } *SilcIDListData, SilcIDListDataStruct;
72 SILC Server entry object.
74 This entry holds information about servers in SILC network. However,
75 contents of this entry is highly dependent of what kind of server we are
76 (normal server or router server) and whether the entry is used as a local
77 list or a global list. These factors dictates the contents of this entry.
79 This entry is defined as follows:
81 Server type List type Contents
82 =======================================================================
83 server local list Server itself
84 server global list NULL
85 router local list All servers is the cell
86 router global list All servers in the SILC network
88 Following short description of the fields:
90 SilcIDListDataStruct data
92 Generic data structure to hold data common to all ID entries.
96 Logical name of the server. There is no limit of the length of the
97 server name. This is usually the same name as defined in DNS.
101 Type of the server. SILC_SERVER or SILC_ROUTER are the possible
106 ID of the server. This includes all the relevant information about
107 the server SILC will ever need. These are also the informations
108 that is broadcasted between servers and routers in the SILC network.
113 Server info (from INFO command) saved temporarily and motd (from
114 MOTD command) saved temporarily.
116 SilcServerEntry router
118 This is a pointer back to the server list. This is the router server
119 where this server is connected to. If this is the router itself and
120 it doesn't have a route this is NULL.
123 SilcCipher receive_key
125 Data sending and receiving keys.
129 A pointer, usually, to the socket list for fast referencing to
130 the data used in connection with this server. This may be anything
131 but as just said, this is usually pointer to the socket connection
135 struct SilcServerEntryStruct {
136 /* Generic data structure. DO NOT add anything before this! */
137 SilcIDListDataStruct data;
145 /* Pointer to the router */
146 SilcServerEntry router;
148 /* Connection data */
153 SILC Channel Client entry structure.
155 This entry used only by the SilcChannelEntry object and it holds
156 information about current clients (ie. users) on channel. Following
157 short description of the fields:
159 SilcClientEntry client
161 Pointer to the client list. This is the client currently on channel.
165 Client's current mode on the channel.
167 SilcChannelEntry channel
169 Back pointer back to channel. As this structure is also used by
170 SilcClientEntry we have this here for fast access to the channel when
171 used by SilcClientEntry.
173 struct SilcChannelClientEntryStruct *client_list
174 struct SilcChannelClientEntryStruct *channel_list
176 List member pointers. This structure is used by channel entry and
177 client entry thus we must have separate list member pointers for
178 them since we are using same entry for both lists (the entry is not
179 duplicated). SilcList requires this.
182 typedef struct SilcChannelClientEntryStruct {
183 SilcClientEntry client;
185 SilcChannelEntry channel;
186 struct SilcChannelClientEntryStruct *client_list;
187 struct SilcChannelClientEntryStruct *channel_list;
188 } *SilcChannelClientEntry;
191 SILC Client entry object.
193 This entry holds information about connected clients ie. users in the SILC
194 network. The contents of this entrt is depended on whether we are normal
195 server or router server and whether the list is a local or global list.
197 This entry is defined as follows:
199 Server type List type Contents
200 =======================================================================
201 server local list All clients in server
202 server global list NULL
203 router local list All clients in cell
204 router global list All clients in SILC
206 Following short description of the fields:
208 SilcIDListDataStruct data
210 Generic data structure to hold data common to all ID entries.
214 Client's usename. This is defined in the following manner:
216 Server type List type Contents
217 ====================================================
218 server local list User's name
219 router local list NULL
220 router global list NULL
222 Router doesn't hold this information since it is not vital data
223 for the router. If this information is needed by the client it is
224 fetched when it is needed.
228 Information about user. This is free information and can be virtually
229 anything. This is defined in following manner:
231 Server type List type Contents
232 ====================================================
233 server local list User's information
234 router local list NULL
235 router global list NULL
237 Router doesn't hold this information since it is not vital data
238 for the router. If this information is needed by the client it is
239 fetched when it is needed.
243 ID of the client. This includes all the information SILC will ever
244 need. Notice that no nickname of the user is saved anywhere. This is
245 beacuse of SilcClientID includes 88 bit hash value of the user's
246 nickname which can be used to track down specific user by their
247 nickname. Nickname is not relevant information that would need to be
252 Client's mode. Client maybe for example server operator or
253 router operator (SILC operator).
257 Time of last time client executed command. We are strict and will
258 not allow any command to be exeucted more than once in about
259 2 seconds. This is result of normal time().
263 Counter to check command bursts. By default, up to 5 commands
264 are allowed before limiting the execution. See command flags
267 SilcServerEntry router
269 This is a pointer to the server list. This is the router server whose
270 cell this client is coming from. This is used to route messages to
275 List of channels this client has joined.
279 A pointer, usually, to the socket list for fast referencing to
280 the data used in connection with this client. This may be anything
281 but as just said, this is usually pointer to the socket connection
285 struct SilcClientEntryStruct {
286 /* Generic data structure. DO NOT add anything before this! */
287 SilcIDListDataStruct data;
289 unsigned char *nickname;
298 /* Pointer to the router */
299 SilcServerEntry router;
301 /* List of channels client has joined to */
304 /* Connection data */
309 SILC Channel entry object.
311 This entry holds information about channels in SILC network. The contents
312 of this entry is depended on whether we are normal server or router server
313 and whether the list is a local or global list.
315 This entry is defined as follows:
317 Server type List type Contents
318 =======================================================================
319 server local list All channels in server
320 server global list NULL
321 router local list All channels in cell
322 router global list All channels in SILC
324 Following short description of the fields:
328 Logical name of the channel.
332 Current mode of the channel. See lib/silccore/silcchannel.h for
337 ID of the channel. This includes all the information SILC will ever
342 Boolean value to tell whether there are users outside this server
343 on this channel. This is set to TRUE if router sends message to
344 the server that there are users outside your server on your
345 channel as well. This way server knows that messages needs to be
346 sent to the router for further routing. If this is a normal
347 server and this channel is not created on this server this field
348 is always TRUE. If this server is a router this field is ignored.
352 Current topic of the channel.
356 Default cipher of the channel. If this is NULL then server picks
357 the cipher to be used. This can be set at SILC_COMMAND_JOIN.
359 SilcServerEntry router
361 This is a pointer to the server list. This is the router server
362 whose cell this channel belongs to. This is used to route messages
365 SilcCipher channel_key
367 The key of the channel (the cipher actually).
372 Raw key data of the channel key.
374 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]
376 Current initial vector. Initial vector is received always along
377 with the channel packet. By default this is filled with NULL.
384 struct SilcChannelEntryStruct {
392 unsigned int user_limit;
393 unsigned char *passphrase;
397 /* List of users on channel */
400 /* Pointer to the router */
401 SilcServerEntry router;
404 SilcCipher channel_key;
406 unsigned int key_len;
407 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE];
414 As for remainder these lists are defined as follows:
416 Entry list (cache) Server type List type Contents
417 =======================================================================
418 servers server local list Server itself
419 servers server global list NULL
420 servers router local list All servers in cell
421 servers router global list All servers in SILC
423 clients server local list All clients in server
424 clients server global list NULL
425 clients router local list All clients in cell
426 clients router global list All clients in SILC
428 channels server local list All channels in server
429 channels server global list NULL
430 channels router local list All channels in cell
431 channels router global list All channels in SILC
433 As seen on the list normal server never defines a global list. This is
434 because of normal server don't know anything about anything global data,
435 they get it from the router if and when they need it. Routers, on the
436 other hand, always define local and global lists because routers really
437 know all the relevant data in the SILC network.
439 This object is used as local and global list by the server/router.
440 Above table shows how this is defined on different conditions.
442 This object holds pointers to the ID cache system. Every ID cache entry
443 has a specific context pointer to allocated entry (server, client or
447 typedef struct SilcIDListStruct {
450 SilcIDCache channels;
454 ID Entry for Unknown connections.
456 This is used during authentication phases where we still don't know
457 what kind of connection remote connection is, hence, we will use this
458 structure instead until we know what type of connection remote end is.
460 This is not in any list. This is always individually allocated and
465 /* Generic data structure. DO NOT add anything before this! */
466 SilcIDListDataStruct data;
470 void silc_idlist_add_data(void *entry, SilcIDListData idata);
471 void silc_idlist_del_data(void *entry);
472 SILC_TASK_CALLBACK_GLOBAL(silc_idlist_purge);
474 silc_idlist_add_server(SilcIDList id_list,
475 char *server_name, int server_type,
476 SilcServerID *id, SilcServerEntry router,
479 silc_idlist_find_server_by_id(SilcIDList id_list, SilcServerID *id,
480 SilcIDCacheEntry *ret_entry);
482 silc_idlist_find_server_by_name(SilcIDList id_list, char *name,
483 SilcIDCacheEntry *ret_entry);
485 silc_idlist_find_server_by_conn(SilcIDList id_list, char *hostname,
486 int port, SilcIDCacheEntry *ret_entry);
488 silc_idlist_replace_server_id(SilcIDList id_list, SilcServerID *old_id,
489 SilcServerID *new_id);
490 void silc_idlist_del_server(SilcIDList id_list, SilcServerEntry entry);
492 silc_idlist_add_client(SilcIDList id_list, unsigned char *nickname,
493 unsigned int nickname_len, char *username,
494 char *userinfo, SilcClientID *id,
495 SilcServerEntry router, void *connection);
496 int silc_idlist_del_client(SilcIDList id_list, SilcClientEntry entry);
498 silc_idlist_get_clients_by_nickname(SilcIDList id_list, char *nickname,
499 char *server, unsigned int *clients_count);
501 silc_idlist_get_clients_by_hash(SilcIDList id_list, char *nickname,
503 unsigned int *clients_count);
505 silc_idlist_find_client_by_hash(SilcIDList id_list, char *nickname,
506 SilcHash md5hash, SilcIDCacheEntry *ret_entry);
508 silc_idlist_find_client_by_id(SilcIDList id_list, SilcClientID *id,
509 SilcIDCacheEntry *ret_entry);
511 silc_idlist_replace_client_id(SilcIDList id_list, SilcClientID *old_id,
512 SilcClientID *new_id);
513 void silc_idlist_client_destructor(SilcIDCache cache,
514 SilcIDCacheEntry entry);
516 silc_idlist_add_channel(SilcIDList id_list, char *channel_name, int mode,
517 SilcChannelID *id, SilcServerEntry router,
518 SilcCipher channel_key, SilcHmac hmac);
519 int silc_idlist_del_channel(SilcIDList id_list, SilcChannelEntry entry);
521 silc_idlist_find_channel_by_name(SilcIDList id_list, char *name,
522 SilcIDCacheEntry *ret_entry);
524 silc_idlist_find_channel_by_id(SilcIDList id_list, SilcChannelID *id,
525 SilcIDCacheEntry *ret_entry);
527 silc_idlist_replace_channel_id(SilcIDList id_list, SilcChannelID *old_id,
528 SilcChannelID *new_id);
530 silc_idlist_get_channels(SilcIDList id_list, SilcChannelID *channel_id,
531 unsigned int *channels_count);