/* idlist.h Author: Pekka Riikonen Copyright (C) 1997 - 2000 Pekka Riikonen This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. */ #ifndef IDLIST_H #define IDLIST_H /* Forward declarations */ typedef struct SilcServerListStruct SilcServerList; typedef struct SilcClientListStruct SilcClientList; typedef struct SilcChannelListStruct SilcChannelList; /* SILC Server list object. This list holds information about servers in SILC network. However, contents of this list is highly dependent of what kind of server we are (normal server or router server) and whether the list is used as a local list or a global list. These factors dictates the contents of this list. This list is defined as follows: Server type List type Contents ======================================================================= server local list Server itself server global list NULL router local list All servers is the cell router global list All servers in the SILC network Following short description of the fields: char *server_name Logical name of the server. There is no limit of the length of the server name. This is usually the same name as defined in DNS. int server_type Type of the server. SILC_SERVER or SILC_ROUTER are the possible choices for this. SilcServerID *id ID of the server. This includes all the relevant information about the server SILC will ever need. These are also the informations that is broadcasted between servers and routers in the SILC network. struct SilcServerListStruct *router This is a pointer back to the server list. This is the router server where this server is connected to. If this is the router itself and it doesn't have a route this is NULL. SilcCipher send_key SilcCipher receive_key void *connection A pointer, usually, to the socket list for fast referencing to the data used in connection with this server. This may be anything but as just said, this is usually pointer to the socket connection list. */ struct SilcServerListStruct { char *server_name; int server_type; SilcServerID *id; /* Pointer to the router */ struct SilcServerListStruct *router; /* Keys */ SilcCipher send_key; SilcCipher receive_key; SilcPKCS public_key; SilcHmac hmac; unsigned char *hmac_key; unsigned int hmac_key_len; /* Connection data */ void *connection; struct SilcServerListStruct *next; struct SilcServerListStruct *prev; }; /* SILC Client list object. This list holds information about connected clients ie. users in the SILC network. The contents of this list is depended on whether we are normal server or router server and whether the list is a local or global list. This list is defined as follows: Server type List type Contents ======================================================================= server local list All clients in server server global list NULL router local list All clients in cell router global list All clients in SILC Following short description of the fields: char username Client's (meaning user's) real name. This is defined in following manner: Server type List type Contents ==================================================== server local list User's name router local list NULL router global list NULL Router doesn't hold this information since it is not vital data for the router. If this information is needed by the client it is fetched when it is needed. char userinfo Information about user. This is free information and can be virtually anything. This is defined in following manner: Server type List type Contents ==================================================== server local list User's information router local list NULL router global list NULL Router doesn't hold this information since it is not vital data for the router. If this information is needed by the client it is fetched when it is needed. SilcClientID *id ID of the client. This includes all the information SILC will ever need. Notice that no nickname of the user is saved anywhere. This is beacuse of SilcClientID includes 88 bit hash value of the user's nickname which can be used to track down specific user by their nickname. Nickname is not relevant information that would need to be saved as plain. int mode Client's mode. Client maybe for example server operator or router operator (SILC operator). SilcServerList *router This is a pointer to the server list. This is the router server whose cell this client is coming from. This is used to route messages to this client. SilcCipher session_key The actual session key established by key exchange protcol between connecting parties. This is used for both encryption and decryption. SilcPKCS public_key Public key of the client. This maybe NULL. SilcHmac hmac unsigned char *hmac_key unsigned int hmac_key_len MAC key used to compute MAC's for packets. void *connection A pointer, usually, to the socket list for fast referencing to the data used in connection with this client. This may be anything but as just said, this is usually pointer to the socket connection list. */ struct SilcClientListStruct { char *nickname; char *username; char *userinfo; SilcClientID *id; int mode; /* Pointer to the router */ SilcServerList *router; /* Pointers to channels this client has joined */ SilcChannelList **channel; unsigned int channel_count; /* Keys */ SilcCipher send_key; SilcCipher receive_key; SilcPKCS public_key; SilcHmac hmac; unsigned char *hmac_key; unsigned int hmac_key_len; /* Connection data */ void *connection; struct SilcClientListStruct *next; struct SilcClientListStruct *prev; }; /* SILC Channel Client list structure. This list used only by the SilcChannelList object and it holds information about current clients (ie. users) on channel. Following short description of the fields: SilcClientList client Pointer to the client list. This is the client currently on channel. int mode Client's current mode on the channel. */ typedef struct SilcChannelClientListStruct { SilcClientList *client; int mode; } SilcChannelClientList; /* SILC Channel list object. This list holds information about channels in SILC network. The contents of this list is depended on whether we are normal server or router server and whether the list is a local or global list. This list is defined as follows: Server type List type Contents ======================================================================= server local list All channels in server server global list NULL router local list All channels in cell router global list All channels in SILC Following short description of the fields: char *channel_name Logical name of the channel. int mode Current mode of the channel. SilcChannelID *id ID of the channel. This includes all the information SILC will ever need. int global_users Boolean value to tell whether there are users outside this server on this channel. This is set to TRUE if router sends message to the server that there are users outside your server on your channel as well. This way server knows that messages needs to be sent to the router for further routing. If this is a normal server and this channel is not created on this server this field is always TRUE. If this server is a router this field is ignored. char *topic Current topic of the channel. SilcServerList *router This is a pointer to the server list. This is the router server whose cell this channel belongs to. This is used to route messages to this channel. SilcCipher send_key SilcCipher receive_key */ struct SilcChannelListStruct { char *channel_name; int mode; SilcChannelID *id; int global_users; char *topic; /* List of users on channel */ SilcChannelClientList *user_list; unsigned int user_list_count; /* Pointer to the router */ SilcServerList *router; /* Channel keys */ SilcCipher channel_key; unsigned char *key; unsigned int key_len; unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]; struct SilcChannelListStruct *next; struct SilcChannelListStruct *prev; }; /* SILC ID List object. As for remainder these lists are defined as follows: List Server type List type Contents ======================================================================= servers server local list Server itself servers server global list NULL servers router local list All servers in cell servers router global list All servers in SILC clients server local list All clients in server clients server global list NULL clients router local list All clients in cell clients router global list All clients in SILC channels server local list All channels in server channels server global list NULL channels router local list All channels in cell channels router global list All channels in SILC As seen on the list normal server never defines a global list. This is because of normal server don't know anything about anything global data, they get it from the router if and when they need it. Routers, on the other hand, always define local and global lists because routers really know all the relevant data in the SILC network. */ typedef struct SilcIDListStruct { SilcServerList *servers; SilcClientList *clients; SilcChannelList *channels; /* ID Caches. Caches are used to perform fast search on the ID's. */ SilcIDCache *server_cache[96]; unsigned int server_cache_count[96]; SilcIDCache *client_cache[96]; unsigned int client_cache_count[96]; SilcIDCache *channel_cache[96]; unsigned int channel_cache_count[96]; } SilcIDListObject; typedef SilcIDListObject *SilcIDList; /* Temporary ID List object. This is used during authentication phases where we still don't know what kind of connection remote connection is, hence, we will use this structure instead until we know what type of connection remote end is. This is not in any list. This is always individually allocated and used as such. */ typedef struct { SilcCipher send_key; SilcCipher receive_key; SilcPKCS pkcs; SilcHmac hmac; unsigned char *hmac_key; unsigned int hmac_key_len; /* SilcComp comp */ } SilcIDListUnknown; /* Prototypes */ void silc_idlist_add_server(SilcServerList **list, char *server_name, int server_type, SilcServerID *id, SilcServerList *router, SilcCipher send_key, SilcCipher receive_key, SilcPKCS public_key, SilcHmac hmac, SilcServerList **new_idlist); void silc_idlist_add_client(SilcClientList **list, char *nickname, char *username, char *userinfo, SilcClientID *id, SilcServerList *router, SilcCipher send_key, SilcCipher receive_key, SilcPKCS public_key, SilcHmac hmac, SilcClientList **new_idlist); void silc_idlist_del_client(SilcClientList **list, SilcClientList *entry); SilcClientList * silc_idlist_find_client_by_nickname(SilcClientList *list, char *nickname, char *server); SilcClientList * silc_idlist_find_client_by_hash(SilcClientList *list, char *nickname, SilcHash hash); SilcClientList * silc_idlist_find_client_by_id(SilcClientList *list, SilcClientID *id); void silc_idlist_add_channel(SilcChannelList **list, char *channel_name, int mode, SilcChannelID *id, SilcServerList *router, SilcCipher channel_key, SilcChannelList **new_idlist); SilcChannelList * silc_idlist_find_channel_by_id(SilcChannelList *list, SilcChannelID *id); void silc_idlist_del_channel(SilcChannelList **list, SilcChannelList *entry); #endif