lib/silcclient/silcclient.h

   1 /*
   2
   3   silcclient.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2000 - 2003 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 /****h* silcclient/Client Library Interface
  21  *
  22  * DESCRIPTION
  23  *
  24  * This interface defines the SILC Client Library API for the application.
  25  * The client operations are defined first.  These are callback functions that
  26  * the application MUST implement since the library may call the functions
  27  * at any time.  At the end of file is the API for the application that
  28  * it can use from the library.  This is the only file that the application
  29  * may include from the SIlC Client Library.
  30  *
  31  * o SILC Client Operations
  32  *
  33  *   These functions must be implemented by the application calling the SILC
  34  *   client library. The client library can call these functions at any time.
  35  *
  36  *   To use this structure: define a static SilcClientOperations variable,
  37  *   fill it and pass its pointer to silc_client_alloc function.
  38  *
  39  * o SILC Client Library API
  40  *
  41  *   This is the API that is published by the SILC Client Library for the
  42  *   applications.  These functions are implemented in the SILC Client Library.
  43  *   Application may freely call these functions from the library.
  44  *
  45  * Please, refer to the README file in this directory for the directions
  46  * of how to use the SILC Client Library.
  47  *
  48  ***/
  49
  50 #ifndef SILCCLIENT_H
  51 #define SILCCLIENT_H
  52
  53 #ifdef __cplusplus
  54 extern "C" {
  55 #endif
  56
  57 #include "client.h"
  58
  59 /* General definitions */
  60
  61 /****s* silcclient/SilcClientAPI/SilcClient
  62  *
  63  * NAME
  64  *
  65  *    typedef struct SilcClientStruct { ... } *SilcClient
  66  *
  67  * DESCRIPTION
  68  *
  69  *    This is the actual SILC Client structure which represents one
  70  *    SILC Client.  It is allocated with the silc_client_alloc function
  71  *    and given as argument to all SILC Client Library functions.  It
  72  *    is initialized with silc_client_init function, and freed with
  73  *    silc_client_free function.
  74  *
  75  * SOURCE
  76  */
  77 struct SilcClientStruct {
  78   /*
  79    * The following fields are set by application
  80    */
  81   char *nickname;               /* Nickname, MAY be set by application  */
  82   char *username;               /* Username, MUST be set by application */
  83   char *hostname;               /* hostname, MUST be set by application */
  84   char *realname;               /* Real name, MUST be set be application */
  85
  86   SilcPublicKey public_key;     /* Public key of user, set by application */
  87   SilcPrivateKey private_key;   /* Private key of user, set by application */
  88   SilcPKCS pkcs;                /* PKCS allocated by application */
  89
  90   /*
  91    * The following fields are set by the library
  92    */
  93
  94   /* Scheduler, set by library.  Application may use this pointer. */
  95   SilcSchedule schedule;
  96
  97   /* Random Number Generator. Application should use this as its primary
  98      random number generator. */
  99   SilcRng rng;
 100
 101   /* Application specific user data pointer. Client library does not
 102      touch this.  This the context sent as argument to silc_client_alloc.
 103      Application can use it freely. */
 104   void *application;
 105
 106   /* Generic hash context for application usage */
 107   SilcHash md5hash;
 108   SilcHash sha1hash;
 109
 110   /* Internal data for client library. Application cannot access this
 111      data at all. */
 112   SilcClientInternal internal;
 113 };
 114 /***/
 115
 116 /****s* silcclient/SilcClientAPI/SilcClientConnection
 117  *
 118  * NAME
 119  *
 120  *    typedef struct SilcClientConnectionStruct { ... }
 121  *                      *SilcClientConnection
 122  *
 123  * DESCRIPTION
 124  *
 125  *    This structure represents a connection.  When connection is created
 126  *    to server this is context is returned to the application in the
 127  *    "connected" client operation.  It includes all the important
 128  *    data for the session, such as nickname, local and remote IDs, and
 129  *    other information.
 130  *
 131  * SOURCE
 132  */
 133 struct SilcClientConnectionStruct {
 134   /*
 135    * Local data
 136    */
 137   char *nickname;                 /* Current nickname */
 138   SilcClientEntry local_entry;    /* Own Client Entry */
 139   SilcClientID *local_id;         /* Current Client ID */
 140   unsigned char *local_id_data;   /* Current Client ID decoded */
 141   SilcUInt32 local_id_data_len;
 142
 143   /*
 144    * Remote data
 145    */
 146   char *remote_host;              /* Remote host name */
 147   int remote_port;                /* Remote port */
 148   SilcServerID *remote_id;        /* Remote Server ID */
 149   unsigned char *remote_id_data;  /* Remote Server ID decoded */
 150   SilcUInt32 remote_id_data_len;
 151
 152   /*
 153    * Common data
 154    */
 155
 156   /* Current command identifier for a command that was sent last.
 157      Application may get the value from this variable to find out the
 158      command identifier for last command. */
 159   SilcUInt16 cmd_ident;
 160
 161   /* User data context. Library does not touch this. Application may
 162      freely set and use this pointer for its needs. */
 163   void *context;
 164
 165   /* Pointer back to the SilcClient.  Application may use this. */
 166   SilcClient client;
 167
 168   /* Current channel.  Application may use and set this pointer if needed. */
 169   SilcChannelEntry current_channel;
 170
 171   /* Socket connection object for this connection.  Application may
 172      use this if needed.  The sock->user_data is back pointer to this
 173      structure. */
 174   SilcSocketConnection sock;
 175
 176   /* Internal data for client library. Application cannot access this
 177      data at all. */
 178   SilcClientConnectionInternal internal;
 179 };
 180 /***/
 181
 182 /****s* silcclient/SilcClientAPI/SilcClientEntry
 183  *
 184  * NAME
 185  *
 186  *    typedef struct SilcClientEntryStruct { ... } *SilcClientEntry
 187  *
 188  * DESCRIPTION
 189  *
 190  *    This structure represents a client or a user in the SILC network.
 191  *    The local user has this structure also and it can be accessed from
 192  *    SilcClientConnection structure.  All other users in the SILC network
 193  *    that are accessed using the Client Library routines will have their
 194  *    own SilcClientEntry structure.  For example, when finding users by
 195  *    their nickname the Client Library returns this structure back to
 196  *    the application.
 197  *
 198  * SOURCE
 199  */
 200 struct SilcClientEntryStruct {
 201   /* General information */
 202   char *nickname;               /* nickname */
 203   char *username;               /* username */
 204   char *hostname;               /* hostname */
 205   char *server;                 /* SILC server name */
 206   char *realname;               /* Realname (userinfo) */
 207
 208   /* Mode, ID and other information */
 209   SilcUInt32 mode;              /* User mode in SILC */
 210   SilcClientID *id;             /* The Client ID */
 211   SilcDList attrs;              /* Requested Attributes (maybe NULL) */
 212   unsigned char *fingerprint;   /* Fingerprint of client's public key */
 213   SilcUInt32 fingerprint_len;   /* Length of the fingerprint */
 214
 215   /* Private message keys */
 216   SilcCipher send_key;          /* Private message key for sending */
 217   SilcCipher receive_key;       /* Private message key for receiving */
 218   SilcHmac hmac_send;           /* Private mesage key HMAC for sending */
 219   SilcHmac hmac_receive;        /* Private mesage key HMAC for receiving */
 220   unsigned char *key;           /* Set only if application provided the
 221                                    key material. NULL if the library
 222                                    generated the key. */
 223   SilcUInt32 key_len;           /* Key length */
 224   SilcClientKeyAgreement ke;    /* Current key agreement context or NULL */
 225
 226   /* SilcClientEntry status information */
 227   SilcEntryStatus status;       /* Status mask */
 228   SilcHashTable channels;       /* All channels client has joined */
 229   SilcUInt16 resolve_cmd_ident; /* Command identifier when resolving */
 230   bool generated;               /* TRUE if library generated `key' */
 231   bool valid;                   /* FALSE if this entry is not valid */
 232 };
 233 /***/
 234
 235 /****s* silcclient/SilcClientAPI/SilcChannelEntry
 236  *
 237  * NAME
 238  *
 239  *    typedef struct SilcChannelEntryStruct { ... } *SilcChannelEntry
 240  *
 241  * DESCRIPTION
 242  *
 243  *    This structure represents a channel in the SILC network.  All
 244  *    channels that the client are aware of or have joined in will be
 245  *    represented as SilcChannelEntry.  The structure includes information
 246  *    about the channel.
 247  *
 248  * SOURCE
 249  */
 250 struct SilcChannelEntryStruct {
 251   /* General information */
 252   char *channel_name;                        /* Channel name */
 253   SilcChannelID *id;                         /* Channel ID */
 254   SilcUInt32 mode;                           /* Channel mode */
 255
 256   /* All clients that has joined this channel */
 257   SilcHashTable user_list;
 258
 259   /* Channel keys */
 260   SilcCipher channel_key;                    /* The channel key */
 261   unsigned char *key;                        /* Raw key data */
 262   SilcUInt32 key_len;                        /* Raw key data length */
 263   unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]; /* Current IV */
 264   SilcHmac hmac;                             /* Current HMAC */
 265
 266   /* Channel private keys */
 267   SilcDList private_keys;                    /* List of private keys or NULL */
 268   SilcChannelPrivateKey curr_key;            /* Current private key */
 269
 270   /* SilcChannelEntry status information */
 271   SilcCipher old_channel_key;
 272   SilcHmac old_hmac;
 273   SilcTask rekey_task;
 274   SilcUInt16 resolve_cmd_ident;              /* Command identifier when
 275                                                 resolving this entry */
 276 };
 277 /***/
 278
 279 /****s* silcclient/SilcClientAPI/SilcServerEntry
 280  *
 281  * NAME
 282  *
 283  *    typedef struct SilcServerEntryStruct { ... } *SilcServerEntry
 284  *
 285  * DESCRIPTION
 286  *
 287  *    This structure represents a server in the SILC network.  All servers
 288  *    that the client is aware of and have for example resolved with
 289  *    SILC_COMMAND_INFO command have their on SilcServerEntry structure.
 290  *
 291  * SOURCE
 292  */
 293 struct SilcServerEntryStruct {
 294   /* General information */
 295   char *server_name;                         /* Server name */
 296   char *server_info;                         /* Server info */
 297   SilcServerID *server_id;                   /* Server ID */
 298   SilcUInt16 resolve_cmd_ident;              /* Command identifier when
 299                                                 resolving this entry */
 300 };
 301 /***/
 302
 303 /****d* silcclient/SilcClientAPI/SilcKeyAgreementStatus
 304  *
 305  * NAME
 306  *
 307  *    typedef enum { ... } SilcKeyAgreementStatus;
 308  *
 309  * DESCRIPTION
 310  *
 311  *    Key agreement status types indicating the status of the key
 312  *    agreement protocol.  These types are returned to the application
 313  *    in the SilcKeyAgreementCallback callback function.
 314  *
 315  * SOURCE
 316  */
 317 typedef enum {
 318   SILC_KEY_AGREEMENT_OK,               /* Everything is Ok */
 319   SILC_KEY_AGREEMENT_ERROR,            /* Unknown error occurred */
 320   SILC_KEY_AGREEMENT_FAILURE,          /* The protocol failed */
 321   SILC_KEY_AGREEMENT_TIMEOUT,          /* The protocol timeout */
 322   SILC_KEY_AGREEMENT_ABORTED,          /* The protocol aborted */
 323   SILC_KEY_AGREEMENT_ALREADY_STARTED,  /* Already started */
 324   SILC_KEY_AGREEMENT_SELF_DENIED,      /* Negotiationg with itself denied */
 325 } SilcKeyAgreementStatus;
 326 /***/
 327
 328 /****f* silcclient/SilcClientAPI/SilcKeyAgreementCallback
 329  *
 330  * SYNOPSIS
 331  *
 332  *    typedef void (*SilcKeyAgreementCallback)(SilcClient client,
 333  *                                             SilcClientConnection conn,
 334  *                                             SilcClientEntry client_entry,
 335  *                                             SilcKeyAgreementStatus status,
 336  *                                             SilcSKEKeyMaterial *key,
 337  *                                             void *context);
 338  *
 339  * DESCRIPTION
 340  *
 341  *    Key agreement callback that is called after the key agreement protocol
 342  *    has been performed. This is called also if error occurred during the
 343  *    key agreement protocol. The `key' is the allocated key material and
 344  *    the caller is responsible of freeing it. The `key' is NULL if error
 345  *    has occurred. The application can freely use the `key' to whatever
 346  *    purpose it needs. See lib/silcske/silcske.h for the definition of
 347  *    the SilcSKEKeyMaterial structure.
 348  *
 349  ***/
 350 typedef void (*SilcKeyAgreementCallback)(SilcClient client,
 351                                          SilcClientConnection conn,
 352                                          SilcClientEntry client_entry,
 353                                          SilcKeyAgreementStatus status,
 354                                          SilcSKEKeyMaterial *key,
 355                                          void *context);
 356
 357 /****s* silcclient/SilcClientAPI/SilcPrivateMessageKeys
 358  *
 359  * NAME
 360  *
 361  *    typedef struct { ... } SilcPrivateMessageKeys;
 362  *
 363  * DESCRIPTION
 364  *
 365  *    Structure to hold the list of private message keys. The array of this
 366  *    structure is returned by the silc_client_list_private_message_keys
 367  *    function.
 368  *
 369  * SOURCE
 370  */
 371 typedef struct {
 372   SilcClientEntry client_entry;       /* The remote client entry */
 373   char *cipher;                       /* The cipher name */
 374   unsigned char *key;                 /* The original key, If the appliation
 375                                          provided it. This is NULL if the
 376                                          library generated the key or if
 377                                          the SKE key material was used. */
 378   SilcUInt32 key_len;                 /* The key length */
 379 } *SilcPrivateMessageKeys;
 380 /***/
 381
 382 /****s* silcclient/SilcClientAPI/SilcChannelPrivateKey
 383  *
 384  * NAME
 385  *
 386  *    typedef struct SilcChannelPrivateKeyStruct { ... }
 387  *                      *SilcChannelPrivateKey;
 388  *
 389  * DESCRIPTION
 390  *
 391  *    Structure to hold one channel private key. The array of this structure
 392  *    is returned by silc_client_list_channel_private_keys function.
 393  *
 394  * SOURCE
 395  */
 396 struct SilcChannelPrivateKeyStruct {
 397   char *name;                         /* Application given name */
 398   SilcCipher cipher;                  /* The cipher and key */
 399   SilcHmac hmac;                      /* The HMAC and hmac key */
 400   unsigned char *key;                 /* The key data */
 401   SilcUInt32 key_len;                 /* The key length */
 402 };
 403 /***/
 404
 405 /****f* silcclient/SilcClientAPI/SilcAskPassphrase
 406  *
 407  * SYNOPSIS
 408  *
 409  *    typedef void (*SilcAskPassphrase)(unsigned char *passphrase,
 410  *                                      SilcUInt32 passphrase_len,
 411  *                                      void *context);
 412  *
 413  * DESCRIPTION
 414  *
 415  *    Ask passphrase callback. This is called by the application when the
 416  *    library calls `ask_passphrase' client operation.  The callback delivers
 417  *    the passphrase to the library.  The passphrases in SILC protocol
 418  *    MUST be in UTF-8 encoding, therefore the `passphrase' SHOULD be UTF-8
 419  *    encoded, and if it is not then library will attempt to encode it.
 420  *
 421  ***/
 422 typedef void (*SilcAskPassphrase)(unsigned char *passphrase,
 423                                   SilcUInt32 passphrase_len,
 424                                   void *context);
 425
 426 /****f* silcclient/SilcClientAPI/SilcVerifyPublicKey
 427  *
 428  * SYNOPSIS
 429  *
 430  *    typedef void (*SilcVerifyPublicKey)(bool success, void *context);
 431  *
 432  * DESCRIPTION
 433  *
 434  *    Public key (or certificate) verification callback. This is called
 435  *    by the application to indicate that the public key verification was
 436  *    either success or failure.
 437  *
 438  ***/
 439 typedef void (*SilcVerifyPublicKey)(bool success, void *context);
 440
 441 /****f* silcclient/SilcClientAPI/SilcGetAuthMeth
 442  *
 443  * SYNOPSIS
 444  *
 445  *    typedef void (*SilcGetAuthMeth)(bool success,
 446  *                                    SilcProtocolAuthMeth auth_meth,
 447  *                                    const unsigned char *auth_data,
 448  *                                    SilcUInt32 auth_data_len, void *context);
 449  *
 450  * DESCRIPTION
 451  *
 452  *    Authentication method resolving callback. This is called by the
 453  *    application to return the resolved authentication method. The client
 454  *    library has called the get_auth_method client operation and given
 455  *    this function pointer as argument. The `success' will indicate whether
 456  *    the authentication method could be resolved. The `auth_meth' is the
 457  *    resolved authentication method. The `auth_data' and the `auth_data_len'
 458  *    are the resolved authentication data. The `context' is the libary's
 459  *    context sent to the get_auth_method client operation.
 460  *
 461  ***/
 462 typedef void (*SilcGetAuthMeth)(bool success,
 463                                 SilcProtocolAuthMeth auth_meth,
 464                                 const unsigned char *auth_data,
 465                                 SilcUInt32 auth_data_len, void *context);
 466
 467 /****d* silcclient/SilcClientAPI/SilcClientMessageType
 468  *
 469  * NAME
 470  *
 471  *    typedef enum { ... } SilcClientMessageType;
 472  *
 473  * DESCRIPTION
 474  *
 475  *    Different message types for `say' client operation.  The application
 476  *    may filter the message sent by the library according this type.
 477  *
 478  * SOURCE
 479  */
 480 typedef enum {
 481   SILC_CLIENT_MESSAGE_INFO,            /* Informational */
 482   SILC_CLIENT_MESSAGE_WARNING,         /* Warning */
 483   SILC_CLIENT_MESSAGE_ERROR,           /* Error */
 484   SILC_CLIENT_MESSAGE_AUDIT,           /* Auditable */
 485 } SilcClientMessageType;
 486 /***/
 487
 488 /****d* silcclient/SilcClientAPI/SilcClientConnectionStatus
 489  *
 490  * NAME
 491  *
 492  *    typedef enum { ... } SilcClientConnectionStatus
 493  *
 494  * DESCRIPTION
 495  *
 496  *    This type is returned to the `connect' client operation to indicate
 497  *    the status of the created connection.  It can indicated if it was
 498  *    successful or whether an error occurred.
 499  *
 500  * SOURCE
 501  */
 502 typedef enum {
 503   SILC_CLIENT_CONN_SUCCESS,            /* Successfully connected */
 504   SILC_CLIENT_CONN_SUCCESS_RESUME,     /* Successfully connected and
 505                                           resumed old detached session */
 506   SILC_CLIENT_CONN_ERROR,              /* Error occurred during connecting */
 507 } SilcClientConnectionStatus;
 508 /***/
 509
 510 /****s* silcclient/SilcClientAPI/SilcClientOperations
 511  *
 512  * NAME
 513  *
 514  *    typedef struct { ... } SilcClientOperations;
 515  *
 516  * DESCRIPTION
 517  *
 518  *    SILC Client Operations. These must be implemented by the application.
 519  *    The Client library may call any of these routines at any time.  The
 520  *    routines are used to deliver certain information to the application
 521  *    or from the application to the client library.
 522  *
 523  * SOURCE
 524  */
 525 typedef struct {
 526   /* Message sent to the application by library. `conn' associates the
 527      message to a specific connection.  `conn', however, may be NULL.
 528      The `type' indicates the type of the message sent by the library.
 529      The application can for example filter the message according the
 530      type.  The variable argument list is arguments to the formatted
 531      message that `msg' may be. */
 532   void (*say)(SilcClient client, SilcClientConnection conn,
 533               SilcClientMessageType type, char *msg, ...);
 534
 535   /* Message for a channel. The `sender' is the sender of the message
 536      The `channel' is the channel. The `message' is the message.  Note
 537      that `message' maybe NULL.  The `flags' indicates message flags
 538      and it is used to determine how the message can be interpreted
 539      (like it may tell the message is multimedia message). */
 540   void (*channel_message)(SilcClient client, SilcClientConnection conn,
 541                           SilcClientEntry sender, SilcChannelEntry channel,
 542                           SilcMessagePayload payload, SilcMessageFlags flags,
 543                           const unsigned char *message,
 544                           SilcUInt32 message_len);
 545
 546   /* Private message to the client. The `sender' is the sender of the
 547      message. The message is `message'and maybe NULL.  The `flags'
 548      indicates message flags  and it is used to determine how the message
 549      can be interpreted (like it may tell the message is multimedia
 550      message). */
 551   void (*private_message)(SilcClient client, SilcClientConnection conn,
 552                           SilcClientEntry sender, SilcMessagePayload payload,
 553                           SilcMessageFlags flags,
 554                           const unsigned char *message,
 555                           SilcUInt32 message_len);
 556
 557   /* Notify message to the client. The notify arguments are sent in the
 558      same order as servers sends them. The arguments are same as received
 559      from the server except for ID's.  If ID is received application receives
 560      the corresponding entry to the ID. For example, if Client ID is received
 561      application receives SilcClientEntry.  Also, if the notify type is
 562      for channel the channel entry is sent to application (even if server
 563      does not send it because client library gets the channel entry from
 564      the Channel ID in the packet's header). */
 565   void (*notify)(SilcClient client, SilcClientConnection conn,
 566                  SilcNotifyType type, ...);
 567
 568   /* Command handler. This function is called always in the command function.
 569      If error occurs it will be called as well. `conn' is the associated
 570      client connection. `cmd_context' is the command context that was
 571      originally sent to the command. `success' is FALSE if error occurred
 572      during command. `command' is the command being processed. It must be
 573      noted that this is not reply from server. This is merely called just
 574      after application has called the command. Just to tell application
 575      that the command really was processed. */
 576   void (*command)(SilcClient client, SilcClientConnection conn,
 577                   SilcClientCommandContext cmd_context, bool success,
 578                   SilcCommand command, SilcStatus status);
 579
 580   /* Command reply handler. This function is called always in the command reply
 581      function. If error occurs it will be called as well. Normal scenario
 582      is that it will be called after the received command data has been parsed
 583      and processed. The function is used to pass the received command data to
 584      the application.
 585
 586      `conn' is the associated client connection. `cmd_payload' is the command
 587      payload data received from server and it can be ignored. It is provided
 588      if the application would like to re-parse the received command data,
 589      however, it must be noted that the data is parsed already by the library
 590      thus the payload can be ignored. `success' is FALSE if error occurred.
 591      In this case arguments are not sent to the application. The `status' is
 592      the command reply status server returned. The `command' is the command
 593      reply being processed. The function has variable argument list and each
 594      command defines the number and type of arguments it passes to the
 595      application (on error they are not sent).
 596
 597      The arguments are sent in the same order as servers sends them.  The
 598      arguments are same as received from the server except for ID's.  If
 599      ID is received application receives the corresponding entry to the
 600      ID. For example, if Client ID is receives application receives
 601      SilcClientEntry. */
 602   void (*command_reply)(SilcClient client, SilcClientConnection conn,
 603                         SilcCommandPayload cmd_payload, bool success,
 604                         SilcCommand command, SilcStatus status, ...);
 605
 606   /* Called to indicate that connection was either successfully established
 607      or connecting failed.  This is also the first time application receives
 608      the SilcClientConnection object which it should save somewhere.
 609      The `status' indicated whether the connection were successful.  If it
 610      is error value the application must always call the function
 611      silc_client_close_connection. */
 612   void (*connected)(SilcClient client, SilcClientConnection conn,
 613                     SilcClientConnectionStatus status);
 614
 615   /* Called to indicate that connection was disconnected to the server.
 616      The `status' may tell the reason of the disconnection, and if the
 617      `message' is non-NULL it may include the disconnection message
 618      received from server. */
 619   void (*disconnected)(SilcClient client, SilcClientConnection conn,
 620                        SilcStatus status, const char *message);
 621
 622   /* Find authentication method and authentication data by hostname and
 623      port. The hostname may be IP address as well. When the authentication
 624      method has been resolved the `completion' callback with the found
 625      authentication method and authentication data is called. The `conn'
 626      may be NULL. */
 627   void (*get_auth_method)(SilcClient client, SilcClientConnection conn,
 628                           char *hostname, SilcUInt16 port,
 629                           SilcGetAuthMeth completion, void *context);
 630
 631   /* Verifies received public key. The `conn_type' indicates which entity
 632      (server, client etc.) has sent the public key. If user decides to trust
 633      the application may save the key as trusted public key for later
 634      use. The `completion' must be called after the public key has been
 635      verified. */
 636   void (*verify_public_key)(SilcClient client, SilcClientConnection conn,
 637                             SilcSocketType conn_type, unsigned char *pk,
 638                             SilcUInt32 pk_len, SilcSKEPKType pk_type,
 639                             SilcVerifyPublicKey completion, void *context);
 640
 641   /* Ask (interact, that is) a passphrase from user. The passphrase is
 642      returned to the library by calling the `completion' callback with
 643      the `context'. The returned passphrase SHOULD be in UTF-8 encoded,
 644      if not then the library will attempt to encode. */
 645   void (*ask_passphrase)(SilcClient client, SilcClientConnection conn,
 646                          SilcAskPassphrase completion, void *context);
 647
 648   /* Notifies application that failure packet was received.  This is called
 649      if there is some protocol active in the client.  The `protocol' is the
 650      protocol context.  The `failure' is opaque pointer to the failure
 651      indication.  Note, that the `failure' is protocol dependant and
 652      application must explicitly cast it to correct type.  Usually `failure'
 653      is 32 bit failure type (see protocol specs for all protocol failure
 654      types). */
 655   void (*failure)(SilcClient client, SilcClientConnection conn,
 656                   SilcProtocol protocol, void *failure);
 657
 658   /* Asks whether the user would like to perform the key agreement protocol.
 659      This is called after we have received an key agreement packet or an
 660      reply to our key agreement packet. This returns TRUE if the user wants
 661      the library to perform the key agreement protocol and FALSE if it is not
 662      desired (application may start it later by calling the function
 663      silc_client_perform_key_agreement). If TRUE is returned also the
 664      `completion' and `context' arguments must be set by the application. */
 665   bool (*key_agreement)(SilcClient client, SilcClientConnection conn,
 666                         SilcClientEntry client_entry, const char *hostname,
 667                         SilcUInt16 port, SilcKeyAgreementCallback *completion,
 668                         void **context);
 669
 670   /* Notifies application that file transfer protocol session is being
 671      requested by the remote client indicated by the `client_entry' from
 672      the `hostname' and `port'. The `session_id' is the file transfer
 673      session and it can be used to either accept or reject the file
 674      transfer request, by calling the silc_client_file_receive or
 675      silc_client_file_close, respectively. */
 676   void (*ftp)(SilcClient client, SilcClientConnection conn,
 677               SilcClientEntry client_entry, SilcUInt32 session_id,
 678               const char *hostname, SilcUInt16 port);
 679
 680   /* Delivers SILC session detachment data indicated by `detach_data' to the
 681      application.  If application has issued SILC_COMMAND_DETACH command
 682      the client session in the SILC network is not quit.  The client remains
 683      in the network but is detached.  The detachment data may be used later
 684      to resume the session in the SILC Network.  The appliation is
 685      responsible of saving the `detach_data', to for example in a file.
 686
 687      The detachment data can be given as argument to the functions
 688      silc_client_connect_to_server, or silc_client_add_connection when
 689      creating connection to remote server, inside SilcClientConnectionParams
 690      structure.  If it is provided the client library will attempt to resume
 691      the session in the network.  After the connection is created
 692      successfully, the application is responsible of setting the user
 693      interface for user into the same state it was before detaching (showing
 694      same channels, channel modes, etc).  It can do this by fetching the
 695      information (like joined channels) from the client library. */
 696   void (*detach)(SilcClient client, SilcClientConnection conn,
 697                  const unsigned char *detach_data,
 698                  SilcUInt32 detach_data_len);
 699 } SilcClientOperations;
 700 /***/
 701
 702 /****f* silcclient/SilcClientAPI/SilcNicknameFormatParse
 703  *
 704  * SYNOPSIS
 705  *
 706  *    typedef void (*SilcNicknameFormatParse)(const char *nickname,
 707  *                                            char **ret_nickname);
 708  *
 709  * DESCRIPTION
 710  *
 711  *    A callback function provided by the application for the library in
 712  *    SilcClientParams structure. This function parses the formatted
 713  *    nickname string `nickname' and returns the true nickname to the
 714  *    `ret_nickname' pointer. The library can call this function at
 715  *    any time.
 716  *
 717  ***/
 718 typedef void (*SilcNicknameFormatParse)(const char *nickname,
 719                                         char **ret_nickname);
 720
 721 /****s* silcclient/SilcClientAPI/SilcClientParams
 722  *
 723  * NAME
 724  *
 725  *    typedef struct { ... } SilcClientParams;
 726  *
 727  * DESCRIPTION
 728  *
 729  *    Client parameters. This can be filled with proper values and
 730  *    given as argument to the silc_client_alloc function. The structure
 731  *    hold various parameters which affects the function of the client.
 732  *
 733  * SOURCE
 734  */
 735 typedef struct {
 736   /* Number of maximum tasks the client library's scheduler can handle.
 737      If set to zero, the default value will be used (200). For WIN32
 738      systems this should be set to 64 as it is the hard limit dictated
 739      by the WIN32. */
 740   int task_max;
 741
 742   /* Rekey timeout in seconds. The client will perform rekey in this
 743      time interval. If set to zero, the default value will be used. */
 744   unsigned int rekey_secs;
 745
 746   /* Connection authentication method request timeout. If server does not
 747      reply back the current authentication method when we've requested it
 748      in this time interval we'll assume the reply will not come at all.
 749      If set to zero, the default value (2 seconds) will be used. */
 750   unsigned int connauth_request_secs;
 751
 752   /* Nickname format string. This can be used to order the client library
 753      to save the nicknames in the library in a certain format. Since
 754      nicknames are not unique in SILC it is possible to have multiple same
 755      nicknames. Using this format string it is possible to order the library
 756      to separate the multiple same nicknames from each other. The format
 757      types are defined below and they can appear in any order in the format
 758      string. If this is NULL then default format is used which is the
 759      default nickname without anything else. The string MUST be NULL
 760      terminated.
 761
 762      Following format types are available:
 763
 764      %n  nickname      - the real nickname returned by the server (mandatory)
 765      %h  hostname      - the stripped hostname of the client
 766      %H  full hostname - the full hostname of the client
 767      %s  server name   - the server name the client is connected
 768      %S  full server   - the full server name the client is connected
 769      %a  number        - ascending number in case there are several
 770                          same nicknames (fe. nick@host and nick@host2)
 771
 772      Example format strings: "%n@%h%a"   (fe. nick@host, nick@host2)
 773                              "%a!%n@%s"  (fe. nick@server, 2!nick@server)
 774                              "%n@%H"     (fe. nick@host.domain.com)
 775
 776      By default this format is employed to the nicknames by the libary
 777      only when there appears multiple same nicknames. If the library has
 778      only one nickname cached the nickname is saved as is and without the
 779      defined format. If you want always to save the nickname in the defined
 780      format set the boolean field `nickname_force_format' to value TRUE.
 781   */
 782   char nickname_format[32];
 783
 784   /* If this is set to TRUE then the `nickname_format' is employed to all
 785      saved nicknames even if there are no multiple same nicknames in the
 786      cache. By default this is FALSE, which means that the `nickname_format'
 787      is employed only if the library will receive a nickname that is
 788      already saved in the cache. It is recommended to leave this to FALSE
 789      value. */
 790   bool nickname_force_format;
 791
 792   /* A callback function provided by the application for the library to
 793      parse the nickname from the formatted nickname string. Even though
 794      the libary formats the nicknames the application knows generally the
 795      format better so this function should be provided for the library
 796      if the application sets the `nickname_format' field. The library
 797      will call this to get the true nickname from the provided formatted
 798      nickname string whenever it needs the true nickname. */
 799   SilcNicknameFormatParse nickname_parse;
 800
 801   /* If this is set to TRUE then the client will ignore all incoming
 802      Requested Attributes queries and does not reply anything back.  This
 803      usually leads into situation where server does not anymore send
 804      the queries after seeing that client does not reply anything back.
 805      If your application does not support Requested Attributes or you do
 806      not want to use them set this to TRUE.  See SilcAttribute and
 807      silc_client_attribute_add for more information on attributes. */
 808   bool ignore_requested_attributes;
 809
 810 } SilcClientParams;
 811 /***/
 812
 813
 814 /* Initialization functions (client.c) */
 815
 816 /****f* silcclient/SilcClientAPI/silc_client_alloc
 817  *
 818  * SYNOPSIS
 819  *
 820  *    SilcClient silc_client_alloc(SilcClientOperations *ops,
 821  *                                 SilcClientParams *params,
 822  *                                 void *application,
 823  *                                 const char *silc_version);
 824  *
 825  * DESCRIPTION
 826  *
 827  *    Allocates new client object. This has to be done before client may
 828  *    work. After calling this one must call silc_client_init to initialize
 829  *    the client. The `application' is application specific user data pointer
 830  *    and caller must free it. The `silc_version' is the application version
 831  *    that will be used to compare against remote host's (usually a server)
 832  *    version string.  The `application' context is accessible by the
 833  *    application by client->application, client being SilcClient.
 834  *
 835  ***/
 836 SilcClient silc_client_alloc(SilcClientOperations *ops,
 837                              SilcClientParams *params,
 838                              void *application,
 839                              const char *version_string);
 840
 841 /****f* silcclient/SilcClientAPI/silc_client_free
 842  *
 843  * SYNOPSIS
 844  *
 845  *    void silc_client_free(SilcClient client);
 846  *
 847  * DESCRIPTION
 848  *
 849  *    Frees client object and its internals.  The execution of the client
 850  *    should be stopped with silc_client_stop function before calling
 851  *    this function.
 852  *
 853  ***/
 854 void silc_client_free(SilcClient client);
 855
 856 /****f* silcclient/SilcClientAPI/silc_client_init
 857  *
 858  * SYNOPSIS
 859  *
 860  *    bool silc_client_init(SilcClient client);
 861  *
 862  * DESCRIPTION
 863  *
 864  *    Initializes the client. This makes all the necessary steps to make
 865  *    the client ready to be run. One must call silc_client_run to run the
 866  *    client. Returns FALSE if error occurred, TRUE otherwise.
 867  *
 868  ***/
 869 bool silc_client_init(SilcClient client);
 870
 871 /****f* silcclient/SilcClientAPI/silc_client_run
 872  *
 873  * SYNOPSIS
 874  *
 875  *    void silc_client_run(SilcClient client);
 876  *
 877  * DESCRIPTION
 878  *
 879  *    Runs the client. This starts the scheduler from the utility library.
 880  *    When this functions returns the execution of the appliation is over.
 881  *    The client must be initialized before calling this.
 882  *
 883  ***/
 884 void silc_client_run(SilcClient client);
 885
 886 /****f* silcclient/SilcClientAPI/silc_client_run_one
 887  *
 888  * SYNOPSIS
 889  *
 890  *    void silc_client_run_one(SilcClient client);
 891  *
 892  * DESCRIPTION
 893  *
 894  *    Runs the client and returns immeadiately. This function is used when
 895  *    the SILC Client object indicated by the `client' is run under some
 896  *    other scheduler, or event loop or main loop.  On GUI applications,
 897  *    for example this may be desired to used to run the client under the
 898  *    GUI application's main loop.  Typically the GUI application would
 899  *    register an idle task that calls this function multiple times in
 900  *    a second to quickly process the SILC specific data.
 901  *
 902  ***/
 903 void silc_client_run_one(SilcClient client);
 904
 905 /****f* silcclient/SilcClientAPI/silc_client_stop
 906  *
 907  * SYNOPSIS
 908  *
 909  *    void silc_client_stop(SilcClient client);
 910  *
 911  * DESCRIPTION
 912  *
 913  *    Stops the client. This is called to stop the client and thus to stop
 914  *    the program.  The client context must be freed with the silc_client_free
 915  *    function.
 916  *
 917  ***/
 918 void silc_client_stop(SilcClient client);
 919
 920
 921 /* Connecting functions (client.c) */
 922
 923 /****s* silcclient/SilcClientAPI/SilcClientConnectionParams
 924  *
 925  * NAME
 926  *
 927  *    typedef struct { ... } SilcClientConnectionParams;
 928  *
 929  * DESCRIPTION
 930  *
 931  *    Client connection parameters.  This can be filled by the application
 932  *    and given as argument to silc_client_connect_to_server or to
 933  *    silc_client_add_connection.
 934  *
 935  * SOURCE
 936  */
 937 typedef struct {
 938   /* The SILC session detachment data that was returned by `detach' client
 939      operation when the application detached from the network.  Application
 940      is responsible of saving the data and giving it as argument here
 941      for resuming the session in the SILC network.
 942
 943      If this is provided here the client library will attempt to resume
 944      the session in the network.  After the connection is created
 945      successfully, the application is responsible of setting the user
 946      interface for user into the same state it was before detaching (showing
 947      same channels, channel modes, etc).  It can do this by fetching the
 948      information (like joined channels) from the client library. */
 949   unsigned char *detach_data;
 950   SilcUInt32 detach_data_len;
 951
 952 } SilcClientConnectionParams;
 953 /***/
 954
 955 /****f* silcclient/SilcClientAPI/silc_client_connect_to_server
 956  *
 957  * SYNOPSIS
 958  *
 959  *    bool silc_client_connect_to_server(SilcClient client,
 960  *                                      SilcClientConnectionParams *params,
 961  *                                      int port, char *host, void *context);
 962  *
 963  * DESCRIPTION
 964  *
 965  *    Connects to remote server. This is the main routine used to connect
 966  *    to SILC server. Returns -1 on error and the created socket otherwise.
 967  *    The `context' is user context that is saved into the SilcClientConnection
 968  *    that is created after the connection is created. Note that application
 969  *    may handle the connecting process outside the library. If this is the
 970  *    case then this function is not used at all. When the connecting is
 971  *    done the `connect' client operation is called, and the `context' is
 972  *    accessible with conn->context, conn being SilcClientConnection.
 973  *    If the `params' is provided they are used by the routine.
 974  *
 975  ***/
 976 bool silc_client_connect_to_server(SilcClient client,
 977                                    SilcClientConnectionParams *params,
 978                                    int port, char *host, void *context);
 979
 980 /****f* silcclient/SilcClientAPI/silc_client_add_connection
 981  *
 982  * SYNOPSIS
 983  *
 984  *
 985  *    SilcClientConnection
 986  *    silc_client_add_connection(SilcClient client,
 987  *                               SilcClientConnectionParams *params,
 988  *                               char *hostname, int port, void *context);
 989  *
 990  * DESCRIPTION
 991  *
 992  *    Allocates and adds new connection to the client. This adds the allocated
 993  *    connection to the connection table and returns a pointer to it. A client
 994  *    can have multiple connections to multiple servers. Every connection must
 995  *    be added to the client using this function. User data `context' may
 996  *    be sent as argument.  If the `params' is provided they are used by
 997  *    the routine.
 998  *
 999  * NOTES
1000  *
1001  *    This function is normally used only if the application performed
1002  *    the connecting outside the library, and did not called the
1003  *    silc_client_connect_to_server function at all. The library
1004  *    however may use this internally.
1005  *
1006  ***/
1007 SilcClientConnection
1008 silc_client_add_connection(SilcClient client,
1009                            SilcClientConnectionParams *params,
1010                            char *hostname, int port, void *context);
1011
1012 /****f* silcclient/SilcClientAPI/silc_client_del_connection
1013  *
1014  * SYNOPSIS
1015  *
1016  *    void silc_client_del_connection(SilcClient client,
1017  *                                    SilcClientConnection conn);
1018  *
1019  * DESCRIPTION
1020  *
1021  *    Removes connection from client. Frees all memory. The library
1022  *    call this function automatically for all connection contexts.
1023  *    The application however may free the connection contexts it has
1024  *    allocated.
1025  *
1026  ***/
1027 void silc_client_del_connection(SilcClient client, SilcClientConnection conn);
1028
1029 /****f* silcclient/SilcClientAPI/silc_client_add_socket
1030  *
1031  * SYNOPSIS
1032  *
1033  *    void silc_client_add_socket(SilcClient client,
1034  *                                SilcSocketConnection sock);
1035  *
1036  * DESCRIPTION
1037  *
1038  *    Adds listener socket to the listener sockets table. This function is
1039  *    used to add socket objects that are listeners to the client.  This should
1040  *    not be used to add other connection objects.
1041  *
1042  ***/
1043 void silc_client_add_socket(SilcClient client, SilcSocketConnection sock);
1044
1045 /****f* silcclient/SilcClientAPI/silc_client_del_socket
1046  *
1047  * SYNOPSIS
1048  *
1049  *    void silc_client_del_socket(SilcClient client,
1050  *                                SilcSocketConnection sock);
1051  *
1052  * DESCRIPTION
1053  *
1054  *    Deletes listener socket from the listener sockets table.  If the
1055  *    application has added a socket with silc_client_add_socket it must
1056  *    also free it using this function.
1057  *
1058  ***/
1059 void silc_client_del_socket(SilcClient client, SilcSocketConnection sock);
1060
1061 /****f* silcclient/SilcClientAPI/silc_client_start_key_exchange
1062  *
1063  * SYNOPSIS
1064  *
1065  *    void silc_client_start_key_exchange(SilcClient client,
1066  *                                        SilcClientConnection conn,
1067  *                                        int fd);
1068  *
1069  * DESCRIPTION
1070  *
1071  *    Start SILC Key Exchange (SKE) protocol to negotiate shared secret
1072  *    key material between client and server.  This function can be called
1073  *    directly if application is performing its own connecting and does not
1074  *    use the connecting provided by this library. This function is normally
1075  *    used only if the application performed the connecting outside the
1076  *    library. The library however may use this internally.  After the
1077  *    key exchange is performed the `connect' client operation is called.
1078  *
1079  ***/
1080 void silc_client_start_key_exchange(SilcClient client,
1081                                     SilcClientConnection conn,
1082                                     int fd);
1083
1084 /****f* silcclient/SilcClientAPI/silc_client_close_connection
1085  *
1086  * SYNOPSIS
1087  *
1088  *    void silc_client_close_connection(SilcClient client,
1089  *                                      SilcClientConnection conn);
1090  *
1091  * DESCRIPTION
1092  *
1093  *    Closes connection to remote end. Free's all allocated data except
1094  *    for some information such as nickname etc. that are valid at all time.
1095  *    Usually application does not need to directly call this, except
1096  *    when explicitly closing the connection, or if an error occurs
1097  *    during connection to server (see 'connect' client operation for
1098  *    more information).
1099  *
1100  ***/
1101 void silc_client_close_connection(SilcClient client,
1102                                   SilcClientConnection conn);
1103
1104
1105 /* Message sending functions (client_channel.c and client_prvmsg.c) */
1106
1107 /****f* silcclient/SilcClientAPI/silc_client_send_channel_message
1108  *
1109  * SYNOPSIS
1110  *
1111  *    void silc_client_send_channel_message(SilcClient client,
1112  *                                          SilcClientConnection conn,
1113  *                                          SilcChannelEntry channel,
1114  *                                          SilcChannelPrivateKey key,
1115  *                                          SilcMessageFlags flags,
1116  *                                          unsigned char *data,
1117  *                                          SilcUInt32 data_len,
1118  *                                          bool_force_send);
1119  *
1120  * DESCRIPTION
1121  *
1122  *    Sends packet to the `channel'. Packet to channel is always encrypted
1123  *    differently from "normal" packets. SILC header of the packet is
1124  *    encrypted with the next receiver's key and the rest of the packet is
1125  *    encrypted with the channel specific key. Padding and HMAC is computed
1126  *    with the next receiver's key. The `data' is the channel message. If
1127  *    the `force_send' is TRUE then the packet is sent immediately.
1128  *
1129  *    If `key' is provided then that private key is used to encrypt the
1130  *    channel message.  If it is not provided, private keys has not been
1131  *    set at all, the normal channel key is used automatically.  If private
1132  *    keys are set then the first key (the key that was added first as
1133  *    private key) is used.
1134  *
1135  *    If the `flags' includes SILC_MESSAGE_FLAG_SIGNED the message will be
1136  *    digitally signed with the SILC key pair.
1137  *
1138  ***/
1139 void silc_client_send_channel_message(SilcClient client,
1140                                       SilcClientConnection conn,
1141                                       SilcChannelEntry channel,
1142                                       SilcChannelPrivateKey key,
1143                                       SilcMessageFlags flags,
1144                                       unsigned char *data,
1145                                       SilcUInt32 data_len,
1146                                       bool force_send);
1147
1148 /****f* silcclient/SilcClientAPI/silc_client_send_private_message
1149  *
1150  * SYNOPSIS
1151  *
1152  *    void silc_client_send_private_message(SilcClient client,
1153  *                                          SilcClientConnection conn,
1154  *                                          SilcClientEntry client_entry,
1155  *                                          SilcMessageFlags flags,
1156  *                                          unsigned char *data,
1157  *                                          SilcUInt32 data_len,
1158  *                                          bool force_send);
1159  *
1160  * DESCRIPTION
1161  *
1162  *    Sends private message to remote client. If private message key has
1163  *    not been set with this client then the message will be encrypted using
1164  *    normal session keys. Private messages are special packets in SILC
1165  *    network hence we need this own function for them. This is similar
1166  *    to silc_client_packet_send_to_channel except that we send private
1167  *    message. The `data' is the private message. If the `force_send' is
1168  *    TRUE the packet is sent immediately.
1169  *
1170  *    If the `flags' includes SILC_MESSAGE_FLAG_SIGNED the message will be
1171  *    digitally signed with the SILC key pair.
1172  *
1173  ***/
1174 void silc_client_send_private_message(SilcClient client,
1175                                       SilcClientConnection conn,
1176                                       SilcClientEntry client_entry,
1177                                       SilcMessageFlags flags,
1178                                       unsigned char *data,
1179                                       SilcUInt32 data_len,
1180                                       bool force_send);
1181
1182
1183 /* Client and Channel entry retrieval (idlist.c) */
1184
1185 /****f* silcclient/SilcClientAPI/SilcGetClientCallback
1186  *
1187  * SYNOPSIS
1188  *
1189  *    typedef void (*SilcGetClientCallback)(SilcClient client,
1190  *                                          SilcClientConnection conn,
1191  *                                          SilcClientEntry *clients,
1192  *                                          SilcUInt32 clients_count,
1193  *                                          void *context);
1194  *
1195  * DESCRIPTION
1196  *
1197  *    Callback function given to the silc_client_get_client function. The
1198  *    found entries are allocated into the `clients' array. The array must
1199  *    not be freed by the receiver, the library will free it later. If the
1200  *    `clients' is NULL, no such clients exist in the SILC Network.
1201  *
1202  ***/
1203 typedef void (*SilcGetClientCallback)(SilcClient client,
1204                                       SilcClientConnection conn,
1205                                       SilcClientEntry *clients,
1206                                       SilcUInt32 clients_count,
1207                                       void *context);
1208
1209 /****f* silcclient/SilcClientAPI/silc_client_get_clients
1210  *
1211  * SYNOPSIS
1212  *
1213  *    void silc_client_get_clients(SilcClient client,
1214  *                                 SilcClientConnection conn,
1215  *                                 const char *nickname,
1216  *                                 const char *server,
1217  *                                 SilcGetClientCallback completion,
1218  *                                 void *context);
1219  *
1220  * DESCRIPTION
1221  *
1222  *    Finds client entry or entries by the `nickname' and `server'. The
1223  *    completion callback will be called when the client entries has been
1224  *    found.  After the server returns the client information it is cached
1225  *    and can be accesses locally at a later time.  The resolving is done
1226  *    with IDENTIFY command.
1227  *
1228  * NOTES
1229  *
1230  *    NOTE: This function is always asynchronous and resolves the client
1231  *    information from the server. Thus, if you already know the client
1232  *    information then use the silc_client_get_client_by_id function to
1233  *    get the client entry since this function may be very slow and should
1234  *    be used only to initially get the client entries.
1235  *
1236  *    Since this routine resolves with IDENTIFY command only the relevant
1237  *    information (user's nickname and username) is resolved.  For example,
1238  *    user's real name, channel list and others are not resolved.  Caller
1239  *    can/must resolve those separately if they are needed (for example,
1240  *    with silc_client_get_client_by_id_resolve).
1241  *
1242  ***/
1243 void silc_client_get_clients(SilcClient client,
1244                              SilcClientConnection conn,
1245                              const char *nickname,
1246                              const char *server,
1247                              SilcGetClientCallback completion,
1248                              void *context);
1249
1250 /****f* silcclient/SilcClientAPI/silc_client_get_clients_local
1251  *
1252  * SYNOPSIS
1253  *
1254  *    SilcClientEntry *silc_client_get_clients_local(SilcClient client,
1255  *                                                   SilcClientConnection conn,
1256  *                                                   const char *nickname,
1257  *                                                   const char *format,
1258  *                                                   SilcUInt32 *clients_count);
1259  *
1260  * DESCRIPTION
1261  *
1262  *    Same as silc_client_get_clients function but does not resolve anything
1263  *    from the server. This checks local cache and returns all matching
1264  *    clients from the local cache. If none was found this returns NULL.
1265  *    The `nickname' is the real nickname of the client, and the `format'
1266  *    is the formatted nickname to find exact match from multiple found
1267  *    entries. The format must be same as given in the SilcClientParams
1268  *    structure to the client library. If the `format' is NULL all found
1269  *    clients by `nickname' are returned. The caller must return the
1270  *    returned array.
1271  *
1272  ***/
1273 SilcClientEntry *silc_client_get_clients_local(SilcClient client,
1274                                                SilcClientConnection conn,
1275                                                const char *nickname,
1276                                                const char *format,
1277                                                SilcUInt32 *clients_count);
1278
1279 /****f* silcclient/SilcClientAPI/silc_client_get_clients_by_channel
1280  *
1281  * SYNOPSIS
1282  *
1283  *    void silc_client_get_clients_by_channel(SilcClient client,
1284  *                                            SilcClientConnection conn,
1285  *                                            SilcChannelEntry channel,
1286  *                                            SilcGetClientCallback completion,
1287  *                                            void *context);
1288  *
1289  * DESCRIPTION
1290  *
1291  *    Gets client entries by the channel indicated by `channel'. Thus,
1292  *    it resovles the users currently on that channel. If all users are
1293  *    already resolved this returns the users from the channel. If the
1294  *    users are resolved only partially this resolves the complete user
1295  *    information. If no users are resolved on this channel at all, this
1296  *    calls USERS command to resolve all users on the channel. The `completion'
1297  *    will be called after the entries are available. When server returns
1298  *    the client information it will be cached and can be accessed locally
1299  *    at a later time.
1300  *
1301  *    This function can be used for example in SILC_COMMAND_JOIN command
1302  *    reply handling in application to resolve users on that channel.  It
1303  *    also can be used after calling silc_client_get_channel_resolve to
1304  *    resolve users on that channel.
1305  *
1306  * NOTES
1307  *
1308  *    The resolving is done with WHOIS command. For this reason this
1309  *    command may take a long time because it resolves detailed user
1310  *    information.
1311  *
1312  ***/
1313 void silc_client_get_clients_by_channel(SilcClient client,
1314                                         SilcClientConnection conn,
1315                                         SilcChannelEntry channel,
1316                                         SilcGetClientCallback completion,
1317                                         void *context);
1318
1319 /****f* silcclient/SilcClientAPI/silc_client_get_clients_by_list
1320  *
1321  * SYNOPSIS
1322  *
1323  *    void silc_client_get_clients_by_list(SilcClient client,
1324  *                                         SilcClientConnection conn,
1325  *                                         SilcUInt32 list_count,
1326  *                                         SilcBuffer client_id_list,
1327  *                                         SilcGetClientCallback completion,
1328  *                                         void *context);
1329  *
1330  * DESCRIPTION
1331  *
1332  *    Gets client entries by the list of client ID's `client_id_list'. This
1333  *    always resolves those client ID's it does not know yet from the server
1334  *    so this function might take a while. The `client_id_list' is a list
1335  *    of ID Payloads added one after other.  JOIN command reply and USERS
1336  *    command reply for example returns this sort of list. The `completion'
1337  *    will be called after the entries are available. When server returns
1338  *    the client information it will be cached and can be accessed locally
1339  *    at a later time.
1340  *
1341  * NOTES
1342  *
1343  *    The resolving is done with IDENTIFY command. This means that only
1344  *    the relevant information of user (it's nickname and username) is
1345  *    resolved. For example, user's real name, channel lists and others
1346  *    are not resolved. Caller can/must resolve those separately if they
1347  *    are needed (for example, with silc_client_get_client_by_id_resolve).
1348  *
1349  ***/
1350 void silc_client_get_clients_by_list(SilcClient client,
1351                                      SilcClientConnection conn,
1352                                      SilcUInt32 list_count,
1353                                      SilcBuffer client_id_list,
1354                                      SilcGetClientCallback completion,
1355                                      void *context);
1356
1357 /****f* silcclient/SilcClientAPI/silc_client_get_client_by_id
1358  *
1359  * SYNOPSIS
1360  *
1361  *    SilcClientEntry silc_client_get_client_by_id(SilcClient client,
1362  *                                                 SilcClientConnection conn,
1363  *                                                 SilcClientID *client_id);
1364  *
1365  * DESCRIPTION
1366  *
1367  *    Find entry for client by the client's ID. Returns the entry or NULL
1368  *    if the entry was not found.  This checks the local cache and does
1369  *    not resolve anything from server.
1370  *
1371  ***/
1372 SilcClientEntry silc_client_get_client_by_id(SilcClient client,
1373                                              SilcClientConnection conn,
1374                                              SilcClientID *client_id);
1375
1376 /****f* silcclient/SilcClientAPI/silc_client_get_client_by_id_resolve
1377  *
1378  * SYNOPSIS
1379  *
1380  *    void
1381  *    silc_client_get_client_by_id_resolve(SilcClient client,
1382  *                                         SilcClientConnection conn,
1383  *                                         SilcClientID *client_id,
1384  *                                         SilcBuffer attributes,
1385  *                                         SilcGetClientCallback completion,
1386  *                                         void *context);
1387  *
1388  * DESCRIPTION
1389  *
1390  *    Same as silc_client_get_client_by_id but will always resolve the
1391  *    information from the server. Use this only if you know that you
1392  *    do not have the entry and the only thing you know about the client
1393  *    is its ID. When server returns the client information it will be
1394  *    cache and can be accessed locally at a later time. The resolving
1395  *    is done by sending WHOIS command.
1396  *
1397  *    If the `attributes' is non-NULL then the buffer includes Requested
1398  *    Attributes which can be used to fetch very detailed information
1399  *    about the user. If it is NULL then only normal WHOIS query is
1400  *    made (for more information about attributes see SilcAttribute).
1401  *    Caller may create the `attributes' with silc_client_attributes_request
1402  *    function.
1403  *
1404  ***/
1405 void silc_client_get_client_by_id_resolve(SilcClient client,
1406                                           SilcClientConnection conn,
1407                                           SilcClientID *client_id,
1408                                           SilcBuffer attributes,
1409                                           SilcGetClientCallback completion,
1410                                           void *context);
1411
1412 /****f* silcclient/SilcClientAPI/silc_client_del_client
1413  *
1414  * SYNOPSIS
1415  *
1416  *    bool silc_client_del_client(SilcClient client, SilcClientConnection conn,
1417  *                                SilcClientEntry client_entry)
1418  *
1419  * DESCRIPTION
1420  *
1421  *    Removes client from local cache by the client entry indicated by
1422  *    the `client_entry'.  Returns TRUE if the deletion were successful.
1423  *
1424  ***/
1425 bool silc_client_del_client(SilcClient client, SilcClientConnection conn,
1426                             SilcClientEntry client_entry);
1427
1428 /****f* silcclient/SilcClientAPI/SilcGetChannelCallback
1429  *
1430  * SYNOPSIS
1431  *
1432  *    typedef void (*SilcGetChannelCallback)(SilcClient client,
1433  *                                           SilcClientConnection conn,
1434  *                                           SilcChannelEntry *channels,
1435  *                                           SilcUInt32 channels_count,
1436  *                                           void *context);
1437  *
1438  * DESCRIPTION
1439  *
1440  *    Callback function given to the silc_client_get_channel_* functions.
1441  *    The found entries are allocated into the `channels' array. The array
1442  *    must not be freed by the receiver, the library will free it later.
1443  *    If the `channel' is NULL, no such channel exist in the SILC Network.
1444  *
1445  ***/
1446 typedef void (*SilcGetChannelCallback)(SilcClient client,
1447                                        SilcClientConnection conn,
1448                                        SilcChannelEntry *channels,
1449                                        SilcUInt32 channels_count,
1450                                        void *context);
1451
1452 /****f* silcclient/SilcClientAPI/silc_client_get_channel
1453  *
1454  * SYNOPSIS
1455  *
1456  *    SilcChannelEntry silc_client_get_channel(SilcClient client,
1457  *                                             SilcClientConnection conn,
1458  *                                             char *channel_name);
1459  *
1460  * DESCRIPTION
1461  *
1462  *    Finds entry for channel by the channel name. Returns the entry or NULL
1463  *    if the entry was not found. It is found only if the client is joined
1464  *    to the channel.  Use silc_client_get_channel_resolve or
1465  *    silc_client_get_channel_by_id_resolve to resolve channel that client
1466  *    is not joined.
1467  *
1468  ***/
1469 SilcChannelEntry silc_client_get_channel(SilcClient client,
1470                                          SilcClientConnection conn,
1471                                          char *channel_name);
1472
1473 /****f* silcclient/SilcClientAPI/silc_client_get_channel_resolve
1474  *
1475  * SYNOPSIS
1476  *
1477  *    void silc_client_get_channel_resolve(SilcClient client,
1478  *                                         SilcClientConnection conn,
1479  *                                         char *channel_name,
1480  *                                         SilcGetChannelCallback completion,
1481  *                                         void *context);
1482  *
1483  * DESCRIPTION
1484  *
1485  *    Resolves entry for channel by the channel name from the server.
1486  *    The resolving is done with IDENTIFY command. Note that users on
1487  *    the channel are not resolved at the same time. Use for example
1488  *    silc_client_get_clients_by_channel to resolve all users on a channel.
1489  *
1490  ***/
1491 void silc_client_get_channel_resolve(SilcClient client,
1492                                      SilcClientConnection conn,
1493                                      char *channel_name,
1494                                      SilcGetChannelCallback completion,
1495                                      void *context);
1496
1497 /****f* silcclient/SilcClientAPI/silc_client_get_channel_by_id
1498  *
1499  * SYNOPSIS
1500  *
1501  *    SilcChannelEntry
1502  *    silc_client_get_channel_by_id(SilcClient client,
1503  *                                  SilcClientConnection conn,
1504  *                                  SilcChannelID *channel_id);
1505  *
1506  * DESCRIPTION
1507  *
1508  *    Finds channel entry by the channel name. Returns the entry or NULL
1509  *    if it was not found.
1510  *
1511  ***/
1512 SilcChannelEntry silc_client_get_channel_by_id(SilcClient client,
1513                                                SilcClientConnection conn,
1514                                                SilcChannelID *channel_id);
1515
1516 /****f* silcclient/SilcClientAPI/silc_client_get_channel_by_id_resolve
1517  *
1518  * SYNOPSIS
1519  *
1520  *    void
1521  *    silc_client_get_channel_by_id_resolve(SilcClient client,
1522  *                                          SilcClientConnection conn,
1523  *                                          SilcChannelID *channel_id,
1524  *                                          SilcGetClientCallback completion,
1525  *                                          void *context);
1526  *
1527  * DESCRIPTION
1528  *
1529  *    Resolves the channel information (its name mainly) from the server
1530  *    by the `channel_id'. Use this only if you know that you do not have
1531  *    the entry cached locally. The resolving is done with IDENTIFY command.
1532  *
1533  *    Note that users on the channel are not resolved at the same time.
1534  *    Use for example silc_client_get_clients_by_channel to resolve all
1535  *    users on a channel.
1536  *
1537  ***/
1538 void silc_client_get_channel_by_id_resolve(SilcClient client,
1539                                            SilcClientConnection conn,
1540                                            SilcChannelID *channel_id,
1541                                            SilcGetChannelCallback completion,
1542                                            void *context);
1543
1544 /****f* silcclient/SilcClientAPI/silc_client_del_channel
1545  *
1546  * SYNOPSIS
1547  *
1548  *    bool silc_client_del_channel(SilcClient client,
1549  *                                 SilcClientConnection conn,
1550  *                                 SilcChannelEntry channel)
1551  *
1552  * DESCRIPTION
1553  *
1554  *    Removes channel from local cache by the channel entry indicated by
1555  *    the `channel'.  Returns TRUE if the deletion were successful.
1556  *
1557  ***/
1558 bool silc_client_del_channel(SilcClient client, SilcClientConnection conn,
1559                              SilcChannelEntry channel);
1560
1561 /****f* silcclient/SilcClientAPI/silc_client_get_server
1562  *
1563  * SYNOPSIS
1564  *
1565  *    SilcServerEntry silc_client_get_server(SilcClient client,
1566  *                                           SilcClientConnection conn,
1567  *                                           char *server_name)
1568  *
1569  * DESCRIPTION
1570  *
1571  *    Finds entry for server by the server name. Returns the entry or NULL
1572  *    if the entry was not found.
1573  *
1574  ***/
1575 SilcServerEntry silc_client_get_server(SilcClient client,
1576                                        SilcClientConnection conn,
1577                                        char *server_name);
1578
1579 /****f* silcclient/SilcClientAPI/silc_client_get_server_by_id
1580  *
1581  * SYNOPSIS
1582  *
1583  *    SilcServerEntry silc_client_get_server_by_id(SilcClient client,
1584  *                                                 SilcClientConnection conn,
1585  *                                                 SilcServerID *server_id);
1586  *
1587  * DESCRIPTION
1588  *
1589  *    Finds entry for server by the server ID. Returns the entry or NULL
1590  *    if the entry was not found.
1591  *
1592  ***/
1593 SilcServerEntry silc_client_get_server_by_id(SilcClient client,
1594                                              SilcClientConnection conn,
1595                                              SilcServerID *server_id);
1596
1597 /****f* silcclient/SilcClientAPI/silc_client_del_server
1598  *
1599  * SYNOPSIS
1600  *
1601  *    bool silc_client_del_server(SilcClient client, SilcClientConnection conn,
1602  *                                SilcServerEntry server);
1603  *
1604  * DESCRIPTION
1605  *
1606  *    Removes server from local cache by the server entry indicated by
1607  *    the `server'.  Returns TRUE if the deletion were successful.
1608  *
1609  ***/
1610 bool silc_client_del_server(SilcClient client, SilcClientConnection conn,
1611                             SilcServerEntry server);
1612
1613 /****f* silcclient/SilcClientAPI/silc_client_on_channel
1614  *
1615  * SYNOPSIS
1616  *
1617  *    SilcChannelUser silc_client_on_channel(SilcChannelEntry channel,
1618  *                                           SilcClientEntry client_entry);
1619  *
1620  * DESCRIPTION
1621  *
1622  *    Returns the SilcChannelUser entry if the `client_entry' is joined on the
1623  *    channel indicated by the `channel'. NULL if client is not joined on
1624  *    the channel.
1625  *
1626  ***/
1627 SilcChannelUser silc_client_on_channel(SilcChannelEntry channel,
1628                                        SilcClientEntry client_entry);
1629
1630 /* Command management (command.c) */
1631
1632 /****f* silcclient/SilcClientAPI/silc_client_command_call
1633  *
1634  * SYNOPSIS
1635  *
1636  *    bool silc_client_command_call(SilcClient client,
1637  *                                  SilcClientConnection conn,
1638  *                                  const char *command_line, ...);
1639  *
1640  * DESCRIPTION
1641  *
1642  *    Calls and executes the command indicated by the `command_name'.
1643  *    The `command_line' is a string which includes the command's name and
1644  *    its arguments separated with whitespaces (' ').  If `command_line'
1645  *    is non-NULL then all variable arguments are ignored by default.
1646  *
1647  *    If `command_line' is NULL, then the variable arguments define the
1648  *    command's name and its arguments.  The first variable argument must
1649  *    be the command name.  The variable argument list must be terminated
1650  *    with NULL.
1651  *
1652  *    Returns FALSE if the command is not known and TRUE after command.
1653  *    execution.  The "command" client operation is called when the
1654  *    command is executed to indicate whether the command executed
1655  *    successfully or not.
1656  *
1657  *    The "command_reply" client operation will be called when reply is
1658  *    received from the server to the command.  Application may also use
1659  *    the silc_client_command_pending to attach to the command reply.
1660  *    The command identifier for silc_client_command_pending function after
1661  *    this function call is conn->cmd_ident, which application may use.
1662  *
1663  * EXAMPLE
1664  *
1665  *    silc_client_command_call(client, conn, NULL, "PING", "silc.silcnet.org",
1666  *                             NULL);
1667  *    silc_client_command_call(client, conn, "PING silc.silcnet.org");
1668  *
1669  ***/
1670 bool silc_client_command_call(SilcClient client,
1671                               SilcClientConnection conn,
1672                               const char *command_line, ...);
1673
1674 /****f* silcclient/SilcClientAPI/silc_client_command_send
1675  *
1676  * SYNOPSIS
1677  *
1678  *    void silc_client_command_send(SilcClient client,
1679  *                                  SilcClientConnection conn,
1680  *                                  SilcCommand command, SilcUInt16 ident,
1681  *                                  SilcUInt32 argc, ...);
1682  *
1683  * DESCRIPTION
1684  *
1685  *    Generic function to send any command. The arguments must be sent already
1686  *    encoded into correct form and in correct order. If application wants
1687  *    to perform the commands by itself, it can do so and send the data
1688  *    directly to the server using this function.  If application is using
1689  *    the silc_client_command_call, this function is usually not used.
1690  *    Note that this overriders the Client Librarys commands and sends
1691  *    the command packet directly to server.
1692  *
1693  *    The variable arguments are a pair of { type, data, data_length },
1694  *    and the `argc' is the number of these pairs.
1695  *
1696  * EXAMPLE
1697  *
1698  *    silc_client_command_send(client, conn, SILC_COMMAND_WHOIS, 0, 1,
1699  *                             1, nickname, strlen(nickname));
1700  *
1701  ***/
1702 void silc_client_command_send(SilcClient client, SilcClientConnection conn,
1703                               SilcCommand command, SilcUInt16 ident,
1704                               SilcUInt32 argc, ...);
1705
1706 /****f* silcclient/SilcClientAPI/silc_client_command_pending
1707  *
1708  * SYNOPSIS
1709  *
1710  *    void silc_client_command_pending(SilcClientConnection conn,
1711  *                                     SilcCommand reply_cmd,
1712  *                                     SilcUInt16 ident,
1713  *                                     SilcCommandCb callback,
1714  *                                     void *context);
1715  *
1716  * DESCRIPTION
1717  *
1718  *    This function can be used to add pending command callback to be
1719  *    called when an command reply is received to an earlier sent command.
1720  *    The `reply_cmd' is the command that must be received in order for
1721  *    the pending command callback indicated by `callback' to be called.
1722  *    The `callback' will deliver the `context' and
1723  *    SilcClientCommandReplyContext which includes the internals of the
1724  *    command reply.
1725  *
1726  *    The `ident' is a command identifier which was set for the earlier
1727  *    sent command.  The command reply will include the same identifier
1728  *    and pending command callback will be called when the reply is
1729  *    received with the same command identifier.  It is possible to
1730  *    add multiple pending command callbacks for same command and for
1731  *    same identifier.
1732  *
1733  *    Application may use this function to add its own command reply
1734  *    handlers if it wishes not to use the standard `command_reply'
1735  *    client operation.  However, note that the pending command callback
1736  *    does not deliver parsed command reply, but application must parse
1737  *    it itself.
1738  *
1739  *    Note also that the application is notified about the received command
1740  *    reply through the `command_reply' client operation before calling
1741  *    the `callback` pending command callback.  That is the normal
1742  *    command reply handling, and is called regardless whether pending
1743  *    command callbacks are used or not.
1744  *
1745  *    Commands that application calls with silc_client_command_call
1746  *    will use a command identifier from conn->cmd_ident variable.  After
1747  *    calling the silc_client_command_call, the conn->cmd_ident includes
1748  *    the command identifier that was used for the command sending.
1749  *
1750  * EXAMPLE
1751  *
1752  *    silc_client_command_call(client, conn, "PING silc.silcnet.org");
1753  *    silc_client_command_pending(conn, SILC_COMMAND_PING, conn->cmd_ident,
1754  *                                my_ping_handler, my_ping_context);
1755  *
1756  ***/
1757 void silc_client_command_pending(SilcClientConnection conn,
1758                                  SilcCommand reply_cmd,
1759                                  SilcUInt16 ident,
1760                                  SilcCommandCb callback,
1761                                  void *context);
1762
1763
1764 /* Private Message key management (client_prvmsg.c) */
1765
1766 /****f* silcclient/SilcClientAPI/silc_client_add_private_message_key
1767  *
1768  * SYNOPSIS
1769  *
1770  *    bool silc_client_add_private_message_key(SilcClient client,
1771  *                                             SilcClientConnection conn,
1772  *                                             SilcClientEntry client_entry,
1773  *                                             const char *cipher,
1774  *                                             const char *hmac,
1775  *                                             unsigned char *key,
1776  *                                             SilcUInt32 key_len,
1777  *                                             bool generate_key,
1778  *                                             bool responder);
1779  *
1780  * DESCRIPTION
1781  *
1782  *    Adds private message key to the client library. The key will be used to
1783  *    encrypt all private message between the client and the remote client
1784  *    indicated by the `client_entry'. If the `key' is NULL and the boolean
1785  *    value `generate_key' is TRUE the library will generate random key.
1786  *    The `key' maybe for example pre-shared-key, passphrase or similar.
1787  *    The `cipher' and `hmac' MAY be provided but SHOULD be NULL to assure
1788  *    that the requirements of the SILC protocol are met. The API, however,
1789  *    allows to allocate any cipher and HMAC.
1790  *
1791  *    If `responder' is TRUE then the sending and receiving keys will be
1792  *    set according the client being the receiver of the private key.  If
1793  *    FALSE the client is being the sender (or negotiator) of the private
1794  *    key.
1795  *
1796  *    It is not necessary to set key for normal private message usage. If the
1797  *    key is not set then the private messages are encrypted using normal
1798  *    session keys. Setting the private key, however, increases the security.
1799  *
1800  *    Returns FALSE if the key is already set for the `client_entry', TRUE
1801  *    otherwise.
1802  *
1803  ***/
1804 bool silc_client_add_private_message_key(SilcClient client,
1805                                          SilcClientConnection conn,
1806                                          SilcClientEntry client_entry,
1807                                          const char *cipher,
1808                                          const char *hmac,
1809                                          unsigned char *key,
1810                                          SilcUInt32 key_len,
1811                                          bool generate_key,
1812                                          bool responder);
1813
1814 /****f* silcclient/SilcClientAPI/silc_client_add_private_message_key_ske
1815  *
1816  * SYNOPSIS
1817  *
1818  *    bool
1819  *    silc_client_add_private_message_key_ske(SilcClient client,
1820  *                                            SilcClientConnection conn,
1821  *                                            SilcClientEntry client_entry,
1822  *                                            const char *cipher,
1823  *                                            const char *hmac,
1824  *                                            SilcSKEKeyMaterial *key);
1825  *
1826  * DESCRIPTION
1827  *
1828  *    Same as silc_client_add_private_message_key but takes the key material
1829  *    from the SKE key material structure. This structure is received if
1830  *    the application uses the silc_client_send_key_agreement to negotiate
1831  *    the key material. The `cipher' and `hmac' SHOULD be provided as it is
1832  *    negotiated also in the SKE protocol.
1833  *
1834  ***/
1835 bool silc_client_add_private_message_key_ske(SilcClient client,
1836                                              SilcClientConnection conn,
1837                                              SilcClientEntry client_entry,
1838                                              const char *cipher,
1839                                              const char *hmac,
1840                                              SilcSKEKeyMaterial *key,
1841                                              bool responder);
1842
1843 /****f* silcclient/SilcClientAPI/silc_client_del_private_message_key
1844  *
1845  * SYNOPSIS
1846  *
1847  *    bool silc_client_del_private_message_key(SilcClient client,
1848  *                                             SilcClientConnection conn,
1849  *                                             SilcClientEntry client_entry);
1850  *
1851  * DESCRIPTION
1852  *
1853  *    Removes the private message from the library. The key won't be used
1854  *    after this to protect the private messages with the remote `client_entry'
1855  *    client. Returns FALSE on error, TRUE otherwise.
1856  *
1857  ***/
1858 bool silc_client_del_private_message_key(SilcClient client,
1859                                          SilcClientConnection conn,
1860                                          SilcClientEntry client_entry);
1861
1862 /****f* silcclient/SilcClientAPI/silc_client_list_private_message_keys
1863  *
1864  * SYNOPSIS
1865  *
1866  *    SilcPrivateMessageKeys
1867  *    silc_client_list_private_message_keys(SilcClient client,
1868  *                                          SilcClientConnection conn,
1869  *                                          SilcUInt32 *key_count);
1870  *
1871  * DESCRIPTION
1872  *
1873  *    Returns array of set private message keys associated to the connection
1874  *    `conn'. Returns allocated SilcPrivateMessageKeys array and the array
1875  *    count to the `key_count' argument. The array must be freed by the caller
1876  *    by calling the silc_client_free_private_message_keys function. Note:
1877  *    the keys returned in the array is in raw format. It might not be desired
1878  *    to show the keys as is. The application might choose not to show the keys
1879  *    at all or to show the fingerprints of the keys.
1880  *
1881  ***/
1882 SilcPrivateMessageKeys
1883 silc_client_list_private_message_keys(SilcClient client,
1884                                       SilcClientConnection conn,
1885                                       SilcUInt32 *key_count);
1886
1887 /****f* silcclient/SilcClientAPI/silc_client_free_private_message_keys
1888  *
1889  * SYNOPSIS
1890  *
1891  *    void silc_client_free_private_message_keys(SilcPrivateMessageKeys keys,
1892  *                                               SilcUInt32 key_count);
1893  *
1894  * DESCRIPTION
1895  *
1896  *    Frees the SilcPrivateMessageKeys array returned by the function
1897  *    silc_client_list_private_message_keys.
1898  *
1899  ***/
1900 void silc_client_free_private_message_keys(SilcPrivateMessageKeys keys,
1901                                            SilcUInt32 key_count);
1902
1903
1904 /* Channel private key management (client_channel.c,
1905    SilcChannelPrivateKey is defined in idlist.h) */
1906
1907 /****f* silcclient/SilcClientAPI/silc_client_add_channel_private_key
1908  *
1909  * SYNOPSIS
1910  *
1911  *    bool silc_client_add_channel_private_key(SilcClient client,
1912  *                                             SilcClientConnection conn,
1913  *                                             SilcChannelEntry channel,
1914  *                                             const char *name,
1915  *                                             char *cipher,
1916  *                                             char *hmac,
1917  *                                             unsigned char *key,
1918  *                                             SilcUInt32 key_len);
1919  *
1920  * DESCRIPTION
1921  *
1922  *    Adds private key for channel. This may be set only if the channel's mode
1923  *    mask includes the SILC_CHANNEL_MODE_PRIVKEY. This returns FALSE if the
1924  *    mode is not set. When channel has private key then the messages are
1925  *    encrypted using that key. All clients on the channel must also know the
1926  *    key in order to decrypt the messages. However, it is possible to have
1927  *    several private keys per one channel. In this case only some of the
1928  *    clients on the channel may know the one key and only some the other key.
1929  *    The `name' can be application given name for the key.
1930  *
1931  *    The private key for channel is optional. If it is not set then the
1932  *    channel messages are encrypted using the channel key generated by the
1933  *    server. However, setting the private key (or keys) for the channel
1934  *    significantly adds security. If more than one key is set the library
1935  *    will automatically try all keys at the message decryption phase. Note:
1936  *    setting many keys slows down the decryption phase as all keys has to
1937  *    be tried in order to find the correct decryption key. However, setting
1938  *    a few keys does not have big impact to the decryption performace.
1939  *
1940  * NOTES
1941  *
1942  *    NOTE: This is entirely local setting. The key set using this function
1943  *    is not sent to the network at any phase.
1944  *
1945  *    NOTE: If the key material was originated by the SKE protocol (using
1946  *    silc_client_send_key_agreement) then the `key' MUST be the
1947  *    key->send_enc_key as this is dictated by the SILC protocol. However,
1948  *    currently it is not expected that the SKE key material would be used
1949  *    as channel private key. However, this API allows it.
1950  *
1951  ***/
1952 bool silc_client_add_channel_private_key(SilcClient client,
1953                                          SilcClientConnection conn,
1954                                          SilcChannelEntry channel,
1955                                          const char *name,
1956                                          char *cipher,
1957                                          char *hmac,
1958                                          unsigned char *key,
1959                                          SilcUInt32 key_len);
1960
1961 /****f* silcclient/SilcClientAPI/silc_client_del_channel_private_keys
1962  *
1963  * SYNOPSIS
1964  *
1965  *    bool silc_client_del_channel_private_keys(SilcClient client,
1966  *                                              SilcClientConnection conn,
1967  *                                              SilcChannelEntry channel);
1968  *
1969  * DESCRIPTION
1970  *
1971  *    Removes all private keys from the `channel'. The old channel key is used
1972  *    after calling this to protect the channel messages. Returns FALSE on
1973  *    on error, TRUE otherwise.
1974  *
1975  ***/
1976 bool silc_client_del_channel_private_keys(SilcClient client,
1977                                           SilcClientConnection conn,
1978                                           SilcChannelEntry channel);
1979
1980 /****f* silcclient/SilcClientAPI/silc_client_del_channel_private_key
1981  *
1982  * SYNOPSIS
1983  *
1984  *    bool silc_client_del_channel_private_key(SilcClient client,
1985  *                                            SilcClientConnection conn,
1986  *                                            SilcChannelEntry channel,
1987  *                                            SilcChannelPrivateKey key);
1988  *
1989  * DESCRIPTION
1990  *
1991  *    Removes and frees private key `key' from the channel `channel'.
1992  *    The `key' is retrieved by calling the function
1993  *    silc_client_list_channel_private_keys. The key is not used after
1994  *    this. If the key was last private key then the old channel key is
1995  *    used hereafter to protect the channel messages. This returns FALSE
1996  *    on error, TRUE otherwise.
1997  *
1998  ***/
1999 bool silc_client_del_channel_private_key(SilcClient client,
2000                                          SilcClientConnection conn,
2001                                          SilcChannelEntry channel,
2002                                          SilcChannelPrivateKey key);
2003
2004 /****f* silcclient/SilcClientAPI/silc_client_list_channel_private_keys
2005  *
2006  * SYNOPSIS
2007  *
2008  *    SilcChannelPrivateKey *
2009  *    silc_client_list_channel_private_keys(SilcClient client,
2010  *                                          SilcClientConnection conn,
2011  *                                          SilcChannelEntry channel,
2012  *                                          SilcUInt32 *key_count);
2013  *
2014  * DESCRIPTION
2015  *
2016  *    Returns array (pointers) of private keys associated to the `channel'.
2017  *    The caller must free the array by calling the function
2018  *    silc_client_free_channel_private_keys. The pointers in the array may be
2019  *    used to delete the specific key by giving the pointer as argument to the
2020  *    function silc_client_del_channel_private_key.
2021  *
2022  ***/
2023 SilcChannelPrivateKey *
2024 silc_client_list_channel_private_keys(SilcClient client,
2025                                       SilcClientConnection conn,
2026                                       SilcChannelEntry channel,
2027                                       SilcUInt32 *key_count);
2028
2029 /****f* silcclient/SilcClientAPI/silc_client_free_channel_private_keys
2030  *
2031  * SYNOPSIS
2032  *
2033  *    void silc_client_free_channel_private_keys(SilcChannelPrivateKey *keys,
2034  *                                               SilcUInt32 key_count);
2035  *
2036  * DESCRIPTION
2037  *
2038  *    Frees the SilcChannelPrivateKey array.
2039  *
2040  ***/
2041 void silc_client_free_channel_private_keys(SilcChannelPrivateKey *keys,
2042                                            SilcUInt32 key_count);
2043
2044 /****f* silcclient/SilcClientAPI/silc_client_current_channel_private_key
2045  *
2046  * SYNOPSIS
2047  *
2048  *    void silc_client_current_channel_private_key(SilcClient client,
2049  *                                                 SilcClientConnection conn,
2050  *                                                 SilcChannelEntry channel,
2051  *                                                 SilcChannelPrivateKey key);
2052  *
2053  * DESCRIPTION
2054  *
2055  *    Sets the `key' to be used as current channel private key on the
2056  *    `channel'.  Packet sent after calling this function will be secured
2057  *    with `key'.
2058  *
2059  ***/
2060 void silc_client_current_channel_private_key(SilcClient client,
2061                                              SilcClientConnection conn,
2062                                              SilcChannelEntry channel,
2063                                              SilcChannelPrivateKey key);
2064
2065
2066 /* Key Agreement routines (client_keyagr.c) */
2067
2068 /****f* silcclient/SilcClientAPI/silc_client_send_key_agreement
2069  *
2070  * SYNOPSIS
2071  *
2072  *    void silc_client_send_key_agreement(SilcClient client,
2073  *                                        SilcClientConnection conn,
2074  *                                        SilcClientEntry client_entry,
2075  *                                        char *hostname,
2076  *                                        int port,
2077  *                                        SilcUInt32 timeout_secs,
2078  *                                        SilcKeyAgreementCallback completion,
2079  *                                        void *context);
2080  *
2081  * DESCRIPTION
2082  *
2083  *    Sends key agreement request to the remote client indicated by the
2084  *    `client_entry'. If the caller provides the `hostname' and the `port'
2085  *    arguments then the library will bind the client to that hostname and
2086  *    that port for the key agreement protocol. It also sends the `hostname'
2087  *    and the `port' in the key agreement packet to the remote client. This
2088  *    would indicate that the remote client may initiate the key agreement
2089  *    protocol to the `hostname' on the `port'.  If port is zero then the
2090  *    bound port is undefined (the operating system defines it).
2091  *
2092  *    If the `hostname' and `port' is not provided then empty key agreement
2093  *    packet is sent to the remote client. The remote client may reply with
2094  *    the same packet including its hostname and port. If the library receives
2095  *    the reply from the remote client the `key_agreement' client operation
2096  *    callback will be called to verify whether the user wants to perform the
2097  *    key agreement or not.
2098  *
2099  * NOTES
2100  *
2101  *    NOTE: If the application provided the `hostname' and the `port' and the
2102  *    remote side initiates the key agreement protocol it is not verified
2103  *    from the user anymore whether the protocol should be executed or not.
2104  *    By setting the `hostname' and `port' the user gives permission to
2105  *    perform the protocol (we are responder in this case).
2106  *
2107  *    NOTE: If the remote side decides not to initiate the key agreement
2108  *    or decides not to reply with the key agreement packet then we cannot
2109  *    perform the key agreement at all. If the key agreement protocol is
2110  *    performed the `completion' callback with the `context' will be called.
2111  *    If remote side decides to ignore the request the `completion' will be
2112  *    called after the specified timeout, `timeout_secs'.
2113  *
2114  *    NOTE: If the `hostname' and the `port' was not provided the `completion'
2115  *    will not be called at all since this does nothing more than sending
2116  *    a packet to the remote host.
2117  *
2118  *    NOTE: There can be only one active key agreement for one client entry.
2119  *    Before setting new one, the old one must be finished (it is finished
2120  *    after calling the completion callback) or the function
2121  *    silc_client_abort_key_agreement must be called.
2122  *
2123  ***/
2124 void silc_client_send_key_agreement(SilcClient client,
2125                                     SilcClientConnection conn,
2126                                     SilcClientEntry client_entry,
2127                                     const char *hostname,
2128                                     const char *bindhost,
2129                                     int port,
2130                                     SilcUInt32 timeout_secs,
2131                                     SilcKeyAgreementCallback completion,
2132                                     void *context);
2133
2134 /****f* silcclient/SilcClientAPI/silc_client_perform_key_agreement
2135  *
2136  * SYNOPSIS
2137  *
2138  *    void
2139  *    silc_client_perform_key_agreement(SilcClient client,
2140  *                                      SilcClientConnection conn,
2141  *                                      SilcClientEntry client_entry,
2142  *                                      char *hostname,
2143  *                                      int port,
2144  *                                      SilcKeyAgreementCallback completion,
2145  *                                      void *context);
2146  *
2147  * DESCRIPTION
2148  *
2149  *    Performs the actual key agreement protocol. Application may use this
2150  *    to initiate the key agreement protocol. This can be called for example
2151  *    after the application has received the `key_agreement' client operation,
2152  *    and did not return TRUE from it.
2153  *
2154  *    The `hostname' is the remote hostname (or IP address) and the `port'
2155  *    is the remote port. The `completion' callback with the `context' will
2156  *    be called after the key agreement protocol.
2157  *
2158  * NOTES
2159  *
2160  *    NOTE: If the application returns TRUE in the `key_agreement' client
2161  *    operation the library will automatically start the key agreement. In this
2162  *    case the application must not call this function. However, application
2163  *    may choose to just ignore the `key_agreement' client operation (and
2164  *    merely just print information about it on the screen) and call this
2165  *    function when the user whishes to do so (by, for example, giving some
2166  *    specific command). Thus, the API provides both, automatic and manual
2167  *    initiation of the key agreement. Calling this function is the manual
2168  *    initiation and returning TRUE in the `key_agreement' client operation
2169  *    is the automatic initiation.
2170  *
2171  ***/
2172 void silc_client_perform_key_agreement(SilcClient client,
2173                                        SilcClientConnection conn,
2174                                        SilcClientEntry client_entry,
2175                                        char *hostname,
2176                                        int port,
2177                                        SilcKeyAgreementCallback completion,
2178                                        void *context);
2179
2180 /****f* silcclient/SilcClientAPI/silc_client_perform_key_agreement_fd
2181  *
2182  * SYNOPSIS
2183  *
2184  *    void
2185  *    silc_client_perform_key_agreement_fd(SilcClient client,
2186  *                                         SilcClientConnection conn,
2187  *                                         SilcClientEntry client_entry,
2188  *                                         int sock,
2189  *                                         char *hostname,
2190  *                                         SilcKeyAgreementCallback completion,
2191  *                                         void *context);
2192  *
2193  * DESCRIPTION
2194  *
2195  *    Same as above but application has created already the connection to
2196  *    the remote host. The `sock' is the socket to the remote connection.
2197  *    Application can use this function if it does not want the client library
2198  *    to create the connection.
2199  *
2200  ***/
2201 void silc_client_perform_key_agreement_fd(SilcClient client,
2202                                           SilcClientConnection conn,
2203                                           SilcClientEntry client_entry,
2204                                           int sock,
2205                                           char *hostname,
2206                                           SilcKeyAgreementCallback completion,
2207                                           void *context);
2208
2209 /****f* silcclient/SilcClientAPI/silc_client_abort_key_agreement
2210  *
2211  * SYNOPSIS
2212  *
2213  *    void silc_client_abort_key_agreement(SilcClient client,
2214  *                                         SilcClientConnection conn,
2215  *                                         SilcClientEntry client_entry);
2216  *
2217  * DESCRIPTION
2218  *
2219  *    This function can be called to unbind the hostname and the port for
2220  *    the key agreement protocol. However, this function has effect only
2221  *    before the key agreement protocol has been performed. After it has
2222  *    been performed the library will automatically unbind the port. The
2223  *    `client_entry' is the client to which we sent the key agreement
2224  *    request.  The key agreement completion callback will be called
2225  *    with SILC_KEY_AGREEMENT_ABORTED status.
2226  *
2227  ***/
2228 void silc_client_abort_key_agreement(SilcClient client,
2229                                      SilcClientConnection conn,
2230                                      SilcClientEntry client_entry);
2231
2232
2233 /* Misc functions */
2234
2235 /****f* silcclient/SilcClientAPI/silc_client_set_away_message
2236  *
2237  * SYNOPSIS
2238  *
2239  *    void silc_client_set_away_message(SilcClient client,
2240  *                                      SilcClientConnection conn,
2241  *                                      char *message);
2242  *
2243  * DESCRIPTION
2244  *
2245  *    Sets away `message'.  The away message may be set when the client's
2246  *    mode is changed to SILC_UMODE_GONE and the client whishes to reply
2247  *    to anyone who sends private message.  The `message' will be sent
2248  *    automatically back to the the client who send private message.  If
2249  *    away message is already set this replaces the old message with the
2250  *    new one.  If `message' is NULL the old away message is removed.
2251  *    The sender may freely free the memory of the `message'.
2252  *
2253  ***/
2254 void silc_client_set_away_message(SilcClient client,
2255                                   SilcClientConnection conn,
2256                                   char *message);
2257
2258 /****f* silcclient/SilcClientAPI/SilcConnectionAuthRequest
2259  *
2260  * SYNOPSIS
2261  *
2262  *    typedef void (*SilcConnectionAuthRequest)(SilcClient client,
2263  *                                              SilcClientConnection conn,
2264  *                                              SilcAuthMethod auth_meth,
2265  *                                              void *context);
2266  *
2267  * DESCRIPTION
2268  *
2269  *    Connection authentication method request callback. This is called
2270  *    by the client library after it has received the authentication method
2271  *    that the application requested by calling the function
2272  *    silc_client_request_authentication_method.
2273  *
2274  ***/
2275 typedef void (*SilcConnectionAuthRequest)(SilcClient client,
2276                                           SilcClientConnection conn,
2277                                           SilcAuthMethod auth_meth,
2278                                           void *context);
2279
2280 /****f* silcclient/SilcClientAPI/silc_client_request_authentication_method
2281  *
2282  * SYNOPSIS
2283  *
2284  *    void
2285  *    silc_client_request_authentication_method(SilcClient client,
2286  *                                              SilcClientConnection conn,
2287  *                                              SilcConnectionAuthRequest
2288  *                                                callback,
2289  *                                              void *context);
2290  *
2291  * DESCRIPTION
2292  *
2293  *    This function can be used to request the current authentication method
2294  *    from the server. This may be called when connecting to the server
2295  *    and the client library requests the authentication data from the
2296  *    application. If the application does not know the current authentication
2297  *    method it can request it from the server using this function.
2298  *    The `callback' with `context' will be called after the server has
2299  *    replied back with the current authentication method.
2300  *
2301  ***/
2302 void
2303 silc_client_request_authentication_method(SilcClient client,
2304                                           SilcClientConnection conn,
2305                                           SilcConnectionAuthRequest callback,
2306                                           void *context);
2307
2308 /****d* silcclient/SilcClientAPI/SilcClientMonitorStatus
2309  *
2310  * NAME
2311  *
2312  *    typedef enum { ... } SilcClientMonitorStatus;
2313  *
2314  * DESCRIPTION
2315  *
2316  *    File transmission session status types.  These will indicate
2317  *    the status of the file transmission session.
2318  *
2319  * SOURCE
2320  */
2321 typedef enum {
2322   SILC_CLIENT_FILE_MONITOR_KEY_AGREEMENT,    /* In key agreemenet phase */
2323   SILC_CLIENT_FILE_MONITOR_SEND,             /* Sending file */
2324   SILC_CLIENT_FILE_MONITOR_RECEIVE,          /* Receiving file */
2325   SILC_CLIENT_FILE_MONITOR_GET,
2326   SILC_CLIENT_FILE_MONITOR_PUT,
2327   SILC_CLIENT_FILE_MONITOR_CLOSED,           /* Session closed */
2328   SILC_CLIENT_FILE_MONITOR_ERROR,            /* Error during session */
2329 } SilcClientMonitorStatus;
2330 /***/
2331
2332 /****d* silcclient/SilcClientAPI/SilcClientFileError
2333  *
2334  * NAME
2335  *
2336  *    typedef enum { ... } SilcClientFileError;
2337  *
2338  * DESCRIPTION
2339  *
2340  *    File transmission error types.  These types are returned by
2341  *    some of the file transmission functions, and by the monitor
2342  *    callback to indicate error.
2343  *
2344  * SOURCE
2345  */
2346 typedef enum {
2347   SILC_CLIENT_FILE_OK,
2348   SILC_CLIENT_FILE_ERROR,
2349   SILC_CLIENT_FILE_UNKNOWN_SESSION,
2350   SILC_CLIENT_FILE_ALREADY_STARTED,
2351   SILC_CLIENT_FILE_NO_SUCH_FILE,
2352   SILC_CLIENT_FILE_PERMISSION_DENIED,
2353   SILC_CLIENT_FILE_KEY_AGREEMENT_FAILED,
2354 } SilcClientFileError;
2355 /***/
2356
2357 /****f* silcclient/SilcClientAPI/SilcClientFileMonitor
2358  *
2359  * SYNOPSIS
2360  *
2361  *    typedef void (*SilcClientFileMonitor)(SilcClient client,
2362  *                                          SilcClientConnection conn,
2363  *                                          SilcClientMonitorStatus status,
2364  *                                          SilcClientFileError error,
2365  *                                          SilcUInt64 offset,
2366  *                                          SilcUInt64 filesize,
2367  *                                          SilcClientEntry client_entry,
2368  *                                          SilcUInt32 session_id,
2369  *                                          const char *filepath,
2370  *                                          void *context);
2371  *
2372  * DESCRIPTION
2373  *
2374  *    Monitor callback that is called during the file transmission to
2375  *    monitor the transmission process.  The `status' indicates the current
2376  *    monitoring process.  The `error' will indicate the error type
2377  *    if `status' is SILC_CLIENT_FILE_MONITOR_ERROR.  The `offset' is the
2378  *    currently transmitted amount of total `filesize'.  The `client_entry'
2379  *    indicates the remote client, and the transmission session ID is the
2380  *    `session_id'.  The filename being transmitted is indicated by the
2381  *    `filepath'.
2382  *
2383  ***/
2384 typedef void (*SilcClientFileMonitor)(SilcClient client,
2385                                       SilcClientConnection conn,
2386                                       SilcClientMonitorStatus status,
2387                                       SilcClientFileError error,
2388                                       SilcUInt64 offset,
2389                                       SilcUInt64 filesize,
2390                                       SilcClientEntry client_entry,
2391                                       SilcUInt32 session_id,
2392                                       const char *filepath,
2393                                       void *context);
2394
2395 /****f* silcclient/SilcClientAPI/silc_client_file_send
2396  *
2397  * SYNOPSIS
2398  *
2399  *    SilcClientFileError
2400  *    silc_client_file_send(SilcClient client,
2401  *                          SilcClientConnection conn,
2402  *                          SilcClientFileMonitor monitor,
2403  *                          void *monitor_context,
2404  *                          const char *local_ip,
2405  *                          SilcUInt32 local_port,
2406  *                          bool do_not_bind,
2407  *                          SilcClientEntry client_entry,
2408  *                          const char *filepath);
2409  *                          SilcUInt32 *session_id);
2410  *
2411  * DESCRIPTION
2412  *
2413  *    Sends a file indicated by the `filepath' to the remote client
2414  *    indicated by the `client_entry'.  This will negotiate a secret key
2415  *    with the remote client before actually starting the transmission of
2416  *    the file.  The `monitor' callback will be called to monitor the
2417  *    transmission of the file.
2418  *
2419  *    This returns a file session ID for the file transmission to the
2420  *    `session_id' pointer.  It can be used to close the session (and
2421  *    abort the file transmission) by calling the silc_client_file_close
2422  *    function.  The session ID is also returned in the `monitor' callback.
2423  *
2424  *    If the `local_ip' is provided then this will try to bind the
2425  *    listener for key exchange protocol to that IP.  If `local_port' is
2426  *    non-zero that port is used.  If `local_ip' is NULL then this will
2427  *    automatically attempt to bind it to local IP address of the machine.
2428  *    If `do_not_bind' is TRUE then the `local_ip' and `local_port' are
2429  *    ignored and it is expected that the receiver will provide the
2430  *    point of contact.  This is usefull if the sender is behind NAT.
2431  *
2432  *    If error will occur during the file transfer process the error
2433  *    status will be returned in the monitor callback.  In this case
2434  *    the application must call silc_client_file_close to close the
2435  *    session.
2436  *
2437  ***/
2438 SilcClientFileError
2439 silc_client_file_send(SilcClient client,
2440                       SilcClientConnection conn,
2441                       SilcClientFileMonitor monitor,
2442                       void *monitor_context,
2443                       const char *local_ip,
2444                       SilcUInt32 local_port,
2445                       bool do_not_bind,
2446                       SilcClientEntry client_entry,
2447                       const char *filepath,
2448                       SilcUInt32 *session_id);
2449
2450 /****f* silcclient/SilcClientAPI/silc_client_file_receive
2451  *
2452  * SYNOPSIS
2453  *
2454  *    SilcClientFileError
2455  *    silc_client_file_receive(SilcClient client,
2456  *                             SilcClientConnection conn,
2457  *                             SilcClientFileMonitor monitor,
2458  *                             void *monitor_context,
2459  *                             const char *path,
2460  *                             SilcUInt32 session_id);
2461  *
2462  * DESCRIPTION
2463  *
2464  *    Receives a file from a client indicated by the `client_entry'.  The
2465  *    `session_id' indicates the file transmission session and it has been
2466  *    received in the `ftp' client operation function.  This will actually
2467  *    perform the key agreement protocol with the remote client before
2468  *    actually starting the file transmission.  The `monitor' callback
2469  *    will be called to monitor the transmission.  If `path' is non NULL
2470  *    the file will be saved into that directory.  If NULL the file is
2471  *    saved in the current working directory.
2472  *
2473  *    If error will occur during the file transfer process the error
2474  *    status will be returned in the monitor callback.  In this case
2475  *    the application must call silc_client_file_close to close the
2476  *    session.
2477  *
2478  ***/
2479 SilcClientFileError
2480 silc_client_file_receive(SilcClient client,
2481                          SilcClientConnection conn,
2482                          SilcClientFileMonitor monitor,
2483                          void *monitor_context,
2484                          const char *path,
2485                          SilcUInt32 session_id);
2486
2487 /****f* silcclient/SilcClientAPI/silc_client_file_close
2488  *
2489  * SYNOPSIS
2490  *
2491  *    SilcClientFileError silc_client_file_close(SilcClient client,
2492  *                                               SilcClientConnection conn,
2493  *                                               SilcUInt32 session_id);
2494  *
2495  * DESCRIPTION
2496  *
2497  *    Closes file transmission session indicated by the `session_id'.
2498  *    If file transmission is being conducted it will be aborted
2499  *    automatically. This function is also used to close the session
2500  *    after successful file transmission. This function can be used
2501  *    also to reject incoming file transmission request.
2502  *
2503  ***/
2504 SilcClientFileError silc_client_file_close(SilcClient client,
2505                                            SilcClientConnection conn,
2506                                            SilcUInt32 session_id);
2507
2508 /****f* silcclient/SilcClientAPI/silc_client_attribute_add
2509  *
2510  * SYNOPSIS
2511  *
2512  *    SilcAttributePayload
2513  *    silc_client_attribute_add(SilcClient client,
2514  *                              SilcClientConnection conn,
2515  *                              SilcAttribute attribute,
2516  *                              void *object,
2517  *                              SilcUInt32 object_size);
2518  *
2519  * DESCRIPTION
2520  *
2521  *    Add new Requsted Attribute for WHOIS command to the client library.
2522  *    The `attribute' object indicated by `object' is added and allocated
2523  *    SilcAttributePayload is returned.  The `object' must be of correct
2524  *    type and of correct size.  See the SilcAttribute for object types
2525  *    for different attributes.  You may also get all added attributes
2526  *    from the client with silc_client_attributes_get function.
2527  *
2528  *    Requested Attributes are different personal information about the
2529  *    user, status information and other information which other users
2530  *    may query with WHOIS command.  Application may set these so that
2531  *    if someone sends WHOIS query these attributes will be replied back
2532  *    to the sender.  The library always puts the public key to the
2533  *    Requested Attributes, but if application wishes to add additional
2534  *    public keys (or certificates) it can be done with this interface.
2535  *    Library also always computes digital signature of the attributes
2536  *    automatically, so application does not need to do that.
2537  *
2538  ***/
2539 SilcAttributePayload silc_client_attribute_add(SilcClient client,
2540                                                SilcClientConnection conn,
2541                                                SilcAttribute attribute,
2542                                                void *object,
2543                                                SilcUInt32 object_size);
2544
2545 /****f* silcclient/SilcClientAPI/silc_client_attribute_del
2546  *
2547  * SYNOPSIS
2548  *
2549  *    bool silc_client_attribute_del(SilcClient client,
2550  *                                   SilcClientConnection conn,
2551  *                                   SilcAttribute attribute,
2552  *                                   SilcAttributePayload attr);
2553  *
2554  * DESCRIPTION
2555  *
2556  *    Delete a Requested Attribute from the client.  If the `attribute'
2557  *    is non-zero then all attributes of that type are deleted and the
2558  *    `attr' is ignored.  If `attr' is non-NULL then that specific
2559  *    attribute is deleted and `attribute' is ignored.
2560  *
2561  *    You may get all added attributes with the function
2562  *    silc_client_attributes_get and to get the SilcAttributePayload.
2563  *    This function Returns TRUE if the attribute was found and deleted.
2564  *
2565  ***/
2566 bool silc_client_attribute_del(SilcClient client,
2567                                SilcClientConnection conn,
2568                                SilcAttribute attribute,
2569                                SilcAttributePayload attr);
2570
2571 /****f* silcclient/SilcClientAPI/silc_client_attributes_get
2572  *
2573  * SYNOPSIS
2574  *
2575  *    const SilcHashTable
2576  *    silc_client_attributes_get(SilcClient client,
2577  *                               SilcClientConnection conn);
2578  *
2579  * DESCRIPTION
2580  *
2581  *    Returns pointer to the SilcHashTable which includes all the added
2582  *    Requested Attributes.  The caller must not free the hash table.
2583  *    The caller may use SilcHashTableList and silc_hash_table_list to
2584  *    traverse the table.  Each entry in the hash table is one added
2585  *    SilcAttributePayload.  It is possible to delete a attribute
2586  *    payload while traversing the table.
2587  *
2588  ***/
2589 const SilcHashTable silc_client_attributes_get(SilcClient client,
2590                                                SilcClientConnection conn);
2591
2592 /****f* silcclient/SilcClientAPI/silc_client_attributes_request
2593  *
2594  * SYNOPSIS
2595  *
2596  *    SilcBuffer silc_client_attributes_request(SilcAttribute attribute, ...);
2597  *
2598  * DESCRIPTION
2599  *
2600  *    Constructs a Requested Attributes buffer. If the `attribute' is zero (0)
2601  *    then all attributes are requested.  Alternatively, `attribute' and
2602  *    all variable arguments can each be requested attribute.  In this case
2603  *    the last must be set to zero (0) to complete the variable list of
2604  *    requested attributes.  See SilcAttribute for all attributes.
2605  *    You can give the returned buffer as argument to for example
2606  *    silc_client_get_client_by_id_resolve function.
2607  *
2608  ***/
2609 SilcBuffer silc_client_attributes_request(SilcAttribute attribute, ...);
2610
2611 /* Low level packet sending functions */
2612
2613 /****f* silcclient/SilcClientAPI/silc_client_send_packet
2614  *
2615  * SYNOPSIS
2616  *
2617  *     bool silc_client_send_packet(SilcClient client,
2618  *                                  SilcClientConnection conn,
2619  *                                  SilcPacketType type,
2620  *                                  const unsigned char *data,
2621  *                                  SilcUInt32 data_len);
2622  *
2623  * DESCRIPTION
2624  *
2625  *    This routine can be used by application to send packets directly
2626  *    to a connection indicated by `conn'.  Usually application does not
2627  *    need this routine since the Client Library handles the packet
2628  *    sending.  The `type' indicates the packet type.  If `data' is
2629  *    NULL then empty packet is sent.  This returns FALSE if packet cannot
2630  *    be sent.
2631  *
2632  ***/
2633 bool silc_client_send_packet(SilcClient client,
2634                              SilcClientConnection conn,
2635                              SilcPacketType type,
2636                              const unsigned char *data,
2637                              SilcUInt32 data_len);
2638
2639 #include "command.h"
2640 #include "command_reply.h"
2641 #include "idlist.h"
2642 #include "protocol.h"
2643
2644 #ifdef __cplusplus
2645 }
2646 #endif
2647
2648 #endif /* SILCCLIENT_H */