lib/silcclient/silcclient.h

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