lib/silcclient/silcclient.h

   1 /*
   2
   3   silcclient.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2000 - 2002 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 /* Forward declarations */
  58 typedef struct SilcClientStruct *SilcClient;
  59 typedef struct SilcClientConnectionStruct *SilcClientConnection;
  60 typedef struct SilcClientPingStruct SilcClientPing;
  61 typedef struct SilcClientAwayStruct SilcClientAway;
  62 typedef struct SilcClientKeyAgreementStruct *SilcClientKeyAgreement;
  63 typedef struct SilcClientFtpSessionStruct *SilcClientFtpSession;
  64 typedef struct SilcClientEntryStruct *SilcClientEntry;
  65 typedef struct SilcChannelEntryStruct *SilcChannelEntry;
  66 typedef struct SilcServerEntryStruct *SilcServerEntry;
  67 typedef struct SilcClientCommandStruct *SilcClientCommand;
  68 typedef struct SilcClientCommandContextStruct *SilcClientCommandContext;
  69 typedef struct SilcClientCommandReplyContextStruct
  70                                            *SilcClientCommandReplyContext;
  71 typedef struct SilcChannelUserStruct *SilcChannelUser;
  72
  73 /* General definitions */
  74
  75 /****d* silcclient/SilcClientAPI/SilcKeyAgreementStatus
  76  *
  77  * NAME
  78  *
  79  *    typedef enum { ... } SilcKeyAgreementStatus;
  80  *
  81  * DESCRIPTION
  82  *
  83  *    Key agreement status types indicating the status of the key
  84  *    agreement protocol.  These types are returned to the application
  85  *    in the SilcKeyAgreementCallback callback function.
  86  *
  87  * SOURCE
  88  */
  89 typedef enum {
  90   SILC_KEY_AGREEMENT_OK,               /* Everything is Ok */
  91   SILC_KEY_AGREEMENT_ERROR,            /* Unknown error occurred */
  92   SILC_KEY_AGREEMENT_FAILURE,          /* The protocol failed */
  93   SILC_KEY_AGREEMENT_TIMEOUT,          /* The protocol timeout */
  94   SILC_KEY_AGREEMENT_ABORTED,          /* The protocol aborted */
  95 } SilcKeyAgreementStatus;
  96 /***/
  97
  98 /****f* silcclient/SilcClientAPI/SilcKeyAgreementCallback
  99  *
 100  * SYNOPSIS
 101  *
 102  *    typedef void (*SilcKeyAgreementCallback)(SilcClient client,
 103  *                                             SilcClientConnection conn,
 104  *                                             SilcClientEntry client_entry,
 105  *                                             SilcKeyAgreementStatus status,
 106  *                                             SilcSKEKeyMaterial *key,
 107  *                                             void *context);
 108  *
 109  * DESCRIPTION
 110  *
 111  *    Key agreement callback that is called after the key agreement protocol
 112  *    has been performed. This is called also if error occurred during the
 113  *    key agreement protocol. The `key' is the allocated key material and
 114  *    the caller is responsible of freeing it. The `key' is NULL if error
 115  *    has occurred. The application can freely use the `key' to whatever
 116  *    purpose it needs. See lib/silcske/silcske.h for the definition of
 117  *    the SilcSKEKeyMaterial structure.
 118  *
 119  ***/
 120 typedef void (*SilcKeyAgreementCallback)(SilcClient client,
 121                                          SilcClientConnection conn,
 122                                          SilcClientEntry client_entry,
 123                                          SilcKeyAgreementStatus status,
 124                                          SilcSKEKeyMaterial *key,
 125                                          void *context);
 126
 127 /****s* silcclient/SilcClientAPI/SilcPrivateMessageKeys
 128  *
 129  * NAME
 130  *
 131  *    typedef struct { ... } SilcPrivateMessageKeys;
 132  *
 133  * DESCRIPTION
 134  *
 135  *    Structure to hold the list of private message keys. The array of this
 136  *    structure is returned by the silc_client_list_private_message_keys
 137  *    function.
 138  *
 139  * SOURCE
 140  */
 141 typedef struct {
 142   SilcClientEntry client_entry;       /* The remote client entry */
 143   char *cipher;                       /* The cipher name */
 144   unsigned char *key;                 /* The original key, If the appliation
 145                                          provided it. This is NULL if the
 146                                          library generated the key or if
 147                                          the SKE key material was used. */
 148   SilcUInt32 key_len;                 /* The key length */
 149 } *SilcPrivateMessageKeys;
 150 /***/
 151
 152 /****s* silcclient/SilcClientAPI/SilcChannelPrivateKey
 153  *
 154  * NAME
 155  *
 156  *    typedef struct { ... } SilcChannelPrivateKey;
 157  *
 158  * DESCRIPTION
 159  *
 160  *    Structure to hold one channel private key. The array of this structure
 161  *    is returned by silc_client_list_channel_private_keys function.
 162  *
 163  * SOURCE
 164  */
 165 typedef struct SilcChannelPrivateKeyStruct {
 166   char *name;                         /* Application given name */
 167   SilcCipher cipher;                  /* The cipher and key */
 168   SilcHmac hmac;                      /* The HMAC and hmac key */
 169   unsigned char *key;                 /* The key data */
 170   SilcUInt32 key_len;                 /* The key length */
 171 } *SilcChannelPrivateKey;
 172 /***/
 173
 174 /****f* silcclient/SilcClientAPI/SilcAskPassphrase
 175  *
 176  * SYNOPSIS
 177  *
 178  *    typedef void (*SilcAskPassphrase)(unsigned char *passphrase,
 179  *                                      SilcUInt32 passphrase_len,
 180  *                                      void *context);
 181  *
 182  * DESCRIPTION
 183  *
 184  *    Ask passphrase callback. This is called by the application when the
 185  *    library calls `ask_passphrase' client operation.  The callback delivers
 186  *    the passphrase to the library.  The passphrases in SILC protocol
 187  *    MUST be in UTF-8 encoding, therefore the `passphrase' SHOULD be UTF-8
 188  *    encoded, and if it is not then library will attempt to encode it.
 189  *
 190  ***/
 191 typedef void (*SilcAskPassphrase)(unsigned char *passphrase,
 192                                   SilcUInt32 passphrase_len,
 193                                   void *context);
 194
 195 /****f* silcclient/SilcClientAPI/SilcVerifyPublicKey
 196  *
 197  * SYNOPSIS
 198  *
 199  *    typedef void (*SilcVerifyPublicKey)(bool success, void *context);
 200  *
 201  * DESCRIPTION
 202  *
 203  *    Public key (or certificate) verification callback. This is called
 204  *    by the application to indicate that the public key verification was
 205  *    either success or failure.
 206  *
 207  ***/
 208 typedef void (*SilcVerifyPublicKey)(bool success, void *context);
 209
 210 /****f* silcclient/SilcClientAPI/SilcGetAuthMeth
 211  *
 212  * SYNOPSIS
 213  *
 214  *    typedef void (*SilcGetAuthMeth)(bool success,
 215  *                                    SilcProtocolAuthMeth auth_meth,
 216  *                                    const unsigned char *auth_data,
 217  *                                    SilcUInt32 auth_data_len, void *context);
 218  *
 219  * DESCRIPTION
 220  *
 221  *    Authentication method resolving callback. This is called by the
 222  *    application to return the resolved authentication method. The client
 223  *    library has called the get_auth_method client operation and given
 224  *    this function pointer as argument. The `success' will indicate whether
 225  *    the authentication method could be resolved. The `auth_meth' is the
 226  *    resolved authentication method. The `auth_data' and the `auth_data_len'
 227  *    are the resolved authentication data. The `context' is the libary's
 228  *    context sent to the get_auth_method client operation.
 229  *
 230  ***/
 231 typedef void (*SilcGetAuthMeth)(bool success,
 232                                 SilcProtocolAuthMeth auth_meth,
 233                                 const unsigned char *auth_data,
 234                                 SilcUInt32 auth_data_len, void *context);
 235
 236 /****d* silcclient/SilcClientAPI/SilcClientMessageType
 237  *
 238  * NAME
 239  *
 240  *    typedef enum { ... } SilcClientMessageType;
 241  *
 242  * DESCRIPTION
 243  *
 244  *    Different message types for `say' client operation.  The application
 245  *    may filter the message sent by the library according this type.
 246  *
 247  * SOURCE
 248  */
 249 typedef enum {
 250   SILC_CLIENT_MESSAGE_INFO,            /* Informational */
 251   SILC_CLIENT_MESSAGE_WARNING,         /* Warning */
 252   SILC_CLIENT_MESSAGE_ERROR,           /* Error */
 253   SILC_CLIENT_MESSAGE_AUDIT,           /* Auditable */
 254 } SilcClientMessageType;
 255 /***/
 256
 257 /****s* silcclient/SilcClientAPI/SilcClientOperations
 258  *
 259  * NAME
 260  *
 261  *    typedef struct { ... } SilcClientOperations;
 262  *
 263  * DESCRIPTION
 264  *
 265  *    SILC Client Operations. These must be implemented by the application.
 266  *    The Client library may call any of these routines at any time.  The
 267  *    routines are used to deliver certain information to the application
 268  *    or from the application to the client library.
 269  *
 270  * SOURCE
 271  */
 272 typedef struct {
 273   /* Message sent to the application by library. `conn' associates the
 274      message to a specific connection.  `conn', however, may be NULL.
 275      The `type' indicates the type of the message sent by the library.
 276      The applicationi can for example filter the message according the
 277      type. */
 278   void (*say)(SilcClient client, SilcClientConnection conn,
 279               SilcClientMessageType type, char *msg, ...);
 280
 281   /* Message for a channel. The `sender' is the sender of the message
 282      The `channel' is the channel. The `msg' is the message.  Note that
 283      `msg' maybe NULL. */
 284   void (*channel_message)(SilcClient client, SilcClientConnection conn,
 285                           SilcClientEntry sender, SilcChannelEntry channel,
 286                           SilcMessageFlags flags,
 287                           const unsigned char *message,
 288                           SilcUInt32 message_len);
 289
 290   /* Private message to the client. The `sender' is the sender of the
 291      message. */
 292   void (*private_message)(SilcClient client, SilcClientConnection conn,
 293                           SilcClientEntry sender, SilcMessageFlags flags,
 294                           const unsigned char *message,
 295                           SilcUInt32 message_len);
 296
 297   /* Notify message to the client. The notify arguments are sent in the
 298      same order as servers sends them. The arguments are same as received
 299      from the server except for ID's.  If ID is received application receives
 300      the corresponding entry to the ID. For example, if Client ID is received
 301      application receives SilcClientEntry.  Also, if the notify type is
 302      for channel the channel entry is sent to application (even if server
 303      does not send it because client library gets the channel entry from
 304      the Channel ID in the packet's header). */
 305   void (*notify)(SilcClient client, SilcClientConnection conn,
 306                  SilcNotifyType type, ...);
 307
 308   /* Command handler. This function is called always in the command function.
 309      If error occurs it will be called as well. `conn' is the associated
 310      client connection. `cmd_context' is the command context that was
 311      originally sent to the command. `success' is FALSE if error occurred
 312      during command. `command' is the command being processed. It must be
 313      noted that this is not reply from server. This is merely called just
 314      after application has called the command. Just to tell application
 315      that the command really was processed. */
 316   void (*command)(SilcClient client, SilcClientConnection conn,
 317                   SilcClientCommandContext cmd_context, int success,
 318                   SilcCommand command);
 319
 320   /* Command reply handler. This function is called always in the command reply
 321      function. If error occurs it will be called as well. Normal scenario
 322      is that it will be called after the received command data has been parsed
 323      and processed. The function is used to pass the received command data to
 324      the application.
 325
 326      `conn' is the associated client connection. `cmd_payload' is the command
 327      payload data received from server and it can be ignored. It is provided
 328      if the application would like to re-parse the received command data,
 329      however, it must be noted that the data is parsed already by the library
 330      thus the payload can be ignored. `success' is FALSE if error occurred.
 331      In this case arguments are not sent to the application. The `status' is
 332      the command reply status server returned. The `command' is the command
 333      reply being processed. The function has variable argument list and each
 334      command defines the number and type of arguments it passes to the
 335      application (on error they are not sent).
 336
 337      The arguments are sent in the same order as servers sends them.  The
 338      arguments are same as received from the server except for ID's.  If
 339      ID is received application receives the corresponding entry to the
 340      ID. For example, if Client ID is receives application receives
 341      SilcClientEntry. */
 342   void (*command_reply)(SilcClient client, SilcClientConnection conn,
 343                         SilcCommandPayload cmd_payload, int success,
 344                         SilcCommand command, SilcCommandStatus status, ...);
 345
 346   /* Called to indicate that connection was either successfully established
 347      or connecting failed.  This is also the first time application receives
 348      the SilcClientConnection object which it should save somewhere.
 349      If the `success' is FALSE the application must always call the function
 350      silc_client_close_connection. */
 351   void (*connect)(SilcClient client, SilcClientConnection conn, int success);
 352
 353   /* Called to indicate that connection was disconnected to the server. */
 354   void (*disconnect)(SilcClient client, SilcClientConnection conn);
 355
 356   /* Find authentication method and authentication data by hostname and
 357      port. The hostname may be IP address as well. When the authentication
 358      method has been resolved the `completion' callback with the found
 359      authentication method and authentication data is called. The `conn'
 360      may be NULL. */
 361   void (*get_auth_method)(SilcClient client, SilcClientConnection conn,
 362                           char *hostname, SilcUInt16 port,
 363                           SilcGetAuthMeth completion, void *context);
 364
 365   /* Verifies received public key. The `conn_type' indicates which entity
 366      (server, client etc.) has sent the public key. If user decides to trust
 367      the key may be saved as trusted public key for later use. The
 368      `completion' must be called after the public key has been verified. */
 369   void (*verify_public_key)(SilcClient client, SilcClientConnection conn,
 370                             SilcSocketType conn_type, unsigned char *pk,
 371                             SilcUInt32 pk_len, SilcSKEPKType pk_type,
 372                             SilcVerifyPublicKey completion, void *context);
 373
 374   /* Ask (interact, that is) a passphrase from user. The passphrase is
 375      returned to the library by calling the `completion' callback with
 376      the `context'. The returned passphrase SHOULD be in UTF-8 encoded,
 377      if not then the library will attempt to encode. */
 378   void (*ask_passphrase)(SilcClient client, SilcClientConnection conn,
 379                          SilcAskPassphrase completion, void *context);
 380
 381   /* Notifies application that failure packet was received.  This is called
 382      if there is some protocol active in the client.  The `protocol' is the
 383      protocol context.  The `failure' is opaque pointer to the failure
 384      indication.  Note, that the `failure' is protocol dependant and
 385      application must explicitly cast it to correct type.  Usually `failure'
 386      is 32 bit failure type (see protocol specs for all protocol failure
 387      types). */
 388   void (*failure)(SilcClient client, SilcClientConnection conn,
 389                   SilcProtocol protocol, void *failure);
 390
 391   /* Asks whether the user would like to perform the key agreement protocol.
 392      This is called after we have received an key agreement packet or an
 393      reply to our key agreement packet. This returns TRUE if the user wants
 394      the library to perform the key agreement protocol and FALSE if it is not
 395      desired (application may start it later by calling the function
 396      silc_client_perform_key_agreement). If TRUE is returned also the
 397      `completion' and `context' arguments must be set by the application. */
 398   int (*key_agreement)(SilcClient client, SilcClientConnection conn,
 399                        SilcClientEntry client_entry, const char *hostname,
 400                        SilcUInt16 port, SilcKeyAgreementCallback *completion,
 401                        void **context);
 402
 403   /* Notifies application that file transfer protocol session is being
 404      requested by the remote client indicated by the `client_entry' from
 405      the `hostname' and `port'. The `session_id' is the file transfer
 406      session and it can be used to either accept or reject the file
 407      transfer request, by calling the silc_client_file_receive or
 408      silc_client_file_close, respectively. */
 409   void (*ftp)(SilcClient client, SilcClientConnection conn,
 410               SilcClientEntry client_entry, SilcUInt32 session_id,
 411               const char *hostname, SilcUInt16 port);
 412 } SilcClientOperations;
 413 /***/
 414
 415 /****f* silcclient/SilcClientAPI/SilcNicknameFormatParse
 416  *
 417  * SYNOPSIS
 418  *
 419  *    typedef void (*SilcNicknameFormatParse)(const char *nickname,
 420  *                                            char **ret_nickname);
 421  *
 422  * DESCRIPTION
 423  *
 424  *    A callback function provided by the application for the library in
 425  *    SilcClientParams structure. This function parses the formatted
 426  *    nickname string `nickname' and returns the true nickname to the
 427  *    `ret_nickname' pointer. The library can call this function at
 428  *    any time.
 429  *
 430  ***/
 431 typedef void (*SilcNicknameFormatParse)(const char *nickname,
 432                                         char **ret_nickname);
 433
 434 /****s* silcclient/SilcClientAPI/SilcClientParams
 435  *
 436  * NAME
 437  *
 438  *    typedef struct { ... } SilcClientParams;
 439  *
 440  * DESCRIPTION
 441  *
 442  *    Client parameters. This can be filled with proper values and
 443  *    given as argument to the silc_client_alloc function. The structure
 444  *    hold various parameters which affects the function of the client.
 445  *
 446  * SOURCE
 447  */
 448 typedef struct {
 449   /* Number of maximum tasks the client library's scheduler can handle.
 450      If set to zero, the default value will be used (200). For WIN32
 451      systems this should be set to 64 as it is the hard limit dictated
 452      by the WIN32. */
 453   int task_max;
 454
 455   /* Rekey timeout in seconds. The client will perform rekey in this
 456      time interval. If set to zero, the default value will be used. */
 457   unsigned int rekey_secs;
 458
 459   /* Connection authentication method request timeout. If server does not
 460      reply back the current authentication method when we've requested it
 461      in this time interval we'll assume the reply will not come at all.
 462      If set to zero, the default value (2 seconds) will be used. */
 463   unsigned int connauth_request_secs;
 464
 465   /* Nickname format string. This can be used to order the client library
 466      to save the nicknames in the library in a certain format. Since
 467      nicknames are not unique in SILC it is possible to have multiple same
 468      nicknames. Using this format string it is possible to order the library
 469      to separate the multiple same nicknames from each other. The format
 470      types are defined below and they can appear in any order in the format
 471      string. If this is NULL then default format is used which is the
 472      default nickname without anything else. The string MUST be NULL
 473      terminated.
 474
 475      Following format types are available:
 476
 477      %n  nickname      - the real nickname returned by the server (mandatory)
 478      %h  hostname      - the stripped hostname of the client
 479      %H  full hostname - the full hostname of the client
 480      %s  server name   - the server name the client is connected
 481      %S  full server   - the full server name the client is connected
 482      %a  number        - ascending number in case there are several
 483                          same nicknames (fe. nick@host and nick@host2)
 484
 485      Example format strings: "%n@%h%a"   (fe. nick@host, nick@host2)
 486                              "%a!%n@%s"  (fe. nick@server, 2!nick@server)
 487                              "%n@%H"     (fe. nick@host.domain.com)
 488
 489      By default this format is employed to the nicknames by the libary
 490      only when there appears multiple same nicknames. If the library has
 491      only one nickname cached the nickname is saved as is and without the
 492      defined format. If you want always to save the nickname in the defined
 493      format set the boolean field `nickname_force_format' to value TRUE.
 494   */
 495   char nickname_format[32];
 496
 497   /* If this is set to TRUE then the `nickname_format' is employed to all
 498      saved nicknames even if there are no multiple same nicknames in the
 499      cache. By default this is FALSE, which means that the `nickname_format'
 500      is employed only if the library will receive a nickname that is
 501      already saved in the cache. It is recommended to leave this to FALSE
 502      value. */
 503   bool nickname_force_format;
 504
 505   /* A callback function provided by the application for the library to
 506      parse the nickname from the formatted nickname string. Even though
 507      the libary formats the nicknames the application knows generally the
 508      format better so this function should be provided for the library
 509      if the application sets the `nickname_format' field. The library
 510      will call this to get the true nickname from the provided formatted
 511      nickname string whenever it needs the true nickname. */
 512   SilcNicknameFormatParse nickname_parse;
 513
 514 } SilcClientParams;
 515 /***/
 516
 517
 518 /* Initialization functions (client.c) */
 519
 520 /****f* silcclient/SilcClientAPI/silc_client_alloc
 521  *
 522  * SYNOPSIS
 523  *
 524  *    SilcClient silc_client_alloc(SilcClientOperations *ops,
 525  *                                 SilcClientParams *params,
 526  *                                 void *application,
 527  *                                 const char *silc_version);
 528  *
 529  * DESCRIPTION
 530  *
 531  *    Allocates new client object. This has to be done before client may
 532  *    work. After calling this one must call silc_client_init to initialize
 533  *    the client. The `application' is application specific user data pointer
 534  *    and caller must free it. The `silc_version' is the application version
 535  *    that will be used to compare against remote host's (usually a server)
 536  *    version string.
 537  *
 538  ***/
 539 SilcClient silc_client_alloc(SilcClientOperations *ops,
 540                              SilcClientParams *params,
 541                              void *application,
 542                              const char *silc_version);
 543
 544 /****f* silcclient/SilcClientAPI/silc_client_free
 545  *
 546  * SYNOPSIS
 547  *
 548  *    void silc_client_free(SilcClient client);
 549  *
 550  * DESCRIPTION
 551  *
 552  *    Frees client object and its internals.  The execution of the client
 553  *    should be stopped with silc_client_stop function before calling
 554  *    this function.
 555  *
 556  ***/
 557 void silc_client_free(SilcClient client);
 558
 559 /****f* silcclient/SilcClientAPI/silc_client_init
 560  *
 561  * SYNOPSIS
 562  *
 563  *    int silc_client_init(SilcClient client);
 564  *
 565  * DESCRIPTION
 566  *
 567  *    Initializes the client. This makes all the necessary steps to make
 568  *    the client ready to be run. One must call silc_client_run to run the
 569  *    client. Returns FALSE if error occurred, TRUE otherwise.
 570  *
 571  ***/
 572 int silc_client_init(SilcClient client);
 573
 574 /****f* silcclient/SilcClientAPI/silc_client_run
 575  *
 576  * SYNOPSIS
 577  *
 578  *    void silc_client_run(SilcClient client);
 579  *
 580  * DESCRIPTION
 581  *
 582  *    Runs the client. This starts the scheduler from the utility library.
 583  *    When this functions returns the execution of the appliation is over.
 584  *
 585  ***/
 586 void silc_client_run(SilcClient client);
 587
 588 /****f* silcclient/SilcClientAPI/silc_client_run_one
 589  *
 590  * SYNOPSIS
 591  *
 592  *    void silc_client_run_one(SilcClient client);
 593  *
 594  * DESCRIPTION
 595  *
 596  *    Runs the client and returns immeadiately. This function is used when
 597  *    the SILC Client object indicated by the `client' is run under some
 598  *    other scheduler, or event loop or main loop.  On GUI applications,
 599  *    for example this may be desired to used to run the client under the
 600  *    GUI application's main loop.  Typically the GUI application would
 601  *    register an idle task that calls this function multiple times in
 602  *    a second to quickly process the SILC specific data.
 603  *
 604  ***/
 605 void silc_client_run_one(SilcClient client);
 606
 607 /****f* silcclient/SilcClientAPI/silc_client_stop
 608  *
 609  * SYNOPSIS
 610  *
 611  *    void silc_client_stop(SilcClient client);
 612  *
 613  * DESCRIPTION
 614  *
 615  *    Stops the client. This is called to stop the client and thus to stop
 616  *    the program.  The client context must be freed with the silc_client_free
 617  *    function.
 618  *
 619  ***/
 620 void silc_client_stop(SilcClient client);
 621
 622
 623 /* Connecting functions (client.c) */
 624
 625 /****f* silcclient/SilcClientAPI/silc_client_connect_to_server
 626  *
 627  * SYNOPSIS
 628  *
 629  *    int silc_client_connect_to_server(SilcClient client, int port,
 630  *                                      char *host, void *context);
 631  *
 632  * DESCRIPTION
 633  *
 634  *    Connects to remote server. This is the main routine used to connect
 635  *    to SILC server. Returns -1 on error and the created socket otherwise.
 636  *    The `context' is user context that is saved into the SilcClientConnection
 637  *    that is created after the connection is created. Note that application
 638  *    may handle the connecting process outside the library. If this is the
 639  *    case then this function is not used at all. When the connecting is
 640  *    done the `connect' client operation is called.
 641  *
 642  ***/
 643 int silc_client_connect_to_server(SilcClient client, int port,
 644                                   char *host, void *context);
 645
 646 /****f* silcclient/SilcClientAPI/silc_client_add_connection
 647  *
 648  * SYNOPSIS
 649  *
 650  *    SilcClientConnection silc_client_add_connection(SilcClient client,
 651  *                                                    char *hostname,
 652  *                                                    int port,
 653  *                                                    void *context);
 654  *
 655  * DESCRIPTION
 656  *
 657  *    Allocates and adds new connection to the client. This adds the allocated
 658  *    connection to the connection table and returns a pointer to it. A client
 659  *    can have multiple connections to multiple servers. Every connection must
 660  *    be added to the client using this function. User data `context' may
 661  *    be sent as argument. This function is normally used only if the
 662  *    application performed the connecting outside the library. The library
 663  *    however may use this internally.
 664  *
 665  ***/
 666 SilcClientConnection silc_client_add_connection(SilcClient client,
 667                                                 char *hostname,
 668                                                 int port,
 669                                                 void *context);
 670
 671 /****f* silcclient/SilcClientAPI/silc_client_del_connection
 672  *
 673  * SYNOPSIS
 674  *
 675  *    void silc_client_del_connection(SilcClient client,
 676  *                                    SilcClientConnection conn);
 677  *
 678  * DESCRIPTION
 679  *
 680  *    Removes connection from client. Frees all memory. The library
 681  *    call this function automatically for all connection contexts.
 682  *    The application however may free the connection contexts it has
 683  *    allocated.
 684  *
 685  ***/
 686 void silc_client_del_connection(SilcClient client, SilcClientConnection conn);
 687
 688 /****f* silcclient/SilcClientAPI/silc_client_add_socket
 689  *
 690  * SYNOPSIS
 691  *
 692  *    void silc_client_add_socket(SilcClient client,
 693  *                                SilcSocketConnection sock);
 694  *
 695  * DESCRIPTION
 696  *
 697  *    Adds listener socket to the listener sockets table. This function is
 698  *    used to add socket objects that are listeners to the client.  This should
 699  *    not be used to add other connection objects.
 700  *
 701  ***/
 702 void silc_client_add_socket(SilcClient client, SilcSocketConnection sock);
 703
 704 /****f* silcclient/SilcClientAPI/silc_client_del_socket
 705  *
 706  * SYNOPSIS
 707  *
 708  *    void silc_client_del_socket(SilcClient client,
 709  *                                SilcSocketConnection sock);
 710  *
 711  * DESCRIPTION
 712  *
 713  *    Deletes listener socket from the listener sockets table.  If the
 714  *    application has added a socket with silc_client_add_socket it must
 715  *    also free it using this function.
 716  *
 717  ***/
 718 void silc_client_del_socket(SilcClient client, SilcSocketConnection sock);
 719
 720 /****f* silcclient/SilcClientAPI/silc_client_start_key_exchange
 721  *
 722  * SYNOPSIS
 723  *
 724  *    void silc_client_start_key_exchange(SilcClient client,
 725  *                                        SilcClientConnection conn,
 726  *                                        int fd);
 727  *
 728  * DESCRIPTION
 729  *
 730  *    Start SILC Key Exchange (SKE) protocol to negotiate shared secret
 731  *    key material between client and server.  This function can be called
 732  *    directly if application is performing its own connecting and does not
 733  *    use the connecting provided by this library. This function is normally
 734  *    used only if the application performed the connecting outside the
 735  *    library. The library however may use this internally.  After the
 736  *    key exchange is performed the `connect' client operation is called.
 737  *
 738  ***/
 739 void silc_client_start_key_exchange(SilcClient client,
 740                                     SilcClientConnection conn,
 741                                     int fd);
 742
 743 /****f* silcclient/SilcClientAPI/silc_client_close_connection
 744  *
 745  * SYNOPSIS
 746  *
 747  *    void silc_client_close_connection(SilcClient client,
 748  *                                      SilcClientConnection conn);
 749  *
 750  * DESCRIPTION
 751  *
 752  *    Closes connection to remote end. Free's all allocated data except
 753  *    for some information such as nickname etc. that are valid at all time.
 754  *
 755  ***/
 756 void silc_client_close_connection(SilcClient client,
 757                                   SilcClientConnection conn);
 758
 759
 760 /* Message sending functions (client_channel.c and client_prvmsg.c) */
 761
 762 /****f* silcclient/SilcClientAPI/silc_client_send_channel_message
 763  *
 764  * SYNOPSIS
 765  *
 766  *    void silc_client_send_channel_message(SilcClient client,
 767  *                                          SilcClientConnection conn,
 768  *                                          SilcChannelEntry channel,
 769  *                                          SilcChannelPrivateKey key,
 770  *                                          SilcMessageFlags flags,
 771  *                                          unsigned char *data,
 772  *                                          SilcUInt32 data_len,
 773  *                                          int force_send);
 774  *
 775  * DESCRIPTION
 776  *
 777  *    Sends packet to the `channel'. Packet to channel is always encrypted
 778  *    differently from "normal" packets. SILC header of the packet is
 779  *    encrypted with the next receiver's key and the rest of the packet is
 780  *    encrypted with the channel specific key. Padding and HMAC is computed
 781  *    with the next receiver's key. The `data' is the channel message. If
 782  *    the `force_send' is TRUE then the packet is sent immediately.
 783  *
 784  *    If `key' is provided then that private key is used to encrypt the
 785  *    channel message.  If it is not provided, private keys has not been
 786  *    set at all, the normal channel key is used automatically.  If private
 787  *    keys are set then the first key (the key that was added first as
 788  *    private key) is used.
 789  *
 790  ***/
 791 void silc_client_send_channel_message(SilcClient client,
 792                                       SilcClientConnection conn,
 793                                       SilcChannelEntry channel,
 794                                       SilcChannelPrivateKey key,
 795                                       SilcMessageFlags flags,
 796                                       unsigned char *data,
 797                                       SilcUInt32 data_len,
 798                                       int force_send);
 799
 800 /****f* silcclient/SilcClientAPI/silc_client_send_private_message
 801  *
 802  * SYNOPSIS
 803  *
 804  *    void silc_client_send_private_message(SilcClient client,
 805  *                                          SilcClientConnection conn,
 806  *                                          SilcClientEntry client_entry,
 807  *                                          SilcMessageFlags flags,
 808  *                                          unsigned char *data,
 809  *                                          SilcUInt32 data_len,
 810  *                                          int force_send);
 811  *
 812  * DESCRIPTION
 813  *
 814  *    Sends private message to remote client. If private message key has
 815  *    not been set with this client then the message will be encrypted using
 816  *    normal session keys. Private messages are special packets in SILC
 817  *    network hence we need this own function for them. This is similar
 818  *    to silc_client_packet_send_to_channel except that we send private
 819  *    message. The `data' is the private message. If the `force_send' is
 820  *    TRUE the packet is sent immediately.
 821  *
 822  ***/
 823 void silc_client_send_private_message(SilcClient client,
 824                                       SilcClientConnection conn,
 825                                       SilcClientEntry client_entry,
 826                                       SilcMessageFlags flags,
 827                                       unsigned char *data,
 828                                       SilcUInt32 data_len,
 829                                       int force_send);
 830
 831
 832 /* Client and Channel entry retrieval (idlist.c) */
 833
 834 /****f* silcclient/SilcClientAPI/SilcGetClientCallback
 835  *
 836  * SYNOPSIS
 837  *
 838  *    typedef void (*SilcGetClientCallback)(SilcClient client,
 839  *                                          SilcClientConnection conn,
 840  *                                          SilcClientEntry *clients,
 841  *                                          SilcUInt32 clients_count,
 842  *                                          void *context);
 843  *
 844  * DESCRIPTION
 845  *
 846  *    Callback function given to the silc_client_get_client function. The
 847  *    found entries are allocated into the `clients' array. The array must
 848  *    not be freed by the receiver, the library will free it later. If the
 849  *    `clients' is NULL, no such clients exist in the SILC Network.
 850  *
 851  ***/
 852 typedef void (*SilcGetClientCallback)(SilcClient client,
 853                                       SilcClientConnection conn,
 854                                       SilcClientEntry *clients,
 855                                       SilcUInt32 clients_count,
 856                                       void *context);
 857
 858 /****f* silcclient/SilcClientAPI/silc_client_get_clients
 859  *
 860  * SYNOPSIS
 861  *
 862  *    void silc_client_get_clients(SilcClient client,
 863  *                                 SilcClientConnection conn,
 864  *                                 const char *nickname,
 865  *                                 const char *server,
 866  *                                 SilcGetClientCallback completion,
 867  *                                 void *context);
 868  *
 869  * DESCRIPTION
 870  *
 871  *    Finds client entry or entries by the `nickname' and `server'. The
 872  *    completion callback will be called when the client entries has been
 873  *    found.  After the server returns the client information it is cached
 874  *    and can be accesses locally at a later time.
 875  *
 876  * NOTES
 877  *
 878  *    NOTE: This function is always asynchronous and resolves the client
 879  *    information from the server. Thus, if you already know the client
 880  *    information then use the silc_client_get_client_by_id function to
 881  *    get the client entry since this function may be very slow and should
 882  *    be used only to initially get the client entries.
 883  *
 884  ***/
 885 void silc_client_get_clients(SilcClient client,
 886                              SilcClientConnection conn,
 887                              const char *nickname,
 888                              const char *server,
 889                              SilcGetClientCallback completion,
 890                              void *context);
 891
 892 /****f* silcclient/SilcClientAPI/silc_client_get_clients_local
 893  *
 894  * SYNOPSIS
 895  *
 896  *    SilcClientEntry *silc_client_get_clients_local(SilcClient client,
 897  *                                                   SilcClientConnection conn,
 898  *                                                   const char *nickname,
 899  *                                                   const char *format,
 900  *                                                   SilcUInt32 *clients_count);
 901  *
 902  * DESCRIPTION
 903  *
 904  *    Same as silc_client_get_clients function but does not resolve anything
 905  *    from the server. This checks local cache and returns all matching
 906  *    clients from the local cache. If none was found this returns NULL.
 907  *    The `nickname' is the real nickname of the client, and the `format'
 908  *    is the formatted nickname to find exact match from multiple found
 909  *    entries. The format must be same as given in the SilcClientParams
 910  *    structure to the client library. If the `format' is NULL all found
 911  *    clients by `nickname' are returned. The caller must return the
 912  *    returned array.
 913  *
 914  ***/
 915 SilcClientEntry *silc_client_get_clients_local(SilcClient client,
 916                                                SilcClientConnection conn,
 917                                                const char *nickname,
 918                                                const char *format,
 919                                                SilcUInt32 *clients_count);
 920
 921 /****f* silcclient/SilcClientAPI/silc_client_get_clients_by_list
 922  *
 923  * SYNOPSIS
 924  *
 925  *    void silc_client_get_clients_by_list(SilcClient client,
 926  *                                         SilcClientConnection conn,
 927  *                                         SilcUInt32 list_count,
 928  *                                         SilcBuffer client_id_list,
 929  *                                         SilcGetClientCallback completion,
 930  *                                         void *context);
 931  *
 932  * DESCRIPTION
 933  *
 934  *    Gets client entries by the list of client ID's `client_id_list'. This
 935  *    always resolves those client ID's it does not know yet from the server
 936  *    so this function might take a while. The `client_id_list' is a list
 937  *    of ID Payloads added one after other.  JOIN command reply and USERS
 938  *    command reply for example returns this sort of list. The `completion'
 939  *    will be called after the entries are available. When server returns
 940  *    the client information it will be cached and can be accessed locally
 941  *    at a later time.
 942  *
 943  ***/
 944 void silc_client_get_clients_by_list(SilcClient client,
 945                                      SilcClientConnection conn,
 946                                      SilcUInt32 list_count,
 947                                      SilcBuffer client_id_list,
 948                                      SilcGetClientCallback completion,
 949                                      void *context);
 950
 951 /****f* silcclient/SilcClientAPI/silc_client_get_client_by_id
 952  *
 953  * SYNOPSIS
 954  *
 955  *    SilcClientEntry silc_client_get_client_by_id(SilcClient client,
 956  *                                                 SilcClientConnection conn,
 957  *                                                 SilcClientID *client_id);
 958  *
 959  * DESCRIPTION
 960  *
 961  *    Find entry for client by the client's ID. Returns the entry or NULL
 962  *    if the entry was not found.  This checks the local cache and does
 963  *    not resolve anything from server.
 964  *
 965  ***/
 966 SilcClientEntry silc_client_get_client_by_id(SilcClient client,
 967                                              SilcClientConnection conn,
 968                                              SilcClientID *client_id);
 969
 970 /****f* silcclient/SilcClientAPI/silc_client_get_client_by_id_resolve
 971  *
 972  * SYNOPSIS
 973  *
 974  *    void
 975  *    silc_client_get_client_by_id_resolve(SilcClient client,
 976  *                                         SilcClientConnection conn,
 977  *                                         SilcClientID *client_id,
 978  *                                         SilcGetClientCallback completion,
 979  *                                         void *context);
 980  *
 981  * DESCRIPTION
 982  *
 983  *    Same as silc_client_get_client_by_id but will always resolve the
 984  *    information from the server. Use this only if you know that you
 985  *    do not have the entry and the only thing you know about the client
 986  *    is its ID. When server returns the client information it will be
 987  *    cache and can be accessed locally at a later time.
 988  *
 989  ***/
 990 void silc_client_get_client_by_id_resolve(SilcClient client,
 991                                           SilcClientConnection conn,
 992                                           SilcClientID *client_id,
 993                                           SilcGetClientCallback completion,
 994                                           void *context);
 995
 996 /****f* silcclient/SilcClientAPI/silc_client_del_client
 997  *
 998  * SYNOPSIS
 999  *
1000  *    bool silc_client_del_client(SilcClient client, SilcClientConnection conn,
1001  *                                SilcClientEntry client_entry)
1002  *
1003  * DESCRIPTION
1004  *
1005  *    Removes client from local cache by the client entry indicated by
1006  *    the `client_entry'.  Returns TRUE if the deletion were successful.
1007  *
1008  ***/
1009 bool silc_client_del_client(SilcClient client, SilcClientConnection conn,
1010                             SilcClientEntry client_entry);
1011
1012 /****f* silcclient/SilcClientAPI/SilcGetChannelCallback
1013  *
1014  * SYNOPSIS
1015  *
1016  *    typedef void (*SilcGetChannelCallback)(SilcClient client,
1017  *                                           SilcClientConnection conn,
1018  *                                           SilcChannelEntry *channels,
1019  *                                           SilcUInt32 channels_count,
1020  *                                           void *context);
1021  *
1022  * DESCRIPTION
1023  *
1024  *    Callback function given to the silc_client_get_channel_* functions.
1025  *    The found entries are allocated into the `channels' array. The array
1026  *    must not be freed by the receiver, the library will free it later.
1027  *    If the `channel' is NULL, no such channel exist in the SILC Network.
1028  *
1029  ***/
1030 typedef void (*SilcGetChannelCallback)(SilcClient client,
1031                                        SilcClientConnection conn,
1032                                        SilcChannelEntry *channels,
1033                                        SilcUInt32 channels_count,
1034                                        void *context);
1035
1036 /****f* silcclient/SilcClientAPI/silc_client_get_channel
1037  *
1038  * SYNOPSIS
1039  *
1040  *    SilcChannelEntry silc_client_get_channel(SilcClient client,
1041  *                                             SilcClientConnection conn,
1042  *                                             char *channel);
1043  *
1044  * DESCRIPTION
1045  *
1046  *    Finds entry for channel by the channel name. Returns the entry or NULL
1047  *    if the entry was not found. It is found only if the client is joined
1048  *    to the channel.
1049  *
1050  ***/
1051 SilcChannelEntry silc_client_get_channel(SilcClient client,
1052                                          SilcClientConnection conn,
1053                                          char *channel);
1054
1055 /****f* silcclient/SilcClientAPI/silc_client_get_channel_id_resolve
1056  *
1057  * SYNOPSIS
1058  *
1059  *    void
1060  *    silc_client_get_channel_by_id_resolve(SilcClient client,
1061  *                                          SilcClientConnection conn,
1062  *                                          SilcChannelID *channel_id,
1063  *                                          SilcGetClientCallback completion,
1064  *                                          void *context);
1065  *
1066  * DESCRIPTION
1067  *
1068  *    Finds channel entry by the channel name. Returns the entry or NULL
1069  *    if it was not found.
1070  *
1071  ***/
1072 SilcChannelEntry silc_client_get_channel_by_id(SilcClient client,
1073                                                SilcClientConnection conn,
1074                                                SilcChannelID *channel_id);
1075
1076 /****f* silcclient/SilcClientAPI/silc_client_get_channel_by_id_resolve
1077  *
1078  * SYNOPSIS
1079  *
1080  *    void
1081  *    silc_client_get_channel_by_id_resolve(SilcClient client,
1082  *                                          SilcClientConnection conn,
1083  *                                          SilcChannelID *channel_id,
1084  *                                          SilcGetClientCallback completion,
1085  *                                          void *context);
1086  *
1087  * DESCRIPTION
1088  *
1089  *    Resolves the channel information (its name mainly) from the server
1090  *    by the `channel_id'. Use this only if you know that you do not have
1091  *    the entry cached locally.
1092  *
1093  ***/
1094 void silc_client_get_channel_by_id_resolve(SilcClient client,
1095                                            SilcClientConnection conn,
1096                                            SilcChannelID *channel_id,
1097                                            SilcGetChannelCallback completion,
1098                                            void *context);
1099
1100 /****f* silcclient/SilcClientAPI/silc_client_del_channel
1101  *
1102  * SYNOPSIS
1103  *
1104  *    bool silc_client_del_channel(SilcClient client,
1105  *                                 SilcClientConnection conn,
1106  *                                 SilcChannelEntry channel)
1107  *
1108  * DESCRIPTION
1109  *
1110  *    Removes channel from local cache by the channel entry indicated by
1111  *    the `channel'.  Returns TRUE if the deletion were successful.
1112  *
1113  ***/
1114 bool silc_client_del_channel(SilcClient client, SilcClientConnection conn,
1115                              SilcChannelEntry channel);
1116
1117 /****f* silcclient/SilcClientAPI/silc_client_get_server
1118  *
1119  * SYNOPSIS
1120  *
1121  *    SilcServerEntry silc_client_get_server(SilcClient client,
1122  *                                           SilcClientConnection conn,
1123  *                                           char *server_name)
1124  *
1125  * DESCRIPTION
1126  *
1127  *    Finds entry for server by the server name. Returns the entry or NULL
1128  *    if the entry was not found.
1129  *
1130  ***/
1131 SilcServerEntry silc_client_get_server(SilcClient client,
1132                                        SilcClientConnection conn,
1133                                        char *server_name);
1134
1135 /****f* silcclient/SilcClientAPI/silc_client_get_server_by_id
1136  *
1137  * SYNOPSIS
1138  *
1139  *    SilcServerEntry silc_client_get_server_by_id(SilcClient client,
1140  *                                                 SilcClientConnection conn,
1141  *                                                 SilcServerID *server_id);
1142  *
1143  * DESCRIPTION
1144  *
1145  *    Finds entry for server by the server ID. Returns the entry or NULL
1146  *    if the entry was not found.
1147  *
1148  ***/
1149 SilcServerEntry silc_client_get_server_by_id(SilcClient client,
1150                                              SilcClientConnection conn,
1151                                              SilcServerID *server_id);
1152
1153 /****f* silcclient/SilcClientAPI/silc_client_del_server
1154  *
1155  * SYNOPSIS
1156  *
1157  *    bool silc_client_del_server(SilcClient client, SilcClientConnection conn,
1158  *                                SilcServerEntry server);
1159  *
1160  * DESCRIPTION
1161  *
1162  *    Removes server from local cache by the server entry indicated by
1163  *    the `server'.  Returns TRUE if the deletion were successful.
1164  *
1165  ***/
1166 bool silc_client_del_server(SilcClient client, SilcClientConnection conn,
1167                             SilcServerEntry server);
1168
1169 /****f* silcclient/SilcClientAPI/silc_client_on_channel
1170  *
1171  * SYNOPSIS
1172  *
1173  *    SilcChannelUser silc_client_on_channel(SilcChannelEntry channel,
1174  *                                           SilcClientEntry client_entry);
1175  *
1176  * DESCRIPTION
1177  *
1178  *    Returns the ChannelUser entry if the `client_entry' is joined on the
1179  *    channel indicated by the `channel'. NULL if client is not joined on
1180  *    the channel.
1181  *
1182  ***/
1183 SilcChannelUser silc_client_on_channel(SilcChannelEntry channel,
1184                                        SilcClientEntry client_entry);
1185
1186 /* Command management (command.c) */
1187
1188 /****f* silcclient/SilcClientAPI/silc_client_command_alloc
1189  *
1190  * SYNOPSIS
1191  *
1192  *    SilcClientCommandContext silc_client_command_alloc(void);
1193  *
1194  * DESCRIPTION
1195  *
1196  *    Allocate Command Context. The context is defined in `command.h' file.
1197  *    The context is used by the library commands and applications should use
1198  *    it as well. However, application may choose to use some own context
1199  *    for its local commands. All library commands, however, must use this
1200  *    context.
1201  *
1202  ***/
1203 SilcClientCommandContext silc_client_command_alloc(void);
1204
1205 /****f* silcclient/SilcClientAPI/silc_client_command_free
1206  *
1207  * SYNOPSIS
1208  *
1209  *    void silc_client_command_free(SilcClientCommandContext ctx);
1210  *
1211  * DESCRIPTION
1212  *
1213  *    Free command context and its internals.  If the contex was duplicated
1214  *    with silc_client_command_dup this may not actually free the data,
1215  *    instead it will decrease the reference counter of the context.  The
1216  *    context will be freed when the reference counter hits zero.
1217  *
1218  ***/
1219 void silc_client_command_free(SilcClientCommandContext ctx);
1220
1221 /****f* silcclient/SilcClientAPI/silc_client_command_dup
1222  *
1223  * SYNOPSIS
1224  *
1225  *    SilcClientCommandContext
1226  *    silc_client_command_dup(SilcClientCommandContext ctx);
1227  *
1228  * DESCRIPTION
1229  *
1230  *    Duplicate Command Context by adding reference counter. The context won't
1231  *    be free'd untill it hits zero.
1232  *
1233  ***/
1234 SilcClientCommandContext silc_client_command_dup(SilcClientCommandContext ctx);
1235
1236 /****f* silcclient/SilcClientAPI/silc_client_command_find
1237  *
1238  * SYNOPSIS
1239  *
1240  *    SilcClientCommand silc_client_command_find(SilcClient client,
1241  *                                               const char *name);
1242  *
1243  * DESCRIPTION
1244  *
1245  *    Finds and returns a pointer to the command list. Return NULL if the
1246  *    command is not found. See the `command.[ch]' for the command list.
1247  *    Command names are not case-sensitive.
1248  *
1249  ***/
1250 SilcClientCommand silc_client_command_find(SilcClient client,
1251                                            const char *name);
1252
1253 /****f* silcclient/SilcClientAPI/silc_client_command_call
1254  *
1255  * SYNOPSIS
1256  *
1257  *    void silc_client_command_call(SilcClientCommand command);
1258  *
1259  * DESCRIPTION
1260  *
1261  *    Calls the command (executes it).  Application can call this after
1262  *    it has allocated the SilcClientCommandContext with the function
1263  *    silc_client_command_alloc and found the command from the client
1264  *    library by calling silc_client_command_find.  This will execute
1265  *    the command.
1266  *
1267  *    Application can call the command function directly too if it
1268  *    wishes to do so.  See the command.h for details of the
1269  *    SilcClientCommand structure.
1270  *
1271  ***/
1272 void silc_client_command_call(SilcClientCommand command,
1273                               SilcClientCommandContext cmd);
1274
1275 /****f* silcclient/SilcClientAPI/silc_client_command_send
1276  *
1277  * SYNOPSIS
1278  *
1279  *    void silc_client_command_send(SilcClient client,
1280  *                                  SilcClientConnection conn,
1281  *                                  SilcCommand command, SilcUInt16 ident,
1282  *                                  SilcUInt32 argc, ...);
1283  *
1284  * DESCRIPTION
1285  *
1286  *    Generic function to send any command. The arguments must be sent already
1287  *    encoded into correct form and in correct order. If application wants
1288  *    to perform the commands by itself, it can do so and send the data
1289  *    directly to the server using this function.  If application is using
1290  *    the silc_client_command_call, this function is usually not used.
1291  *
1292  ***/
1293 void silc_client_command_send(SilcClient client, SilcClientConnection conn,
1294                               SilcCommand command, SilcUInt16 ident,
1295                               SilcUInt32 argc, ...);
1296
1297 /****f* silcclient/SilcClientAPI/silc_client_command_pending
1298  *
1299  * SYNOPSIS
1300  *
1301  *    void silc_client_command_pending(SilcClientConnection conn,
1302  *                                     SilcCommand reply_cmd,
1303  *                                     SilcUInt16 ident,
1304  *                                     SilcCommandCb callback,
1305  *                                     void *context);
1306  *
1307  * DESCRIPTION
1308  *
1309  *    Add new pending command to be executed when reply to a command has been
1310  *    received.  The `reply_cmd' is the command that will call the `callback'
1311  *    with `context' when reply has been received.  If `ident' is non-zero
1312  *    the `callback' will be executed when received reply with command
1313  *    identifier `ident'.
1314  *
1315  *    Note that the application is notified about the received command
1316  *    reply through the `command_reply' client operation before calling
1317  *    the `callback` pending command callback.
1318  *
1319  ***/
1320 void silc_client_command_pending(SilcClientConnection conn,
1321                                  SilcCommand reply_cmd,
1322                                  SilcUInt16 ident,
1323                                  SilcCommandCb callback,
1324                                  void *context);
1325
1326
1327 /* Private Message key management (client_prvmsg.c) */
1328
1329 /****f* silcclient/SilcClientAPI/silc_client_add_private_message_key
1330  *
1331  * SYNOPSIS
1332  *
1333  *    int silc_client_add_private_message_key(SilcClient client,
1334  *                                            SilcClientConnection conn,
1335  *                                            SilcClientEntry client_entry,
1336  *                                            char *cipher,
1337  *                                            unsigned char *key,
1338  *                                            SilcUInt32 key_len,
1339  *                                            bool generate_key,
1340  *                                            bool responder);
1341  *
1342  * DESCRIPTION
1343  *
1344  *    Adds private message key to the client library. The key will be used to
1345  *    encrypt all private message between the client and the remote client
1346  *    indicated by the `client_entry'. If the `key' is NULL and the boolean
1347  *    value `generate_key' is TRUE the library will generate random key.
1348  *    The `key' maybe for example pre-shared-key, passphrase or similar.
1349  *    The `cipher' MAY be provided but SHOULD be NULL to assure that the
1350  *    requirements of the SILC protocol are met. The API, however, allows
1351  *    to allocate any cipher.
1352  *
1353  *    If `responder' is TRUE then the sending and receiving keys will be
1354  *    set according the client being the receiver of the private key.  If
1355  *    FALSE the client is being the sender (or negotiator) of the private
1356  *    key.
1357  *
1358  *    It is not necessary to set key for normal private message usage. If the
1359  *    key is not set then the private messages are encrypted using normal
1360  *    session keys. Setting the private key, however, increases the security.
1361  *
1362  *    Returns FALSE if the key is already set for the `client_entry', TRUE
1363  *    otherwise.
1364  *
1365  ***/
1366 int silc_client_add_private_message_key(SilcClient client,
1367                                         SilcClientConnection conn,
1368                                         SilcClientEntry client_entry,
1369                                         char *cipher,
1370                                         unsigned char *key,
1371                                         SilcUInt32 key_len,
1372                                         bool generate_key,
1373                                         bool responder);
1374
1375 /****f* silcclient/SilcClientAPI/silc_client_add_private_message_key_ske
1376  *
1377  * SYNOPSIS
1378  *
1379  *    int silc_client_add_private_message_key_ske(SilcClient client,
1380  *                                                SilcClientConnection conn,
1381  *                                                SilcClientEntry client_entry,
1382  *                                                char *cipher,
1383  *                                                SilcSKEKeyMaterial *key);
1384  *
1385  * DESCRIPTION
1386  *
1387  *    Same as silc_client_add_private_message_key but takes the key material
1388  *    from the SKE key material structure. This structure is received if
1389  *    the application uses the silc_client_send_key_agreement to negotiate
1390  *    the key material. The `cipher' SHOULD be provided as it is negotiated
1391  *    also in the SKE protocol.
1392  *
1393  ***/
1394 int silc_client_add_private_message_key_ske(SilcClient client,
1395                                             SilcClientConnection conn,
1396                                             SilcClientEntry client_entry,
1397                                             char *cipher,
1398                                             SilcSKEKeyMaterial *key,
1399                                             bool responder);
1400
1401 /****f* silcclient/SilcClientAPI/silc_client_send_private_message_key
1402  *
1403  * SYNOPSIS
1404  *
1405  *    int silc_client_send_private_message_key(SilcClient client,
1406  *                                             SilcClientConnection conn,
1407  *                                             SilcClientEntry client_entry,
1408  *                                             int force_send);
1409  *
1410  * DESCRIPTION
1411  *
1412  *    Sends private message key payload to the remote client indicated by
1413  *    the `client_entry'. If the `force_send' is TRUE the packet is sent
1414  *    immediately. Returns FALSE if error occurs, TRUE otherwise. The
1415  *    application should call this function after setting the key to the
1416  *    client.
1417  *
1418  *    Note that the key sent using this function is sent to the remote client
1419  *    through the SILC network. The packet is protected using normal session
1420  *    keys.
1421  *
1422  ***/
1423 int silc_client_send_private_message_key(SilcClient client,
1424                                          SilcClientConnection conn,
1425                                          SilcClientEntry client_entry,
1426                                          int force_send);
1427
1428 /****f* silcclient/SilcClientAPI/silc_client_del_private_message_key
1429  *
1430  * SYNOPSIS
1431  *
1432  *    int silc_client_del_private_message_key(SilcClient client,
1433  *                                            SilcClientConnection conn,
1434  *                                            SilcClientEntry client_entry);
1435  *
1436  * DESCRIPTION
1437  *
1438  *    Removes the private message from the library. The key won't be used
1439  *    after this to protect the private messages with the remote `client_entry'
1440  *    client. Returns FALSE on error, TRUE otherwise.
1441  *
1442  ***/
1443 int silc_client_del_private_message_key(SilcClient client,
1444                                         SilcClientConnection conn,
1445                                         SilcClientEntry client_entry);
1446
1447 /****f* silcclient/SilcClientAPI/silc_client_list_private_message_keys
1448  *
1449  * SYNOPSIS
1450  *
1451  *    SilcPrivateMessageKeys
1452  *    silc_client_list_private_message_keys(SilcClient client,
1453  *                                          SilcClientConnection conn,
1454  *                                          SilcUInt32 *key_count);
1455  *
1456  * DESCRIPTION
1457  *
1458  *    Returns array of set private message keys associated to the connection
1459  *    `conn'. Returns allocated SilcPrivateMessageKeys array and the array
1460  *    count to the `key_count' argument. The array must be freed by the caller
1461  *    by calling the silc_client_free_private_message_keys function. Note:
1462  *    the keys returned in the array is in raw format. It might not be desired
1463  *    to show the keys as is. The application might choose not to show the keys
1464  *    at all or to show the fingerprints of the keys.
1465  *
1466  ***/
1467 SilcPrivateMessageKeys
1468 silc_client_list_private_message_keys(SilcClient client,
1469                                       SilcClientConnection conn,
1470                                       SilcUInt32 *key_count);
1471
1472 /****f* silcclient/SilcClientAPI/silc_client_free_private_message_keys
1473  *
1474  * SYNOPSIS
1475  *
1476  *    void silc_client_free_private_message_keys(SilcPrivateMessageKeys keys,
1477  *                                               SilcUInt32 key_count);
1478  *
1479  * DESCRIPTION
1480  *
1481  *    Frees the SilcPrivateMessageKeys array returned by the function
1482  *    silc_client_list_private_message_keys.
1483  *
1484  ***/
1485 void silc_client_free_private_message_keys(SilcPrivateMessageKeys keys,
1486                                            SilcUInt32 key_count);
1487
1488
1489 /* Channel private key management (client_channel.c,
1490    SilcChannelPrivateKey is defined in idlist.h) */
1491
1492 /****f* silcclient/SilcClientAPI/silc_client_add_channel_private_key
1493  *
1494  * SYNOPSIS
1495  *
1496  *    int silc_client_add_channel_private_key(SilcClient client,
1497  *                                            SilcClientConnection conn,
1498  *                                            SilcChannelEntry channel,
1499  *                                            const char *name,
1500  *                                            char *cipher,
1501  *                                            char *hmac,
1502  *                                            unsigned char *key,
1503  *                                            SilcUInt32 key_len);
1504  *
1505  * DESCRIPTION
1506  *
1507  *    Adds private key for channel. This may be set only if the channel's mode
1508  *    mask includes the SILC_CHANNEL_MODE_PRIVKEY. This returns FALSE if the
1509  *    mode is not set. When channel has private key then the messages are
1510  *    encrypted using that key. All clients on the channel must also know the
1511  *    key in order to decrypt the messages. However, it is possible to have
1512  *    several private keys per one channel. In this case only some of the
1513  *    clients on the channel may know the one key and only some the other key.
1514  *    The `name' can be application given name for the key.
1515  *
1516  *    The private key for channel is optional. If it is not set then the
1517  *    channel messages are encrypted using the channel key generated by the
1518  *    server. However, setting the private key (or keys) for the channel
1519  *    significantly adds security. If more than one key is set the library
1520  *    will automatically try all keys at the message decryption phase. Note:
1521  *    setting many keys slows down the decryption phase as all keys has to
1522  *    be tried in order to find the correct decryption key. However, setting
1523  *    a few keys does not have big impact to the decryption performace.
1524  *
1525  * NOTES
1526  *
1527  *    NOTE: This is entirely local setting. The key set using this function
1528  *    is not sent to the network at any phase.
1529  *
1530  *    NOTE: If the key material was originated by the SKE protocol (using
1531  *    silc_client_send_key_agreement) then the `key' MUST be the
1532  *    key->send_enc_key as this is dictated by the SILC protocol. However,
1533  *    currently it is not expected that the SKE key material would be used
1534  *    as channel private key. However, this API allows it.
1535  *
1536  ***/
1537 int silc_client_add_channel_private_key(SilcClient client,
1538                                         SilcClientConnection conn,
1539                                         SilcChannelEntry channel,
1540                                         const char *name,
1541                                         char *cipher,
1542                                         char *hmac,
1543                                         unsigned char *key,
1544                                         SilcUInt32 key_len);
1545
1546 /****f* silcclient/SilcClientAPI/silc_client_del_channel_private_keys
1547  *
1548  * SYNOPSIS
1549  *
1550  *    int silc_client_del_channel_private_keys(SilcClient client,
1551  *                                             SilcClientConnection conn,
1552  *                                             SilcChannelEntry channel);
1553  *
1554  * DESCRIPTION
1555  *
1556  *    Removes all private keys from the `channel'. The old channel key is used
1557  *    after calling this to protect the channel messages. Returns FALSE on
1558  *    on error, TRUE otherwise.
1559  *
1560  ***/
1561 int silc_client_del_channel_private_keys(SilcClient client,
1562                                          SilcClientConnection conn,
1563                                          SilcChannelEntry channel);
1564
1565 /****f* silcclient/SilcClientAPI/silc_client_del_channel_private_key
1566  *
1567  * SYNOPSIS
1568  *
1569  *    int silc_client_del_channel_private_key(SilcClient client,
1570  *                                            SilcClientConnection conn,
1571  *                                            SilcChannelEntry channel,
1572  *                                            SilcChannelPrivateKey key);
1573  *
1574  * DESCRIPTION
1575  *
1576  *    Removes and frees private key `key' from the channel `channel'.
1577  *    The `key' is retrieved by calling the function
1578  *    silc_client_list_channel_private_keys. The key is not used after
1579  *    this. If the key was last private key then the old channel key is
1580  *    used hereafter to protect the channel messages. This returns FALSE
1581  *    on error, TRUE otherwise.
1582  *
1583  ***/
1584 int silc_client_del_channel_private_key(SilcClient client,
1585                                         SilcClientConnection conn,
1586                                         SilcChannelEntry channel,
1587                                         SilcChannelPrivateKey key);
1588
1589 /****f* silcclient/SilcClientAPI/silc_client_list_channel_private_keys
1590  *
1591  * SYNOPSIS
1592  *
1593  *    SilcChannelPrivateKey *
1594  *    silc_client_list_channel_private_keys(SilcClient client,
1595  *                                          SilcClientConnection conn,
1596  *                                          SilcChannelEntry channel,
1597  *                                          SilcUInt32 *key_count);
1598  *
1599  * DESCRIPTION
1600  *
1601  *    Returns array (pointers) of private keys associated to the `channel'.
1602  *    The caller must free the array by calling the function
1603  *    silc_client_free_channel_private_keys. The pointers in the array may be
1604  *    used to delete the specific key by giving the pointer as argument to the
1605  *    function silc_client_del_channel_private_key.
1606  *
1607  ***/
1608 SilcChannelPrivateKey *
1609 silc_client_list_channel_private_keys(SilcClient client,
1610                                       SilcClientConnection conn,
1611                                       SilcChannelEntry channel,
1612                                       SilcUInt32 *key_count);
1613
1614 /****f* silcclient/SilcClientAPI/silc_client_free_channel_private_keys
1615  *
1616  * SYNOPSIS
1617  *
1618  *    void silc_client_free_channel_private_keys(SilcChannelPrivateKey *keys,
1619  *                                               SilcUInt32 key_count);
1620  *
1621  * DESCRIPTION
1622  *
1623  *    Frees the SilcChannelPrivateKey array.
1624  *
1625  ***/
1626 void silc_client_free_channel_private_keys(SilcChannelPrivateKey *keys,
1627                                            SilcUInt32 key_count);
1628
1629 /****f* silcclient/SilcClientAPI/silc_client_current_channel_private_key
1630  *
1631  * SYNOPSIS
1632  *
1633  *    void silc_client_current_channel_private_key(SilcClient client,
1634  *                                                 SilcClientConnection conn,
1635  *                                                 SilcChannelEntry channel,
1636  *                                                 SilcChannelPrivateKey key);
1637  *
1638  * DESCRIPTION
1639  *
1640  *    Sets the `key' to be used as current channel private key on the
1641  *    `channel'.  Packet sent after calling this function will be secured
1642  *    with `key'.
1643  *
1644  ***/
1645 void silc_client_current_channel_private_key(SilcClient client,
1646                                              SilcClientConnection conn,
1647                                              SilcChannelEntry channel,
1648                                              SilcChannelPrivateKey key);
1649
1650
1651 /* Key Agreement routines (client_keyagr.c) */
1652
1653 /****f* silcclient/SilcClientAPI/silc_client_send_key_agreement
1654  *
1655  * SYNOPSIS
1656  *
1657  *    void silc_client_send_key_agreement(SilcClient client,
1658  *                                        SilcClientConnection conn,
1659  *                                        SilcClientEntry client_entry,
1660  *                                        char *hostname,
1661  *                                        int port,
1662  *                                        SilcUInt32 timeout_secs,
1663  *                                        SilcKeyAgreementCallback completion,
1664  *                                        void *context);
1665  *
1666  * DESCRIPTION
1667  *
1668  *    Sends key agreement request to the remote client indicated by the
1669  *    `client_entry'. If the caller provides the `hostname' and the `port'
1670  *    arguments then the library will bind the client to that hostname and
1671  *    that port for the key agreement protocol. It also sends the `hostname'
1672  *    and the `port' in the key agreement packet to the remote client. This
1673  *    would indicate that the remote client may initiate the key agreement
1674  *    protocol to the `hostname' on the `port'.  If port is zero then the
1675  *    bound port is undefined (the operating system defines it).
1676  *
1677  *    If the `hostname' and `port' is not provided then empty key agreement
1678  *    packet is sent to the remote client. The remote client may reply with
1679  *    the same packet including its hostname and port. If the library receives
1680  *    the reply from the remote client the `key_agreement' client operation
1681  *    callback will be called to verify whether the user wants to perform the
1682  *    key agreement or not.
1683  *
1684  * NOTES
1685  *
1686  *    NOTE: If the application provided the `hostname' and the `port' and the
1687  *    remote side initiates the key agreement protocol it is not verified
1688  *    from the user anymore whether the protocol should be executed or not.
1689  *    By setting the `hostname' and `port' the user gives permission to
1690  *    perform the protocol (we are responder in this case).
1691  *
1692  *    NOTE: If the remote side decides not to initiate the key agreement
1693  *    or decides not to reply with the key agreement packet then we cannot
1694  *    perform the key agreement at all. If the key agreement protocol is
1695  *    performed the `completion' callback with the `context' will be called.
1696  *    If remote side decides to ignore the request the `completion' will be
1697  *    called after the specified timeout, `timeout_secs'.
1698  *
1699  *    NOTE: If the `hostname' and the `port' was not provided the `completion'
1700  *    will not be called at all since this does nothing more than sending
1701  *    a packet to the remote host.
1702  *
1703  *    NOTE: There can be only one active key agreement for one client entry.
1704  *    Before setting new one, the old one must be finished (it is finished
1705  *    after calling the completion callback) or the function
1706  *    silc_client_abort_key_agreement must be called.
1707  *
1708  ***/
1709 void silc_client_send_key_agreement(SilcClient client,
1710                                     SilcClientConnection conn,
1711                                     SilcClientEntry client_entry,
1712                                     const char *hostname,
1713                                     const char *bindhost,
1714                                     int port,
1715                                     SilcUInt32 timeout_secs,
1716                                     SilcKeyAgreementCallback completion,
1717                                     void *context);
1718
1719 /****f* silcclient/SilcClientAPI/silc_client_perform_key_agreement
1720  *
1721  * SYNOPSIS
1722  *
1723  *    void
1724  *    silc_client_perform_key_agreement(SilcClient client,
1725  *                                      SilcClientConnection conn,
1726  *                                      SilcClientEntry client_entry,
1727  *                                      char *hostname,
1728  *                                      int port,
1729  *                                      SilcKeyAgreementCallback completion,
1730  *                                      void *context);
1731  *
1732  * DESCRIPTION
1733  *
1734  *    Performs the actual key agreement protocol. Application may use this
1735  *    to initiate the key agreement protocol. This can be called for example
1736  *    after the application has received the `key_agreement' client operation,
1737  *    and did not return TRUE from it.
1738  *
1739  *    The `hostname' is the remote hostname (or IP address) and the `port'
1740  *    is the remote port. The `completion' callback with the `context' will
1741  *    be called after the key agreement protocol.
1742  *
1743  * NOTES
1744  *
1745  *    NOTE: If the application returns TRUE in the `key_agreement' client
1746  *    operation the library will automatically start the key agreement. In this
1747  *    case the application must not call this function. However, application
1748  *    may choose to just ignore the `key_agreement' client operation (and
1749  *    merely just print information about it on the screen) and call this
1750  *    function when the user whishes to do so (by, for example, giving some
1751  *    specific command). Thus, the API provides both, automatic and manual
1752  *    initiation of the key agreement. Calling this function is the manual
1753  *    initiation and returning TRUE in the `key_agreement' client operation
1754  *    is the automatic initiation.
1755  *
1756  ***/
1757 void silc_client_perform_key_agreement(SilcClient client,
1758                                        SilcClientConnection conn,
1759                                        SilcClientEntry client_entry,
1760                                        char *hostname,
1761                                        int port,
1762                                        SilcKeyAgreementCallback completion,
1763                                        void *context);
1764
1765 /****f* silcclient/SilcClientAPI/silc_client_perform_key_agreement_fd
1766  *
1767  * SYNOPSIS
1768  *
1769  *    void
1770  *    silc_client_perform_key_agreement_fd(SilcClient client,
1771  *                                         SilcClientConnection conn,
1772  *                                         SilcClientEntry client_entry,
1773  *                                         int sock,
1774  *                                         char *hostname,
1775  *                                         SilcKeyAgreementCallback completion,
1776  *                                         void *context);
1777  *
1778  * DESCRIPTION
1779  *
1780  *    Same as above but application has created already the connection to
1781  *    the remote host. The `sock' is the socket to the remote connection.
1782  *    Application can use this function if it does not want the client library
1783  *    to create the connection.
1784  *
1785  ***/
1786 void silc_client_perform_key_agreement_fd(SilcClient client,
1787                                           SilcClientConnection conn,
1788                                           SilcClientEntry client_entry,
1789                                           int sock,
1790                                           char *hostname,
1791                                           SilcKeyAgreementCallback completion,
1792                                           void *context);
1793
1794 /****f* silcclient/SilcClientAPI/silc_client_abort_key_agreement
1795  *
1796  * SYNOPSIS
1797  *
1798  *    void silc_client_abort_key_agreement(SilcClient client,
1799  *                                         SilcClientConnection conn,
1800  *                                         SilcClientEntry client_entry);
1801  *
1802  * DESCRIPTION
1803  *
1804  *    This function can be called to unbind the hostname and the port for
1805  *    the key agreement protocol. However, this function has effect only
1806  *    before the key agreement protocol has been performed. After it has
1807  *    been performed the library will automatically unbind the port. The
1808  *    `client_entry' is the client to which we sent the key agreement
1809  *    request.  The key agreement completion callback will be called
1810  *    with SILC_KEY_AGREEMENT_ABORTED status.
1811  *
1812  ***/
1813 void silc_client_abort_key_agreement(SilcClient client,
1814                                      SilcClientConnection conn,
1815                                      SilcClientEntry client_entry);
1816
1817
1818 /* Misc functions */
1819
1820 /****f* silcclient/SilcClientAPI/silc_client_set_away_message
1821  *
1822  * SYNOPSIS
1823  *
1824  *    void silc_client_set_away_message(SilcClient client,
1825  *                                      SilcClientConnection conn,
1826  *                                      char *message);
1827  *
1828  * DESCRIPTION
1829  *
1830  *    Sets away `message'.  The away message may be set when the client's
1831  *    mode is changed to SILC_UMODE_GONE and the client whishes to reply
1832  *    to anyone who sends private message.  The `message' will be sent
1833  *    automatically back to the the client who send private message.  If
1834  *    away message is already set this replaces the old message with the
1835  *    new one.  If `message' is NULL the old away message is removed.
1836  *    The sender may freely free the memory of the `message'.
1837  *
1838  ***/
1839 void silc_client_set_away_message(SilcClient client,
1840                                   SilcClientConnection conn,
1841                                   char *message);
1842
1843
1844 /****f* silcclient/SilcClientAPI/SilcConnectionAuthRequest
1845  *
1846  * SYNOPSIS
1847  *
1848  *    typedef void (*SilcConnectionAuthRequest)(SilcClient client,
1849  *                                              SilcClientConnection conn,
1850  *                                              SilcAuthMethod auth_meth,
1851  *                                              void *context);
1852  *
1853  * DESCRIPTION
1854  *
1855  *    Connection authentication method request callback. This is called
1856  *    by the client library after it has received the authentication method
1857  *    that the application requested by calling the function
1858  *    silc_client_request_authentication_method.
1859  *
1860  ***/
1861 typedef void (*SilcConnectionAuthRequest)(SilcClient client,
1862                                           SilcClientConnection conn,
1863                                           SilcAuthMethod auth_meth,
1864                                           void *context);
1865
1866 /****f* silcclient/SilcClientAPI/silc_client_request_authentication_method
1867  *
1868  * SYNOPSIS
1869  *
1870  *    void
1871  *    silc_client_request_authentication_method(SilcClient client,
1872  *                                              SilcClientConnection conn,
1873  *                                              SilcConnectionAuthRequest
1874  *                                                callback,
1875  *                                              void *context);
1876  *
1877  * DESCRIPTION
1878  *
1879  *    This function can be used to request the current authentication method
1880  *    from the server. This may be called when connecting to the server
1881  *    and the client library requests the authentication data from the
1882  *    application. If the application does not know the current authentication
1883  *    method it can request it from the server using this function.
1884  *    The `callback' with `context' will be called after the server has
1885  *    replied back with the current authentication method.
1886  *
1887  ***/
1888 void
1889 silc_client_request_authentication_method(SilcClient client,
1890                                           SilcClientConnection conn,
1891                                           SilcConnectionAuthRequest callback,
1892                                           void *context);
1893
1894 /****d* silcclient/SilcClientAPI/SilcClientMonitorStatus
1895  *
1896  * NAME
1897  *
1898  *    typedef enum { ... } SilcClientMonitorStatus;
1899  *
1900  * DESCRIPTION
1901  *
1902  *    File transmission session status types.  These will indicate
1903  *    the status of the file transmission session.
1904  *
1905  * SOURCE
1906  */
1907 typedef enum {
1908   SILC_CLIENT_FILE_MONITOR_KEY_AGREEMENT,    /* In key agreemenet phase */
1909   SILC_CLIENT_FILE_MONITOR_SEND,             /* Sending file */
1910   SILC_CLIENT_FILE_MONITOR_RECEIVE,          /* Receiving file */
1911   SILC_CLIENT_FILE_MONITOR_GET,
1912   SILC_CLIENT_FILE_MONITOR_PUT,
1913   SILC_CLIENT_FILE_MONITOR_CLOSED,           /* Session closed */
1914   SILC_CLIENT_FILE_MONITOR_ERROR,            /* Error during session */
1915 } SilcClientMonitorStatus;
1916 /***/
1917
1918 /****d* silcclient/SilcClientAPI/SilcClientFileError
1919  *
1920  * NAME
1921  *
1922  *    typedef enum { ... } SilcClientFileError;
1923  *
1924  * DESCRIPTION
1925  *
1926  *    File transmission error types.  These types are returned by
1927  *    some of the file transmission functions, and by the monitor
1928  *    callback to indicate error.
1929  *
1930  * SOURCE
1931  */
1932 typedef enum {
1933   SILC_CLIENT_FILE_OK,
1934   SILC_CLIENT_FILE_ERROR,
1935   SILC_CLIENT_FILE_UNKNOWN_SESSION,
1936   SILC_CLIENT_FILE_ALREADY_STARTED,
1937   SILC_CLIENT_FILE_NO_SUCH_FILE,
1938   SILC_CLIENT_FILE_PERMISSION_DENIED,
1939   SILC_CLIENT_FILE_KEY_AGREEMENT_FAILED,
1940 } SilcClientFileError;
1941 /***/
1942
1943 /****f* silcclient/SilcClientAPI/SilcClientFileMonitor
1944  *
1945  * SYNOPSIS
1946  *
1947  *    typedef void (*SilcClientFileMonitor)(SilcClient client,
1948  *                                          SilcClientConnection conn,
1949  *                                          SilcClientMonitorStatus status,
1950  *                                          SilcClientFileError error,
1951  *                                          SilcUInt64 offset,
1952  *                                          SilcUInt64 filesize,
1953  *                                          SilcClientEntry client_entry,
1954  *                                          SilcUInt32 session_id,
1955  *                                          const char *filepath,
1956  *                                          void *context);
1957  *
1958  * DESCRIPTION
1959  *
1960  *    Monitor callback that is called during the file transmission to
1961  *    monitor the transmission process.  The `status' indicates the current
1962  *    monitoring process.  The `error' will indicate the error type
1963  *    if `status' is SILC_CLIENT_FILE_MONITOR_ERROR.  The `offset' is the
1964  *    currently transmitted amount of total `filesize'.  The `client_entry'
1965  *    indicates the remote client, and the transmission session ID is the
1966  *    `session_id'.  The filename being transmitted is indicated by the
1967  *    `filepath'.
1968  *
1969  ***/
1970 typedef void (*SilcClientFileMonitor)(SilcClient client,
1971                                       SilcClientConnection conn,
1972                                       SilcClientMonitorStatus status,
1973                                       SilcClientFileError error,
1974                                       SilcUInt64 offset,
1975                                       SilcUInt64 filesize,
1976                                       SilcClientEntry client_entry,
1977                                       SilcUInt32 session_id,
1978                                       const char *filepath,
1979                                       void *context);
1980
1981 /****f* silcclient/SilcClientAPI/silc_client_file_send
1982  *
1983  * SYNOPSIS
1984  *
1985  *    SilcClientFileError
1986  *    silc_client_file_send(SilcClient client,
1987  *                          SilcClientConnection conn,
1988  *                          SilcClientFileMonitor monitor,
1989  *                          void *monitor_context,
1990  *                          const char *local_ip,
1991  *                          SilcUInt32 local_port,
1992  *                          SilcClientEntry client_entry,
1993  *                          const char *filepath);
1994  *                          SilcUInt32 *session_id);
1995  *
1996  * DESCRIPTION
1997  *
1998  *    Sends a file indicated by the `filepath' to the remote client
1999  *    indicated by the `client_entry'.  This will negotiate a secret key
2000  *    with the remote client before actually starting the transmission of
2001  *    the file.  The `monitor' callback will be called to monitor the
2002  *    transmission of the file.
2003  *
2004  *    This returns a file session ID for the file transmission to the
2005  *    `session_id' pointer..  It can be used to close the session (and
2006  *    abort the file transmission) by calling the silc_client_file_close
2007  *    function.  The session ID is also returned in the `monitor' callback.
2008  *
2009  *    If the `local_ip' is provided then this will try to bind the
2010  *    listener for key exchange protocol to that IP.  If `local_port' is
2011  *    non-zero that port is used.  If `local_ip' is NULL then this will
2012  *    automatically attempt to bind it to local IP address of the machine.
2013  *    If that fails then this does not bind to any address and port, and
2014  *    assume that the remote client will provide the listener for the
2015  *    key exchange protocol.
2016  *
2017  *    If error will occur during the file transfer process the error
2018  *    status will be returned in the monitor callback.  In this case
2019  *    the application must call silc_client_file_close to close the
2020  *    session.
2021  *
2022  ***/
2023 SilcClientFileError
2024 silc_client_file_send(SilcClient client,
2025                       SilcClientConnection conn,
2026                       SilcClientFileMonitor monitor,
2027                       void *monitor_context,
2028                       const char *local_ip,
2029                       SilcUInt32 local_port,
2030                       SilcClientEntry client_entry,
2031                       const char *filepath,
2032                       SilcUInt32 *session_id);
2033
2034 /****f* silcclient/SilcClientAPI/silc_client_file_receive
2035  *
2036  * SYNOPSIS
2037  *
2038  *    SilcClientFileError
2039  *    silc_client_file_receive(SilcClient client,
2040  *                             SilcClientConnection conn,
2041  *                             SilcClientFileMonitor monitor,
2042  *                             void *monitor_context,
2043  *                             SilcUInt32 session_id);
2044  *
2045  * DESCRIPTION
2046  *
2047  *    Receives a file from a client indicated by the `client_entry'.  The
2048  *    `session_id' indicates the file transmission session and it has been
2049  *    received in the `ftp' client operation function.  This will actually
2050  *    perform the key agreement protocol with the remote client before
2051  *    actually starting the file transmission.  The `monitor' callback
2052  *    will be called to monitor the transmission.
2053  *
2054  *    If error will occur during the file transfer process the error
2055  *    status will be returned in the monitor callback.  In this case
2056  *    the application must call silc_client_file_close to close the
2057  *    session.
2058  *
2059  ***/
2060 SilcClientFileError
2061 silc_client_file_receive(SilcClient client,
2062                          SilcClientConnection conn,
2063                          SilcClientFileMonitor monitor,
2064                          void *monitor_context,
2065                          SilcUInt32 session_id);
2066
2067 /****f* silcclient/SilcClientAPI/silc_client_file_close
2068  *
2069  * SYNOPSIS
2070  *
2071  *    SilcClientFileError silc_client_file_close(SilcClient client,
2072  *                                               SilcClientConnection conn,
2073  *                                               SilcUInt32 session_id);
2074  *
2075  * DESCRIPTION
2076  *
2077  *    Closes file transmission session indicated by the `session_id'.
2078  *    If file transmission is being conducted it will be aborted
2079  *    automatically. This function is also used to close the session
2080  *    after successful file transmission. This function can be used
2081  *    also to reject incoming file transmission request.
2082  *
2083  ***/
2084 SilcClientFileError silc_client_file_close(SilcClient client,
2085                                            SilcClientConnection conn,
2086                                            SilcUInt32 session_id);
2087
2088 #include "client.h"
2089 #include "command.h"
2090 #include "command_reply.h"
2091 #include "idlist.h"
2092 #include "protocol.h"
2093
2094 #ifdef __cplusplus
2095 }
2096 #endif
2097
2098 #endif /* SILCCLIENT_H */