/*
- silcclient.h
+ silcclient.h
Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 2000 - 2002 Pekka Riikonen
+ Copyright (C) 2000 - 2005 Pekka Riikonen
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
* applications. These functions are implemented in the SILC Client Library.
* Application may freely call these functions from the library.
*
- * Please, refer to the README file in this directory for the directions
- * of how to use the SILC Client Library.
- *
***/
#ifndef SILCCLIENT_H
*/
struct SilcClientStruct {
/*
- * The following fields are set by application
+ * The following fields are set by application. Strings MUST be UTF-8
+ * encoded strings.
*/
char *nickname; /* Nickname, MAY be set by application */
char *username; /* Username, MUST be set by application */
char *hostname; /* hostname, MUST be set by application */
char *realname; /* Real name, MUST be set be application */
-
+
SilcPublicKey public_key; /* Public key of user, set by application */
SilcPrivateKey private_key; /* Private key of user, set by application */
SilcPKCS pkcs; /* PKCS allocated by application */
/* Scheduler, set by library. Application may use this pointer. */
SilcSchedule schedule;
-
+
/* Random Number Generator. Application should use this as its primary
random number generator. */
SilcRng rng;
-
+
/* Application specific user data pointer. Client library does not
touch this. This the context sent as argument to silc_client_alloc.
Application can use it freely. */
void *application;
-
+
/* Generic hash context for application usage */
SilcHash md5hash;
SilcHash sha1hash;
/* Internal data for client library. Application cannot access this
data at all. */
SilcClientInternal internal;
-};
+};
/***/
/****s* silcclient/SilcClientAPI/SilcClientConnection
* to server this is context is returned to the application in the
* "connected" client operation. It includes all the important
* data for the session, such as nickname, local and remote IDs, and
- * other information.
+ * other information. All strings in the structure are UTF-8 encoded.
*
* SOURCE
*/
/*
* Remote data
*/
- char *remote_host; /* Remote host name */
+ char *remote_host; /* Remote host name, UTF-8 encoded */
int remote_port; /* Remote port */
SilcServerID *remote_id; /* Remote Server ID */
unsigned char *remote_id_data; /* Remote Server ID decoded */
};
/***/
+/****s* silcclient/SilcClientAPI/SilcClientEntry
+ *
+ * NAME
+ *
+ * typedef struct SilcClientEntryStruct { ... } *SilcClientEntry
+ *
+ * DESCRIPTION
+ *
+ * This structure represents a client or a user in the SILC network.
+ * The local user has this structure also and it can be accessed from
+ * SilcClientConnection structure. All other users in the SILC network
+ * that are accessed using the Client Library routines will have their
+ * own SilcClientEntry structure. For example, when finding users by
+ * their nickname the Client Library returns this structure back to
+ * the application. All strings in the structure are UTF-8 encoded.
+ *
+ * SOURCE
+ */
+struct SilcClientEntryStruct {
+ /* General information */
+ char *nickname; /* nickname */
+ char *username; /* username */
+ char *hostname; /* hostname */
+ char *server; /* SILC server name */
+ char *realname; /* Realname (userinfo) */
+
+ /* Mode, ID and other information */
+ SilcUInt32 mode; /* User mode in SILC, see SilcUserMode */
+ SilcClientID *id; /* The Client ID */
+ SilcDList attrs; /* Requested Attributes (maybe NULL) */
+ unsigned char *fingerprint; /* Fingerprint of client's public key */
+ SilcUInt32 fingerprint_len; /* Length of the fingerprint */
+ SilcPublicKey public_key; /* User's public key, may be NULL */
+
+ /* Private message keys */
+ SilcCipher send_key; /* Private message key for sending */
+ SilcCipher receive_key; /* Private message key for receiving */
+ SilcHmac hmac_send; /* Private mesage key HMAC for sending */
+ SilcHmac hmac_receive; /* Private mesage key HMAC for receiving */
+ unsigned char *key; /* Set only if application provided the
+ key material. NULL if the library
+ generated the key. */
+ SilcUInt32 key_len; /* Key length */
+ SilcClientKeyAgreement ke; /* Current key agreement context or NULL */
+
+ /* SilcClientEntry status information */
+ SilcEntryStatus status; /* Status mask */
+ SilcHashTable channels; /* All channels client has joined */
+ SilcUInt16 resolve_cmd_ident; /* Command identifier when resolving */
+ unsigned int generated : 1; /* TRUE if library generated `key' */
+ unsigned int valid : 1; /* FALSE if this entry is not valid */
+ unsigned int prv_resp : 1; /* TRUE if private message key indicator
+ has been received (responder). */
+
+ /* Application specific data. Application may set here whatever it wants. */
+ void *context;
+};
+/***/
+
+/****s* silcclient/SilcClientAPI/SilcChannelEntry
+ *
+ * NAME
+ *
+ * typedef struct SilcChannelEntryStruct { ... } *SilcChannelEntry
+ *
+ * DESCRIPTION
+ *
+ * This structure represents a channel in the SILC network. All
+ * channels that the client are aware of or have joined in will be
+ * represented as SilcChannelEntry. The structure includes information
+ * about the channel. All strings in the structure are UTF-8 encoded.
+ *
+ * SOURCE
+ */
+struct SilcChannelEntryStruct {
+ /* General information */
+ char *channel_name; /* Channel name */
+ SilcChannelID *id; /* Channel ID */
+ SilcUInt32 mode; /* Channel mode, ChannelModes. */
+ char *topic; /* Current topic, may be NULL */
+ SilcPublicKey founder_key; /* Founder key, may be NULL */
+ SilcUInt32 user_limit; /* User limit on channel */
+
+ /* All clients that has joined this channel. The key to the table is the
+ SilcClientEntry and the context is SilcChannelUser context. */
+ SilcHashTable user_list;
+
+ /* Channel keys */
+ SilcCipher channel_key; /* The channel key */
+ unsigned char *key; /* Raw key data */
+ SilcUInt32 key_len; /* Raw key data length */
+ unsigned char iv[SILC_CIPHER_MAX_IV_SIZE]; /* Current IV */
+ SilcHmac hmac; /* Current HMAC */
+
+ /* Channel private keys */
+ SilcDList private_keys; /* List of private keys or NULL */
+ SilcChannelPrivateKey curr_key; /* Current private key */
+
+ /* SilcChannelEntry status information */
+ SilcDList old_channel_keys;
+ SilcDList old_hmacs;
+ SilcUInt16 resolve_cmd_ident; /* Command identifier when
+ resolving this entry */
+
+ /* Application specific data. Application may set here whatever it wants. */
+ void *context;
+};
+/***/
+
+/****s* silcclient/SilcClientAPI/SilcChannelUser
+ *
+ * NAME
+ *
+ * typedef struct SilcChannelUserStruct { ... } *SilcChannelUser
+ *
+ * DESCRIPTION
+ *
+ * This structure represents a client that has joined to a channel.
+ * It shows the client and the channel and the client's mode (channel
+ * user mode) on the channel.
+ *
+ * SOURCE
+ */
+struct SilcChannelUserStruct {
+ SilcClientEntry client; /* Client joined on channel */
+ SilcUInt32 mode; /* mode, ChannelUserModes */
+ SilcChannelEntry channel; /* The channel user has joined */
+
+ /* Application specific data. Application may set here whatever it wants. */
+ void *context;
+};
+/***/
+
+/****s* silcclient/SilcClientAPI/SilcServerEntry
+ *
+ * NAME
+ *
+ * typedef struct SilcServerEntryStruct { ... } *SilcServerEntry
+ *
+ * DESCRIPTION
+ *
+ * This structure represents a server in the SILC network. All servers
+ * that the client is aware of and have for example resolved with
+ * SILC_COMMAND_INFO command have their on SilcServerEntry structure.
+ * All strings in the structure are UTF-8 encoded.
+ *
+ * SOURCE
+ */
+struct SilcServerEntryStruct {
+ /* General information */
+ char *server_name; /* Server name */
+ char *server_info; /* Server info */
+ SilcServerID *server_id; /* Server ID */
+ SilcUInt16 resolve_cmd_ident; /* Command identifier when
+ resolving this entry */
+
+ /* Application specific data. Application may set here whatever it wants. */
+ void *context;
+};
+/***/
+
/****d* silcclient/SilcClientAPI/SilcKeyAgreementStatus
*
* NAME
* DESCRIPTION
*
* Key agreement status types indicating the status of the key
- * agreement protocol. These types are returned to the application
+ * agreement protocol. These types are returned to the application
* in the SilcKeyAgreementCallback callback function.
*
* SOURCE
*
* NAME
*
- * typedef struct { ... } SilcChannelPrivateKey;
+ * typedef struct SilcChannelPrivateKeyStruct { ... }
+ * *SilcChannelPrivateKey;
*
* DESCRIPTION
*
*
* SOURCE
*/
-typedef struct SilcChannelPrivateKeyStruct {
+struct SilcChannelPrivateKeyStruct {
char *name; /* Application given name */
SilcCipher cipher; /* The cipher and key */
SilcHmac hmac; /* The HMAC and hmac key */
unsigned char *key; /* The key data */
SilcUInt32 key_len; /* The key length */
-} *SilcChannelPrivateKey;
+};
/***/
/****f* silcclient/SilcClientAPI/SilcAskPassphrase
*
* SYNOPSIS
*
- * typedef void (*SilcVerifyPublicKey)(bool success, void *context);
+ * typedef void (*SilcVerifyPublicKey)(SilcBool success, void *context);
*
* DESCRIPTION
*
* either success or failure.
*
***/
-typedef void (*SilcVerifyPublicKey)(bool success, void *context);
+typedef void (*SilcVerifyPublicKey)(SilcBool success, void *context);
/****f* silcclient/SilcClientAPI/SilcGetAuthMeth
*
* SYNOPSIS
*
- * typedef void (*SilcGetAuthMeth)(bool success,
+ * typedef void (*SilcGetAuthMeth)(SilcBool success,
* SilcProtocolAuthMeth auth_meth,
* const unsigned char *auth_data,
* SilcUInt32 auth_data_len, void *context);
- *
+ *
* DESCRIPTION
*
* Authentication method resolving callback. This is called by the
* context sent to the get_auth_method client operation.
*
***/
-typedef void (*SilcGetAuthMeth)(bool success,
+typedef void (*SilcGetAuthMeth)(SilcBool success,
SilcProtocolAuthMeth auth_meth,
const unsigned char *auth_data,
SilcUInt32 auth_data_len, void *context);
* DESCRIPTION
*
* This type is returned to the `connect' client operation to indicate
- * the status of the created connection. It can indicated if it was
+ * the status of the created connection. It can indicate if it was
* successful or whether an error occurred.
*
* SOURCE
SILC_CLIENT_CONN_SUCCESS, /* Successfully connected */
SILC_CLIENT_CONN_SUCCESS_RESUME, /* Successfully connected and
resumed old detached session */
- SILC_CLIENT_CONN_ERROR, /* Error occurred during connecting */
+ SILC_CLIENT_CONN_ERROR, /* Unknown error occurred during
+ connecting */
+ SILC_CLIENT_CONN_ERROR_KE, /* Key Exchange failed */
+ SILC_CLIENT_CONN_ERROR_AUTH, /* Authentication failed */
+ SILC_CLIENT_CONN_ERROR_RESUME, /* Resuming failed */
+ SILC_CLIENT_CONN_ERROR_TIMEOUT, /* Timeout during connecting */
} SilcClientConnectionStatus;
/***/
*/
typedef struct {
/* Message sent to the application by library. `conn' associates the
- message to a specific connection. `conn', however, may be NULL.
+ message to a specific connection. `conn', however, may be NULL.
The `type' indicates the type of the message sent by the library.
The application can for example filter the message according the
- type. */
- void (*say)(SilcClient client, SilcClientConnection conn,
+ type. The variable argument list is arguments to the formatted
+ message that `msg' may be. */
+ void (*say)(SilcClient client, SilcClientConnection conn,
SilcClientMessageType type, char *msg, ...);
- /* Message for a channel. The `sender' is the sender of the message
- The `channel' is the channel. The `message' is the message. Note
- that `message' maybe NULL. The `flags' indicates message flags
+ /* Message for a channel. The `sender' is the sender of the message
+ The `channel' is the channel. The `message' is the message. Note
+ that `message' maybe NULL. The `flags' indicates message flags
and it is used to determine how the message can be interpreted
(like it may tell the message is multimedia message). */
- void (*channel_message)(SilcClient client, SilcClientConnection conn,
- SilcClientEntry sender, SilcChannelEntry channel,
- SilcMessageFlags flags,
+ void (*channel_message)(SilcClient client, SilcClientConnection conn,
+ SilcClientEntry sender, SilcChannelEntry channel,
+ SilcMessagePayload payload,
+ SilcChannelPrivateKey key, SilcMessageFlags flags,
const unsigned char *message,
SilcUInt32 message_len);
/* Private message to the client. The `sender' is the sender of the
- message. The message is `message'and maybe NULL. The `flags'
- indicates message flags and it is used to determine how the message
- can be interpreted (like it may tell the message is multimedia
+ message. The message is `message'and maybe NULL. The `flags'
+ indicates message flags and it is used to determine how the message
+ can be interpreted (like it may tell the message is multimedia
message). */
void (*private_message)(SilcClient client, SilcClientConnection conn,
- SilcClientEntry sender, SilcMessageFlags flags,
+ SilcClientEntry sender, SilcMessagePayload payload,
+ SilcMessageFlags flags,
const unsigned char *message,
SilcUInt32 message_len);
for channel the channel entry is sent to application (even if server
does not send it because client library gets the channel entry from
the Channel ID in the packet's header). */
- void (*notify)(SilcClient client, SilcClientConnection conn,
+ void (*notify)(SilcClient client, SilcClientConnection conn,
SilcNotifyType type, ...);
/* Command handler. This function is called always in the command function.
noted that this is not reply from server. This is merely called just
after application has called the command. Just to tell application
that the command really was processed. */
- void (*command)(SilcClient client, SilcClientConnection conn,
- SilcClientCommandContext cmd_context, bool success,
+ void (*command)(SilcClient client, SilcClientConnection conn,
+ SilcClientCommandContext cmd_context, SilcBool success,
SilcCommand command, SilcStatus status);
/* Command reply handler. This function is called always in the command reply
function. If error occurs it will be called as well. Normal scenario
is that it will be called after the received command data has been parsed
and processed. The function is used to pass the received command data to
- the application.
-
+ the application.
+
`conn' is the associated client connection. `cmd_payload' is the command
payload data received from server and it can be ignored. It is provided
if the application would like to re-parse the received command data,
command defines the number and type of arguments it passes to the
application (on error they are not sent).
- The arguments are sent in the same order as servers sends them. The
- arguments are same as received from the server except for ID's. If
- ID is received application receives the corresponding entry to the
- ID. For example, if Client ID is receives application receives
+ The arguments are sent in the same order as servers sends them. The
+ arguments are same as received from the server except for ID's. If
+ ID is received application receives the corresponding entry to the
+ ID. For example, if Client ID is receives application receives
SilcClientEntry. */
void (*command_reply)(SilcClient client, SilcClientConnection conn,
- SilcCommandPayload cmd_payload, bool success,
+ SilcCommandPayload cmd_payload, SilcBool success,
SilcCommand command, SilcStatus status, ...);
/* Called to indicate that connection was either successfully established
/* Called to indicate that connection was disconnected to the server.
The `status' may tell the reason of the disconnection, and if the
`message' is non-NULL it may include the disconnection message
- received from server. */
+ received from server. Application must not call the
+ silc_client_close_connection in this callback. The 'conn' is also
+ invalid after this function returns back to library. */
void (*disconnected)(SilcClient client, SilcClientConnection conn,
SilcStatus status, const char *message);
/* Verifies received public key. The `conn_type' indicates which entity
(server, client etc.) has sent the public key. If user decides to trust
- the application may save the key as trusted public key for later
- use. The `completion' must be called after the public key has been
+ the application may save the key as trusted public key for later
+ use. The `completion' must be called after the public key has been
verified. */
void (*verify_public_key)(SilcClient client, SilcClientConnection conn,
- SilcSocketType conn_type, unsigned char *pk,
+ SilcSocketType conn_type, unsigned char *pk,
SilcUInt32 pk_len, SilcSKEPKType pk_type,
SilcVerifyPublicKey completion, void *context);
application must explicitly cast it to correct type. Usually `failure'
is 32 bit failure type (see protocol specs for all protocol failure
types). */
- void (*failure)(SilcClient client, SilcClientConnection conn,
+ void (*failure)(SilcClient client, SilcClientConnection conn,
SilcProtocol protocol, void *failure);
/* Asks whether the user would like to perform the key agreement protocol.
desired (application may start it later by calling the function
silc_client_perform_key_agreement). If TRUE is returned also the
`completion' and `context' arguments must be set by the application. */
- bool (*key_agreement)(SilcClient client, SilcClientConnection conn,
+ SilcBool (*key_agreement)(SilcClient client, SilcClientConnection conn,
SilcClientEntry client_entry, const char *hostname,
SilcUInt16 port, SilcKeyAgreementCallback *completion,
void **context);
const char *hostname, SilcUInt16 port);
/* Delivers SILC session detachment data indicated by `detach_data' to the
- application. If application has issued SILC_COMMAND_DETACH command
- the client session in the SILC network is not quit. The client remains
+ application. If application has issued SILC_COMMAND_DETACH command
+ the client session in the SILC network is not quit. The client remains
in the network but is detached. The detachment data may be used later
- to resume the session in the SILC Network. The appliation is
+ to resume the session in the SILC Network. The appliation is
responsible of saving the `detach_data', to for example in a file.
The detachment data can be given as argument to the functions
/* Connection authentication method request timeout. If server does not
reply back the current authentication method when we've requested it
- in this time interval we'll assume the reply will not come at all.
+ in this time interval we'll assume the reply will not come at all.
If set to zero, the default value (2 seconds) will be used. */
unsigned int connauth_request_secs;
/* Nickname format string. This can be used to order the client library
- to save the nicknames in the library in a certain format. Since
+ to save the nicknames in the library in a certain format. Since
nicknames are not unique in SILC it is possible to have multiple same
nicknames. Using this format string it is possible to order the library
to separate the multiple same nicknames from each other. The format
string. If this is NULL then default format is used which is the
default nickname without anything else. The string MUST be NULL
terminated.
-
+
Following format types are available:
-
+
%n nickname - the real nickname returned by the server (mandatory)
%h hostname - the stripped hostname of the client
%H full hostname - the full hostname of the client
char nickname_format[32];
/* If this is set to TRUE then the `nickname_format' is employed to all
- saved nicknames even if there are no multiple same nicknames in the
+ saved nicknames even if there are no multiple same nicknames in the
cache. By default this is FALSE, which means that the `nickname_format'
is employed only if the library will receive a nickname that is
already saved in the cache. It is recommended to leave this to FALSE
value. */
- bool nickname_force_format;
+ SilcBool nickname_force_format;
/* A callback function provided by the application for the library to
parse the nickname from the formatted nickname string. Even though
If your application does not support Requested Attributes or you do
not want to use them set this to TRUE. See SilcAttribute and
silc_client_attribute_add for more information on attributes. */
- bool ignore_requested_attributes;
+ SilcBool ignore_requested_attributes;
+
+ /* If this is set to TRUE, the silcclient library will not register and
+ deregister the cipher, pkcs, hash and hmac algorithms. The application
+ itself will need to handle that. */
+ SilcBool dont_register_crypto_library;
} SilcClientParams;
/***/
*
* SYNOPSIS
*
- * SilcClient silc_client_alloc(SilcClientOperations *ops,
+ * SilcClient silc_client_alloc(SilcClientOperations *ops,
* SilcClientParams *params,
* void *application,
* const char *silc_version);
* application by client->application, client being SilcClient.
*
***/
-SilcClient silc_client_alloc(SilcClientOperations *ops,
+SilcClient silc_client_alloc(SilcClientOperations *ops,
SilcClientParams *params,
void *application,
const char *version_string);
*
* SYNOPSIS
*
- * int silc_client_init(SilcClient client);
+ * SilcBool silc_client_init(SilcClient client);
*
* DESCRIPTION
*
* client. Returns FALSE if error occurred, TRUE otherwise.
*
***/
-int silc_client_init(SilcClient client);
+SilcBool silc_client_init(SilcClient client);
/****f* silcclient/SilcClientAPI/silc_client_run
*
*
* SYNOPSIS
*
- * int silc_client_connect_to_server(SilcClient client,
+ * int silc_client_connect_to_server(SilcClient client,
* SilcClientConnectionParams *params,
* int port, char *host, void *context);
*
* DESCRIPTION
*
* Connects to remote server. This is the main routine used to connect
- * to SILC server. Returns -1 on error and the created socket otherwise.
+ * to SILC server. Returns -1 on error and the created socket otherwise.
* The `context' is user context that is saved into the SilcClientConnection
* that is created after the connection is created. Note that application
* may handle the connecting process outside the library. If this is the
* If the `params' is provided they are used by the routine.
*
***/
-int silc_client_connect_to_server(SilcClient client,
+int silc_client_connect_to_server(SilcClient client,
SilcClientConnectionParams *params,
int port, char *host, void *context);
* connection to the connection table and returns a pointer to it. A client
* can have multiple connections to multiple servers. Every connection must
* be added to the client using this function. User data `context' may
- * be sent as argument. If the `params' is provided they are used by
+ * be sent as argument. If the `params' is provided they are used by
* the routine.
*
* NOTES
*
- * This function is normally used only if the application performed
+ * This function is normally used only if the application performed
* the connecting outside the library, and did not called the
* silc_client_connect_to_server function at all. The library
* however may use this internally.
*
* SYNOPSIS
*
- * void silc_client_del_connection(SilcClient client,
+ * void silc_client_del_connection(SilcClient client,
* SilcClientConnection conn);
*
* DESCRIPTION
*
* SYNOPSIS
*
- * void silc_client_add_socket(SilcClient client,
+ * void silc_client_add_socket(SilcClient client,
* SilcSocketConnection sock);
*
* DESCRIPTION
*
* SYNOPSIS
*
- * void silc_client_del_socket(SilcClient client,
+ * void silc_client_del_socket(SilcClient client,
* SilcSocketConnection sock);
*
* DESCRIPTION
* library. The library however may use this internally. After the
* key exchange is performed the `connect' client operation is called.
*
+ * NOTES
+ *
+ * The silc_client_add_connection must be called before calling this
+ * function to create the SilcClientConnection context for this
+ * connection.
+ *
***/
void silc_client_start_key_exchange(SilcClient client,
SilcClientConnection conn,
* DESCRIPTION
*
* Closes connection to remote end. Free's all allocated data except
- * for some information such as nickname etc. that are valid at all time.
+ * for some information such as nickname etc. that are valid at all time.
+ * Usually application does not need to directly call this, except
+ * when explicitly closing the connection, or if an error occurs
+ * during connection to server (see 'connect' client operation for
+ * more information).
*
***/
void silc_client_close_connection(SilcClient client,
*
* SYNOPSIS
*
- * void silc_client_send_channel_message(SilcClient client,
+ * SilcBool silc_client_send_channel_message(SilcClient client,
* SilcClientConnection conn,
* SilcChannelEntry channel,
* SilcChannelPrivateKey key,
* SilcMessageFlags flags,
- * unsigned char *data,
- * SilcUInt32 data_len,
- * int force_send);
+ * unsigned char *data,
+ * SilcUInt32 data_len,
+ * SilcBool force_send);
*
* DESCRIPTION
*
* Sends packet to the `channel'. Packet to channel is always encrypted
- * differently from "normal" packets. SILC header of the packet is
+ * differently from "normal" packets. SILC header of the packet is
* encrypted with the next receiver's key and the rest of the packet is
* encrypted with the channel specific key. Padding and HMAC is computed
* with the next receiver's key. The `data' is the channel message. If
- * the `force_send' is TRUE then the packet is sent immediately.
+ * the `force_send' is TRUE then the packet is sent immediately.
*
* If `key' is provided then that private key is used to encrypt the
* channel message. If it is not provided, private keys has not been
* set at all, the normal channel key is used automatically. If private
* keys are set then the first key (the key that was added first as
- * private key) is used.
+ * private key) is used.
+ *
+ * If the `flags' includes SILC_MESSAGE_FLAG_SIGNED the message will be
+ * digitally signed with the SILC key pair.
+ *
+ * Returns TRUE if the message was sent, and FALSE if error occurred or
+ * the sending is not allowed due to channel modes (like sending is
+ * blocked).
*
***/
-void silc_client_send_channel_message(SilcClient client,
+SilcBool silc_client_send_channel_message(SilcClient client,
SilcClientConnection conn,
SilcChannelEntry channel,
SilcChannelPrivateKey key,
SilcMessageFlags flags,
- unsigned char *data,
- SilcUInt32 data_len,
- int force_send);
+ unsigned char *data,
+ SilcUInt32 data_len,
+ SilcBool force_send);
/****f* silcclient/SilcClientAPI/silc_client_send_private_message
*
* SYNOPSIS
*
- * void silc_client_send_private_message(SilcClient client,
+ * SilcBool silc_client_send_private_message(SilcClient client,
* SilcClientConnection conn,
* SilcClientEntry client_entry,
* SilcMessageFlags flags,
- * unsigned char *data,
- * SilcUInt32 data_len,
- * int force_send);
+ * unsigned char *data,
+ * SilcUInt32 data_len,
+ * SilcBool force_send);
*
* DESCRIPTION
*
* network hence we need this own function for them. This is similar
* to silc_client_packet_send_to_channel except that we send private
* message. The `data' is the private message. If the `force_send' is
- * TRUE the packet is sent immediately.
+ * TRUE the packet is sent immediately.
+ *
+ * If the `flags' includes SILC_MESSAGE_FLAG_SIGNED the message will be
+ * digitally signed with the SILC key pair.
+ *
+ * Returns TRUE if the message was sent, and FALSE if error occurred.
*
***/
-void silc_client_send_private_message(SilcClient client,
+SilcBool silc_client_send_private_message(SilcClient client,
SilcClientConnection conn,
SilcClientEntry client_entry,
SilcMessageFlags flags,
- unsigned char *data,
- SilcUInt32 data_len,
- int force_send);
+ unsigned char *data,
+ SilcUInt32 data_len,
+ SilcBool force_send);
/* Client and Channel entry retrieval (idlist.c) */
*
* DESCRIPTION
*
- * Finds client entry or entries by the `nickname' and `server'. The
+ * Finds client entry or entries by the `nickname' and `server'. The
* completion callback will be called when the client entries has been
* found. After the server returns the client information it is cached
- * and can be accesses locally at a later time.
+ * and can be accesses locally at a later time. The resolving is done
+ * with IDENTIFY command. The `server' may be NULL.
*
* NOTES
*
* information from the server. Thus, if you already know the client
* information then use the silc_client_get_client_by_id function to
* get the client entry since this function may be very slow and should
- * be used only to initially get the client entries.
+ * be used only to initially get the client entries.
+ *
+ * Since this routine resolves with IDENTIFY command only the relevant
+ * information (user's nickname and username) is resolved. For example,
+ * user's real name, channel list and others are not resolved. Caller
+ * can/must resolve those separately if they are needed (for example,
+ * with silc_client_get_client_by_id_resolve).
*
***/
void silc_client_get_clients(SilcClient client,
SilcGetClientCallback completion,
void *context);
+/****f* silcclient/SilcClientAPI/silc_client_get_clients_whois
+ *
+ * SYNOPSIS
+ *
+ * void silc_client_get_clients_whois(SilcClient client,
+ * SilcClientConnection conn,
+ * const char *nickname,
+ * const char *server,
+ * SilcBuffer attributes,
+ * SilcGetClientCallback completion,
+ * void *context);
+ *
+ * DESCRIPTION
+ *
+ * Finds client entry or entries by the `nickname' and `server'. The
+ * completion callback will be called when the client entries has been
+ * found. After the server returns the client information it is cached
+ * and can be accesses locally at a later time. The resolving is done
+ * with WHOIS command. The `server' may be NULL.
+ *
+ * If the `attributes' is non-NULL then the buffer includes Requested
+ * Attributes which can be used to fetch very detailed information
+ * about the user. If it is NULL then only normal WHOIS query is
+ * made (for more information about attributes see SilcAttribute).
+ * Caller may create the `attributes' with silc_client_attributes_request
+ * function.
+ *
+ * NOTES
+ *
+ * The resolving is done with WHOIS command. For this reason this
+ * command may take a long time because it resolves detailed user
+ * information.
+ *
+ ***/
+void silc_client_get_clients_whois(SilcClient client,
+ SilcClientConnection conn,
+ const char *nickname,
+ const char *server,
+ SilcBuffer attributes,
+ SilcGetClientCallback completion,
+ void *context);
+
/****f* silcclient/SilcClientAPI/silc_client_get_clients_local
*
* SYNOPSIS
const char *format,
SilcUInt32 *clients_count);
+/****f* silcclient/SilcClientAPI/silc_client_get_clients_by_channel
+ *
+ * SYNOPSIS
+ *
+ * void silc_client_get_clients_by_channel(SilcClient client,
+ * SilcClientConnection conn,
+ * SilcChannelEntry channel,
+ * SilcGetClientCallback completion,
+ * void *context);
+ *
+ * DESCRIPTION
+ *
+ * Gets client entries by the channel indicated by `channel'. Thus,
+ * it resovles the users currently on that channel. If all users are
+ * already resolved this returns the users from the channel. If the
+ * users are resolved only partially this resolves the complete user
+ * information. If no users are resolved on this channel at all, this
+ * calls USERS command to resolve all users on the channel. The `completion'
+ * will be called after the entries are available. When server returns
+ * the client information it will be cached and can be accessed locally
+ * at a later time.
+ *
+ * This function can be used for example in SILC_COMMAND_JOIN command
+ * reply handling in application to resolve users on that channel. It
+ * also can be used after calling silc_client_get_channel_resolve to
+ * resolve users on that channel.
+ *
+ * NOTES
+ *
+ * The resolving is done with WHOIS command. For this reason this
+ * command may take a long time because it resolves detailed user
+ * information.
+ *
+ ***/
+void silc_client_get_clients_by_channel(SilcClient client,
+ SilcClientConnection conn,
+ SilcChannelEntry channel,
+ SilcGetClientCallback completion,
+ void *context);
+
/****f* silcclient/SilcClientAPI/silc_client_get_clients_by_list
*
* SYNOPSIS
* the client information it will be cached and can be accessed locally
* at a later time.
*
+ * NOTES
+ *
+ * The resolving is done with IDENTIFY command. This means that only
+ * the relevant information of user (it's nickname and username) is
+ * resolved. For example, user's real name, channel lists and others
+ * are not resolved. Caller can/must resolve those separately if they
+ * are needed (for example, with silc_client_get_client_by_id_resolve).
+ *
***/
void silc_client_get_clients_by_list(SilcClient client,
SilcClientConnection conn,
*
* SYNOPSIS
*
- * void
+ * void
* silc_client_get_client_by_id_resolve(SilcClient client,
* SilcClientConnection conn,
* SilcClientID *client_id,
* information from the server. Use this only if you know that you
* do not have the entry and the only thing you know about the client
* is its ID. When server returns the client information it will be
- * cache and can be accessed locally at a later time.
+ * cache and can be accessed locally at a later time. The resolving
+ * is done by sending WHOIS command.
*
* If the `attributes' is non-NULL then the buffer includes Requested
* Attributes which can be used to fetch very detailed information
*
* SYNOPSIS
*
- * bool silc_client_del_client(SilcClient client, SilcClientConnection conn,
+ * SilcBool silc_client_del_client(SilcClient client, SilcClientConnection conn,
* SilcClientEntry client_entry)
*
* DESCRIPTION
* the `client_entry'. Returns TRUE if the deletion were successful.
*
***/
-bool silc_client_del_client(SilcClient client, SilcClientConnection conn,
+SilcBool silc_client_del_client(SilcClient client, SilcClientConnection conn,
SilcClientEntry client_entry);
/****f* silcclient/SilcClientAPI/SilcGetChannelCallback
*
* SilcChannelEntry silc_client_get_channel(SilcClient client,
* SilcClientConnection conn,
- * char *channel);
+ * char *channel_name);
*
* DESCRIPTION
*
* Finds entry for channel by the channel name. Returns the entry or NULL
* if the entry was not found. It is found only if the client is joined
- * to the channel.
+ * to the channel. Use silc_client_get_channel_resolve or
+ * silc_client_get_channel_by_id_resolve to resolve channel that client
+ * is not joined.
*
***/
SilcChannelEntry silc_client_get_channel(SilcClient client,
SilcClientConnection conn,
- char *channel);
+ char *channel_name);
+
+/****f* silcclient/SilcClientAPI/silc_client_get_channel_resolve
+ *
+ * SYNOPSIS
+ *
+ * void silc_client_get_channel_resolve(SilcClient client,
+ * SilcClientConnection conn,
+ * char *channel_name,
+ * SilcGetChannelCallback completion,
+ * void *context);
+ *
+ * DESCRIPTION
+ *
+ * Resolves entry for channel by the channel name from the server.
+ * The resolving is done with IDENTIFY command. Note that users on
+ * the channel are not resolved at the same time. Use for example
+ * silc_client_get_clients_by_channel to resolve all users on a channel.
+ *
+ ***/
+void silc_client_get_channel_resolve(SilcClient client,
+ SilcClientConnection conn,
+ char *channel_name,
+ SilcGetChannelCallback completion,
+ void *context);
/****f* silcclient/SilcClientAPI/silc_client_get_channel_by_id
*
*
* DESCRIPTION
*
- * Finds channel entry by the channel name. Returns the entry or NULL
- * if it was not found.
+ * Finds channel entry by the channel ID. Returns the entry or NULL
+ * if the entry was not found. This checks the local cache and does
+ * not resolve anything from server.
*
***/
SilcChannelEntry silc_client_get_channel_by_id(SilcClient client,
*
* SYNOPSIS
*
- * void
+ * void
* silc_client_get_channel_by_id_resolve(SilcClient client,
* SilcClientConnection conn,
* SilcChannelID *channel_id,
*
* Resolves the channel information (its name mainly) from the server
* by the `channel_id'. Use this only if you know that you do not have
- * the entry cached locally.
+ * the entry cached locally. The resolving is done with IDENTIFY command.
+ *
+ * Note that users on the channel are not resolved at the same time.
+ * Use for example silc_client_get_clients_by_channel to resolve all
+ * users on a channel.
*
***/
void silc_client_get_channel_by_id_resolve(SilcClient client,
*
* SYNOPSIS
*
- * bool silc_client_del_channel(SilcClient client,
+ * SilcBool silc_client_del_channel(SilcClient client,
* SilcClientConnection conn,
* SilcChannelEntry channel)
*
* the `channel'. Returns TRUE if the deletion were successful.
*
***/
-bool silc_client_del_channel(SilcClient client, SilcClientConnection conn,
+SilcBool silc_client_del_channel(SilcClient client, SilcClientConnection conn,
SilcChannelEntry channel);
/****f* silcclient/SilcClientAPI/silc_client_get_server
*
* SYNOPSIS
*
- * bool silc_client_del_server(SilcClient client, SilcClientConnection conn,
+ * SilcBool silc_client_del_server(SilcClient client, SilcClientConnection conn,
* SilcServerEntry server);
*
* DESCRIPTION
* the `server'. Returns TRUE if the deletion were successful.
*
***/
-bool silc_client_del_server(SilcClient client, SilcClientConnection conn,
+SilcBool silc_client_del_server(SilcClient client, SilcClientConnection conn,
SilcServerEntry server);
/****f* silcclient/SilcClientAPI/silc_client_on_channel
*
* DESCRIPTION
*
- * Returns the ChannelUser entry if the `client_entry' is joined on the
+ * Returns the SilcChannelUser entry if the `client_entry' is joined on the
* channel indicated by the `channel'. NULL if client is not joined on
- * the channel.
+ * the channel.
*
***/
SilcChannelUser silc_client_on_channel(SilcChannelEntry channel,
*
* SYNOPSIS
*
- * void silc_client_command_call(SilcClient client,
+ * SilcBool silc_client_command_call(SilcClient client,
* SilcClientConnection conn,
* const char *command_line, ...);
*
* NULL);
* silc_client_command_call(client, conn, "PING silc.silcnet.org");
*
+ * NOTES
+ *
+ * This command executes the commands implemented inside the client
+ * library. These commands are designed for command line applications,
+ * but GUI application may call them too if needed. Alternatively
+ * application may override the library and use silc_client_command_send
+ * function instead.
+ *
***/
-bool silc_client_command_call(SilcClient client,
+SilcBool silc_client_command_call(SilcClient client,
SilcClientConnection conn,
const char *command_line, ...);
*
* SYNOPSIS
*
- * void silc_client_command_send(SilcClient client,
+ * void silc_client_command_send(SilcClient client,
* SilcClientConnection conn,
* SilcCommand command, SilcUInt16 ident,
* SilcUInt32 argc, ...);
* to perform the commands by itself, it can do so and send the data
* directly to the server using this function. If application is using
* the silc_client_command_call, this function is usually not used.
+ * Note that this overriders the Client Librarys commands and sends
+ * the command packet directly to server.
+ *
+ * Programmer should get familiar with the SILC protocol commands
+ * specification when using this function, as the arguments needs to
+ * be encoded as specified in the protocol.
*
* The variable arguments are a pair of { type, data, data_length },
* and the `argc' is the number of these pairs.
* called when an command reply is received to an earlier sent command.
* The `reply_cmd' is the command that must be received in order for
* the pending command callback indicated by `callback' to be called.
+ * The `callback' will deliver the `context' and
+ * SilcClientCommandReplyContext which includes the internals of the
+ * command reply.
*
* The `ident' is a command identifier which was set for the earlier
* sent command. The command reply will include the same identifier
- * and pending command callback will be called when the reply is
+ * and pending command callback will be called when the reply is
* received with the same command identifier. It is possible to
* add multiple pending command callbacks for same command and for
* same identifier.
*
* Note also that the application is notified about the received command
* reply through the `command_reply' client operation before calling
- * the `callback` pending command callback. That is the normal
+ * the `callback` pending command callback. That is the normal
* command reply handling, and is called regardless whether pending
* command callbacks are used or not.
*
*
* SYNOPSIS
*
- * int silc_client_add_private_message_key(SilcClient client,
- * SilcClientConnection conn,
- * SilcClientEntry client_entry,
- * char *cipher,
- * unsigned char *key,
- * SilcUInt32 key_len,
- * bool generate_key,
- * bool responder);
+ * SilcBool silc_client_add_private_message_key(SilcClient client,
+ * SilcClientConnection conn,
+ * SilcClientEntry client_entry,
+ * const char *cipher,
+ * const char *hmac,
+ * unsigned char *key,
+ * SilcUInt32 key_len,
+ * SilcBool generate_key,
+ * SilcBool responder);
*
* DESCRIPTION
*
* indicated by the `client_entry'. If the `key' is NULL and the boolean
* value `generate_key' is TRUE the library will generate random key.
* The `key' maybe for example pre-shared-key, passphrase or similar.
- * The `cipher' MAY be provided but SHOULD be NULL to assure that the
- * requirements of the SILC protocol are met. The API, however, allows
- * to allocate any cipher.
+ * The `cipher' and `hmac' MAY be provided but SHOULD be NULL to assure
+ * that the requirements of the SILC protocol are met. The API, however,
+ * allows to allocate any cipher and HMAC.
*
* If `responder' is TRUE then the sending and receiving keys will be
* set according the client being the receiver of the private key. If
*
* It is not necessary to set key for normal private message usage. If the
* key is not set then the private messages are encrypted using normal
- * session keys. Setting the private key, however, increases the security.
+ * session keys. Setting the private key, however, increases the security.
*
* Returns FALSE if the key is already set for the `client_entry', TRUE
- * otherwise.
+ * otherwise.
*
***/
-int silc_client_add_private_message_key(SilcClient client,
- SilcClientConnection conn,
- SilcClientEntry client_entry,
- char *cipher,
- unsigned char *key,
- SilcUInt32 key_len,
- bool generate_key,
- bool responder);
+SilcBool silc_client_add_private_message_key(SilcClient client,
+ SilcClientConnection conn,
+ SilcClientEntry client_entry,
+ const char *cipher,
+ const char *hmac,
+ unsigned char *key,
+ SilcUInt32 key_len,
+ SilcBool generate_key,
+ SilcBool responder);
/****f* silcclient/SilcClientAPI/silc_client_add_private_message_key_ske
*
* SYNOPSIS
*
- * int silc_client_add_private_message_key_ske(SilcClient client,
- * SilcClientConnection conn,
- * SilcClientEntry client_entry,
- * char *cipher,
- * SilcSKEKeyMaterial *key);
+ * SilcBool
+ * silc_client_add_private_message_key_ske(SilcClient client,
+ * SilcClientConnection conn,
+ * SilcClientEntry client_entry,
+ * const char *cipher,
+ * const char *hmac,
+ * SilcSKEKeyMaterial *key);
*
* DESCRIPTION
*
* Same as silc_client_add_private_message_key but takes the key material
* from the SKE key material structure. This structure is received if
* the application uses the silc_client_send_key_agreement to negotiate
- * the key material. The `cipher' SHOULD be provided as it is negotiated
- * also in the SKE protocol.
+ * the key material. The `cipher' and `hmac' SHOULD be provided as it is
+ * negotiated also in the SKE protocol.
*
***/
-int silc_client_add_private_message_key_ske(SilcClient client,
- SilcClientConnection conn,
- SilcClientEntry client_entry,
- char *cipher,
- SilcSKEKeyMaterial *key,
- bool responder);
+SilcBool silc_client_add_private_message_key_ske(SilcClient client,
+ SilcClientConnection conn,
+ SilcClientEntry client_entry,
+ const char *cipher,
+ const char *hmac,
+ SilcSKEKeyMaterial *key,
+ SilcBool responder);
/****f* silcclient/SilcClientAPI/silc_client_del_private_message_key
*
* SYNOPSIS
*
- * int silc_client_del_private_message_key(SilcClient client,
- * SilcClientConnection conn,
- * SilcClientEntry client_entry);
+ * SilcBool silc_client_del_private_message_key(SilcClient client,
+ * SilcClientConnection conn,
+ * SilcClientEntry client_entry);
*
* DESCRIPTION
*
* Removes the private message from the library. The key won't be used
* after this to protect the private messages with the remote `client_entry'
- * client. Returns FALSE on error, TRUE otherwise.
+ * client. Returns FALSE on error, TRUE otherwise.
*
***/
-int silc_client_del_private_message_key(SilcClient client,
- SilcClientConnection conn,
- SilcClientEntry client_entry);
+SilcBool silc_client_del_private_message_key(SilcClient client,
+ SilcClientConnection conn,
+ SilcClientEntry client_entry);
/****f* silcclient/SilcClientAPI/silc_client_list_private_message_keys
*
* silc_client_list_private_message_keys(SilcClient client,
* SilcClientConnection conn,
* SilcUInt32 *key_count);
- *
+ *
* DESCRIPTION
*
* Returns array of set private message keys associated to the connection
* `conn'. Returns allocated SilcPrivateMessageKeys array and the array
* count to the `key_count' argument. The array must be freed by the caller
- * by calling the silc_client_free_private_message_keys function. Note:
+ * by calling the silc_client_free_private_message_keys function. Note:
* the keys returned in the array is in raw format. It might not be desired
* to show the keys as is. The application might choose not to show the keys
- * at all or to show the fingerprints of the keys.
+ * at all or to show the fingerprints of the keys.
*
***/
SilcPrivateMessageKeys
SilcClientConnection conn,
SilcUInt32 *key_count);
+/****f* silcclient/SilcClientAPI/silc_client_send_private_message_key_request
+ *
+ * SYNOPSIS
+ *
+ * SilcBool
+ * silc_client_send_private_message_key_request(SilcClient client,
+ * SilcClientConnection conn,
+ * SilcClientEntry client_entry);
+ *
+ * DESCRIPTION
+ *
+ * This function can be used to send an private message key indicator
+ * request to the remote client indicated by 'client_entry'. This can
+ * be used when setting a static or pre-shared private message key.
+ * The sender of this packet is the initiator and must set the 'responder'
+ * argument in silc_client_add_private_message_key function to FALSE.
+ * The receiver of this indicator request must set it to TRUE, if the
+ * receiver decides to set a private message key. By using this
+ * function applications may automate initiator/responder setting in
+ * private message key functions, without asking from user which one is
+ * the initiator and which one is responder.
+ *
+ * NOTES
+ *
+ * The sender of this packet must set the private message key for
+ * 'client_entry' before calling this function. The 'responder'
+ * argument MUST be set to FALSE when setting the key.
+ *
+ ***/
+SilcBool
+silc_client_send_private_message_key_request(SilcClient client,
+ SilcClientConnection conn,
+ SilcClientEntry client_entry);
+
/****f* silcclient/SilcClientAPI/silc_client_free_private_message_keys
*
* SYNOPSIS
*
* void silc_client_free_private_message_keys(SilcPrivateMessageKeys keys,
* SilcUInt32 key_count);
- *
+ *
* DESCRIPTION
*
* Frees the SilcPrivateMessageKeys array returned by the function
- * silc_client_list_private_message_keys.
+ * silc_client_list_private_message_keys.
*
***/
void silc_client_free_private_message_keys(SilcPrivateMessageKeys keys,
SilcUInt32 key_count);
-/* Channel private key management (client_channel.c,
+/* Channel private key management (client_channel.c,
SilcChannelPrivateKey is defined in idlist.h) */
/****f* silcclient/SilcClientAPI/silc_client_add_channel_private_key
*
* SYNOPSIS
*
- * int silc_client_add_channel_private_key(SilcClient client,
- * SilcClientConnection conn,
- * SilcChannelEntry channel,
- * const char *name,
- * char *cipher,
- * char *hmac,
- * unsigned char *key,
- * SilcUInt32 key_len);
- *
- * DESCRIPTION
- *
- * Adds private key for channel. This may be set only if the channel's mode
- * mask includes the SILC_CHANNEL_MODE_PRIVKEY. This returns FALSE if the
- * mode is not set. When channel has private key then the messages are
- * encrypted using that key. All clients on the channel must also know the
- * key in order to decrypt the messages. However, it is possible to have
- * several private keys per one channel. In this case only some of the
- * clients on the channel may know the one key and only some the other key.
- * The `name' can be application given name for the key.
+ * SilcBool silc_client_add_channel_private_key(SilcClient client,
+ * SilcClientConnection conn,
+ * SilcChannelEntry channel,
+ * const char *name,
+ * char *cipher,
+ * char *hmac,
+ * unsigned char *key,
+ * SilcUInt32 key_len,
+ * SilcChannelPrivateKey *ret_key);
+ *
+ * DESCRIPTION
+ *
+ * Adds private key for channel. When channel has private key then the
+ * messages are encrypted using that key. All clients on the channel
+ * must also know the key in order to decrypt the messages. However,
+ * it is possible to have several private keys per one channel. In this
+ * case only some of the clients on the channel may know the one key
+ * and only some the other key. The `name' can be application given
+ * name for the key. This returns the created key to the 'ret_key'
+ * pointer if it is non-NULL;
+ *
+ * If `cipher' and/or `hmac' is NULL then default values will be used
+ * (aes-256-cbc for cipher and hmac-sha1-96 for hmac).
*
* The private key for channel is optional. If it is not set then the
* channel messages are encrypted using the channel key generated by the
- * server. However, setting the private key (or keys) for the channel
+ * server. However, setting the private key (or keys) for the channel
* significantly adds security. If more than one key is set the library
* will automatically try all keys at the message decryption phase. Note:
* setting many keys slows down the decryption phase as all keys has to
* be tried in order to find the correct decryption key. However, setting
- * a few keys does not have big impact to the decryption performace.
+ * a few keys does not have big impact to the decryption performace.
*
* NOTES
*
* silc_client_send_key_agreement) then the `key' MUST be the
* key->send_enc_key as this is dictated by the SILC protocol. However,
* currently it is not expected that the SKE key material would be used
- * as channel private key. However, this API allows it.
+ * as channel private key. However, this API allows it.
*
***/
-int silc_client_add_channel_private_key(SilcClient client,
- SilcClientConnection conn,
- SilcChannelEntry channel,
- const char *name,
- char *cipher,
- char *hmac,
- unsigned char *key,
- SilcUInt32 key_len);
+SilcBool silc_client_add_channel_private_key(SilcClient client,
+ SilcClientConnection conn,
+ SilcChannelEntry channel,
+ const char *name,
+ char *cipher,
+ char *hmac,
+ unsigned char *key,
+ SilcUInt32 key_len,
+ SilcChannelPrivateKey *ret_key);
/****f* silcclient/SilcClientAPI/silc_client_del_channel_private_keys
*
* SYNOPSIS
*
- * int silc_client_del_channel_private_keys(SilcClient client,
- * SilcClientConnection conn,
- * SilcChannelEntry channel);
- *
+ * SilcBool silc_client_del_channel_private_keys(SilcClient client,
+ * SilcClientConnection conn,
+ * SilcChannelEntry channel);
+ *
* DESCRIPTION
*
* Removes all private keys from the `channel'. The old channel key is used
* after calling this to protect the channel messages. Returns FALSE on
- * on error, TRUE otherwise.
+ * on error, TRUE otherwise.
*
***/
-int silc_client_del_channel_private_keys(SilcClient client,
- SilcClientConnection conn,
- SilcChannelEntry channel);
+SilcBool silc_client_del_channel_private_keys(SilcClient client,
+ SilcClientConnection conn,
+ SilcChannelEntry channel);
/****f* silcclient/SilcClientAPI/silc_client_del_channel_private_key
*
* SYNOPSIS
*
- * int silc_client_del_channel_private_key(SilcClient client,
+ * SilcBool silc_client_del_channel_private_key(SilcClient client,
* SilcClientConnection conn,
* SilcChannelEntry channel,
* SilcChannelPrivateKey key);
- *
+ *
* DESCRIPTION
*
- * Removes and frees private key `key' from the channel `channel'.
- * The `key' is retrieved by calling the function
+ * Removes and frees private key `key' from the channel `channel'.
+ * The `key' is retrieved by calling the function
* silc_client_list_channel_private_keys. The key is not used after
* this. If the key was last private key then the old channel key is
* used hereafter to protect the channel messages. This returns FALSE
- * on error, TRUE otherwise.
+ * on error, TRUE otherwise.
*
***/
-int silc_client_del_channel_private_key(SilcClient client,
- SilcClientConnection conn,
- SilcChannelEntry channel,
- SilcChannelPrivateKey key);
+SilcBool silc_client_del_channel_private_key(SilcClient client,
+ SilcClientConnection conn,
+ SilcChannelEntry channel,
+ SilcChannelPrivateKey key);
/****f* silcclient/SilcClientAPI/silc_client_list_channel_private_keys
*
* The caller must free the array by calling the function
* silc_client_free_channel_private_keys. The pointers in the array may be
* used to delete the specific key by giving the pointer as argument to the
- * function silc_client_del_channel_private_key.
+ * function silc_client_del_channel_private_key.
*
***/
SilcChannelPrivateKey *
* the same packet including its hostname and port. If the library receives
* the reply from the remote client the `key_agreement' client operation
* callback will be called to verify whether the user wants to perform the
- * key agreement or not.
+ * key agreement or not.
*
* NOTES
*
- * NOTE: If the application provided the `hostname' and the `port' and the
+ * NOTE: If the application provided the `hostname' and the `port' and the
* remote side initiates the key agreement protocol it is not verified
* from the user anymore whether the protocol should be executed or not.
* By setting the `hostname' and `port' the user gives permission to
* perform the key agreement at all. If the key agreement protocol is
* performed the `completion' callback with the `context' will be called.
* If remote side decides to ignore the request the `completion' will be
- * called after the specified timeout, `timeout_secs'.
+ * called after the specified timeout, `timeout_secs'.
*
* NOTE: If the `hostname' and the `port' was not provided the `completion'
* will not be called at all since this does nothing more than sending
*
* NOTE: There can be only one active key agreement for one client entry.
* Before setting new one, the old one must be finished (it is finished
- * after calling the completion callback) or the function
- * silc_client_abort_key_agreement must be called.
+ * after calling the completion callback) or the function
+ * silc_client_abort_key_agreement must be called.
*
***/
void silc_client_send_key_agreement(SilcClient client,
*
* SYNOPSIS
*
- * void
+ * void
* silc_client_perform_key_agreement(SilcClient client,
* SilcClientConnection conn,
* SilcClientEntry client_entry,
* be called after the key agreement protocol.
*
* NOTES
- *
+ *
* NOTE: If the application returns TRUE in the `key_agreement' client
* operation the library will automatically start the key agreement. In this
* case the application must not call this function. However, application
* specific command). Thus, the API provides both, automatic and manual
* initiation of the key agreement. Calling this function is the manual
* initiation and returning TRUE in the `key_agreement' client operation
- * is the automatic initiation.
+ * is the automatic initiation.
*
***/
void silc_client_perform_key_agreement(SilcClient client,
*
* DESCRIPTION
*
- * Same as above but application has created already the connection to
- * the remote host. The `sock' is the socket to the remote connection.
+ * Same as above but application has created already the connection to
+ * the remote host. The `sock' is the socket to the remote connection.
* Application can use this function if it does not want the client library
- * to create the connection.
+ * to create the connection.
*
***/
void silc_client_perform_key_agreement_fd(SilcClient client,
* DESCRIPTION
*
* This function can be called to unbind the hostname and the port for
- * the key agreement protocol. However, this function has effect only
+ * the key agreement protocol. However, this function has effect only
* before the key agreement protocol has been performed. After it has
- * been performed the library will automatically unbind the port. The
- * `client_entry' is the client to which we sent the key agreement
+ * been performed the library will automatically unbind the port. The
+ * `client_entry' is the client to which we sent the key agreement
* request. The key agreement completion callback will be called
* with SILC_KEY_AGREEMENT_ABORTED status.
*
* to anyone who sends private message. The `message' will be sent
* automatically back to the the client who send private message. If
* away message is already set this replaces the old message with the
- * new one. If `message' is NULL the old away message is removed.
- * The sender may freely free the memory of the `message'.
+ * new one. If `message' is NULL the old away message is removed.
+ * The sender may freely free the memory of the `message'.
*
***/
void silc_client_set_away_message(SilcClient client,
*
* SYNOPSIS
*
- * void
+ * void
* silc_client_request_authentication_method(SilcClient client,
* SilcClientConnection conn,
- * SilcConnectionAuthRequest
+ * SilcConnectionAuthRequest
* callback,
* void *context);
*
* replied back with the current authentication method.
*
***/
-void
+void
silc_client_request_authentication_method(SilcClient client,
SilcClientConnection conn,
SilcConnectionAuthRequest callback,
* monitoring process. The `error' will indicate the error type
* if `status' is SILC_CLIENT_FILE_MONITOR_ERROR. The `offset' is the
* currently transmitted amount of total `filesize'. The `client_entry'
- * indicates the remote client, and the transmission session ID is the
- * `session_id'. The filename being transmitted is indicated by the
+ * indicates the remote client, and the transmission session ID is the
+ * `session_id'. The filename being transmitted is indicated by the
* `filepath'.
*
***/
const char *filepath,
void *context);
+/****f* silcclient/SilcClientAPI/SilcClientFileName
+ *
+ * SYNOPSIS
+ *
+ * typedef void (*SilcClientFileName)(const char *filepath,
+ * void *context);
+ *
+ * DESCRIPTION
+ *
+ * Completion callback for the SilcClientFileAskName callback function.
+ * Application calls this to deliver the filepath and filename where
+ * the downloaded file is to be saved.
+ *
+ ***/
+typedef void (*SilcClientFileName)(const char *filepath,
+ void *context);
+
+/****f* silcclient/SilcClientAPI/SilcClientFileAskName
+ *
+ * SYNOPSIS
+ *
+ * typedef void (*SilcClientFileAskName)(SilcClient client,
+ * SilcClientConnection conn,
+ * SilcUInt32 session_id,
+ * const char *remote_filename,
+ * SilcClientFileName completion,
+ * void *completion_context,
+ * void *context);
+ *
+ * DESCRIPTION
+ *
+ * File name asking callback, that is called if it is given to the
+ * silc_client_file_receive and the path given to that as argument was
+ * NULL. The library calls this to ask the filename and filepath to
+ * where the file is to be saved. The 'remote_filename' is the file
+ * that is being downloaded. Application must call the 'completion'
+ * with 'completion_context' to continue with the file downloading.
+ * It is not mandatory to provide this to the silc_client_file_receive.
+ *
+ ***/
+typedef void (*SilcClientFileAskName)(SilcClient client,
+ SilcClientConnection conn,
+ SilcUInt32 session_id,
+ const char *remote_filename,
+ SilcClientFileName completion,
+ void *completion_context,
+ void *context);
+
/****f* silcclient/SilcClientAPI/silc_client_file_send
*
* SYNOPSIS
*
- * SilcClientFileError
+ * SilcClientFileError
* silc_client_file_send(SilcClient client,
* SilcClientConnection conn,
* SilcClientFileMonitor monitor,
* void *monitor_context,
* const char *local_ip,
* SilcUInt32 local_port,
+ * SilcBool do_not_bind,
* SilcClientEntry client_entry,
* const char *filepath);
* SilcUInt32 *session_id);
*
* DESCRIPTION
*
- * Sends a file indicated by the `filepath' to the remote client
+ * Sends a file indicated by the `filepath' to the remote client
* indicated by the `client_entry'. This will negotiate a secret key
* with the remote client before actually starting the transmission of
* the file. The `monitor' callback will be called to monitor the
* transmission of the file.
*
* This returns a file session ID for the file transmission to the
- * `session_id' pointer.. It can be used to close the session (and
+ * `session_id' pointer. It can be used to close the session (and
* abort the file transmission) by calling the silc_client_file_close
- * function. The session ID is also returned in the `monitor' callback.
+ * function. The session ID is also returned in the `monitor' callback.
*
- * If the `local_ip' is provided then this will try to bind the
+ * If the `local_ip' is provided then this will try to bind the
* listener for key exchange protocol to that IP. If `local_port' is
* non-zero that port is used. If `local_ip' is NULL then this will
* automatically attempt to bind it to local IP address of the machine.
- * If that fails then this does not bind to any address and port, and
- * assume that the remote client will provide the listener for the
- * key exchange protocol.
+ * If `do_not_bind' is TRUE then the `local_ip' and `local_port' are
+ * ignored and it is expected that the receiver will provide the
+ * point of contact. This is usefull if the sender is behind NAT.
*
* If error will occur during the file transfer process the error
* status will be returned in the monitor callback. In this case
* session.
*
***/
-SilcClientFileError
+SilcClientFileError
silc_client_file_send(SilcClient client,
SilcClientConnection conn,
SilcClientFileMonitor monitor,
void *monitor_context,
const char *local_ip,
SilcUInt32 local_port,
+ SilcBool do_not_bind,
SilcClientEntry client_entry,
const char *filepath,
SilcUInt32 *session_id);
*
* SYNOPSIS
*
- * SilcClientFileError
+ * SilcClientFileError
* silc_client_file_receive(SilcClient client,
* SilcClientConnection conn,
* SilcClientFileMonitor monitor,
* void *monitor_context,
* const char *path,
- * SilcUInt32 session_id);
+ * SilcUInt32 session_id,
+ * SilcClientFileAskName ask_name,
+ * void *ask_name_context);
*
* DESCRIPTION
*
* received in the `ftp' client operation function. This will actually
* perform the key agreement protocol with the remote client before
* actually starting the file transmission. The `monitor' callback
- * will be called to monitor the transmission. If `path' is non NULL
+ * will be called to monitor the transmission. If `path' is non-NULL
* the file will be saved into that directory. If NULL the file is
- * saved in the current working directory.
+ * saved in the current working directory, unless the 'ask_name'
+ * callback is non-NULL. In this case the callback is called to ask
+ * the path and filename from application.
*
* If error will occur during the file transfer process the error
* status will be returned in the monitor callback. In this case
* session.
*
***/
-SilcClientFileError
+SilcClientFileError
silc_client_file_receive(SilcClient client,
SilcClientConnection conn,
SilcClientFileMonitor monitor,
void *monitor_context,
const char *path,
- SilcUInt32 session_id);
+ SilcUInt32 session_id,
+ SilcClientFileAskName ask_name,
+ void *ask_name_context);
/****f* silcclient/SilcClientAPI/silc_client_file_close
*
* If file transmission is being conducted it will be aborted
* automatically. This function is also used to close the session
* after successful file transmission. This function can be used
- * also to reject incoming file transmission request.
+ * also to reject incoming file transmission request. If the
+ * session was already started and the monitor callback was set
+ * the monitor callback will be called with the monitor status
+ * SILC_CLIENT_FILE_MONITOR_CLOSED.
*
***/
SilcClientFileError silc_client_file_close(SilcClient client,
*
* SYNOPSIS
*
- * bool silc_client_attribute_del(SilcClient client,
+ * SilcBool silc_client_attribute_del(SilcClient client,
* SilcClientConnection conn,
* SilcAttribute attribute,
* SilcAttributePayload attr);
* is non-zero then all attributes of that type are deleted and the
* `attr' is ignored. If `attr' is non-NULL then that specific
* attribute is deleted and `attribute' is ignored.
- *
+ *
* You may get all added attributes with the function
* silc_client_attributes_get and to get the SilcAttributePayload.
* This function Returns TRUE if the attribute was found and deleted.
*
***/
-bool silc_client_attribute_del(SilcClient client,
- SilcClientConnection conn,
- SilcAttribute attribute,
- SilcAttributePayload attr);
+SilcBool silc_client_attribute_del(SilcClient client,
+ SilcClientConnection conn,
+ SilcAttribute attribute,
+ SilcAttributePayload attr);
/****f* silcclient/SilcClientAPI/silc_client_attributes_get
*
* payload while traversing the table.
*
***/
-const SilcHashTable silc_client_attributes_get(SilcClient client,
- SilcClientConnection conn);
+SilcHashTable silc_client_attributes_get(SilcClient client,
+ SilcClientConnection conn);
/****f* silcclient/SilcClientAPI/silc_client_attributes_request
*
* You can give the returned buffer as argument to for example
* silc_client_get_client_by_id_resolve function.
*
+ * EXAMPLE
+ *
+ * Request all attributes
+ * buffer = silc_client_attributes_request(0);
+ *
+ * Request only the following attributes
+ * buffer = silc_client_attributes_request(SILC_ATTRIBUTE_USER_INFO,
+ * SILC_ATTRIBUTE_SERVICE,
+ * SILC_ATTRIBUTE_MOOD, 0);
+ *
***/
SilcBuffer silc_client_attributes_request(SilcAttribute attribute, ...);
/* Low level packet sending functions */
-/****f* silcclient/SilcClientAPI/silc_client_packet_send
+/****f* silcclient/SilcClientAPI/silc_client_send_packet
*
* SYNOPSIS
*
- * void silc_client_packet_send(SilcClient client,
- * SilcSocketConnection sock,
- * SilcPacketType type,
- * void *dst_id,
- * SilcIdType dst_id_type,
- * SilcCipher cipher,
- * SilcHmac hmac,
- * unsigned char *data,
- * SilcUInt32 data_len,
- * bool force_send);
+ * SilcBool silc_client_send_packet(SilcClient client,
+ * SilcClientConnection conn,
+ * SilcPacketType type,
+ * const unsigned char *data,
+ * SilcUInt32 data_len);
*
* DESCRIPTION
*
- * Constructs a Requested Attributes buffer. If the `attribute' is zero (0)
- * then all attributes are requested. Alternatively, `attribute' and
- * all variable arguments can each be requested attribute. In this case
- * the last must be set to zero (0) to complete the variable list of
- * requested attributes. See SilcAttribute for all attributes.
- * You can give the returned buffer as argument to for example
- * silc_client_get_client_by_id_resolve function.
+ * This routine can be used by application to send packets directly
+ * to a connection indicated by `conn'. Usually application does not
+ * need this routine since the Client Library handles the packet
+ * sending. The `type' indicates the packet type. If `data' is
+ * NULL then empty packet is sent. This returns FALSE if packet cannot
+ * be sent.
*
***/
-void silc_client_packet_send(SilcClient client,
- SilcSocketConnection sock,
- SilcPacketType type,
- void *dst_id,
- SilcIdType dst_id_type,
- SilcCipher cipher,
- SilcHmac hmac,
- unsigned char *data,
- SilcUInt32 data_len,
- bool force_send);
+SilcBool silc_client_send_packet(SilcClient client,
+ SilcClientConnection conn,
+ SilcPacketType type,
+ const unsigned char *data,
+ SilcUInt32 data_len);
#include "command.h"
#include "command_reply.h"
projects / silc.git / blobdiff