lib/silcclient/silcclient.h

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