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().
244 SilcServerEntry router
246 This is a pointer to the server list. This is the router server whose
247 cell this client is coming from. This is used to route messages to
252 List of channels this client has joined.
256 A pointer, usually, to the socket list for fast referencing to
257 the data used in connection with this client. This may be anything
258 but as just said, this is usually pointer to the socket connection
262 struct SilcClientEntryStruct {
263 /* Generic data structure. DO NOT add anything before this! */
264 SilcIDListDataStruct data;
266 unsigned char *nickname;
274 /* Pointer to the router */
275 SilcServerEntry router;
277 /* List of channels client has joined to */
280 /* Connection data */
285 SILC Channel entry object.
287 This entry holds information about channels in SILC network. The contents
288 of this entry is depended on whether we are normal server or router server
289 and whether the list is a local or global list.
291 This entry is defined as follows:
293 Server type List type Contents
294 =======================================================================
295 server local list All channels in server
296 server global list NULL
297 router local list All channels in cell
298 router global list All channels in SILC
300 Following short description of the fields:
304 Logical name of the channel.
308 Current mode of the channel. See lib/silccore/silcchannel.h for
313 ID of the channel. This includes all the information SILC will ever
318 Boolean value to tell whether there are users outside this server
319 on this channel. This is set to TRUE if router sends message to
320 the server that there are users outside your server on your
321 channel as well. This way server knows that messages needs to be
322 sent to the router for further routing. If this is a normal
323 server and this channel is not created on this server this field
324 is always TRUE. If this server is a router this field is ignored.
328 Current topic of the channel.
332 Default cipher of the channel. If this is NULL then server picks
333 the cipher to be used. This can be set at SILC_COMMAND_JOIN.
335 SilcServerEntry router
337 This is a pointer to the server list. This is the router server
338 whose cell this channel belongs to. This is used to route messages
341 SilcCipher channel_key
343 The key of the channel (the cipher actually).
348 Raw key data of the channel key.
350 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]
352 Current initial vector. Initial vector is received always along
353 with the channel packet. By default this is filled with NULL.
360 struct SilcChannelEntryStruct {
368 /* Data that is related to different channel modes. */
370 unsigned int user_limit;
371 unsigned char *passphrase;
372 unsigned char *ban_list;
373 unsigned char *invite_list;
374 unsigned char *cipher;
375 unsigned int key_len;
378 /* List of users on channel */
381 /* Pointer to the router */
382 SilcServerEntry router;
385 SilcCipher channel_key;
387 unsigned int key_len;
388 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE];
395 As for remainder these lists are defined as follows:
397 Entry list (cache) Server type List type Contents
398 =======================================================================
399 servers server local list Server itself
400 servers server global list NULL
401 servers router local list All servers in cell
402 servers router global list All servers in SILC
404 clients server local list All clients in server
405 clients server global list NULL
406 clients router local list All clients in cell
407 clients router global list All clients in SILC
409 channels server local list All channels in server
410 channels server global list NULL
411 channels router local list All channels in cell
412 channels router global list All channels in SILC
414 As seen on the list normal server never defines a global list. This is
415 because of normal server don't know anything about anything global data,
416 they get it from the router if and when they need it. Routers, on the
417 other hand, always define local and global lists because routers really
418 know all the relevant data in the SILC network.
420 This object is used as local and global list by the server/router.
421 Above table shows how this is defined on different conditions.
423 This object holds pointers to the ID cache system. Every ID cache entry
424 has a specific context pointer to allocated entry (server, client or
428 typedef struct SilcIDListStruct {
431 SilcIDCache channels;
435 ID Entry for Unknown connections.
437 This is used during authentication phases where we still don't know
438 what kind of connection remote connection is, hence, we will use this
439 structure instead until we know what type of connection remote end is.
441 This is not in any list. This is always individually allocated and
446 /* Generic data structure. DO NOT add anything before this! */
447 SilcIDListDataStruct data;
451 void silc_idlist_add_data(void *entry, SilcIDListData idata);
452 void silc_idlist_del_data(void *entry);
454 silc_idlist_add_server(SilcIDList id_list,
455 char *server_name, int server_type,
456 SilcServerID *id, SilcServerEntry router,
459 silc_idlist_find_server_by_id(SilcIDList id_list, SilcServerID *id,
460 SilcIDCacheEntry *ret_entry);
462 silc_idlist_find_server_by_name(SilcIDList id_list, char *name,
463 SilcIDCacheEntry *ret_entry);
465 silc_idlist_find_server_by_conn(SilcIDList id_list, char *hostname,
466 int port, SilcIDCacheEntry *ret_entry);
468 silc_idlist_replace_server_id(SilcIDList id_list, SilcServerID *old_id,
469 SilcServerID *new_id);
470 void silc_idlist_del_server(SilcIDList id_list, SilcServerEntry entry);
472 silc_idlist_add_client(SilcIDList id_list, unsigned char *nickname,
473 char *username, char *userinfo, SilcClientID *id,
474 SilcServerEntry router, void *connection);
475 int silc_idlist_del_client(SilcIDList id_list, SilcClientEntry entry);
477 silc_idlist_get_clients_by_nickname(SilcIDList id_list, char *nickname,
478 char *server, unsigned int *clients_count);
480 silc_idlist_get_clients_by_hash(SilcIDList id_list, char *nickname,
482 unsigned int *clients_count);
484 silc_idlist_find_client_by_nickname(SilcIDList id_list, char *nickname,
486 SilcIDCacheEntry *ret_entry);
488 silc_idlist_find_client_by_hash(SilcIDList id_list, char *nickname,
489 SilcHash md5hash, SilcIDCacheEntry *ret_entry);
491 silc_idlist_find_client_by_id(SilcIDList id_list, SilcClientID *id,
492 SilcIDCacheEntry *ret_entry);
494 silc_idlist_replace_client_id(SilcIDList id_list, SilcClientID *old_id,
495 SilcClientID *new_id);
496 void silc_idlist_client_destructor(SilcIDCache cache,
497 SilcIDCacheEntry entry);
499 silc_idlist_add_channel(SilcIDList id_list, char *channel_name, int mode,
500 SilcChannelID *id, SilcServerEntry router,
501 SilcCipher channel_key, SilcHmac hmac);
502 int silc_idlist_del_channel(SilcIDList id_list, SilcChannelEntry entry);
504 silc_idlist_find_channel_by_name(SilcIDList id_list, char *name,
505 SilcIDCacheEntry *ret_entry);
507 silc_idlist_find_channel_by_id(SilcIDList id_list, SilcChannelID *id,
508 SilcIDCacheEntry *ret_entry);
510 silc_idlist_replace_channel_id(SilcIDList id_list, SilcChannelID *old_id,
511 SilcChannelID *new_id);