lib/silcclient/client.h

   1 /*
   2
   3   client.h
   4
   5   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
   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; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   This program is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19 */
  20
  21 #ifndef CLIENT_H
  22 #define CLIENT_H
  23
  24 /* Forward declarations */
  25 typedef struct SilcClientStruct *SilcClient;
  26 typedef struct SilcClientConnectionStruct *SilcClientConnection;
  27 typedef struct SilcClientPingStruct SilcClientPing;
  28 typedef struct SilcClientAwayStruct SilcClientAway;
  29 typedef struct SilcClientKeyAgreementStruct *SilcClientKeyAgreement;
  30
  31 #include "idlist.h"
  32 #include "command.h"
  33 #include "silcapi.h"
  34
  35 /* Generic rekey context for connections */
  36 typedef struct {
  37   /* Current sending encryption key, provided for re-key. The `pfs'
  38      is TRUE if the Perfect Forward Secrecy is performed in re-key. */
  39   unsigned char *send_enc_key;
  40   uint32 enc_key_len;
  41   int ske_group;
  42   bool pfs;
  43   uint32 timeout;
  44   void *context;
  45 } *SilcClientRekey;
  46
  47 /* Connection structure used in client to associate all the important
  48    connection specific data to this structure. */
  49 struct SilcClientConnectionStruct {
  50   /*
  51    * Local data
  52    */
  53   char *nickname;
  54
  55   /* Local client ID for this connection */
  56   SilcClientID *local_id;
  57
  58   /* Decoded local ID so that the above defined ID would not have
  59      to be decoded for every packet. */
  60   unsigned char *local_id_data;
  61   uint32 local_id_data_len;
  62
  63   /* Own client entry. */
  64   SilcClientEntry local_entry;
  65
  66   /*
  67    * Remote data
  68    */
  69   char *remote_host;
  70   int remote_port;
  71   int remote_type;
  72   char *remote_info;
  73
  74   /* Remote server ID for this connection */
  75   SilcServerID *remote_id;
  76
  77   /* Decoded remote ID so that the above defined ID would not have
  78      to be decoded for every packet. */
  79   unsigned char *remote_id_data;
  80   uint32 remote_id_data_len;
  81
  82   /*
  83    * Common data
  84    */
  85   /* Keys and stuff negotiated in the SKE protocol */
  86   SilcCipher send_key;
  87   SilcCipher receive_key;
  88   SilcHmac hmac_send;
  89   SilcHmac hmac_receive;
  90   SilcHash hash;
  91
  92   /* Client ID and Channel ID cache. Messages transmitted in SILC network
  93      are done using different unique ID's. These are the cache for
  94      thoses ID's used in the communication. */
  95   SilcIDCache client_cache;
  96   SilcIDCache channel_cache;
  97   SilcIDCache server_cache;
  98
  99   /* Current channel on window. All channels are saved (allocated) into
 100      the cache entries. */
 101   SilcChannelEntry current_channel;
 102
 103   /* Socket connection object for this connection (window). This
 104      object will have a back-pointer to this window object for fast
 105      referencing (sock->user_data). */
 106   SilcSocketConnection sock;
 107
 108   /* Pending command queue for this connection */
 109   SilcDList pending_commands;
 110
 111   /* Current command identifier, 0 not used */
 112   uint16 cmd_ident;
 113
 114   /* Requested pings. */
 115   SilcClientPing *ping;
 116   uint32 ping_count;
 117
 118   /* Set away message */
 119   SilcClientAway *away;
 120
 121   /* Re-key context */
 122   SilcClientRekey rekey;
 123
 124   /* Pointer back to the SilcClient. This object is passed to the application
 125      and the actual client object is accesible through this pointer. */
 126   SilcClient client;
 127
 128   /* User data context. Library does not touch this. */
 129   void *context;
 130 };
 131
 132 /* Main client structure. */
 133 struct SilcClientStruct {
 134   /*
 135    * Public data. All the following pointers must be set by the allocator
 136    * of this structure.
 137    */
 138
 139   /* Users's username, hostname and realname. */
 140   char *username;
 141   char *hostname;
 142   char *realname;
 143
 144   /* Private and public key of the user. */
 145   SilcPKCS pkcs;
 146   SilcPublicKey public_key;
 147   SilcPrivateKey private_key;
 148
 149   /* Application specific user data pointer. Client library does not
 150      touch this. */
 151   void *application;
 152
 153   /*
 154    * Private data. Following pointers are used internally by the client
 155    * library and should be considered read-only fields.
 156    */
 157
 158   /* All client operations that are implemented in the application. */
 159   SilcClientOperations *ops;
 160
 161   /* SILC client scheduler and task queues */
 162   SilcSchedule schedule;
 163   SilcTaskQueue io_queue;
 164   SilcTaskQueue timeout_queue;
 165   SilcTaskQueue generic_queue;
 166
 167   /* Table of connections in client. All the connection data is saved here. */
 168   SilcClientConnection *conns;
 169   uint32 conns_count;
 170
 171   /* Table of listenning sockets in client.  Client can have listeners
 172      (like key agreement protocol server) and those sockets are saved here.
 173      This table is checked always if the connection object cannot be found
 174      from the `conns' table. */
 175   SilcSocketConnection *sockets;
 176   uint32 sockets_count;
 177
 178   /* Generic cipher and hash objects. These can be used and referenced
 179      by the application as well. */
 180   SilcCipher none_cipher;
 181   SilcHash md5hash;
 182   SilcHash sha1hash;
 183   SilcHmac md5hmac;
 184   SilcHmac sha1hmac;
 185
 186   /* Random Number Generator. Application should use this as its primary
 187      random number generator. */
 188   SilcRng rng;
 189 };
 190
 191 /* Macros */
 192
 193 /* Registers generic task for file descriptor for reading from network and
 194    writing to network. As being generic task the actual task is allocated
 195    only once and after that the same task applies to all registered fd's. */
 196 #define SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(fd)                      \
 197 do {                                                                    \
 198   SilcTask tmptask = silc_task_register(client->generic_queue, (fd),    \
 199                                         silc_client_packet_process,     \
 200                                         context, 0, 0,                  \
 201                                         SILC_TASK_GENERIC,              \
 202                                         SILC_TASK_PRI_NORMAL);          \
 203   silc_task_set_iotype(tmptask, SILC_TASK_WRITE);                       \
 204 } while(0)
 205
 206 #define SILC_CLIENT_SET_CONNECTION_FOR_INPUT(s, fd)                     \
 207 do {                                                                    \
 208   silc_schedule_set_listen_fd((s), (fd), (1L << SILC_TASK_READ));       \
 209 } while(0)
 210
 211 #define SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(s, fd)                    \
 212 do {                                                                    \
 213   silc_schedule_set_listen_fd((s), (fd), ((1L << SILC_TASK_READ) |      \
 214                                      (1L << SILC_TASK_WRITE)));         \
 215 } while(0)
 216
 217 /* Finds socket connection object by file descriptor */
 218 #define SILC_CLIENT_GET_SOCK(__x, __fd, __sock)         \
 219 do {                                                    \
 220   int __i;                                              \
 221                                                         \
 222   for (__i = 0; __i < (__x)->conns_count; __i++)        \
 223     if ((__x)->conns[__i] &&                            \
 224         (__x)->conns[__i]->sock->sock == (__fd))        \
 225       break;                                            \
 226                                                         \
 227   if (__i >= (__x)->conns_count) {                      \
 228     (__sock) = NULL;                                    \
 229     for (__i = 0; __i < (__x)->sockets_count; __i++)    \
 230       if ((__x)->sockets[__i] &&                        \
 231           (__x)->sockets[__i]->sock == (__fd))          \
 232         (__sock) = (__x)->sockets[__i];                 \
 233   } else                                                \
 234     (__sock) = (__x)->conns[__i]->sock;                 \
 235 } while(0)
 236
 237 /* Check whether rekey protocol is active */
 238 #define SILC_CLIENT_IS_REKEY(sock)                                      \
 239   (sock->protocol && sock->protocol->protocol &&                        \
 240    sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)
 241
 242 /* Prototypes (some of the prototypes are defined in the silcapi.h) */
 243
 244 void silc_client_packet_send(SilcClient client,
 245                              SilcSocketConnection sock,
 246                              SilcPacketType type,
 247                              void *dst_id,
 248                              SilcIdType dst_id_type,
 249                              SilcCipher cipher,
 250                              SilcHmac hmac,
 251                              unsigned char *data,
 252                              uint32 data_len,
 253                              int force_send);
 254 void silc_client_disconnected_by_server(SilcClient client,
 255                                         SilcSocketConnection sock,
 256                                         SilcBuffer message);
 257 void silc_client_error_by_server(SilcClient client,
 258                                  SilcSocketConnection sock,
 259                                  SilcBuffer message);
 260 void silc_client_receive_new_id(SilcClient client,
 261                                 SilcSocketConnection sock,
 262                                 SilcIDPayload idp);
 263 SilcChannelEntry silc_client_new_channel_id(SilcClient client,
 264                                             SilcSocketConnection sock,
 265                                             char *channel_name,
 266                                             uint32 mode,
 267                                             SilcIDPayload idp);
 268 void silc_client_save_channel_key(SilcClientConnection conn,
 269                                   SilcBuffer key_payload,
 270                                   SilcChannelEntry channel);
 271 void silc_client_receive_channel_key(SilcClient client,
 272                                      SilcSocketConnection sock,
 273                                      SilcBuffer packet);
 274 void silc_client_channel_message(SilcClient client,
 275                                  SilcSocketConnection sock,
 276                                  SilcPacketContext *packet);
 277 void silc_client_remove_from_channels(SilcClient client,
 278                                       SilcClientConnection conn,
 279                                       SilcClientEntry client_entry);
 280 void silc_client_replace_from_channels(SilcClient client,
 281                                        SilcClientConnection conn,
 282                                        SilcClientEntry old,
 283                                        SilcClientEntry new);
 284 void silc_client_process_failure(SilcClient client,
 285                                  SilcSocketConnection sock,
 286                                  SilcPacketContext *packet);
 287 void silc_client_key_agreement(SilcClient client,
 288                                SilcSocketConnection sock,
 289                                SilcPacketContext *packet);
 290 void silc_client_notify_by_server(SilcClient client,
 291                                   SilcSocketConnection sock,
 292                                   SilcPacketContext *packet);
 293 void silc_client_private_message(SilcClient client,
 294                                  SilcSocketConnection sock,
 295                                  SilcPacketContext *packet);
 296
 297 #endif