Merged silc_1_0_branch to trunk.
[silc.git] / apps / silcd / idlist.h
index 38181263433966284758ea8db622b83a6748529f..cfb46feaddf2847f56cea06e3aba6296646dfbd1 100644 (file)
@@ -2,15 +2,15 @@
 
   idlist.h
 
-  Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
+  Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 1997 - 2001 Pekka Riikonen
+  Copyright (C) 1997 - 2003 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
@@ -30,14 +30,14 @@ typedef struct SilcChannelEntryStruct *SilcChannelEntry;
    the cache. */
 typedef struct {
   SilcIDCache cache;
-  void *timeout_queue;
+  SilcUInt32 timeout;
 } *SilcIDListPurge;
 
 /* Channel key re-key context. */
 typedef struct {
-  void *context;
   SilcChannelEntry channel;
-  uint32 key_len;
+  SilcUInt32 key_len;
+  SilcTask task;
 } *SilcServerChannelRekey;
 
 /* Generic rekey context for connections */
@@ -45,22 +45,37 @@ typedef struct {
   /* Current sending encryption key, provided for re-key. The `pfs'
      is TRUE if the Perfect Forward Secrecy is performed in re-key. */
   unsigned char *send_enc_key;
-  uint32 enc_key_len;
+  SilcUInt32 enc_key_len;
   int ske_group;
   bool pfs;
-  uint32 timeout;
+  SilcUInt32 timeout;
   void *context;
 } *SilcServerRekey;
 
+/* ID List Entry status flags. */
+typedef SilcUInt8 SilcIDListStatus;
+#define SILC_IDLIST_STATUS_NONE         0x00  /* No status */
+#define SILC_IDLIST_STATUS_REGISTERED   0x01  /* Entry is registered */
+#define SILC_IDLIST_STATUS_RESOLVED     0x02  /* Entry info is resolved */
+#define SILC_IDLIST_STATUS_RESOLVING    0x04  /* Entry is being resolved
+                                                with WHOIS or IDENTIFY */
+#define SILC_IDLIST_STATUS_DISABLED     0x08  /* Entry is disabled */
+#define SILC_IDLIST_STATUS_RESUMED      0x10  /* Entry is resumed */
+#define SILC_IDLIST_STATUS_LOCAL        0x20  /* Entry locally connected */
+#define SILC_IDLIST_STATUS_RESUME_RES   0x40  /* Entry resolved while
+                                                resuming */
+#define SILC_IDLIST_STATUS_NOATTR       0x80  /* Entry does not support
+                                                attributes in WHOIS */
+
 /*
    Generic ID list data structure.
 
    This structure is included in all ID list entries and it includes data
    pointers that are common to all ID entries.  This structure is always
    defined to the first field in the ID entries and is used to explicitly
-   cast to this type without first explicitly casting to correct ID entry
-   type.  Hence, the ID list entry is casted to this type to get this data
-   from the ID entry (which is usually opaque pointer).
+   type cast to this type without first explicitly casting to correct ID
+   entry type.  Hence, the ID list entry is type casted to this type to
+   get this data from the ID entry (which is usually opaque pointer).
 
    Note that some of the fields may be NULL.
 
@@ -70,30 +85,38 @@ typedef struct {
   SilcCipher send_key;
   SilcCipher receive_key;
 
-  /* Re-key context */
-  SilcServerRekey rekey;
-
-  /* Hash selected in the SKE protocol, NULL if not needed at all */
-  SilcHash hash;
-
   /* HMAC */
   SilcHmac hmac_send;
   SilcHmac hmac_receive;
 
+  /* Packet sequence numbers */
+  SilcUInt32 psn_send;
+  SilcUInt32 psn_receive;
+
+  /* Hash selected in the SKE protocol, NULL if not needed at all */
+  SilcHash hash;
+
   /* Public key */
   SilcPublicKey public_key;
+  unsigned char fingerprint[20];
+
+  /* Re-key context */
+  SilcServerRekey rekey;
+
+  long last_receive;           /* Time last received data */
+  long last_sent;              /* Time last sent data */
+
+  unsigned long created;       /* Time when entry was created */
 
-  long last_receive;         /* Time last received data */
-  long last_sent;           /* Time last sent data */
-  bool registered;           /* Boolean whether connection is registered */
+  SilcIDListStatus status;     /* Status mask of the entry */
 } *SilcIDListData, SilcIDListDataStruct;
 
-/* 
+/*
    SILC Server entry object.
 
-   This entry holds information about servers in SILC network. However, 
-   contents of this entry is highly dependent of what kind of server we are 
-   (normal server or router server) and whether the entry is used as a local 
+   This entry holds information about servers in SILC network. However,
+   contents of this entry is highly dependent of what kind of server we are
+   (normal server or router server) and whether the entry is used as a local
    list or a global list. These factors dictates the contents of this entry.
 
    This entry is defined as follows:
@@ -116,7 +139,7 @@ typedef struct {
        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.
 
-   uint8 server_type
+   SilcUInt8 server_type
 
        Type of the server. SILC_SERVER or SILC_ROUTER are the possible
        choices for this.
@@ -135,8 +158,8 @@ typedef struct {
 
    SilcServerEntry 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 
+       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
@@ -150,14 +173,14 @@ typedef struct {
        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 SilcServerEntryStruct {
   /* Generic data structure. DO NOT add anything before this! */
   SilcIDListDataStruct data;
 
   char *server_name;
-  uint8 server_type;
+  SilcUInt8 server_type;
   SilcServerID *id;
   char *server_info;
   char *motd;
@@ -169,18 +192,18 @@ struct SilcServerEntryStruct {
   void *connection;
 };
 
-/* 
+/*
    SILC Channel Client entry structure.
 
    This entry used only by the SilcChannelEntry object and it holds
    information about current clients (ie. users) on channel. Following
-   short description  of the fields:
+   short description of the fields:
 
    SilcClientEntry client
 
        Pointer to the client list. This is the client currently on channel.
 
-   uint32 mode
+   SilcUInt32 mode
 
        Client's current mode on the channel.
 
@@ -190,28 +213,18 @@ struct SilcServerEntryStruct {
        SilcClientEntry we have this here for fast access to the channel when
        used by SilcClientEntry.
 
-  struct SilcChannelClientEntryStruct *client_list
-  struct SilcChannelClientEntryStruct *channel_list
-
-       List member pointers. This structure is used by channel entry and
-       client entry thus we must have separate list member pointers for
-       them since we are using same entry for both lists (the entry is not
-       duplicated). SilcList requires this.
-
 */
 typedef struct SilcChannelClientEntryStruct {
   SilcClientEntry client;
-  uint32 mode;
+  SilcUInt32 mode;
   SilcChannelEntry channel;
-  struct SilcChannelClientEntryStruct *client_list;
-  struct SilcChannelClientEntryStruct *channel_list;
 } *SilcChannelClientEntry;
 
-/* 
+/*
    SILC Client entry object.
 
    This entry holds information about connected clients ie. users in the SILC
-   network. The contents of this entrt is depended on whether we are normal 
+   network. The contents of this entrt is depended on whether we are normal
    server or router server and whether the list is a local or global list.
 
    This entry is defined as follows:
@@ -247,7 +260,7 @@ typedef struct SilcChannelClientEntryStruct {
        router        local list     NULL
        router        global list    NULL
 
-       Router doesn't hold this information since it is not vital data 
+       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.
 
@@ -255,14 +268,14 @@ typedef struct SilcChannelClientEntryStruct {
 
        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 
+       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.
 
@@ -270,12 +283,12 @@ typedef struct SilcChannelClientEntryStruct {
 
        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 
+       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.
 
-   uint32 mode
+   SilcUInt32 mode
 
        Client's mode.  Client maybe for example server operator or
        router operator (SILC operator).
@@ -286,7 +299,7 @@ typedef struct SilcChannelClientEntryStruct {
        not allow any command to be exeucted more than once in about
        2 seconds. This is result of normal time().
 
-   uint8 fast_command
+   SilcUInt8 fast_command
 
        Counter to check command bursts.  By default, up to 5 commands
        are allowed before limiting the execution.  See command flags
@@ -294,13 +307,15 @@ typedef struct SilcChannelClientEntryStruct {
 
    SilcServerEntry 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 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.
 
-   SilcList channels
+   SilcHashTable channels;
 
-       List of channels this client has joined.
+       All the channels this client has joined.  The context saved in the
+       hash table shares memory with the channel entrys `user_list' hash
+       table.
 
    void *connection
 
@@ -309,6 +324,14 @@ typedef struct SilcChannelClientEntryStruct {
        but as just said, this is usually pointer to the socket connection
        list.
 
+   SilcUInt16 resolve_cmd_ident
+
+       Command identifier for the entry when the entry's data.status
+       is SILC_IDLIST_STATUS_RESOLVING.  If this entry is asked to be
+       resolved when the status is set then the resolver may attach to
+       this command identifier and handle the process after the resolving
+       is over.
+
 */
 struct SilcClientEntryStruct {
   /* Generic data structure. DO NOT add anything before this! */
@@ -319,26 +342,37 @@ struct SilcClientEntryStruct {
   char *username;
   char *userinfo;
   SilcClientID *id;
-  uint32 mode;
+  SilcUInt32 mode;
 
   long last_command;
-  uint8 fast_command;
+  SilcUInt8 fast_command;
+
+  /* Requested Attributes */
+  unsigned char *attrs;
+  SilcUInt16 attrs_len;
 
   /* Pointer to the router */
   SilcServerEntry router;
 
-  /* List of channels client has joined to */
-  SilcList channels;
+  /* All channels this client has joined */
+  SilcHashTable channels;
 
   /* Connection data */
   void *connection;
+
+  /* Last time updated/accessed */
+  unsigned long updated;
+
+  /* data.status is RESOLVING and this includes the resolving command
+     reply identifier. */
+  SilcUInt16 resolve_cmd_ident;
 };
 
-/* 
+/*
    SILC Channel entry object.
 
-   This entry holds information about channels in SILC network. The contents 
-   of this entry is depended on whether we are normal server or router server 
+   This entry holds information about channels in SILC network. The contents
+   of this entry is depended on whether we are normal server or router server
    and whether the list is a local or global list.
 
    This entry is defined as follows:
@@ -356,7 +390,7 @@ struct SilcClientEntryStruct {
 
        Logical name of the channel.
 
-   uint32 mode
+   SilcUInt32 mode
 
        Current mode of the channel.  See lib/silccore/silcchannel.h for
        all modes.
@@ -367,12 +401,12 @@ struct SilcClientEntryStruct {
        need.
 
    bool 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 
+       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.
 
@@ -391,19 +425,21 @@ struct SilcClientEntryStruct {
        the cipher to be used. This can be set at SILC_COMMAND_JOIN.
 
    SilcPublicKey founder_key
-   SilcAuthMethod founder_method
-   unsigned char *founder_passwd
-   uint32 founder_passwd_len
 
-       If the SILC_CMODE_FOUNDER_AUTH has been set then these will include
-       the founder's public key, authentication method and the password
-       if the method is SILC_AUTH_PASSWORD.  If it is SILC_AUTH_PUBLIC_KEY
-       then the `founder_passwd' is NULL.
+       If the SILC_CMODE_FOUNDER_AUTH has been set then this will include
+       the founder's public key.  When the mode and this key is set the
+       channel is also permanent channel and cannot be destroyed.
+
+   SilcHashTable user_list
+
+       All users joined on this channel.  Note that the context saved to
+       this entry shares memory with the client entrys `channels' hash
+       table.
 
    SilcServerEntry 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 
+       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 channel_key
@@ -411,7 +447,7 @@ struct SilcClientEntryStruct {
        The key of the channel (the cipher actually).
 
    unsigned char *key
-   uint32 key_len
+   SilcUInt32 key_len
 
        Raw key data of the channel key.
 
@@ -431,25 +467,22 @@ struct SilcClientEntryStruct {
 */
 struct SilcChannelEntryStruct {
   char *channel_name;
-  uint32 mode;
+  SilcUInt32 mode;
   SilcChannelID *id;
-  bool global_users;
   char *topic;
   char *cipher;
   char *hmac_name;
-
   SilcPublicKey founder_key;
-  SilcAuthMethod founder_method;
-  unsigned char *founder_passwd;
-  uint32 founder_passwd_len;
+  SilcHashTable channel_pubkeys;
 
-  uint32 user_limit;
+  SilcUInt32 user_limit;
   unsigned char *passphrase;
-  char *invite_list;
-  char *ban_list;
+  SilcHashTable invite_list;
+  SilcHashTable ban_list;
 
-  /* List of users on channel */
-  SilcList user_list;
+  /* All users on this channel */
+  SilcHashTable user_list;
+  SilcUInt32 user_count;
 
   /* Pointer to the router */
   SilcServerEntry router;
@@ -457,14 +490,20 @@ struct SilcChannelEntryStruct {
   /* Channel keys */
   SilcCipher channel_key;
   unsigned char *key;
-  uint32 key_len;
-  unsigned char iv[SILC_CIPHER_MAX_IV_SIZE];
+  SilcUInt32 key_len;
   SilcHmac hmac;
 
   SilcServerChannelRekey rekey;
+  unsigned long created;
+  unsigned long updated;
+
+  /* Flags */
+  unsigned int global_users : 1;
+  unsigned int disabled : 1;
+  unsigned int users_resolved : 1;
 };
 
-/* 
+/*
    SILC ID List object.
 
    As for remainder these lists are defined as follows:
@@ -509,7 +548,7 @@ typedef struct SilcIDListStruct {
 /*
    ID Entry for Unknown connections.
 
-   This is used during authentication phases where we still don't know 
+   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.
 
@@ -526,50 +565,53 @@ typedef struct {
 void silc_idlist_add_data(void *entry, SilcIDListData idata);
 void silc_idlist_del_data(void *entry);
 SILC_TASK_CALLBACK_GLOBAL(silc_idlist_purge);
-SilcServerEntry 
-silc_idlist_add_server(SilcIDList id_list, 
+SilcServerEntry
+silc_idlist_add_server(SilcIDList id_list,
                       char *server_name, int server_type,
                       SilcServerID *id, SilcServerEntry router,
                       void *connection);
 SilcServerEntry
 silc_idlist_find_server_by_id(SilcIDList id_list, SilcServerID *id,
-                             SilcIDCacheEntry *ret_entry);
+                             bool registered, SilcIDCacheEntry *ret_entry);
 SilcServerEntry
 silc_idlist_find_server_by_name(SilcIDList id_list, char *name,
-                               SilcIDCacheEntry *ret_entry);
+                               bool registered, SilcIDCacheEntry *ret_entry);
 SilcServerEntry
 silc_idlist_find_server_by_conn(SilcIDList id_list, char *hostname,
-                               int port, SilcIDCacheEntry *ret_entry);
+                               int port, bool registered,
+                               SilcIDCacheEntry *ret_entry);
 SilcServerEntry
 silc_idlist_replace_server_id(SilcIDList id_list, SilcServerID *old_id,
                              SilcServerID *new_id);
 int silc_idlist_del_server(SilcIDList id_list, SilcServerEntry entry);
 SilcClientEntry
-silc_idlist_add_client(SilcIDList id_list, unsigned char *nickname, 
-                      uint32 nickname_len, char *username, 
-                      char *userinfo, SilcClientID *id, 
-                      SilcServerEntry router, void *connection);
+silc_idlist_add_client(SilcIDList id_list, char *nickname, char *username,
+                      char *userinfo, SilcClientID *id,
+                      SilcServerEntry router, void *connection,
+                      int expire);
 int silc_idlist_del_client(SilcIDList id_list, SilcClientEntry entry);
 int silc_idlist_get_clients_by_nickname(SilcIDList id_list, char *nickname,
-                                       char *server, 
+                                       char *server,
                                        SilcClientEntry **clients,
-                                       uint32 *clients_count);
+                                       SilcUInt32 *clients_count);
 int silc_idlist_get_clients_by_hash(SilcIDList id_list, char *nickname,
                                    SilcHash md5hash,
                                    SilcClientEntry **clients,
-                                   uint32 *clients_count);
+                                   SilcUInt32 *clients_count);
 SilcClientEntry
 silc_idlist_find_client_by_id(SilcIDList id_list, SilcClientID *id,
-                             SilcIDCacheEntry *ret_entry);
+                             bool registered, SilcIDCacheEntry *ret_entry);
 SilcClientEntry
-silc_idlist_replace_client_id(SilcIDList id_list, SilcClientID *old_id,
-                             SilcClientID *new_id);
+silc_idlist_replace_client_id(SilcServer server,
+                             SilcIDList id_list, SilcClientID *old_id,
+                             SilcClientID *new_id, const char *nickname);
 void silc_idlist_client_destructor(SilcIDCache cache,
                                   SilcIDCacheEntry entry);
 SilcChannelEntry
 silc_idlist_add_channel(SilcIDList id_list, char *channel_name, int mode,
                        SilcChannelID *id, SilcServerEntry router,
-                       SilcCipher channel_key, SilcHmac hmac);
+                       SilcCipher channel_key, SilcHmac hmac,
+                       int expire);
 int silc_idlist_del_channel(SilcIDList id_list, SilcChannelEntry entry);
 SilcChannelEntry
 silc_idlist_find_channel_by_name(SilcIDList id_list, char *name,
@@ -582,6 +624,6 @@ silc_idlist_replace_channel_id(SilcIDList id_list, SilcChannelID *old_id,
                               SilcChannelID *new_id);
 SilcChannelEntry *
 silc_idlist_get_channels(SilcIDList id_list, SilcChannelID *channel_id,
-                        uint32 *channels_count);
+                        SilcUInt32 *channels_count);
 
 #endif