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 /* Time when last received or sent data */
60 /* Boolean value whether connection is registered */
62 } *SilcIDListData, SilcIDListDataStruct;
65 SILC Server entry object.
67 This entry holds information about servers in SILC network. However,
68 contents of this entry is highly dependent of what kind of server we are
69 (normal server or router server) and whether the entry is used as a local
70 list or a global list. These factors dictates the contents of this entry.
72 This entry is defined as follows:
74 Server type List type Contents
75 =======================================================================
76 server local list Server itself
77 server global list NULL
78 router local list All servers is the cell
79 router global list All servers in the SILC network
81 Following short description of the fields:
83 SilcIDListDataStruct data
85 Generic data structure to hold data common to all ID entries.
89 Logical name of the server. There is no limit of the length of the
90 server name. This is usually the same name as defined in DNS.
94 Type of the server. SILC_SERVER or SILC_ROUTER are the possible
99 ID of the server. This includes all the relevant information about
100 the server SILC will ever need. These are also the informations
101 that is broadcasted between servers and routers in the SILC network.
103 SilcServerEntry router
105 This is a pointer back to the server list. This is the router server
106 where this server is connected to. If this is the router itself and
107 it doesn't have a route this is NULL.
110 SilcCipher receive_key
112 Data sending and receiving keys.
116 A pointer, usually, to the socket list for fast referencing to
117 the data used in connection with this server. This may be anything
118 but as just said, this is usually pointer to the socket connection
122 struct SilcServerEntryStruct {
123 /* Generic data structure. DO NOT add anything before this! */
124 SilcIDListDataStruct data;
130 /* Pointer to the router */
131 SilcServerEntry router;
133 /* Connection data */
138 SILC Channel Client entry structure.
140 This entry used only by the SilcChannelEntry object and it holds
141 information about current clients (ie. users) on channel. Following
142 short description of the fields:
144 SilcClientEntry client
146 Pointer to the client list. This is the client currently on channel.
150 Client's current mode on the channel.
152 SilcChannelEntry channel
154 Back pointer back to channel. As this structure is also used by
155 SilcClientEntry we have this here for fast access to the channel when
156 used by SilcClientEntry.
158 struct SilcChannelClientEntryStruct *client_list
159 struct SilcChannelClientEntryStruct *channel_list
161 List member pointers. This structure is used by channel entry and
162 client entry thus we must have separate list member pointers for
163 them since we are using same entry for both lists (the entry is not
164 duplicated). SilcList requires this.
167 typedef struct SilcChannelClientEntryStruct {
168 SilcClientEntry client;
170 SilcChannelEntry channel;
171 struct SilcChannelClientEntryStruct *client_list;
172 struct SilcChannelClientEntryStruct *channel_list;
173 } *SilcChannelClientEntry;
176 SILC Client entry object.
178 This entry holds information about connected clients ie. users in the SILC
179 network. The contents of this entrt is depended on whether we are normal
180 server or router server and whether the list is a local or global list.
182 This entry is defined as follows:
184 Server type List type Contents
185 =======================================================================
186 server local list All clients in server
187 server global list NULL
188 router local list All clients in cell
189 router global list All clients in SILC
191 Following short description of the fields:
193 SilcIDListDataStruct data
195 Generic data structure to hold data common to all ID entries.
199 Client's (meaning user's) real name. This is defined in following
202 Server type List type Contents
203 ====================================================
204 server local list User's name
205 router local list NULL
206 router global list NULL
208 Router doesn't hold this information since it is not vital data
209 for the router. If this information is needed by the client it is
210 fetched when it is needed.
214 Information about user. This is free information and can be virtually
215 anything. This is defined in following manner:
217 Server type List type Contents
218 ====================================================
219 server local list User's information
220 router local list NULL
221 router global list NULL
223 Router doesn't hold this information since it is not vital data
224 for the router. If this information is needed by the client it is
225 fetched when it is needed.
229 ID of the client. This includes all the information SILC will ever
230 need. Notice that no nickname of the user is saved anywhere. This is
231 beacuse of SilcClientID includes 88 bit hash value of the user's
232 nickname which can be used to track down specific user by their
233 nickname. Nickname is not relevant information that would need to be
238 Client's mode. Client maybe for example server operator or
239 router operator (SILC operator).
243 Time of last time client executed command. We are strict and will
244 not allow any command to be exeucted more than once in about
245 2 seconds. This is result of normal time().
247 SilcServerEntry router
249 This is a pointer to the server list. This is the router server whose
250 cell this client is coming from. This is used to route messages to
253 SilcCipher session_key
255 The actual session key established by key exchange protcol between
256 connecting parties. This is used for both encryption and decryption.
260 PKCS of the client. This maybe NULL.
264 MAC key used to compute MAC's for packets.
268 A pointer, usually, to the socket list for fast referencing to
269 the data used in connection with this client. This may be anything
270 but as just said, this is usually pointer to the socket connection
274 struct SilcClientEntryStruct {
275 /* Generic data structure. DO NOT add anything before this! */
276 SilcIDListDataStruct data;
286 /* Pointer to the router */
287 SilcServerEntry router;
289 /* List of channels client has joined to */
292 /* Connection data */
297 SILC Channel entry object.
299 This entry holds information about channels in SILC network. The contents
300 of this entry is depended on whether we are normal server or router server
301 and whether the list is a local or global list.
303 This entry is defined as follows:
305 Server type List type Contents
306 =======================================================================
307 server local list All channels in server
308 server global list NULL
309 router local list All channels in cell
310 router global list All channels in SILC
312 Following short description of the fields:
316 Logical name of the channel.
320 Current mode of the channel. See lib/silccore/silcchannel.h for
325 ID of the channel. This includes all the information SILC will ever
330 Boolean value to tell whether there are users outside this server
331 on this channel. This is set to TRUE if router sends message to
332 the server that there are users outside your server on your
333 channel as well. This way server knows that messages needs to be
334 sent to the router for further routing. If this is a normal
335 server and this channel is not created on this server this field
336 is always TRUE. If this server is a router this field is ignored.
340 Current topic of the channel.
344 Default cipher of the channel. If this is NULL then server picks
345 the cipher to be used. This can be set at SILC_COMMAND_JOIN.
347 SilcServerEntry router
349 This is a pointer to the server list. This is the router server
350 whose cell this channel belongs to. This is used to route messages
353 SilcCipher channel_key
355 The key of the channel (the cipher actually).
360 Raw key data of the channel key.
362 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]
364 Current initial vector. Initial vector is received always along
365 with the channel packet. By default this is filled with NULL.
368 struct SilcChannelEntryStruct {
376 /* Data that is related to different channel modes. */
378 unsigned int user_limit;
379 unsigned char *passphrase;
380 unsigned char *ban_list;
381 unsigned char *invite_list;
382 unsigned char *cipher;
383 unsigned int key_len;
386 /* List of users on channel */
389 /* Pointer to the router */
390 SilcServerEntry router;
393 SilcCipher channel_key;
395 unsigned int key_len;
396 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);
468 silc_idlist_replace_server_id(SilcIDList id_list, SilcServerID *old_id,
469 SilcServerID *new_id);
471 silc_idlist_add_client(SilcIDList id_list, char *nickname, char *username,
472 char *userinfo, SilcClientID *id,
473 SilcServerEntry router, void *connection);
474 void silc_idlist_del_client(SilcIDList id_list, SilcClientEntry entry);
476 silc_idlist_get_clients_by_nickname(SilcIDList id_list, char *nickname,
477 char *server, unsigned int *clients_count);
479 silc_idlist_find_client_by_nickname(SilcIDList id_list, char *nickname,
482 silc_idlist_find_client_by_hash(SilcIDList id_list, char *nickname,
485 silc_idlist_find_client_by_id(SilcIDList id_list, SilcClientID *id);
487 silc_idlist_replace_client_id(SilcIDList id_list, SilcClientID *old_id,
488 SilcClientID *new_id);
490 silc_idlist_add_channel(SilcIDList id_list, char *channel_name, int mode,
491 SilcChannelID *id, SilcServerEntry router,
492 SilcCipher channel_key);
493 void silc_idlist_del_channel(SilcIDList id_list, SilcChannelEntry entry);
495 silc_idlist_find_channel_by_name(SilcIDList id_list, char *name);
497 silc_idlist_find_channel_by_id(SilcIDList id_list, SilcChannelID *id);