5 Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
7 Copyright (C) 1997 - 2000 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 unsigned short cmd_ident; /* Current command identifier, 0 not used */
57 long last_receive; /* Time last received data */
58 long last_sent; /* Time last sent data */
59 unsigned char registered; /* Boolean whether connection is registered */
60 } *SilcIDListData, SilcIDListDataStruct;
63 SILC Server entry object.
65 This entry holds information about servers in SILC network. However,
66 contents of this entry is highly dependent of what kind of server we are
67 (normal server or router server) and whether the entry is used as a local
68 list or a global list. These factors dictates the contents of this entry.
70 This entry is defined as follows:
72 Server type List type Contents
73 =======================================================================
74 server local list Server itself
75 server global list NULL
76 router local list All servers is the cell
77 router global list All servers in the SILC network
79 Following short description of the fields:
81 SilcIDListDataStruct data
83 Generic data structure to hold data common to all ID entries.
87 Logical name of the server. There is no limit of the length of the
88 server name. This is usually the same name as defined in DNS.
92 Type of the server. SILC_SERVER or SILC_ROUTER are the possible
97 ID of the server. This includes all the relevant information about
98 the server SILC will ever need. These are also the informations
99 that is broadcasted between servers and routers in the SILC network.
101 SilcServerEntry router
103 This is a pointer back to the server list. This is the router server
104 where this server is connected to. If this is the router itself and
105 it doesn't have a route this is NULL.
108 SilcCipher receive_key
110 Data sending and receiving keys.
114 A pointer, usually, to the socket list for fast referencing to
115 the data used in connection with this server. This may be anything
116 but as just said, this is usually pointer to the socket connection
120 struct SilcServerEntryStruct {
121 /* Generic data structure. DO NOT add anything before this! */
122 SilcIDListDataStruct data;
128 /* Pointer to the router */
129 SilcServerEntry router;
131 /* Connection data */
136 SILC Channel Client entry structure.
138 This entry used only by the SilcChannelEntry object and it holds
139 information about current clients (ie. users) on channel. Following
140 short description of the fields:
142 SilcClientEntry client
144 Pointer to the client list. This is the client currently on channel.
148 Client's current mode on the channel.
150 SilcChannelEntry channel
152 Back pointer back to channel. As this structure is also used by
153 SilcClientEntry we have this here for fast access to the channel when
154 used by SilcClientEntry.
156 struct SilcChannelClientEntryStruct *client_list
157 struct SilcChannelClientEntryStruct *channel_list
159 List member pointers. This structure is used by channel entry and
160 client entry thus we must have separate list member pointers for
161 them since we are using same entry for both lists (the entry is not
162 duplicated). SilcList requires this.
165 typedef struct SilcChannelClientEntryStruct {
166 SilcClientEntry client;
168 SilcChannelEntry channel;
169 struct SilcChannelClientEntryStruct *client_list;
170 struct SilcChannelClientEntryStruct *channel_list;
171 } *SilcChannelClientEntry;
174 SILC Client entry object.
176 This entry holds information about connected clients ie. users in the SILC
177 network. The contents of this entrt is depended on whether we are normal
178 server or router server and whether the list is a local or global list.
180 This entry is defined as follows:
182 Server type List type Contents
183 =======================================================================
184 server local list All clients in server
185 server global list NULL
186 router local list All clients in cell
187 router global list All clients in SILC
189 Following short description of the fields:
191 SilcIDListDataStruct data
193 Generic data structure to hold data common to all ID entries.
197 Client's (meaning user's) real name. This is defined in following
200 Server type List type Contents
201 ====================================================
202 server local list User's name
203 router local list NULL
204 router global list NULL
206 Router doesn't hold this information since it is not vital data
207 for the router. If this information is needed by the client it is
208 fetched when it is needed.
212 Information about user. This is free information and can be virtually
213 anything. This is defined in following manner:
215 Server type List type Contents
216 ====================================================
217 server local list User's information
218 router local list NULL
219 router global list NULL
221 Router doesn't hold this information since it is not vital data
222 for the router. If this information is needed by the client it is
223 fetched when it is needed.
227 ID of the client. This includes all the information SILC will ever
228 need. Notice that no nickname of the user is saved anywhere. This is
229 beacuse of SilcClientID includes 88 bit hash value of the user's
230 nickname which can be used to track down specific user by their
231 nickname. Nickname is not relevant information that would need to be
236 Client's mode. Client maybe for example server operator or
237 router operator (SILC operator).
241 Time of last time client executed command. We are strict and will
242 not allow any command to be exeucted more than once in about
243 2 seconds. This is result of normal time().
245 SilcServerEntry router
247 This is a pointer to the server list. This is the router server whose
248 cell this client is coming from. This is used to route messages to
251 SilcCipher session_key
253 The actual session key established by key exchange protcol between
254 connecting parties. This is used for both encryption and decryption.
258 PKCS of the client. This maybe NULL.
262 MAC key used to compute MAC's for packets.
266 A pointer, usually, to the socket list for fast referencing to
267 the data used in connection with this client. This may be anything
268 but as just said, this is usually pointer to the socket connection
272 struct SilcClientEntryStruct {
273 /* Generic data structure. DO NOT add anything before this! */
274 SilcIDListDataStruct data;
284 /* Pointer to the router */
285 SilcServerEntry router;
287 /* List of channels client has joined to */
290 /* Connection data */
295 SILC Channel entry object.
297 This entry holds information about channels in SILC network. The contents
298 of this entry is depended on whether we are normal server or router server
299 and whether the list is a local or global list.
301 This entry is defined as follows:
303 Server type List type Contents
304 =======================================================================
305 server local list All channels in server
306 server global list NULL
307 router local list All channels in cell
308 router global list All channels in SILC
310 Following short description of the fields:
314 Logical name of the channel.
318 Current mode of the channel. See lib/silccore/silcchannel.h for
323 ID of the channel. This includes all the information SILC will ever
328 Boolean value to tell whether there are users outside this server
329 on this channel. This is set to TRUE if router sends message to
330 the server that there are users outside your server on your
331 channel as well. This way server knows that messages needs to be
332 sent to the router for further routing. If this is a normal
333 server and this channel is not created on this server this field
334 is always TRUE. If this server is a router this field is ignored.
338 Current topic of the channel.
342 Default cipher of the channel. If this is NULL then server picks
343 the cipher to be used. This can be set at SILC_COMMAND_JOIN.
345 SilcServerEntry router
347 This is a pointer to the server list. This is the router server
348 whose cell this channel belongs to. This is used to route messages
351 SilcCipher channel_key
353 The key of the channel (the cipher actually).
358 Raw key data of the channel key.
360 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]
362 Current initial vector. Initial vector is received always along
363 with the channel packet. By default this is filled with NULL.
366 struct SilcChannelEntryStruct {
374 /* Data that is related to different channel modes. */
376 unsigned int user_limit;
377 unsigned char *passphrase;
378 unsigned char *ban_list;
379 unsigned char *invite_list;
380 unsigned char *cipher;
381 unsigned int key_len;
384 /* List of users on channel */
387 /* Pointer to the router */
388 SilcServerEntry router;
391 SilcCipher channel_key;
393 unsigned int key_len;
394 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE];
400 As for remainder these lists are defined as follows:
402 Entry list (cache) Server type List type Contents
403 =======================================================================
404 servers server local list Server itself
405 servers server global list NULL
406 servers router local list All servers in cell
407 servers router global list All servers in SILC
409 clients server local list All clients in server
410 clients server global list NULL
411 clients router local list All clients in cell
412 clients router global list All clients in SILC
414 channels server local list All channels in server
415 channels server global list NULL
416 channels router local list All channels in cell
417 channels router global list All channels in SILC
419 As seen on the list normal server never defines a global list. This is
420 because of normal server don't know anything about anything global data,
421 they get it from the router if and when they need it. Routers, on the
422 other hand, always define local and global lists because routers really
423 know all the relevant data in the SILC network.
425 This object is used as local and global list by the server/router.
426 Above table shows how this is defined on different conditions.
428 This object holds pointers to the ID cache system. Every ID cache entry
429 has a specific context pointer to allocated entry (server, client or
433 typedef struct SilcIDListStruct {
436 SilcIDCache channels;
440 ID Entry for Unknown connections.
442 This is used during authentication phases where we still don't know
443 what kind of connection remote connection is, hence, we will use this
444 structure instead until we know what type of connection remote end is.
446 This is not in any list. This is always individually allocated and
451 /* Generic data structure. DO NOT add anything before this! */
452 SilcIDListDataStruct data;
456 void silc_idlist_add_data(void *entry, SilcIDListData idata);
457 void silc_idlist_del_data(void *entry);
459 silc_idlist_add_server(SilcIDList id_list,
460 char *server_name, int server_type,
461 SilcServerID *id, SilcServerEntry router,
464 silc_idlist_find_server_by_id(SilcIDList id_list, SilcServerID *id,
465 SilcIDCacheEntry *ret_entry);
467 silc_idlist_replace_server_id(SilcIDList id_list, SilcServerID *old_id,
468 SilcServerID *new_id);
470 silc_idlist_add_client(SilcIDList id_list, char *nickname, char *username,
471 char *userinfo, SilcClientID *id,
472 SilcServerEntry router, void *connection);
473 void silc_idlist_del_client(SilcIDList id_list, SilcClientEntry entry);
475 silc_idlist_get_clients_by_nickname(SilcIDList id_list, char *nickname,
476 char *server, unsigned int *clients_count);
478 silc_idlist_get_clients_by_hash(SilcIDList id_list, char *nickname,
480 unsigned int *clients_count);
482 silc_idlist_find_client_by_nickname(SilcIDList id_list, char *nickname,
484 SilcIDCacheEntry *ret_entry);
486 silc_idlist_find_client_by_hash(SilcIDList id_list, char *nickname,
487 SilcHash md5hash, SilcIDCacheEntry *ret_entry);
489 silc_idlist_find_client_by_id(SilcIDList id_list, SilcClientID *id,
490 SilcIDCacheEntry *ret_entry);
492 silc_idlist_replace_client_id(SilcIDList id_list, SilcClientID *old_id,
493 SilcClientID *new_id);
495 silc_idlist_add_channel(SilcIDList id_list, char *channel_name, int mode,
496 SilcChannelID *id, SilcServerEntry router,
497 SilcCipher channel_key);
498 void silc_idlist_del_channel(SilcIDList id_list, SilcChannelEntry entry);
500 silc_idlist_find_channel_by_name(SilcIDList id_list, char *name,
501 SilcIDCacheEntry *ret_entry);
503 silc_idlist_find_channel_by_id(SilcIDList id_list, SilcChannelID *id,
504 SilcIDCacheEntry *ret_entry);