lib/silcclient/idlist.h

   1 /*
   2
   3   idlist.h
   4
   5   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
   6
   7   Copyright (C) 1997 - 2000 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 IDLIST_H
  22 #define IDLIST_H
  23
  24 /* Client entry context. When client receives information about new client
  25    (it receives its ID, for example, by IDENTIFY request) we create new
  26    client entry. This entry also includes the private message keys if
  27    they are used. */
  28 typedef struct SilcClientEntryStruct {
  29   char *nickname;               /* nickname */
  30   char *username;               /* username[@host] */
  31   char *server;                 /* SILC server name */
  32   char *realname;               /* Realname (userinfo) */
  33   unsigned int num;
  34   SilcClientID *id;             /* The Client ID */
  35   SilcCipher send_key;          /* Private message key for sending */
  36   SilcCipher receive_key;       /* Private message key for receiving */
  37   unsigned char *key;           /* Set only if appliation provided the
  38                                    key material. NULL if the library
  39                                    generated the key. */
  40   unsigned int key_len;
  41   int generated;                /* TRUE if library generated the key */
  42   SilcClientKeyAgreement ke;    /* Current key agreement context or NULL */
  43 } *SilcClientEntry;
  44
  45 /* Client and its mode on a channel */
  46 typedef struct SilcChannelUserStruct {
  47   SilcClientEntry client;
  48   unsigned int mode;
  49   struct SilcChannelUserStruct *next;
  50 } *SilcChannelUser;
  51
  52 /* Channel entry context. This is allocate for every channel client has
  53    joined to. This includes for example the channel specific keys */
  54 /* XXX channel_key is the server generated key. Later this context must
  55    include the channel private key. */
  56 typedef struct SilcChannelEntryStruct {
  57   char *channel_name;
  58   SilcChannelID *id;
  59   unsigned int mode;
  60   int on_channel;
  61
  62   /* Joined clients */
  63   SilcList clients;
  64
  65   /* Channel keys */
  66   SilcCipher channel_key;
  67   unsigned char *key;
  68   unsigned int key_len;
  69   unsigned char iv[SILC_CIPHER_MAX_IV_SIZE];
  70   SilcHmac hmac;
  71 } *SilcChannelEntry;
  72
  73 /* Prototypes (some functions are defined in the silcapi.h) */
  74
  75 SilcClientEntry silc_idlist_get_client(SilcClient client,
  76                                        SilcClientConnection conn,
  77                                        char *nickname,
  78                                        char *server,
  79                                        unsigned int num,
  80                                        int query);
  81
  82 #endif