More client library rewrites (added rekey)
[silc.git] / lib / silcclient / client_internal.h
index 0016a73241a5fc4fe3d3895b76248cd6921b8da8..0acee44df7bbbdfe4c7593bebee14bbc3b15cd06 100644 (file)
 #include "client_register.h"
 #include "client_entry.h"
 #include "client_prvmsg.h"
+#include "client_channel.h"
+#include "client_notify.h"
+#include "client_keyagr.h"
+
+/****************************** Definitions *********************************/
+
+/* Packet retry counter and timer defines, for exponential backoff algorithm.
+   Meaningful with UDP transport when packets may get lost. */
+#define SILC_CLIENT_RETRY_COUNT   4      /* Max packet retry count */
+#define SILC_CLIENT_RETRY_MUL     2      /* Retry timer interval growth */
+#define SILC_CLIENT_RETRY_RAND    2      /* Randomizer, timeout += rnd % 2 */
+#define SILC_CLIENT_RETRY_MIN     1      /* Min retry timeout, seconds */
+#define SLIC_CLIENT_RETRY_MAX     16    /* Max retry timeout, seconds */
+
+/********************************** Types ***********************************/
+
+/* Public key verification context */
+typedef struct {
+  SilcSKE ske;
+  SilcSKEVerifyCbCompletion completion;
+  void *completion_context;
+} *VerifyKeyContext;
 
 /* Context to hold the connection authentication request callbacks that
    will be called when the server has replied back to our request about
@@ -60,15 +82,6 @@ typedef struct {
   void *context;
 } SilcClientInternalConnectContext;
 
-/* Structure to hold ping time information. Every PING command will
-   add entry of this structure and is removed after reply to the ping
-   as been received. */
-struct SilcClientPingStruct {
-  time_t start_time;
-  void *dest_id;
-  char *dest_name;
-};
-
 /* Structure to hold away messages set by user. This is mainly created
    for future extensions where away messages could be set according filters
    such as nickname and hostname. For now only one away message can
@@ -117,7 +130,6 @@ typedef struct SilcClientCommandContextStruct {
   SilcStatus error;                  /* Current command reply error */
 
   void *context;                     /* Context for free use */
-  unsigned int processed     : 1;     /* Set when reply was processed  */
   unsigned int called        : 1;     /* Set when called by application */
   unsigned int verbose       : 1;     /* Verbose with 'say' client operation */
   unsigned int resolved      : 1;     /* Set when resolving something */
@@ -131,19 +143,8 @@ struct SilcClientInternalStruct {
   SilcClientParams *params;             /* Client parameters */
   SilcPacketEngine packet_engine;        /* Packet engine */
   SilcMutex lock;                       /* Client lock */
-
-  /* List of connections in client. All the connection data is saved here. */
-  SilcDList conns;
-
-  /* Registered commands */
-  SilcList commands;
-
-  /* Generic cipher and hash objects. */
-  SilcHmac md5hmac;
-  SilcHmac sha1hmac;
-
-  /* Client version. Used to compare to remote host's version strings. */
-  char *silc_client_version;
+  SilcList commands;                    /* Registered commands */
+  char *silc_client_version;            /* Version set by application */
 
   /* Events */
   unsigned int run_callback    : 1;     /* Call running callback */
@@ -151,85 +152,65 @@ struct SilcClientInternalStruct {
 
 /* Internal context for conn->internal in SilcClientConnection. */
 struct SilcClientConnectionInternalStruct {
-  /* Client ID and Channel ID cache. Messages transmitted in SILC network
-     are done using different unique ID's. These are the cache for
-     thoses ID's used in the communication. */
-  SilcIDCache client_cache;
-  SilcIDCache channel_cache;
-  SilcIDCache server_cache;
-
-  /* Pending command queue for this connection */
-  SilcList pending_commands;
-
-  /* Requested pings. */
-  SilcClientPing *ping;
-  SilcUInt32 ping_count;
-
-  /* Set away message */
-  SilcClientAway *away;
-
-  /* Authentication request context. */
-  SilcClientConnAuthRequest connauth;
-
-  /* File transmission sessions */
-  SilcDList ftp_sessions;
-  SilcUInt32 next_session_id;
-  SilcClientFtpSession active_session;
-
-  /* Requested Attributes */
-  SilcHashTable attrs;
+  SilcIDCacheEntry local_entry;                 /* Local client cache entry */
+  SilcClientConnectionParams params;    /* Connection parameters */
 
   SilcFSMStruct fsm;                    /* Connection FSM */
-  SilcFSMThreadStruct packet_thread;     /* FSM thread for packet processor */
   SilcFSMThreadStruct event_thread;      /* FSM thread for events */
   SilcFSMSemaStruct wait_event;                 /* Event signaller */
-  SilcMutex lock;                       /* Connection lock */
   SilcSchedule schedule;                /* Connection's scheduler */
+  SilcMutex lock;                       /* Connection lock */
   SilcSKE ske;                          /* Key exchange protocol */
   SilcSKERekeyMaterial rekey;           /* Rekey material */
+  SilcList thread_pool;                         /* Packet thread pool */
+  SilcList pending_commands;            /* Pending commands list */
   SilcHash hash;                        /* Negotiated hash function */
-  SilcClientConnectionParams params;    /* Connection parameters */
-  SilcAtomic16 cmd_ident;               /* Current command identifier */
-  SilcIDCacheEntry local_entry;                 /* Local client cache entry */
+  SilcHash sha1hash;                    /* SHA-1 default hash context */
+  SilcBuffer local_idp;                         /* Local ID Payload */
+  SilcBuffer remote_idp;                /* Remote ID Payload */
+  SilcAsyncOperation op;                /* Protocols async operation */
 
-  SilcHashTable privmsg_wait;           /* Waited private messages */
+  SilcIDCache client_cache;             /* Client entry cache */
+  SilcIDCache channel_cache;            /* Channel entry cache */
+  SilcIDCache server_cache;             /* Server entry cache */
+
+  SilcAtomic16 cmd_ident;               /* Current command identifier */
+  SilcUInt8 retry_count;                /* Packet retry counter */
+  SilcUInt8 retry_timer;                /* Packet retry timer */
 
   /* Events */
   unsigned int connect            : 1;  /* Connect remote host */
   unsigned int disconnected       : 1;  /* Disconnected by remote host */
   unsigned int key_exchange       : 1;   /* Start key exchange */
-  unsigned int new_packet         : 1;  /* New packet received */
+  unsigned int rekeying           : 1;   /* Start rekey */
 
   /* Flags */
   unsigned int verbose            : 1;   /* Notify application */
   unsigned int registering        : 1;  /* Set when registering to network */
+  unsigned int rekey_responder    : 1;   /* Set when rekeying as responder */
+
+  SilcClientAway *away;
+  SilcClientConnAuthRequest connauth;
+  SilcDList ftp_sessions;
+  SilcUInt32 next_session_id;
+  SilcClientFtpSession active_session;
+  SilcHashTable attrs;
+  SilcHashTable privmsg_wait;           /* Waited private messages */
 };
 
+SILC_FSM_STATE(silc_client_connection_st_run);
 SILC_FSM_STATE(silc_client_connection_st_packet);
-
-void silc_client_channel_message(SilcClient client,
-                                SilcClientConnection conn,
-                                SilcPacket packet);
-void silc_client_ftp(SilcClient client, SilcClientConnection conn,
-                    SilcPacket packet);
-void silc_client_channel_key(SilcClient client,
-                            SilcClientConnection conn,
-                            SilcPacket packet);
-void silc_client_notify(SilcClient client,
-                       SilcClientConnection conn,
-                       SilcPacket packet);
-void silc_client_disconnect(SilcClient client,
-                           SilcClientConnection conn,
-                           SilcPacket packet);
-void silc_client_error(SilcClient client,
-                      SilcClientConnection conn,
-                      SilcPacket packet);
-void silc_client_key_agreement(SilcClient client,
-                              SilcClientConnection conn,
-                              SilcPacket packet);
-void silc_client_connection_auth_request(SilcClient client,
-                                        SilcClientConnection conn,
-                                        SilcPacket packet);
+SILC_FSM_STATE(silc_client_connection_st_close);
+SILC_FSM_STATE(silc_client_error);
+SILC_FSM_STATE(silc_client_disconnect);
+
+void silc_client_del_connection(SilcClient client, SilcClientConnection conn);
+SilcBool silc_client_del_client(SilcClient client, SilcClientConnection conn,
+                               SilcClientEntry client_entry);
+SilcBool silc_client_del_channel(SilcClient client, SilcClientConnection conn,
+                                SilcChannelEntry channel);
+SilcBool silc_client_del_server(SilcClient client, SilcClientConnection conn,
+                               SilcServerEntry server);
 SilcUInt16 silc_client_command_send_argv(SilcClient client,
                                         SilcClientConnection conn,
                                         SilcCommand command,
@@ -239,127 +220,14 @@ SilcUInt16 silc_client_command_send_argv(SilcClient client,
                                         unsigned char **argv,
                                         SilcUInt32 *argv_lens,
                                         SilcUInt32 *argv_types);
+void silc_client_command_free(SilcClientCommandContext cmd);
+void silc_client_fsm_destructor(SilcFSM fsm, void *fsm_context,
+                               void *destructor_context);
 
-#if 0
-/* Session resuming callback */
-typedef void (*SilcClientResumeSessionCallback)(SilcClient client,
-                                               SilcClientConnection conn,
-                                               SilcBool success,
-                                               void *context);
-
-/* Rekey must be performed at the lastest when this many packets is sent */
-#define SILC_CLIENT_REKEY_THRESHOLD 0xfffffe00
-
-/* Macros */
-
-/* Registers generic task for file descriptor for reading from network and
-   writing to network. As being generic task the actual task is allocated
-   only once and after that the same task applies to all registered fd's. */
-#define SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(fd)     \
-do {                                                   \
-  silc_schedule_task_add(client->schedule, (fd),       \
-                        silc_client_packet_process,    \
-                        context, 0, 0,                 \
-                        SILC_TASK_GENERIC,             \
-                        SILC_TASK_PRI_NORMAL);         \
-} while(0)
-
-#define SILC_CLIENT_SET_CONNECTION_FOR_INPUT(s, fd)                    \
-do {                                                                   \
-  silc_schedule_set_listen_fd((s), (fd), SILC_TASK_READ, FALSE);       \
-} while(0)
-
-#define SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(s, fd)                   \
-do {                                                                   \
-  silc_schedule_set_listen_fd((s), (fd), (SILC_TASK_READ |             \
-                                         SILC_TASK_WRITE), FALSE);     \
-} while(0)
-
-/* Finds socket connection object by file descriptor */
-#define SILC_CLIENT_GET_SOCK(__x, __fd, __sock)                        \
-do {                                                           \
-  int __i;                                                     \
-                                                               \
-  for (__i = 0; __i < (__x)->internal->conns_count; __i++)     \
-    if ((__x)->internal->conns[__i] &&                         \
-       (__x)->internal->conns[__i]->sock &&                    \
-       (__x)->internal->conns[__i]->sock->sock == (__fd))      \
-      break;                                                   \
-                                                               \
-  if (__i >= (__x)->internal->conns_count) {                   \
-    (__sock) = NULL;                                           \
-    for (__i = 0; __i < (__x)->internal->sockets_count; __i++) \
-      if ((__x)->internal->sockets[__i] &&                     \
-         (__x)->internal->sockets[__i]->sock == (__fd))        \
-        (__sock) = (__x)->internal->sockets[__i];              \
-  } else                                                       \
-    (__sock) = (__x)->internal->conns[__i]->sock;              \
-} while(0)
-
-/* Check whether rekey protocol is active */
-#define SILC_CLIENT_IS_REKEY(sock)                                     \
-  (sock->protocol && sock->protocol->protocol &&                       \
-   sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)
-
-/* Prototypes */
-
-SILC_TASK_CALLBACK_GLOBAL(silc_client_packet_process);
-void silc_client_packet_send(SilcClient client,
-                             SilcClientConnection conn,
-                             SilcPacketType type,
-                             void *dst_id,
-                             SilcIdType dst_id_type,
-                             SilcCipher cipher,
-                             SilcHmac hmac,
-                             unsigned char *data,
-                             SilcUInt32 data_len,
-                             SilcBool force_send);
-int silc_client_packet_send_real(SilcClient client,
-                                SilcClientConnection conn,
-                                SilcBool force_send);
-void silc_client_ftp_free_sessions(SilcClient client,
-                                  SilcClientConnection conn);
-void silc_client_ftp_session_free(SilcClientFtpSession session);
-void silc_client_ftp_session_free_client(SilcClientConnection conn,
-                                        SilcClientEntry client_entry);
-void silc_client_close_connection_real(SilcClient client,
-                                      SilcClientConnection conn,
-                                      SilcClientConnection conn);
-
-void silc_client_save_channel_key(SilcClient client,
-                                 SilcClientConnection conn,
-                                 SilcBuffer key_payload,
-                                 SilcChannelEntry channel);
-void silc_client_remove_from_channels(SilcClient client,
-                                     SilcClientConnection conn,
-                                     SilcClientEntry client_entry);
-void silc_client_replace_from_channels(SilcClient client,
-                                      SilcClientConnection conn,
-                                      SilcClientEntry old,
-                                      SilcClientEntry newclient);
-void silc_client_process_failure(SilcClient client,
-                                SilcClientConnection conn,
-                                SilcPacket packet);
-SilcBuffer silc_client_get_detach_data(SilcClient client,
-                                      SilcClientConnection conn);
-SilcBool silc_client_process_detach_data(SilcClient client,
-                                    SilcClientConnection conn,
-                                    unsigned char **old_id,
-                                    SilcUInt16 *old_id_len);
-void silc_client_resume_session(SilcClient client,
-                               SilcClientConnection conn,
-                               SilcClientResumeSessionCallback callback,
-                               void *context);
-SilcBuffer silc_client_attributes_process(SilcClient client,
-                                         SilcClientConnection conn,
-                                         SilcDList attrs);
-void silc_client_packet_queue_purge(SilcClient client,
-                                   SilcClientConnection conn);
-SILC_TASK_CALLBACK_GLOBAL(silc_client_rekey_callback);
-void
-silc_client_command_reply_whois_save(SilcClientCommandReplyContext cmd,
-                                    SilcStatus status,
-                                    SilcBool notify);
-#endif /* 0 */
+void silc_client_ftp(SilcClient client, SilcClientConnection conn,
+                    SilcPacket packet);
+void silc_client_connection_auth_request(SilcClient client,
+                                        SilcClientConnection conn,
+                                        SilcPacket packet);
 
 #endif