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.
64 SilcServerEntry router
66 This is a pointer back to the server list. This is the router server
67 where this server is connected to. If this is the router itself and
68 it doesn't have a route this is NULL.
72 SilcCipher receive_key
76 A pointer, usually, to the socket list for fast referencing to
77 the data used in connection with this server. This may be anything
78 but as just said, this is usually pointer to the socket connection
82 struct SilcServerEntryStruct {
87 /* TRUE when server is registered to server */
90 /* Pointer to the router */
91 SilcServerEntry router;
95 SilcCipher receive_key;
97 SilcPublicKey public_key;
99 unsigned char *hmac_key;
100 unsigned int hmac_key_len;
102 /* Connection data */
107 SILC Client entry object.
109 This entry holds information about connected clients ie. users in the SILC
110 network. The contents of this entrt is depended on whether we are normal
111 server or router server and whether the list is a local or global list.
113 This entry is defined as follows:
115 Server type List type Contents
116 =======================================================================
117 server local list All clients in server
118 server global list NULL
119 router local list All clients in cell
120 router global list All clients in SILC
122 Following short description of the fields:
126 Client's (meaning user's) real name. This is defined in following
129 Server type List type Contents
130 ====================================================
131 server local list User's name
132 router local list NULL
133 router global list NULL
135 Router doesn't hold this information since it is not vital data
136 for the router. If this information is needed by the client it is
137 fetched when it is needed.
141 Information about user. This is free information and can be virtually
142 anything. This is defined in following manner:
144 Server type List type Contents
145 ====================================================
146 server local list User's information
147 router local list NULL
148 router global list NULL
150 Router doesn't hold this information since it is not vital data
151 for the router. If this information is needed by the client it is
152 fetched when it is needed.
156 ID of the client. This includes all the information SILC will ever
157 need. Notice that no nickname of the user is saved anywhere. This is
158 beacuse of SilcClientID includes 88 bit hash value of the user's
159 nickname which can be used to track down specific user by their
160 nickname. Nickname is not relevant information that would need to be
165 Client's mode. Client maybe for example server operator or
166 router operator (SILC operator).
168 SilcServerEntry router
170 This is a pointer to the server list. This is the router server whose
171 cell this client is coming from. This is used to route messages to
174 SilcCipher session_key
176 The actual session key established by key exchange protcol between
177 connecting parties. This is used for both encryption and decryption.
181 PKCS of the client. This maybe NULL.
184 unsigned char *hmac_key
185 unsigned int hmac_key_len
187 MAC key used to compute MAC's for packets.
191 A pointer, usually, to the socket list for fast referencing to
192 the data used in connection with this client. This may be anything
193 but as just said, this is usually pointer to the socket connection
197 struct SilcClientEntryStruct {
204 /* TRUE when client is registered to server */
207 /* Pointer to the router */
208 SilcServerEntry router;
210 /* Pointers to channels this client has joined */
211 SilcChannelEntry *channel;
212 unsigned int channel_count;
216 SilcCipher receive_key;
219 SilcPublicKey public_key;
220 unsigned char *hmac_key;
221 unsigned int hmac_key_len;
223 /* Connection data */
228 SILC Channel Client entry structure.
230 This entry used only by the SilcChannelEntry object and it holds
231 information about current clients (ie. users) on channel. Following
232 short description of the fields:
234 SilcClientEntry client
236 Pointer to the client list. This is the client currently on channel.
240 Client's current mode on the channel.
243 typedef struct SilcChannelClientEntryStruct {
244 SilcClientEntry client;
246 } *SilcChannelClientEntry;
249 SILC Channel entry object.
251 This entry holds information about channels in SILC network. The contents
252 of this entry is depended on whether we are normal server or router server
253 and whether the list is a local or global list.
255 This entry is defined as follows:
257 Server type List type Contents
258 =======================================================================
259 server local list All channels in server
260 server global list NULL
261 router local list All channels in cell
262 router global list All channels in SILC
264 Following short description of the fields:
268 Logical name of the channel.
272 Current mode of the channel.
276 ID of the channel. This includes all the information SILC will ever
281 Boolean value to tell whether there are users outside this server
282 on this channel. This is set to TRUE if router sends message to
283 the server that there are users outside your server on your
284 channel as well. This way server knows that messages needs to be
285 sent to the router for further routing. If this is a normal
286 server and this channel is not created on this server this field
287 is always TRUE. If this server is a router this field is ignored.
291 Current topic of the channel.
293 SilcServerEntry router
295 This is a pointer to the server list. This is the router server
296 whose cell this channel belongs to. This is used to route messages
299 SilcCipher channel_key
301 The key of the channel (the cipher actually).
306 Raw key data of the channel key.
308 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]
310 Current initial vector. Initial vector is received always along
311 with the channel packet. By default this is filled with NULL.
314 struct SilcChannelEntryStruct {
321 /* List of users on channel */
322 SilcChannelClientEntry user_list;
323 unsigned int user_list_count;
325 /* Pointer to the router */
326 SilcServerEntry router;
329 SilcCipher channel_key;
331 unsigned int key_len;
332 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE];
338 As for remainder these lists are defined as follows:
340 Entry list (cache) Server type List type Contents
341 =======================================================================
342 servers server local list Server itself
343 servers server global list NULL
344 servers router local list All servers in cell
345 servers router global list All servers in SILC
347 clients server local list All clients in server
348 clients server global list NULL
349 clients router local list All clients in cell
350 clients router global list All clients in SILC
352 channels server local list All channels in server
353 channels server global list NULL
354 channels router local list All channels in cell
355 channels router global list All channels in SILC
357 As seen on the list normal server never defines a global list. This is
358 because of normal server don't know anything about anything global data,
359 they get it from the router if and when they need it. Routers, on the
360 other hand, always define local and global lists because routers really
361 know all the relevant data in the SILC network.
363 This object is used as local and global list by the server/router.
364 Above table shows how this is defined on different conditions.
366 This object holds pointers to the ID cache system. Every ID cache entry
367 has a specific context pointer to allocated entry (server, client or
371 typedef struct SilcIDListStruct {
374 SilcIDCache channels;
378 Temporary ID Entry object.
380 This is used during authentication phases where we still don't know
381 what kind of connection remote connection is, hence, we will use this
382 structure instead until we know what type of connection remote end is.
384 This is not in any list. This is always individually allocated and
390 SilcCipher receive_key;
392 SilcPublicKey public_key;
395 unsigned char *hmac_key;
396 unsigned int hmac_key_len;
403 silc_idlist_add_server(SilcIDList id_list,
404 char *server_name, int server_type,
405 SilcServerID *id, SilcServerEntry router,
406 SilcCipher send_key, SilcCipher receive_key,
407 SilcPKCS pkcs, SilcHmac hmac,
408 SilcPublicKey public_key, void *connection);
410 silc_idlist_add_client(SilcIDList id_list, char *nickname, char *username,
411 char *userinfo, SilcClientID *id,
412 SilcServerEntry router,
413 SilcCipher send_key, SilcCipher receive_key,
414 SilcPKCS pkcs, SilcHmac hmac,
415 SilcPublicKey public_key, void *connection);
416 void silc_idlist_del_client(SilcIDList id_list, SilcClientEntry entry);
418 silc_idlist_find_client_by_nickname(SilcIDList id_list, char *nickname,
421 silc_idlist_find_client_by_hash(SilcIDList id_list, unsigned char *hash,
424 silc_idlist_find_client_by_id(SilcIDList id_list, SilcClientID *id);
426 silc_idlist_add_channel(SilcIDList id_list, char *channel_name, int mode,
427 SilcChannelID *id, SilcServerEntry router,
428 SilcCipher channel_key);
429 void silc_idlist_del_channel(SilcIDList id_list, SilcChannelEntry entry);
431 silc_idlist_find_channel_by_name(SilcIDList id_list, char *name);
433 silc_idlist_find_channel_by_id(SilcIDList id_list, SilcChannelID *id);