lib/silcclient/client.h

   1 /*
   2
   3   client.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 2007 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_H
  21 #define CLIENT_H
  22
  23 #ifndef SILCCLIENT_H
  24 #error "Do not include this header directly"
  25 #endif
  26
  27 /* Forward declarations */
  28 typedef struct SilcClientStruct *SilcClient;
  29 typedef struct SilcClientConnectionStruct *SilcClientConnection;
  30 typedef struct SilcClientEntryStruct *SilcClientEntry;
  31 typedef struct SilcChannelEntryStruct *SilcChannelEntry;
  32 typedef struct SilcServerEntryStruct *SilcServerEntry;
  33
  34 typedef struct SilcClientKeyAgreementStruct *SilcClientKeyAgreement;
  35 typedef struct SilcClientFtpSessionStruct *SilcClientFtpSession;
  36 typedef struct SilcClientCommandReplyContextStruct
  37                                            *SilcClientCommandReplyContext;
  38 typedef struct SilcChannelUserStruct *SilcChannelUser;
  39 typedef struct SilcClientInternalStruct *SilcClientInternal;
  40 typedef struct SilcClientConnectionInternalStruct
  41      *SilcClientConnectionInternal;
  42 typedef struct SilcChannelPrivateKeyStruct *SilcChannelPrivateKey;
  43
  44 /* Internal client entry context */
  45 typedef struct SilcClientEntryInternalStruct {
  46   void *prv_waiter;             /* Private message packet waiter */
  47   SilcRwLock lock;              /* Read/write lock */
  48   SilcCipher send_key;          /* Private message key for sending */
  49   SilcCipher receive_key;       /* Private message key for receiving */
  50   SilcHmac hmac_send;           /* Private mesage key HMAC for sending */
  51   SilcHmac hmac_receive;        /* Private mesage key HMAC for receiving */
  52   unsigned char *key;           /* Valid if application provided the key */
  53   SilcUInt32 key_len;           /* Key data length */
  54   SilcClientKeyAgreement ke;    /* Current key agreement context or NULL */
  55
  56   SilcAtomic32 refcnt;          /* Reference counter */
  57   SilcAtomic32 deleted;         /* Flag indicating whether the client object is
  58                                    already scheduled for deletion */
  59   SilcUInt16 resolve_cmd_ident; /* Command identifier when resolving */
  60
  61   /* Flags */
  62   unsigned int valid       : 1; /* FALSE if this entry is not valid.  Entry
  63                                    without nickname is not valid. */
  64   unsigned int generated   : 1; /* TRUE if library generated `key' */
  65   unsigned int prv_resp    : 1; /* TRUE if we are responder when using
  66                                    private message keys. */
  67 } SilcClientEntryInternal;
  68
  69 /* Internal channel entry context */
  70 typedef struct SilcChannelEntryInternalStruct {
  71   SilcRwLock lock;                           /* Read/write lock */
  72
  73   /* SilcChannelEntry status information */
  74   SilcDList old_channel_keys;
  75   SilcDList old_hmacs;
  76
  77   /* Channel private keys */
  78   SilcDList private_keys;                    /* List of private keys or NULL */
  79   SilcChannelPrivateKey curr_key;            /* Current private key */
  80
  81   /* Channel keys */
  82   SilcCipher send_key;                       /* The channel key */
  83   SilcCipher receive_key;                    /* The channel key */
  84   SilcHmac hmac;                             /* Current HMAC */
  85   unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]; /* Current IV */
  86
  87   SilcAtomic32 refcnt;                       /* Reference counter */
  88   SilcAtomic32 deleted;                      /* Flag indicating whether the
  89                                                 channel object is already
  90                                                 scheduled for deletion */
  91   SilcUInt16 resolve_cmd_ident;              /* Channel information resolving
  92                                                 identifier. This is used when
  93                                                 resolving users, and other
  94                                                 stuff that relates to the
  95                                                 channel. Not used for the
  96                                                 channel resolving itself. */
  97 } SilcChannelEntryInternal;
  98
  99 /* Internal server entry context */
 100 typedef struct SilcServerEntryInternalStruct {
 101   SilcRwLock lock;                           /* Read/write lock */
 102   SilcUInt16 resolve_cmd_ident;              /* Resolving identifier */
 103   SilcAtomic32 refcnt;                       /* Reference counter */
 104 } SilcServerEntryInternal;
 105
 106 #endif /* CLIENT_H */