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 SILC Server entry object.
32 This entry holds information about servers in SILC network. However,
33 contents of this entry is highly dependent of what kind of server we are
34 (normal server or router server) and whether the entry is used as a local
35 list or a global list. These factors dictates the contents of this entry.
37 This entry is defined as follows:
39 Server type List type Contents
40 =======================================================================
41 server local list Server itself
42 server global list NULL
43 router local list All servers is the cell
44 router global list All servers in the SILC network
46 Following short description of the fields:
50 Logical name of the server. There is no limit of the length of the
51 server name. This is usually the same name as defined in DNS.
55 Type of the server. SILC_SERVER or SILC_ROUTER are the possible
60 ID of the server. This includes all the relevant information about
61 the server SILC will ever need. These are also the informations
62 that is broadcasted between servers and routers in the SILC network.
66 Time when data was received from the server last time.
68 SilcServerEntry router
70 This is a pointer back to the server list. This is the router server
71 where this server is connected to. If this is the router itself and
72 it doesn't have a route this is NULL.
75 SilcCipher receive_key
77 Data sending and receiving keys.
81 A pointer, usually, to the socket list for fast referencing to
82 the data used in connection with this server. This may be anything
83 but as just said, this is usually pointer to the socket connection
87 struct SilcServerEntryStruct {
93 /* TRUE when server is registered to server */
96 /* Pointer to the router */
97 SilcServerEntry router;
101 SilcCipher receive_key;
103 SilcPublicKey public_key;
105 unsigned char *hmac_key;
106 unsigned int hmac_key_len;
108 /* Connection data */
113 SILC Client entry object.
115 This entry holds information about connected clients ie. users in the SILC
116 network. The contents of this entrt is depended on whether we are normal
117 server or router server and whether the list is a local or global list.
119 This entry is defined as follows:
121 Server type List type Contents
122 =======================================================================
123 server local list All clients in server
124 server global list NULL
125 router local list All clients in cell
126 router global list All clients in SILC
128 Following short description of the fields:
132 Client's (meaning user's) real name. This is defined in following
135 Server type List type Contents
136 ====================================================
137 server local list User's name
138 router local list NULL
139 router global list NULL
141 Router doesn't hold this information since it is not vital data
142 for the router. If this information is needed by the client it is
143 fetched when it is needed.
147 Information about user. This is free information and can be virtually
148 anything. This is defined in following manner:
150 Server type List type Contents
151 ====================================================
152 server local list User's information
153 router local list NULL
154 router global list NULL
156 Router doesn't hold this information since it is not vital data
157 for the router. If this information is needed by the client it is
158 fetched when it is needed.
162 ID of the client. This includes all the information SILC will ever
163 need. Notice that no nickname of the user is saved anywhere. This is
164 beacuse of SilcClientID includes 88 bit hash value of the user's
165 nickname which can be used to track down specific user by their
166 nickname. Nickname is not relevant information that would need to be
171 Client's mode. Client maybe for example server operator or
172 router operator (SILC operator).
176 Time of last time data was received from the client. This is
177 result of normal time().
181 Time of last time client executed command. We are strict and will
182 not allow any command to be exeucted more than once in about
183 2 seconds. This is result of normal time().
187 Boolean value to indicate whether this client has registered itself
188 to the server. After KE and authentication protocols has been
189 successfully completed will client become registered.
191 SilcServerEntry router
193 This is a pointer to the server list. This is the router server whose
194 cell this client is coming from. This is used to route messages to
197 SilcCipher session_key
199 The actual session key established by key exchange protcol between
200 connecting parties. This is used for both encryption and decryption.
204 PKCS of the client. This maybe NULL.
208 MAC key used to compute MAC's for packets.
212 A pointer, usually, to the socket list for fast referencing to
213 the data used in connection with this client. This may be anything
214 but as just said, this is usually pointer to the socket connection
218 struct SilcClientEntryStruct {
225 /* Time of last accesses of the client */
229 /* TRUE when client is registered to server */
232 /* Pointer to the router */
233 SilcServerEntry router;
235 /* List of channels client has joined to */
236 SilcChannelEntry *channel;
237 unsigned int channel_count;
241 SilcCipher receive_key;
244 SilcPublicKey public_key;
246 /* Connection data */
251 SILC Channel Client entry structure.
253 This entry used only by the SilcChannelEntry object and it holds
254 information about current clients (ie. users) on channel. Following
255 short description of the fields:
257 SilcClientEntry client
259 Pointer to the client list. This is the client currently on channel.
263 Client's current mode on the channel.
266 typedef struct SilcChannelClientEntryStruct {
267 SilcClientEntry client;
269 struct SilcChannelClientEntryStruct *next;
270 } *SilcChannelClientEntry;
273 SILC Channel entry object.
275 This entry holds information about channels in SILC network. The contents
276 of this entry is depended on whether we are normal server or router server
277 and whether the list is a local or global list.
279 This entry is defined as follows:
281 Server type List type Contents
282 =======================================================================
283 server local list All channels in server
284 server global list NULL
285 router local list All channels in cell
286 router global list All channels in SILC
288 Following short description of the fields:
292 Logical name of the channel.
296 Current mode of the channel. See lib/silccore/silcchannel.h for
301 ID of the channel. This includes all the information SILC will ever
306 Boolean value to tell whether there are users outside this server
307 on this channel. This is set to TRUE if router sends message to
308 the server that there are users outside your server on your
309 channel as well. This way server knows that messages needs to be
310 sent to the router for further routing. If this is a normal
311 server and this channel is not created on this server this field
312 is always TRUE. If this server is a router this field is ignored.
316 Current topic of the channel.
320 Default cipher of the channel. If this is NULL then server picks
321 the cipher to be used. This can be set at SILC_COMMAND_JOIN.
323 SilcServerEntry router
325 This is a pointer to the server list. This is the router server
326 whose cell this channel belongs to. This is used to route messages
329 SilcCipher channel_key
331 The key of the channel (the cipher actually).
336 Raw key data of the channel key.
338 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]
340 Current initial vector. Initial vector is received always along
341 with the channel packet. By default this is filled with NULL.
344 struct SilcChannelEntryStruct {
352 /* Data that is related to different channel modes. */
354 unsigned int user_limit;
355 unsigned char *passphrase;
356 unsigned char *ban_list;
357 unsigned char *invite_list;
358 unsigned char *cipher;
359 unsigned int key_len;
362 /* List of users on channel */
365 /* Pointer to the router */
366 SilcServerEntry router;
369 SilcCipher channel_key;
371 unsigned int key_len;
372 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE];
378 As for remainder these lists are defined as follows:
380 Entry list (cache) Server type List type Contents
381 =======================================================================
382 servers server local list Server itself
383 servers server global list NULL
384 servers router local list All servers in cell
385 servers router global list All servers in SILC
387 clients server local list All clients in server
388 clients server global list NULL
389 clients router local list All clients in cell
390 clients router global list All clients in SILC
392 channels server local list All channels in server
393 channels server global list NULL
394 channels router local list All channels in cell
395 channels router global list All channels in SILC
397 As seen on the list normal server never defines a global list. This is
398 because of normal server don't know anything about anything global data,
399 they get it from the router if and when they need it. Routers, on the
400 other hand, always define local and global lists because routers really
401 know all the relevant data in the SILC network.
403 This object is used as local and global list by the server/router.
404 Above table shows how this is defined on different conditions.
406 This object holds pointers to the ID cache system. Every ID cache entry
407 has a specific context pointer to allocated entry (server, client or
411 typedef struct SilcIDListStruct {
414 SilcIDCache channels;
418 Temporary ID Entry object.
420 This is used during authentication phases where we still don't know
421 what kind of connection remote connection is, hence, we will use this
422 structure instead until we know what type of connection remote end is.
424 This is not in any list. This is always individually allocated and
430 SilcCipher receive_key;
432 SilcPublicKey public_key;
435 unsigned char *hmac_key;
436 unsigned int hmac_key_len;
443 silc_idlist_add_server(SilcIDList id_list,
444 char *server_name, int server_type,
445 SilcServerID *id, SilcServerEntry router,
446 SilcCipher send_key, SilcCipher receive_key,
447 SilcPKCS pkcs, SilcHmac hmac,
448 SilcPublicKey public_key, void *connection);
450 silc_idlist_find_server_by_id(SilcIDList id_list, SilcServerID *id);
452 silc_idlist_replace_server_id(SilcIDList id_list, SilcServerID *old_id,
453 SilcServerID *new_id);
455 silc_idlist_add_client(SilcIDList id_list, char *nickname, char *username,
456 char *userinfo, SilcClientID *id,
457 SilcServerEntry router,
458 SilcCipher send_key, SilcCipher receive_key,
459 SilcPKCS pkcs, SilcHmac hmac,
460 SilcPublicKey public_key, void *connection);
461 void silc_idlist_del_client(SilcIDList id_list, SilcClientEntry entry);
463 silc_idlist_get_clients_by_nickname(SilcIDList id_list, char *nickname,
464 char *server, unsigned int *clients_count);
466 silc_idlist_find_client_by_nickname(SilcIDList id_list, char *nickname,
469 silc_idlist_find_client_by_hash(SilcIDList id_list, char *nickname,
472 silc_idlist_find_client_by_id(SilcIDList id_list, SilcClientID *id);
474 silc_idlist_replace_client_id(SilcIDList id_list, SilcClientID *old_id,
475 SilcClientID *new_id);
477 silc_idlist_add_channel(SilcIDList id_list, char *channel_name, int mode,
478 SilcChannelID *id, SilcServerEntry router,
479 SilcCipher channel_key);
480 void silc_idlist_del_channel(SilcIDList id_list, SilcChannelEntry entry);
482 silc_idlist_find_channel_by_name(SilcIDList id_list, char *name);
484 silc_idlist_find_channel_by_id(SilcIDList id_list, SilcChannelID *id);