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 /* Internal context for connection process. This is needed as we
  24    doing asynchronous connecting. */
  25 typedef struct {
  26   SilcClient client;
  27   SilcClientConnection conn;
  28   SilcTask task;
  29   int sock;
  30   char *host;
  31   int port;
  32   int tries;
  33   void *context;
  34 } SilcClientInternalConnectContext;
  35
  36 /* Structure to hold ping time information. Every PING command will
  37    add entry of this structure and is removed after reply to the ping
  38    as been received. */
  39 struct SilcClientPingStruct {
  40   time_t start_time;
  41   void *dest_id;
  42   char *dest_name;
  43 };
  44
  45 /* Structure to hold away messages set by user. This is mainly created
  46    for future extensions where away messages could be set according filters
  47    such as nickname and hostname. For now only one away message can
  48    be set in one connection. */
  49 struct SilcClientAwayStruct {
  50   char *away;
  51   struct SilcClientAwayStruct *next;
  52 };
  53
  54 /* Internal context for the client->internal pointer in the SilcClient. */
  55 struct SilcClientInternalStruct {
  56   /* All client operations that are implemented by the application. */
  57   SilcClientOperations *ops;
  58
  59   /* Client Parameters */
  60   SilcClientParams *params;
  61
  62   /* Table of connections in client. All the connection data is saved here. */
  63   SilcClientConnection *conns;
  64   SilcUInt32 conns_count;
  65
  66   /* Table of listenning sockets in client.  Client can have listeners
  67      (like key agreement protocol server) and those sockets are saved here.
  68      This table is checked always if the connection object cannot be found
  69      from the `conns' table. */
  70   SilcSocketConnection *sockets;
  71   SilcUInt32 sockets_count;
  72
  73   /* Registered commands */
  74   SilcList commands;
  75
  76   /* Generic cipher and hash objects. */
  77   SilcCipher none_cipher;
  78   SilcHmac md5hmac;
  79   SilcHmac sha1hmac;
  80
  81   /* Client version. Used to compare to remote host's version strings. */
  82   char *silc_client_version;
  83 };
  84
  85 /* Session resuming callback */
  86 typedef void (*SilcClientResumeSessionCallback)(SilcClient client,
  87                                                 SilcClientConnection conn,
  88                                                 bool success,
  89                                                 void *context);
  90
  91 /* Macros */
  92
  93 /* Registers generic task for file descriptor for reading from network and
  94    writing to network. As being generic task the actual task is allocated
  95    only once and after that the same task applies to all registered fd's. */
  96 #define SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(fd)      \
  97 do {                                                    \
  98   silc_schedule_task_add(client->schedule, (fd),        \
  99                          silc_client_packet_process,    \
 100                          context, 0, 0,                 \
 101                          SILC_TASK_GENERIC,             \
 102                          SILC_TASK_PRI_NORMAL);         \
 103 } while(0)
 104
 105 #define SILC_CLIENT_SET_CONNECTION_FOR_INPUT(s, fd)                     \
 106 do {                                                                    \
 107   silc_schedule_set_listen_fd((s), (fd), SILC_TASK_READ, FALSE);        \
 108 } while(0)
 109
 110 #define SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(s, fd)                    \
 111 do {                                                                    \
 112   silc_schedule_set_listen_fd((s), (fd), (SILC_TASK_READ |              \
 113                                           SILC_TASK_WRITE), FALSE);     \
 114 } while(0)
 115
 116 /* Finds socket connection object by file descriptor */
 117 #define SILC_CLIENT_GET_SOCK(__x, __fd, __sock)                 \
 118 do {                                                            \
 119   int __i;                                                      \
 120                                                                 \
 121   for (__i = 0; __i < (__x)->internal->conns_count; __i++)      \
 122     if ((__x)->internal->conns[__i] &&                          \
 123         (__x)->internal->conns[__i]->sock->sock == (__fd))      \
 124       break;                                                    \
 125                                                                 \
 126   if (__i >= (__x)->internal->conns_count) {                    \
 127     (__sock) = NULL;                                            \
 128     for (__i = 0; __i < (__x)->internal->sockets_count; __i++)  \
 129       if ((__x)->internal->sockets[__i] &&                      \
 130           (__x)->internal->sockets[__i]->sock == (__fd))        \
 131         (__sock) = (__x)->internal->sockets[__i];               \
 132   } else                                                        \
 133     (__sock) = (__x)->internal->conns[__i]->sock;               \
 134 } while(0)
 135
 136 /* Check whether rekey protocol is active */
 137 #define SILC_CLIENT_IS_REKEY(sock)                                      \
 138   (sock->protocol && sock->protocol->protocol &&                        \
 139    sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)
 140
 141 /* Prototypes */
 142
 143 SILC_TASK_CALLBACK_GLOBAL(silc_client_packet_process);
 144 int silc_client_packet_send_real(SilcClient client,
 145                                  SilcSocketConnection sock,
 146                                  bool force_send);
 147 void silc_client_ftp_free_sessions(SilcClient client,
 148                                    SilcClientConnection conn);
 149 void silc_client_ftp_session_free(SilcClientFtpSession session);
 150 void silc_client_ftp_session_free_client(SilcClientConnection conn,
 151                                          SilcClientEntry client_entry);
 152 void silc_client_close_connection_real(SilcClient client,
 153                                        SilcSocketConnection sock,
 154                                        SilcClientConnection conn);
 155 void silc_client_disconnected_by_server(SilcClient client,
 156                                         SilcSocketConnection sock,
 157                                         SilcBuffer packet);
 158 void silc_client_error_by_server(SilcClient client,
 159                                  SilcSocketConnection sock,
 160                                  SilcBuffer message);
 161 void silc_client_receive_new_id(SilcClient client,
 162                                 SilcSocketConnection sock,
 163                                 SilcIDPayload idp);
 164 void silc_client_save_channel_key(SilcClient client,
 165                                   SilcClientConnection conn,
 166                                   SilcBuffer key_payload,
 167                                   SilcChannelEntry channel);
 168 void silc_client_receive_channel_key(SilcClient client,
 169                                      SilcSocketConnection sock,
 170                                      SilcBuffer packet);
 171 void silc_client_channel_message(SilcClient client,
 172                                  SilcSocketConnection sock,
 173                                  SilcPacketContext *packet);
 174 void silc_client_remove_from_channels(SilcClient client,
 175                                       SilcClientConnection conn,
 176                                       SilcClientEntry client_entry);
 177 void silc_client_replace_from_channels(SilcClient client,
 178                                        SilcClientConnection conn,
 179                                        SilcClientEntry old,
 180                                        SilcClientEntry newclient);
 181 void silc_client_process_failure(SilcClient client,
 182                                  SilcSocketConnection sock,
 183                                  SilcPacketContext *packet);
 184 void silc_client_key_agreement(SilcClient client,
 185                                SilcSocketConnection sock,
 186                                SilcPacketContext *packet);
 187 void silc_client_notify_by_server(SilcClient client,
 188                                   SilcSocketConnection sock,
 189                                   SilcPacketContext *packet);
 190 void silc_client_private_message(SilcClient client,
 191                                  SilcSocketConnection sock,
 192                                  SilcPacketContext *packet);
 193 void silc_client_connection_auth_request(SilcClient client,
 194                                          SilcSocketConnection sock,
 195                                          SilcPacketContext *packet);
 196 void silc_client_ftp(SilcClient client,
 197                      SilcSocketConnection sock,
 198                      SilcPacketContext *packet);
 199 SilcBuffer silc_client_get_detach_data(SilcClient client,
 200                                        SilcClientConnection conn);
 201 bool silc_client_process_detach_data(SilcClient client,
 202                                      SilcClientConnection conn,
 203                                      unsigned char **old_id,
 204                                      SilcUInt16 *old_id_len);
 205 void silc_client_resume_session(SilcClient client,
 206                                 SilcClientConnection conn,
 207                                 SilcClientResumeSessionCallback callback,
 208                                 void *context);
 209 SilcBuffer silc_client_attributes_process(SilcClient client,
 210                                           SilcSocketConnection sock,
 211                                           SilcDList attrs);
 212
 213 #endif