lib/silcclient/client_internal.h

   1 /*
   2
   3   client_internal.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 2001 Pekka Riikonen
   8
   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; version 2 of the License.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18 */
  19
  20 #ifndef CLIENT_INTERNAL_H
  21 #define CLIENT_INTERNAL_H
  22
  23 /* Context to hold the connection authentication request callbacks that
  24    will be called when the server has replied back to our request about
  25    current authentication method in the session. */
  26 typedef struct {
  27   SilcConnectionAuthRequest callback;
  28   void *context;
  29   SilcTask timeout;
  30 } *SilcClientConnAuthRequest;
  31
  32 /* Generic rekey context for connections */
  33 typedef struct {
  34   /* Current sending encryption key, provided for re-key. The `pfs'
  35      is TRUE if the Perfect Forward Secrecy is performed in re-key. */
  36   unsigned char *send_enc_key;
  37   SilcUInt32 enc_key_len;
  38   int ske_group;
  39   bool pfs;
  40   SilcUInt32 timeout;
  41   void *context;
  42 } *SilcClientRekey;
  43
  44 /* Internal context for connection process. This is needed as we
  45    doing asynchronous connecting. */
  46 typedef struct {
  47   SilcClient client;
  48   SilcClientConnection conn;
  49   SilcTask task;
  50   int sock;
  51   char *host;
  52   int port;
  53   int tries;
  54   void *context;
  55 } SilcClientInternalConnectContext;
  56
  57 /* Structure to hold ping time information. Every PING command will
  58    add entry of this structure and is removed after reply to the ping
  59    as been received. */
  60 struct SilcClientPingStruct {
  61   time_t start_time;
  62   void *dest_id;
  63   char *dest_name;
  64 };
  65
  66 /* Structure to hold away messages set by user. This is mainly created
  67    for future extensions where away messages could be set according filters
  68    such as nickname and hostname. For now only one away message can
  69    be set in one connection. */
  70 struct SilcClientAwayStruct {
  71   char *away;
  72   struct SilcClientAwayStruct *next;
  73 };
  74
  75 /* Internal context for the client->internal pointer in the SilcClient. */
  76 struct SilcClientInternalStruct {
  77   /* All client operations that are implemented by the application. */
  78   SilcClientOperations *ops;
  79
  80   /* Client Parameters */
  81   SilcClientParams *params;
  82
  83   /* Table of connections in client. All the connection data is saved here. */
  84   SilcClientConnection *conns;
  85   SilcUInt32 conns_count;
  86
  87   /* Table of listenning sockets in client.  Client can have listeners
  88      (like key agreement protocol server) and those sockets are saved here.
  89      This table is checked always if the connection object cannot be found
  90      from the `conns' table. */
  91   SilcSocketConnection *sockets;
  92   SilcUInt32 sockets_count;
  93
  94   /* Registered commands */
  95   SilcList commands;
  96
  97   /* Generic cipher and hash objects. */
  98   SilcCipher none_cipher;
  99   SilcHmac md5hmac;
 100   SilcHmac sha1hmac;
 101
 102   /* Client version. Used to compare to remote host's version strings. */
 103   char *silc_client_version;
 104 };
 105
 106 /* Internal context for conn->internal in SilcClientConnection. */
 107 struct SilcClientConnectionInternalStruct {
 108   /* Keys and stuff negotiated in the SKE protocol */
 109   SilcCipher send_key;
 110   SilcCipher receive_key;
 111   SilcHmac hmac_send;
 112   SilcHmac hmac_receive;
 113   SilcHash hash;
 114   SilcUInt32 psn_send;
 115   SilcUInt32 psn_receive;
 116
 117   /* Client ID and Channel ID cache. Messages transmitted in SILC network
 118      are done using different unique ID's. These are the cache for
 119      thoses ID's used in the communication. */
 120   SilcIDCache client_cache;
 121   SilcIDCache channel_cache;
 122   SilcIDCache server_cache;
 123
 124   /* Pending command queue for this connection */
 125   SilcDList pending_commands;
 126
 127   /* Requested pings. */
 128   SilcClientPing *ping;
 129   SilcUInt32 ping_count;
 130
 131   /* Set away message */
 132   SilcClientAway *away;
 133
 134   /* Re-key context */
 135   SilcClientRekey rekey;
 136
 137   /* Authentication request context. */
 138   SilcClientConnAuthRequest connauth;
 139
 140   /* File transmission sessions */
 141   SilcDList ftp_sessions;
 142   SilcUInt32 next_session_id;
 143   SilcClientFtpSession active_session;
 144
 145   /* Requested Attributes */
 146   SilcHashTable attrs;
 147
 148   /* Connection parameters */
 149   SilcClientConnectionParams params;
 150 };
 151
 152 /* Session resuming callback */
 153 typedef void (*SilcClientResumeSessionCallback)(SilcClient client,
 154                                                 SilcClientConnection conn,
 155                                                 bool success,
 156                                                 void *context);
 157
 158 /* Macros */
 159
 160 /* Registers generic task for file descriptor for reading from network and
 161    writing to network. As being generic task the actual task is allocated
 162    only once and after that the same task applies to all registered fd's. */
 163 #define SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(fd)      \
 164 do {                                                    \
 165   silc_schedule_task_add(client->schedule, (fd),        \
 166                          silc_client_packet_process,    \
 167                          context, 0, 0,                 \
 168                          SILC_TASK_GENERIC,             \
 169                          SILC_TASK_PRI_NORMAL);         \
 170 } while(0)
 171
 172 #define SILC_CLIENT_SET_CONNECTION_FOR_INPUT(s, fd)                     \
 173 do {                                                                    \
 174   silc_schedule_set_listen_fd((s), (fd), SILC_TASK_READ, FALSE);        \
 175 } while(0)
 176
 177 #define SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(s, fd)                    \
 178 do {                                                                    \
 179   silc_schedule_set_listen_fd((s), (fd), (SILC_TASK_READ |              \
 180                                           SILC_TASK_WRITE), FALSE);     \
 181 } while(0)
 182
 183 /* Finds socket connection object by file descriptor */
 184 #define SILC_CLIENT_GET_SOCK(__x, __fd, __sock)                 \
 185 do {                                                            \
 186   int __i;                                                      \
 187                                                                 \
 188   for (__i = 0; __i < (__x)->internal->conns_count; __i++)      \
 189     if ((__x)->internal->conns[__i] &&                          \
 190         (__x)->internal->conns[__i]->sock->sock == (__fd))      \
 191       break;                                                    \
 192                                                                 \
 193   if (__i >= (__x)->internal->conns_count) {                    \
 194     (__sock) = NULL;                                            \
 195     for (__i = 0; __i < (__x)->internal->sockets_count; __i++)  \
 196       if ((__x)->internal->sockets[__i] &&                      \
 197           (__x)->internal->sockets[__i]->sock == (__fd))        \
 198         (__sock) = (__x)->internal->sockets[__i];               \
 199   } else                                                        \
 200     (__sock) = (__x)->internal->conns[__i]->sock;               \
 201 } while(0)
 202
 203 /* Check whether rekey protocol is active */
 204 #define SILC_CLIENT_IS_REKEY(sock)                                      \
 205   (sock->protocol && sock->protocol->protocol &&                        \
 206    sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)
 207
 208 /* Prototypes */
 209
 210 SILC_TASK_CALLBACK_GLOBAL(silc_client_packet_process);
 211 int silc_client_packet_send_real(SilcClient client,
 212                                  SilcSocketConnection sock,
 213                                  bool force_send);
 214 void silc_client_ftp_free_sessions(SilcClient client,
 215                                    SilcClientConnection conn);
 216 void silc_client_ftp_session_free(SilcClientFtpSession session);
 217 void silc_client_ftp_session_free_client(SilcClientConnection conn,
 218                                          SilcClientEntry client_entry);
 219 void silc_client_close_connection_real(SilcClient client,
 220                                        SilcSocketConnection sock,
 221                                        SilcClientConnection conn);
 222 void silc_client_disconnected_by_server(SilcClient client,
 223                                         SilcSocketConnection sock,
 224                                         SilcBuffer packet);
 225 void silc_client_error_by_server(SilcClient client,
 226                                  SilcSocketConnection sock,
 227                                  SilcBuffer message);
 228 void silc_client_receive_new_id(SilcClient client,
 229                                 SilcSocketConnection sock,
 230                                 SilcIDPayload idp);
 231 void silc_client_save_channel_key(SilcClient client,
 232                                   SilcClientConnection conn,
 233                                   SilcBuffer key_payload,
 234                                   SilcChannelEntry channel);
 235 void silc_client_receive_channel_key(SilcClient client,
 236                                      SilcSocketConnection sock,
 237                                      SilcBuffer packet);
 238 void silc_client_channel_message(SilcClient client,
 239                                  SilcSocketConnection sock,
 240                                  SilcPacketContext *packet);
 241 void silc_client_remove_from_channels(SilcClient client,
 242                                       SilcClientConnection conn,
 243                                       SilcClientEntry client_entry);
 244 void silc_client_replace_from_channels(SilcClient client,
 245                                        SilcClientConnection conn,
 246                                        SilcClientEntry old,
 247                                        SilcClientEntry newclient);
 248 void silc_client_process_failure(SilcClient client,
 249                                  SilcSocketConnection sock,
 250                                  SilcPacketContext *packet);
 251 void silc_client_key_agreement(SilcClient client,
 252                                SilcSocketConnection sock,
 253                                SilcPacketContext *packet);
 254 void silc_client_notify_by_server(SilcClient client,
 255                                   SilcSocketConnection sock,
 256                                   SilcPacketContext *packet);
 257 void silc_client_private_message(SilcClient client,
 258                                  SilcSocketConnection sock,
 259                                  SilcPacketContext *packet);
 260 void silc_client_connection_auth_request(SilcClient client,
 261                                          SilcSocketConnection sock,
 262                                          SilcPacketContext *packet);
 263 void silc_client_ftp(SilcClient client,
 264                      SilcSocketConnection sock,
 265                      SilcPacketContext *packet);
 266 SilcBuffer silc_client_get_detach_data(SilcClient client,
 267                                        SilcClientConnection conn);
 268 bool silc_client_process_detach_data(SilcClient client,
 269                                      SilcClientConnection conn,
 270                                      unsigned char **old_id,
 271                                      SilcUInt16 *old_id_len);
 272 void silc_client_resume_session(SilcClient client,
 273                                 SilcClientConnection conn,
 274                                 SilcClientResumeSessionCallback callback,
 275                                 void *context);
 276 SilcBuffer silc_client_attributes_process(SilcClient client,
 277                                           SilcSocketConnection sock,
 278                                           SilcDList attrs);
 279
 280 #endif