lib/silcclient/silcapi.h

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