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;
30 Generic ID list data structure.
32 This structure is included in all ID list entries and it includes data
33 pointers that are common to all ID entries. This structure is always
34 defined to the first field in the ID entries and is used to explicitly
35 cast to this type without first explicitly casting to correct ID entry
36 type. Hence, the ID list entry is casted to this type to get this data
37 from the ID entry (which is usually opaque pointer).
39 Note that some of the fields may be NULL.
43 /* Send and receive symmetric keys */
45 SilcCipher receive_key;
47 /* HMAC and raw key data */
49 unsigned char *hmac_key;
50 unsigned int hmac_key_len;
52 /* PKCS and public key */
54 SilcPublicKey public_key;
56 long last_receive; /* Time last received data */
57 long last_sent; /* Time last sent data */
58 unsigned char registered; /* Boolean whether connection is registered */
59 } *SilcIDListData, SilcIDListDataStruct;
62 SILC Server entry object.
64 This entry holds information about servers in SILC network. However,
65 contents of this entry is highly dependent of what kind of server we are
66 (normal server or router server) and whether the entry is used as a local
67 list or a global list. These factors dictates the contents of this entry.
69 This entry is defined as follows:
71 Server type List type Contents
72 =======================================================================
73 server local list Server itself
74 server global list NULL
75 router local list All servers is the cell
76 router global list All servers in the SILC network
78 Following short description of the fields:
80 SilcIDListDataStruct data
82 Generic data structure to hold data common to all ID entries.
86 Logical name of the server. There is no limit of the length of the
87 server name. This is usually the same name as defined in DNS.
91 Type of the server. SILC_SERVER or SILC_ROUTER are the possible
96 ID of the server. This includes all the relevant information about
97 the server SILC will ever need. These are also the informations
98 that is broadcasted between servers and routers in the SILC network.
100 SilcServerEntry router
102 This is a pointer back to the server list. This is the router server
103 where this server is connected to. If this is the router itself and
104 it doesn't have a route this is NULL.
107 SilcCipher receive_key
109 Data sending and receiving keys.
113 A pointer, usually, to the socket list for fast referencing to
114 the data used in connection with this server. This may be anything
115 but as just said, this is usually pointer to the socket connection
119 struct SilcServerEntryStruct {
120 /* Generic data structure. DO NOT add anything before this! */
121 SilcIDListDataStruct data;
127 /* Pointer to the router */
128 SilcServerEntry router;
130 /* Connection data */
135 SILC Channel Client entry structure.
137 This entry used only by the SilcChannelEntry object and it holds
138 information about current clients (ie. users) on channel. Following
139 short description of the fields:
141 SilcClientEntry client
143 Pointer to the client list. This is the client currently on channel.
147 Client's current mode on the channel.
149 SilcChannelEntry channel
151 Back pointer back to channel. As this structure is also used by
152 SilcClientEntry we have this here for fast access to the channel when
153 used by SilcClientEntry.
155 struct SilcChannelClientEntryStruct *client_list
156 struct SilcChannelClientEntryStruct *channel_list
158 List member pointers. This structure is used by channel entry and
159 client entry thus we must have separate list member pointers for
160 them since we are using same entry for both lists (the entry is not
161 duplicated). SilcList requires this.
164 typedef struct SilcChannelClientEntryStruct {
165 SilcClientEntry client;
167 SilcChannelEntry channel;
168 struct SilcChannelClientEntryStruct *client_list;
169 struct SilcChannelClientEntryStruct *channel_list;
170 } *SilcChannelClientEntry;
173 SILC Client entry object.
175 This entry holds information about connected clients ie. users in the SILC
176 network. The contents of this entrt is depended on whether we are normal
177 server or router server and whether the list is a local or global list.
179 This entry is defined as follows:
181 Server type List type Contents
182 =======================================================================
183 server local list All clients in server
184 server global list NULL
185 router local list All clients in cell
186 router global list All clients in SILC
188 Following short description of the fields:
190 SilcIDListDataStruct data
192 Generic data structure to hold data common to all ID entries.
196 Client's (meaning user's) real name. This is defined in following
199 Server type List type Contents
200 ====================================================
201 server local list User's name
202 router local list NULL
203 router global list NULL
205 Router doesn't hold this information since it is not vital data
206 for the router. If this information is needed by the client it is
207 fetched when it is needed.
211 Information about user. This is free information and can be virtually
212 anything. This is defined in following manner:
214 Server type List type Contents
215 ====================================================
216 server local list User's information
217 router local list NULL
218 router global list NULL
220 Router doesn't hold this information since it is not vital data
221 for the router. If this information is needed by the client it is
222 fetched when it is needed.
226 ID of the client. This includes all the information SILC will ever
227 need. Notice that no nickname of the user is saved anywhere. This is
228 beacuse of SilcClientID includes 88 bit hash value of the user's
229 nickname which can be used to track down specific user by their
230 nickname. Nickname is not relevant information that would need to be
235 Client's mode. Client maybe for example server operator or
236 router operator (SILC operator).
240 Time of last time client executed command. We are strict and will
241 not allow any command to be exeucted more than once in about
242 2 seconds. This is result of normal time().
246 Counter to check command bursts. By default, up to 5 commands
247 are allowed before limiting the execution. See command flags
250 SilcServerEntry router
252 This is a pointer to the server list. This is the router server whose
253 cell this client is coming from. This is used to route messages to
258 List of channels this client has joined.
262 A pointer, usually, to the socket list for fast referencing to
263 the data used in connection with this client. This may be anything
264 but as just said, this is usually pointer to the socket connection
268 struct SilcClientEntryStruct {
269 /* Generic data structure. DO NOT add anything before this! */
270 SilcIDListDataStruct data;
272 unsigned char *nickname;
281 /* Pointer to the router */
282 SilcServerEntry router;
284 /* List of channels client has joined to */
287 /* Connection data */
292 SILC Channel entry object.
294 This entry holds information about channels in SILC network. The contents
295 of this entry is depended on whether we are normal server or router server
296 and whether the list is a local or global list.
298 This entry is defined as follows:
300 Server type List type Contents
301 =======================================================================
302 server local list All channels in server
303 server global list NULL
304 router local list All channels in cell
305 router global list All channels in SILC
307 Following short description of the fields:
311 Logical name of the channel.
315 Current mode of the channel. See lib/silccore/silcchannel.h for
320 ID of the channel. This includes all the information SILC will ever
325 Boolean value to tell whether there are users outside this server
326 on this channel. This is set to TRUE if router sends message to
327 the server that there are users outside your server on your
328 channel as well. This way server knows that messages needs to be
329 sent to the router for further routing. If this is a normal
330 server and this channel is not created on this server this field
331 is always TRUE. If this server is a router this field is ignored.
335 Current topic of the channel.
339 Default cipher of the channel. If this is NULL then server picks
340 the cipher to be used. This can be set at SILC_COMMAND_JOIN.
342 SilcServerEntry router
344 This is a pointer to the server list. This is the router server
345 whose cell this channel belongs to. This is used to route messages
348 SilcCipher channel_key
350 The key of the channel (the cipher actually).
355 Raw key data of the channel key.
357 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]
359 Current initial vector. Initial vector is received always along
360 with the channel packet. By default this is filled with NULL.
367 struct SilcChannelEntryStruct {
375 /* Data that is related to different channel modes. */
377 unsigned int user_limit;
378 unsigned char *passphrase;
379 unsigned char *ban_list;
380 unsigned char *invite_list;
381 unsigned char *cipher;
382 unsigned int key_len;
385 /* List of users on channel */
388 /* Pointer to the router */
389 SilcServerEntry router;
392 SilcCipher channel_key;
394 unsigned int key_len;
395 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE];
402 As for remainder these lists are defined as follows:
404 Entry list (cache) Server type List type Contents
405 =======================================================================
406 servers server local list Server itself
407 servers server global list NULL
408 servers router local list All servers in cell
409 servers router global list All servers in SILC
411 clients server local list All clients in server
412 clients server global list NULL
413 clients router local list All clients in cell
414 clients router global list All clients in SILC
416 channels server local list All channels in server
417 channels server global list NULL
418 channels router local list All channels in cell
419 channels router global list All channels in SILC
421 As seen on the list normal server never defines a global list. This is
422 because of normal server don't know anything about anything global data,
423 they get it from the router if and when they need it. Routers, on the
424 other hand, always define local and global lists because routers really
425 know all the relevant data in the SILC network.
427 This object is used as local and global list by the server/router.
428 Above table shows how this is defined on different conditions.
430 This object holds pointers to the ID cache system. Every ID cache entry
431 has a specific context pointer to allocated entry (server, client or
435 typedef struct SilcIDListStruct {
438 SilcIDCache channels;
442 ID Entry for Unknown connections.
444 This is used during authentication phases where we still don't know
445 what kind of connection remote connection is, hence, we will use this
446 structure instead until we know what type of connection remote end is.
448 This is not in any list. This is always individually allocated and
453 /* Generic data structure. DO NOT add anything before this! */
454 SilcIDListDataStruct data;
458 void silc_idlist_add_data(void *entry, SilcIDListData idata);
459 void silc_idlist_del_data(void *entry);
461 silc_idlist_add_server(SilcIDList id_list,
462 char *server_name, int server_type,
463 SilcServerID *id, SilcServerEntry router,
466 silc_idlist_find_server_by_id(SilcIDList id_list, SilcServerID *id,
467 SilcIDCacheEntry *ret_entry);
469 silc_idlist_find_server_by_name(SilcIDList id_list, char *name,
470 SilcIDCacheEntry *ret_entry);
472 silc_idlist_find_server_by_conn(SilcIDList id_list, char *hostname,
473 int port, SilcIDCacheEntry *ret_entry);
475 silc_idlist_replace_server_id(SilcIDList id_list, SilcServerID *old_id,
476 SilcServerID *new_id);
477 void silc_idlist_del_server(SilcIDList id_list, SilcServerEntry entry);
479 silc_idlist_add_client(SilcIDList id_list, unsigned char *nickname,
480 char *username, char *userinfo, SilcClientID *id,
481 SilcServerEntry router, void *connection);
482 int silc_idlist_del_client(SilcIDList id_list, SilcClientEntry entry);
484 silc_idlist_get_clients_by_nickname(SilcIDList id_list, char *nickname,
485 char *server, unsigned int *clients_count);
487 silc_idlist_get_clients_by_hash(SilcIDList id_list, char *nickname,
489 unsigned int *clients_count);
491 silc_idlist_find_client_by_nickname(SilcIDList id_list, char *nickname,
493 SilcIDCacheEntry *ret_entry);
495 silc_idlist_find_client_by_hash(SilcIDList id_list, char *nickname,
496 SilcHash md5hash, SilcIDCacheEntry *ret_entry);
498 silc_idlist_find_client_by_id(SilcIDList id_list, SilcClientID *id,
499 SilcIDCacheEntry *ret_entry);
501 silc_idlist_replace_client_id(SilcIDList id_list, SilcClientID *old_id,
502 SilcClientID *new_id);
503 void silc_idlist_client_destructor(SilcIDCache cache,
504 SilcIDCacheEntry entry);
506 silc_idlist_add_channel(SilcIDList id_list, char *channel_name, int mode,
507 SilcChannelID *id, SilcServerEntry router,
508 SilcCipher channel_key, SilcHmac hmac);
509 int silc_idlist_del_channel(SilcIDList id_list, SilcChannelEntry entry);
511 silc_idlist_find_channel_by_name(SilcIDList id_list, char *name,
512 SilcIDCacheEntry *ret_entry);
514 silc_idlist_find_channel_by_id(SilcIDList id_list, SilcChannelID *id,
515 SilcIDCacheEntry *ret_entry);
517 silc_idlist_replace_channel_id(SilcIDList id_list, SilcChannelID *old_id,
518 SilcChannelID *new_id);