5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2000 - 2014 Pekka Riikonen
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.
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.
20 /****h* silcclient/Client Library Interface
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
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.
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.
62 #include "silcclient_entry.h"
64 /* General definitions */
66 /****d* silcclient/SilcClientAPI/SilcClientConnectionStatus
70 * typedef enum { ... } SilcClientConnectionStatus
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.
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;
93 /****f* silcclient/SilcClientAPI/SilcClientRunning
97 * typedef void (*SilcClientRunning)(SilcClient client, void *context);
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.
106 typedef void (*SilcClientRunning)(SilcClient client, void *context);
108 /****f* silcclient/SilcClientAPI/SilcClientStopped
112 * typedef void (*SilcClientStopped)(SilcClient client, void *context);
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.
124 typedef void (*SilcClientStopped)(SilcClient client, void *context);
126 /****f* silcclient/SilcClientAPI/SilcClientConnectCallback
130 * void (*SilcClientConnectCallback)(SilcClient client,
131 * SilcClientConnection conn,
132 * SilcClientConnectionStatus status,
134 * const char *message,
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.
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.
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.
161 typedef void (*SilcClientConnectCallback)(SilcClient client,
162 SilcClientConnection conn,
163 SilcClientConnectionStatus status,
168 /****s* silcclient/SilcClientAPI/SilcClient
172 * typedef struct SilcClientStruct { ... } *SilcClient
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.
182 * This context represents the client. Each connection to remote server
183 * is represented by SilcClientConnection context.
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. */
196 /* Internal data for client library. Application cannot access this. */
197 SilcClientInternal internal;
201 /****s* silcclient/SilcClientAPI/SilcClientConnection
205 * typedef struct SilcClientConnectionStruct { ... }
206 * *SilcClientConnection
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.
218 struct SilcClientConnectionStruct {
219 SilcClientEntry local_entry; /* Our own Client Entry */
220 SilcClientID *local_id; /* Our current Client ID */
222 char *remote_host; /* Remote host name */
223 int remote_port; /* Remote port */
224 SilcID remote_id; /* Remote ID */
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 */
235 /* Current say() operation associated context, identifies the client,
236 channel or server the message is related to. Application can use
237 this information to target the message better. */
239 SilcClientEntry client_entry;
240 SilcChannelEntry channel_entry;
241 SilcServerEntry server_entry;
243 SilcIdType context_type; /* Defines which pointer is set
244 in the union. If SILC_ID_NONE
247 /* Application specific data. Application may set here whatever it wants. */
250 /* Internal data for client library. Application cannot access this. */
251 SilcClientConnectionInternal internal;
255 /****s* silcclient/SilcClientAPI/SilcChannelUser
259 * typedef struct SilcChannelUserStruct { ... } *SilcChannelUser
263 * This structure represents a client that has joined to a channel.
264 * It shows the client and the channel and the client's mode (channel
265 * user mode) on the channel.
269 struct SilcChannelUserStruct {
270 SilcClientEntry client; /* Client joined on channel */
271 SilcUInt32 mode; /* mode, ChannelUserModes */
272 SilcChannelEntry channel; /* The channel user has joined */
274 /* Application specific data. Application may set here whatever it wants. */
279 /****s* silcclient/SilcClientAPI/SilcClientStats
283 * typedef struct { ... } SilcClientStats;
287 * This structure holds SILC network statistics returned by the
288 * SILC_COMMAND_STATS command reply to the application.
292 typedef struct SilcClientStatsStruct {
293 SilcUInt32 starttime; /* SILC server start time */
294 SilcUInt32 uptime; /* SILC server uptime*/
295 SilcUInt32 my_clients; /* Number of clients in the server */
296 SilcUInt32 my_channels; /* Number of channel in the server */
297 SilcUInt32 my_server_ops; /* Number of server operators in the server */
298 SilcUInt32 my_router_ops; /* Number of router operators in the router */
299 SilcUInt32 cell_clients; /* Number of clients in the cell */
300 SilcUInt32 cell_channels; /* Number of channels in the cell */
301 SilcUInt32 cell_servers; /* Number of server in the cell */
302 SilcUInt32 clients; /* All clients in SILC network */
303 SilcUInt32 channels; /* All channels in SILC network */
304 SilcUInt32 servers; /* All servers in SILC network */
305 SilcUInt32 routers; /* All routers in SILC network */
306 SilcUInt32 server_ops; /* All server operators in SILC network */
307 SilcUInt32 router_ops; /* All router operators in SILC network */
311 /****d* silcclient/SilcClientAPI/SilcKeyAgreementStatus
315 * typedef enum { ... } SilcKeyAgreementStatus;
319 * Key agreement status types indicating the status of the key
320 * agreement protocol. These types are returned to the application
321 * in the SilcKeyAgreementCallback callback function.
326 SILC_KEY_AGREEMENT_OK, /* Everything is Ok */
327 SILC_KEY_AGREEMENT_ERROR, /* Unknown error occurred */
328 SILC_KEY_AGREEMENT_FAILURE, /* The protocol failed */
329 SILC_KEY_AGREEMENT_TIMEOUT, /* The protocol timeout */
330 SILC_KEY_AGREEMENT_ABORTED, /* The protocol aborted */
331 SILC_KEY_AGREEMENT_ALREADY_STARTED, /* Already started */
332 SILC_KEY_AGREEMENT_SELF_DENIED, /* Negotiationg with itself denied */
333 SILC_KEY_AGREEMENT_NO_MEMORY, /* System out of memory */
334 } SilcKeyAgreementStatus;
337 /****f* silcclient/SilcClientAPI/SilcKeyAgreementCallback
341 * typedef void (*SilcKeyAgreementCallback)(SilcClient client,
342 * SilcClientConnection conn,
343 * SilcClientEntry client_entry,
344 * SilcKeyAgreementStatus status,
345 * SilcSKEKeyMaterial *key,
350 * Key agreement callback that is called after the key agreement protocol
351 * has been performed. This is called also if error occurred during the
352 * key agreement protocol. The `key' is the allocated key material and
353 * the caller is responsible of freeing it. The `key' is NULL if error
354 * has occurred. The application can freely use the `key' to whatever
355 * purpose it needs. See lib/silcske/silcske.h for the definition of
356 * the SilcSKEKeyMaterial structure.
359 typedef void (*SilcKeyAgreementCallback)(SilcClient client,
360 SilcClientConnection conn,
361 SilcClientEntry client_entry,
362 SilcKeyAgreementStatus status,
363 SilcSKEKeyMaterial key,
366 /****s* silcclient/SilcClientAPI/SilcPrivateMessageKeys
370 * typedef struct { ... } SilcPrivateMessageKeys;
374 * Structure to hold the list of private message keys. The list of these
375 * structures is returned by the silc_client_list_private_message_keys
380 typedef struct SilcPrivateMessageKeysStruct {
381 SilcClientEntry client_entry; /* The remote client entry */
382 char *cipher; /* The cipher name */
383 unsigned char *key; /* The original key, If the appliation
384 provided it. This is NULL if
385 the SKE key material was used. */
386 SilcUInt32 key_len; /* The key length */
387 } *SilcPrivateMessageKeys;
390 /****s* silcclient/SilcClientAPI/SilcChannelPrivateKey
394 * typedef struct SilcChannelPrivateKeyStruct { ... }
395 * *SilcChannelPrivateKey;
399 * Structure to hold one channel private key. The array of this structure
400 * is returned by silc_client_list_channel_private_keys function.
404 struct SilcChannelPrivateKeyStruct {
405 char *name; /* Application given name */
406 SilcCipher send_key; /* The cipher and key */
407 SilcCipher receive_key; /* The cipher and key */
408 SilcHmac hmac; /* The HMAC and hmac key */
412 /****f* silcclient/SilcClientAPI/SilcAskPassphrase
416 * typedef void (*SilcAskPassphrase)(const unsigned char *passphrase,
417 * SilcUInt32 passphrase_len,
422 * Ask passphrase callback. This is called by the application when the
423 * library calls `ask_passphrase' client operation. The callback delivers
424 * the passphrase to the library. The passphrases in SILC protocol
425 * MUST be in UTF-8 encoding, therefore the `passphrase' SHOULD be UTF-8
426 * encoded, and if it is not then library will attempt to encode it.
429 typedef void (*SilcAskPassphrase)(const unsigned char *passphrase,
430 SilcUInt32 passphrase_len,
433 /****f* silcclient/SilcClientAPI/SilcVerifyPublicKey
437 * typedef void (*SilcVerifyPublicKey)(SilcBool success, void *context);
441 * Public key (or certificate) verification callback. This is called
442 * by the application to indicate that the public key verification was
443 * either success or failure.
446 typedef void (*SilcVerifyPublicKey)(SilcBool success, void *context);
448 /****f* silcclient/SilcClientAPI/SilcGetAuthMeth
452 * typedef void (*SilcGetAuthMeth)(SilcAuthMethod auth_meth,
453 * const void *auth, SilcUInt32 auth_len,
458 * Authentication data resolving callback. This is called by the
459 * application to return the resolved authentication data. The client
460 * library has called the get_auth_method client operation and given
461 * this function pointer as argument. The `auth_meth' is the selected
462 * authentication method. The `auth_data' and the `auth_data_len'
463 * are the resolved authentication data. The `context' is the libary's
464 * context sent to the get_auth_method client operation.
466 * If the `auth_method' is SILC_AUTH_PASSWORD then `auth' and `auth_len'
467 * is the passphrase and its length. If it is SILC_AUTH_PUBLIC_KEY the
468 * `auth' must be NULL. The library will use the private key given as
469 * argument to silc_client_connect_to_server, silc_client_connect_to_client
470 * or silc_client_key_exchange. If it is SILC_AUTH_NONE, both `auth' and
471 * `auth_len' are ignored.
474 typedef void (*SilcGetAuthMeth)(SilcAuthMethod auth_meth,
475 const void *auth, SilcUInt32 auth_len,
478 /****d* silcclient/SilcClientAPI/SilcClientMessageType
482 * typedef enum { ... } SilcClientMessageType;
486 * Different message types for `say' client operation. The application
487 * may filter the message sent by the library according this type.
492 SILC_CLIENT_MESSAGE_INFO, /* Informational */
493 SILC_CLIENT_MESSAGE_WARNING, /* Warning */
494 SILC_CLIENT_MESSAGE_ERROR, /* Error */
495 SILC_CLIENT_MESSAGE_COMMAND_ERROR, /* Error during command */
496 SILC_CLIENT_MESSAGE_AUDIT, /* Auditable */
497 } SilcClientMessageType;
500 /****s* silcclient/SilcClientAPI/SilcClientOperations
504 * typedef struct { ... } SilcClientOperations;
508 * SILC Client Operations. These must be implemented by the application.
509 * The Client library may call any of these routines at any time. The
510 * routines are used to deliver certain information to the application
511 * or from the application to the client library.
515 typedef struct SilcClientOperationsStruct {
516 /* Message sent to the application by library. `conn' associates the
517 message to a specific connection. `conn', however, may be NULL.
518 The `type' indicates the type of the message sent by the library.
519 The application can for example filter the message according the
520 type. The variable argument list is arguments to the formatted
521 message `msg'. A SilcClientEntry, SilcChannelEntry or SilcServerEntry
522 can be associated with the message inside the `conn' by the library,
523 and application may use it to better target the message. */
524 void (*say)(SilcClient client, SilcClientConnection conn,
525 SilcClientMessageType type, char *msg, ...);
527 /* Message for a channel. The `sender' is the sender of the message
528 The `channel' is the channel. The `message' is the message. Note
529 that `message' maybe NULL. The `flags' indicates message flags
530 and it is used to determine how the message can be interpreted
531 (like it may tell the message is multimedia message). The `payload'
532 may be used to retrieve all the details of the message. */
533 void (*channel_message)(SilcClient client, SilcClientConnection conn,
534 SilcClientEntry sender, SilcChannelEntry channel,
535 SilcMessagePayload payload,
536 SilcChannelPrivateKey key, SilcMessageFlags flags,
537 const unsigned char *message,
538 SilcUInt32 message_len);
540 /* Private message to the client. The `sender' is the sender of the
541 message. The message is `message'and maybe NULL. The `flags'
542 indicates message flags and it is used to determine how the message
543 can be interpreted (like it may tell the message is multimedia
544 message). The `payload' may be used to retrieve all the details of
546 void (*private_message)(SilcClient client, SilcClientConnection conn,
547 SilcClientEntry sender, SilcMessagePayload payload,
548 SilcMessageFlags flags, const unsigned char *message,
549 SilcUInt32 message_len);
551 /* Notify message to the client. The arguments are notify `type' specific.
552 See separate documentation in the Toolkit Reference Manual for the notify
554 void (*notify)(SilcClient client, SilcClientConnection conn,
555 SilcNotifyType type, ...);
557 /* Command handler. This function is called always after application has
558 called a command. It will be called to indicate that the command
559 was processed. It will also be called if error occurs while processing
560 the command. The `success' indicates whether the command was sent
561 or if error occurred. The `status' indicates the actual error.
562 The `argc' and `argv' are the command line arguments sent to the
563 command by application. Note that, this is not reply to the command
564 from server, this is merely and indication to application that the
565 command was processed. */
566 void (*command)(SilcClient client, SilcClientConnection conn,
567 SilcBool success, SilcCommand command, SilcStatus status,
568 SilcUInt32 argc, unsigned char **argv);
570 /* Command reply handler. Delivers a reply to command that was sent
571 earlier. The `conn' is the associated client connection. The `command'
572 indicates the command reply type. If the `status' other than
573 SILC_STATUS_OK an error occurred. In this case the `error' will indicate
574 the error. It is possible to receive list of command replies and list
575 of errors. In this case the `status' will indicate it is an list entry
576 (the `status' is SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM and/or
577 SILC_STATUS_LIST_END).
579 The arguments received in `ap' are command specific. See a separate
580 documentation in the Toolkit Reference Manual for the command reply
582 void (*command_reply)(SilcClient client, SilcClientConnection conn,
583 SilcCommand command, SilcStatus status,
584 SilcStatus error, va_list ap);
586 /* Find authentication method and authentication data by hostname and
587 port. The hostname may be IP address as well. The `auth_method' is
588 the authentication method the remote connection requires. It is
589 however possible that remote accepts also some other authentication
590 method. Application should use the method that may have been
591 configured for this connection. If none has been configured it should
592 use the required `auth_method'. If the `auth_method' is
593 SILC_AUTH_NONE, server does not require any authentication or the
594 required authentication method is not known. The `completion'
595 callback must be called to deliver the chosen authentication method
596 and data. The `conn' may be NULL. */
597 void (*get_auth_method)(SilcClient client, SilcClientConnection conn,
598 char *hostname, SilcUInt16 port,
599 SilcAuthMethod auth_method,
600 SilcGetAuthMeth completion, void *context);
602 /* Called to verify received public key. The `conn_type' indicates which
603 entity (server or client) has sent the public key. If user decides to
604 trust the key the application may save the key as trusted public key for
605 later use. The `completion' must be called after the public key has
607 void (*verify_public_key)(SilcClient client, SilcClientConnection conn,
608 SilcConnectionType conn_type,
609 SilcPublicKey public_key,
610 SilcVerifyPublicKey completion, void *context);
612 /* Ask from end user a passphrase or a password. The passphrase is
613 returned to the library by calling the `completion' callback with
614 the `context'. The returned passphrase SHOULD be in UTF-8 encoded,
615 if not then the library will attempt to encode. */
616 void (*ask_passphrase)(SilcClient client, SilcClientConnection conn,
617 SilcAskPassphrase completion, void *context);
619 /* Called to indicate that incoming key agreement request has been
620 received. If the application wants to perform key agreement it may
621 call silc_client_perform_key_agreement to initiate key agreement or
622 silc_client_send_key_agreement to provide connection point to the
623 remote client in case the `hostname' is NULL. If key agreement is
624 not desired this request can be ignored. The `protocol' is either
625 value 0 for TCP or value 1 for UDP. */
626 void (*key_agreement)(SilcClient client, SilcClientConnection conn,
627 SilcClientEntry client_entry,
628 const char *hostname, SilcUInt16 protocol,
631 /* Notifies application that file transfer protocol session is being
632 requested by the remote client indicated by the `client_entry' from
633 the `hostname' and `port'. The `session_id' is the file transfer
634 session and it can be used to either accept or reject the file
635 transfer request, by calling the silc_client_file_receive or
636 silc_client_file_close, respectively. */
637 void (*ftp)(SilcClient client, SilcClientConnection conn,
638 SilcClientEntry client_entry, SilcUInt32 session_id,
639 const char *hostname, SilcUInt16 port);
640 } SilcClientOperations;
643 /****s* silcclient/SilcClientAPI/SilcClientParams
647 * typedef struct { ... } SilcClientParams;
651 * Client parameters. This can be filled with proper values and
652 * given as argument to the silc_client_alloc function. The structure
653 * hold various parameters which affects the function of the client.
657 typedef struct SilcClientParamsStruct {
658 /* If this boolean is set to TRUE then the client library will use
659 threads. Any of the callback functions in the SilcClientOperations
660 and other callbacks may be called at any time in a thread. The
661 application may need to employ appropriate concurrency control
662 in the callbacks to protect application specific data. */
665 /* Nickname format string. This can be used to order the client library
666 to save the nicknames in the library in a certain format. Since
667 nicknames are not unique in SILC it is possible to have multiple same
668 nicknames. Using this format string it is possible to order the library
669 to separate the multiple same nicknames from each other. If this is
670 empty then default format is used which is the default nickname
671 without anything else. The string MUST be NULL terminated.
673 Following format types are available:
675 %n nickname - the real nickname returned by the server (mandatory)
676 %a number - ascending number in case there are several
677 same nicknames (fe. nick#2 and nick#3)
678 %h hostname - the stripped hostname of the client
679 %H full hostname - the full hostname of the client
681 Example format strings: "%n#%a" (fe. nick#2, nick#3)
682 "%n#%h%a" (fe. nick#host, nick#host2)
683 "%a!%n#%h" (fe. nick#host, 2!nick#host)
685 Note that there must always be some separator characters around '%n'
686 format. It is not possible to put format characters before or after
687 '%n' without separators (such ash '#'). Also note that the separator
688 character should be a character that cannot be part of normal nickname.
689 Note that, using '@' as a separator is not recommended as the nickname
690 string may contain it to separate a server name from the nickname (eg.
691 nickname@silcnet.org).
693 char nickname_format[32];
695 /* If this is set to TRUE then the `nickname_format' is employed to all
696 saved nicknames even if there are no multiple same nicknames in the
697 cache. By default this is FALSE, which means that the `nickname_format'
698 is employed only if the library will receive a nickname that is
699 already saved in the cache. It is recommended to leave this to FALSE
701 SilcBool nickname_force_format;
703 /* If this is set to TRUE then all nickname strings returned by the library
704 and stored by the library are in the format of 'nickname@server', eg.
705 nickname@silcnet.org. If this is FALSE then the server name of the
706 nickname is available only from the SilcClientEntry structure. When this
707 is TRUE the server name is still parsed to SilcClientEntry. */
708 SilcBool full_nicknames;
710 /* If this is set to TRUE then all channel name strings returned by the
711 library and stored by the library are in the format of 'channel@server',
712 eg. silc@silcnet.org. If this is FALSE then the server name of the
713 channel is available only from the SilcChannelEntry structure. When this
714 is TRUE the server name is still parsed to SilcChannelEntry. Note that,
715 not all SILC server versions return such channel name strings. */
716 SilcBool full_channel_names;
718 /* If this is set to TRUE, the silcclient library will not register and
719 deregister the cipher, pkcs, hash and hmac algorithms. The application
720 itself will need to handle that. */
721 SilcBool dont_register_crypto_library;
727 /* Initialization functions (client.c) */
729 /****f* silcclient/SilcClientAPI/silc_client_alloc
733 * SilcClient silc_client_alloc(SilcClientOperations *ops,
734 * SilcClientParams *params,
736 * const char *silc_version);
740 * Allocates new client object. This has to be done before client may
741 * work. After calling this one must call silc_client_init to initialize
742 * the client. The `application' is application specific user data pointer
743 * and caller must free it. The `silc_version' is the application version
744 * that will be used to compare against remote host's (usually a server)
745 * version string. The `application' context is accessible by the
746 * application by client->application, client being SilcClient.
749 SilcClient silc_client_alloc(SilcClientOperations *ops,
750 SilcClientParams *params,
752 const char *version_string);
754 /****f* silcclient/SilcClientAPI/silc_client_free
758 * void silc_client_free(SilcClient client);
762 * Frees client object and its internals. The execution of the client
763 * should be stopped with silc_client_stop function before calling
767 void silc_client_free(SilcClient client);
769 /****f* silcclient/SilcClientAPI/silc_client_init
773 * SilcBool silc_client_init(SilcClient client, const char *username,
774 * const char *hostname, const char *realname,
775 * SilcClientRunning running, void *context);
779 * Initializes the client. This makes all the necessary steps to make
780 * the client ready to be run. One must call silc_client_run to run the
781 * client. Returns FALSE if error occurred, TRUE otherwise.
783 * The `username' and `hostname' strings must be given and they must be
784 * UTF-8 encoded. The `username' is the client's username in the
785 * operating system, `hostname' is the client's host name and the
786 * `realname' is the user's real name.
788 * The `running' callback with `context' is called after the client is
789 * running after silc_client_run or silc_client_run_one has been called.
790 * Application may start using the Client library API after that. Setting
791 * the callback is optional, but highly recommended.
794 SilcBool silc_client_init(SilcClient client, const char *username,
795 const char *hostname, const char *realname,
796 SilcClientRunning running, void *context);
798 /****f* silcclient/SilcClientAPI/silc_client_run
802 * void silc_client_run(SilcClient client);
806 * Runs the client. This starts the scheduler from the utility library.
807 * When this functions returns the execution of the application is over.
808 * The client must be initialized before calling this.
811 void silc_client_run(SilcClient client);
813 /****f* silcclient/SilcClientAPI/silc_client_run_one
817 * void silc_client_run_one(SilcClient client);
821 * Runs the client and returns immeadiately. This function is used when
822 * the SILC Client object indicated by the `client' is run under some
823 * other scheduler, or event loop or main loop. On GUI applications,
824 * for example this may be desired to used to run the client under the
825 * GUI application's main loop. Typically the GUI application would
826 * register an idle task that calls this function multiple times in
827 * a second to quickly process the SILC specific data.
830 void silc_client_run_one(SilcClient client);
832 /****f* silcclient/SilcClientAPI/silc_client_stop
836 * void silc_client_stop(SilcClient client, SilcClientStopped stopped,
841 * Stops the client. This is called to stop the client and thus to stop
842 * the program. The client context must be freed with the silc_client_free
843 * function. All connections that exist in this client must be closed
844 * before calling this function. Connections can be closed by calling
845 * silc_client_close_connection.
847 * The `stopped' will be called once the client and all connections have
848 * finished. The client may be freed after that. Note that the `stopped'
849 * won't be called before all connections have finished. Setting the
850 * callback is optional.
853 void silc_client_stop(SilcClient client, SilcClientStopped stopped,
856 /* Connecting functions */
858 /****s* silcclient/SilcClientAPI/SilcClientConnectionParams
862 * typedef struct { ... } SilcClientConnectionParams;
866 * Client connection parameters. This can be filled by the application
867 * and given as argument to silc_client_connect_to_server,
868 * silc_client_connect_to_client, silc_client_key_exchange or
869 * silc_client_send_key_agreement.
873 typedef struct SilcClientConnectionParamsStruct {
874 /* If this is provided the user's nickname in the network will be the
875 string given here. If it is given, it must be UTF-8 encoded. If this
876 string is not given, the user's username by default is used as nickname.
877 The nickname may later be changed by using NICK command. The maximum
878 length for the nickname string is 128 bytes. */
881 /* If this key repository pointer is non-NULL then public key received in
882 the key exchange protocol will be verified from this repository. If
883 this is not provided then the `verify_public_key' client operation will
884 be called back to application. If the boolean `verify_notfound' is set
885 to TRUE then the `verify_public_key' client operation will be called
886 in case the public key is not found in `repository'. Only public keys
887 added with at least SILC_SKR_USAGE_KEY_AGREEMENT in the repository will
888 be checked, other keys will be ignored. */
890 SilcBool verify_notfound;
892 /* Authentication data. Application may set here the authentication data
893 and authentication method to be used in connecting. If `auth_set'
894 boolean is TRUE then authentication data is provided by application.
895 If the authentication method is public key authentication then the key
896 pair given as argument when connecting will be used and `auth' field
897 is NULL. If it is passphrase authentication, it can be provided in
898 `auth' and `auth_len' fields. If `auth_set' is FALSE
899 the `get_auth_method' client operation will be called to get the
900 authentication method and data from application. */
902 SilcAuthMethod auth_method;
906 /* If this boolean is set to TRUE then the connection will use UDP instead
907 of TCP. If UDP is set then also the next `local_ip' and `local_port'
911 /* The `local_ip' specifies the local IP address used with the connection.
912 It must be non-NULL if `udp' boolean is TRUE. If the `local_port' is
913 non-zero it will be used as local port with UDP connection. The remote
914 host will also send packets to the specified address and port. If the
915 `bind_ip' is non-NULL a listener is bound to that address instead of
921 /* If this boolean is set to TRUE then the key exchange is done with
922 perfect forward secrecy. */
925 /* If this boolean is set to TRUE then connection authentication protocol
926 is not performed during connecting. Only key exchange protocol is
927 performed. This usually must be set to TRUE when connecting to another
928 client, but must be FALSE with server connections. */
929 SilcBool no_authentication;
931 /* The SILC session detachment data that was returned in the `command_reply'
932 client operation for SILC_COMMAND_DETACH command. If this is provided
933 here the client library will attempt to resume the session in the network.
934 After the connection is created and the session has been resumed the
935 client will receive SILC_COMMAND_NICK command_reply for the client's
936 nickname in the network and SILC_COMMAND_JOIN command reply for all the
937 channels that the client has joined in the network. It may also receive
938 SILC_COMMAND_UMODE command reply to set user's mode on the network. */
939 unsigned char *detach_data;
940 SilcUInt32 detach_data_len;
942 /* Connection timeout. If non-zero, the connection will timeout unless
943 the SILC connection is completed in the specified amount of time. */
944 SilcUInt32 timeout_secs;
946 /* Rekey timeout in seconds. The client will perform rekey in this
947 time interval. If set to zero, the default value will be used
948 (3600 seconds, 1 hour). */
949 SilcUInt32 rekey_secs;
951 /* If this is set to TRUE then the client will ignore all incoming
952 Requested Attributes queries and does not reply anything back. This
953 usually leads into situation where server does not anymore send
954 the queries after seeing that client does not reply anything back.
955 If your application does not support Requested Attributes or you do
956 not want to use them set this to TRUE. See SilcAttribute and
957 silc_client_attribute_add for more information on attributes. */
958 SilcBool ignore_requested_attributes;
960 /* User context for SilcClientConnection. If non-NULL this context is
961 set to the 'context' field in SilcClientConnection when the connection
962 context is created. */
964 } SilcClientConnectionParams;
967 /****f* silcclient/SilcClientAPI/silc_client_connect_to_server
972 * silc_client_connect_to_server(SilcClient client,
973 * SilcClientConnectionParams *params,
974 * SilcPublicKey public_key,
975 * SilcPrivateKey private_key,
976 * char *remote_host, int port,
977 * SilcClientConnectCallback callback,
982 * Connects to remote server `remote_host' at port `port'. This function
983 * can be used to create connection to remote SILC server and start
984 * SILC session in the SILC network. The `params' may be provided
985 * to provide various connection parameters. The `public_key' and the
986 * `private_key' is your identity used in this connection. When
987 * authentication method is based on digital signatures, this key pair
988 * will be used. The `callback' with `context' will be called after the
989 * connection has been created. It will also be called later when remote
992 * If application wishes to create the network connection itself, use
993 * the silc_client_key_exchange after creating the connection to start
994 * key exchange and authentication with the server.
996 * Returns SilcAsyncOperation which can be used to cancel the connecting,
997 * or NULL on error. Note that the returned pointer becomes invalid
998 * after the `callback' is called.
1002 silc_client_connect_to_server(SilcClient client,
1003 SilcClientConnectionParams *params,
1004 SilcPublicKey public_key,
1005 SilcPrivateKey private_key,
1006 char *remote_host, int port,
1007 SilcClientConnectCallback callback,
1010 /****f* silcclient/SilcClientAPI/silc_client_connect_to_client
1014 * SilcAsyncOperation
1015 * silc_client_connect_to_client(SilcClient client,
1016 * SilcClientConnectionParams *params,
1017 * SilcPublicKey public_key,
1018 * SilcPrivateKey private_key,
1019 * char *remote_host, int port,
1020 * SilcClientConnectCallback callback,
1025 * Connects to remote client `remote_host' at port `port'. This function
1026 * can be used to create peer-to-peer connection to another SILC client,
1027 * for example, for direct conferencing, or file transfer or for other
1028 * purposes. The `params' may be provided to provide various connection
1029 * parameters. The `public_key' and the `private_key' is your identity
1030 * used in this connection. The `callback' with `context' will be called
1031 * after the connection has been created. It will also be called later
1032 * when remote host disconnects.
1034 * If application wishes to create the network connection itself, use
1035 * the silc_client_key_exchange after creating the connection to start
1036 * key exchange with the client.
1038 * Returns SilcAsyncOperation which can be used to cancel the connecting,
1039 * or NULL on error. Note that the returned pointer becomes invalid
1040 * after the `callback' is called.
1044 silc_client_connect_to_client(SilcClient client,
1045 SilcClientConnectionParams *params,
1046 SilcPublicKey public_key,
1047 SilcPrivateKey private_key,
1048 char *remote_host, int port,
1049 SilcClientConnectCallback callback,
1052 /****f* silcclient/SilcClientAPI/silc_client_key_exchange
1056 * SilcAsyncOperation
1057 * silc_client_key_exchange(SilcClient client,
1058 * SilcClientConnectionParams *params,
1059 * SilcPublicKey public_key,
1060 * SilcPrivateKey private_key,
1061 * SilcStream stream,
1062 * SilcConnectionType conn_type,
1063 * SilcClientConnectCallback callback,
1068 * Starts key exchange protocol and authentication protocol in the
1069 * connection indicated by `stream'. This function can be be used to
1070 * start SILC session with remote host (usually server) when the caller
1071 * has itself created the connection, instead of calling the function
1072 * silc_client_connect_to_server or silc_client_connect_to_client. If
1073 * one of those functions was used this function must not be called as
1074 * in that case the key exchange is performed automatically.
1076 * Use this function only if you have created the connection by yourself.
1077 * After creating the connection the socket must be wrapped into a
1078 * socket stream. See silcsocketstream.h for more information. Note that
1079 * the `stream' must have valid remote IP address (and optionally also
1080 * hostname) and port set.
1082 * The `params' may be provided to provide various connection parameters.
1083 * The `public_key' and the `private_key' is your identity used in this
1084 * session. The `callback' with `context' will be called after the session
1085 * has been set up. It will also be called later when remote host
1086 * disconnects. The `conn_type' is the type of session this is going to
1087 * be. If the remote is SILC server it is SILC_CONN_SERVER or if it is
1088 * SILC client it is SILC_CONN_CLIENT.
1090 * Returns SilcAsyncOperation which can be used to cancel the connecting,
1091 * or NULL on error. Note that the returned pointer becomes invalid
1092 * after the `callback' is called.
1098 * // Create remote connection stream. Resolve hostname and IP also.
1099 * sock = create_connection(remote_host, port);
1100 * silc_socket_tcp_stream_create(sock, TRUE, FALSE, schedule,
1101 * stream_create_cb, app);
1103 * // Stream callback delivers our new SilcStream context
1104 * void stream_create_cb(SilcSocketStreamStatus status, SilcStream stream,
1108 * if (status != SILC_SOCKET_OK)
1111 * // Start key exchange
1112 * silc_client_key_exchange(client, NULL, public_key, private_key,
1113 * stream, SILC_CONN_SERVER, connection_cb, app);
1119 silc_client_key_exchange(SilcClient client,
1120 SilcClientConnectionParams *params,
1121 SilcPublicKey public_key,
1122 SilcPrivateKey private_key,
1124 SilcConnectionType conn_type,
1125 SilcClientConnectCallback callback,
1128 /****f* silcclient/SilcClientAPI/silc_client_close_connection
1132 * void silc_client_close_connection(SilcClient client,
1133 * SilcClientConnection conn);
1137 * Closes the remote connection `conn'. The `conn' will become invalid
1138 * after this call. Usually this function is called only when explicitly
1139 * closing connection for example in case of error, or when the remote
1140 * connection was created by the application or when the remote is client
1141 * connection. Server connections are usually closed by sending QUIT
1142 * command to the server. However, this call may also be used.
1145 void silc_client_close_connection(SilcClient client,
1146 SilcClientConnection conn);
1148 /* Message sending functions */
1150 /****f* silcclient/SilcClientAPI/silc_client_send_channel_message
1154 * SilcBool silc_client_send_channel_message(SilcClient client,
1155 * SilcClientConnection conn,
1156 * SilcChannelEntry channel,
1157 * SilcChannelPrivateKey key,
1158 * SilcMessageFlags flags,
1160 * unsigned char *data,
1161 * SilcUInt32 data_len);
1165 * Sends encrypted message to the `channel'. The plaintext message is
1166 * the `data' of `data_len' bytes in length.
1168 * If `key' is provided then that private channel message key is used to
1169 * encrypt the message. If it is not provided and the `channel' does not
1170 * have SILC_CHANNEL_MODE_PRIVKEY set, the curent channel key is used
1171 * instead. If the mode is set but `key' is NULL the key that was added
1172 * first as private channel message key will be used.
1174 * If the `flags' includes SILC_MESSAGE_FLAG_SIGNED the message will be
1175 * digitally signed with the SILC key pair associated with the `conn'.
1176 * In this case the `hash' pointer must be provided as well.
1178 * Returns TRUE if the message was sent, and FALSE if error occurred or
1179 * the sending is not allowed due to channel modes (like sending is
1180 * blocked). This function is thread safe and private messages can be
1181 * sent from multiple threads.
1184 SilcBool silc_client_send_channel_message(SilcClient client,
1185 SilcClientConnection conn,
1186 SilcChannelEntry channel,
1187 SilcChannelPrivateKey key,
1188 SilcMessageFlags flags,
1190 unsigned char *data,
1191 SilcUInt32 data_len);
1193 /****f* silcclient/SilcClientAPI/silc_client_send_private_message
1197 * SilcBool silc_client_send_private_message(SilcClient client,
1198 * SilcClientConnection conn,
1199 * SilcClientEntry client_entry,
1200 * SilcMessageFlags flags,
1202 * unsigned char *data,
1203 * SilcUInt32 data_len);
1207 * Sends private message to remote client. If private message key has
1208 * not been set with this client then the message will be encrypted using
1209 * the session keys used in `conn' connection. If the `flags' includes
1210 * SILC_MESSAGE_FLAG_SIGNED the message will be digitally signed with the
1211 * SILC key pair associated with `conn'. In this case the caller must also
1212 * provide the `hash' pointer.
1214 * Returns TRUE if the message was sent, and FALSE if error occurred.
1215 * This function is thread safe and private messages can be sent from
1219 SilcBool silc_client_send_private_message(SilcClient client,
1220 SilcClientConnection conn,
1221 SilcClientEntry client_entry,
1222 SilcMessageFlags flags,
1224 unsigned char *data,
1225 SilcUInt32 data_len);
1227 /****f* silcclient/SilcClientAPI/silc_client_private_message_wait_init
1232 * silc_client_private_message_wait_init(SilcClient client,
1233 * SilcClientConnection conn,
1234 * SilcClientEntry client_entry);
1238 * Initializes private message waiting functionality for the client
1239 * indicated by `client_entry'. Once this is called private message
1240 * from remote connection indicated by `conn' for `client_entry' may
1241 * be waiter for, for example in a thread. The function
1242 * silc_client_private_message_wait is used to block the current thread
1243 * until a private message is received from a specified client entry.
1244 * Return FALSE in case an internal error occurred.
1247 SilcBool silc_client_private_message_wait_init(SilcClient client,
1248 SilcClientConnection conn,
1249 SilcClientEntry client_entry);
1251 /****f* silcclient/SilcClientAPI/silc_client_private_message_wait_uninit
1256 * silc_client_private_message_wait_uninit(SilcClient client,
1257 * SilcClientConnection conn,
1258 * SilcClientEntry client_entry);
1262 * Unintializes private message waiting for client indicated by
1263 * `client_entry'. After this call private message cannot be waited
1264 * anymore and silc_client_private_message_wait will return with FALSE
1268 void silc_client_private_message_wait_uninit(SilcClient client,
1269 SilcClientConnection conn,
1270 SilcClientEntry client_entry);
1272 /****f* silcclient/SilcClientAPI/silc_client_private_message_wait
1277 * silc_client_private_message_wait(SilcClient client,
1278 * SilcClientConnection conn,
1279 * SilcClientEntry client_entry,
1280 * SilcMessagePayload *payload);
1284 * Blocks current thread or process until a private message has been
1285 * received from the remote client indicated by `client_entry'. Before
1286 * private messages can be waited the silc_client_private_message_wait_init
1287 * must be called. This function can be used from a thread to wait for
1288 * private message from the specified client. Multiple threads can be
1289 * created to wait messages from multiple clients. Any other private
1290 * message received from the connection indicated by `conn' will be
1291 * forwarded to the normal `private_message' client operation callback.
1292 * The private messages from `client_entry' will not be delivered to the
1293 * `private_message' client operation callback.
1295 * Returns TRUE and the received private message into `payload'. The caller
1296 * must free the returned SilcMessagePayload. If this function returns
1297 * FALSE the private messages cannot be waited anymore. This happens
1298 * when some other thread calls silc_client_private_message_wait_uninit.
1299 * This returns FALSE also if silc_client_private_message_wait_init has
1303 SilcBool silc_client_private_message_wait(SilcClient client,
1304 SilcClientConnection conn,
1305 SilcClientEntry client_entry,
1306 SilcMessagePayload *payload);
1308 /****f* silcclient/SilcClientAPI/silc_client_on_channel
1312 * SilcChannelUser silc_client_on_channel(SilcChannelEntry channel,
1313 * SilcClientEntry client_entry);
1317 * Returns the SilcChannelUser entry if the `client_entry' is joined on the
1318 * channel indicated by the `channel'. NULL if client is not joined on
1322 SilcChannelUser silc_client_on_channel(SilcChannelEntry channel,
1323 SilcClientEntry client_entry);
1326 /* Command management */
1328 /****f* silcclient/SilcClientAPI/silc_client_command_call
1332 * SilcUInt16 silc_client_command_call(SilcClient client,
1333 * SilcClientConnection conn,
1334 * const char *command_line, ...);
1338 * Calls and executes the command indicated by the `command_name'.
1339 * The `command_line' is a string which includes the command's name and
1340 * its arguments separated with whitespaces (' '). If `command_line'
1341 * is non-NULL then all variable arguments are ignored by default.
1343 * If `command_line' is NULL, then the variable arguments define the
1344 * command's name and its arguments. The first variable argument must
1345 * be the command name. The variable argument list must be terminated
1348 * Returns command identifier for this sent command. It can be used
1349 * to additionally attach to the command reply using the function
1350 * silc_client_command_pending, if needed. Returns 0 on error.
1352 * The `command' client operation callback will be called when the
1353 * command is executed to indicate whether or not the command executed
1356 * The `command_reply' client operation callbak will be called when reply
1357 * is received from the server to the command. Application may also use
1358 * the silc_client_command_pending to attach to the command reply.
1359 * The command identifier for silc_client_command_pending function after
1360 * this function call is conn->cmd_ident, which application may use.
1364 * silc_client_command_call(client, conn, NULL, "PING", "silc.silcnet.org",
1366 * silc_client_command_call(client, conn, "PING silc.silcnet.org");
1370 * This command executes the commands implemented inside the client
1371 * library. These commands are designed for command line applications,
1372 * but GUI application may call them too if needed. Alternatively
1373 * application may override the library and use silc_client_command_send
1377 SilcUInt16 silc_client_command_call(SilcClient client,
1378 SilcClientConnection conn,
1379 const char *command_line, ...);
1381 /****f* silcclient/SilcClientAPI/SilcClientCommandReply
1385 * typedef SilcBool (*SilcClientCommandReply)(SilcClient client,
1386 * SilcClientConnection conn,
1387 * SilcCommand command,
1388 * SilcStatus status,
1395 * The command reply callback function given as argument to functions
1396 * silc_client_command_send and silc_client_command_pending. This is
1397 * called to deliver the command replies to the caller. Each command
1398 * reply received from the server to the `command' will be delivered
1399 * separately to the caller by calling this callback. The `status' will
1400 * indicate whether there is only one reply or multiple replies. The
1401 * `error' will indicate if an error occurred. The `ap' will include
1402 * command reply arguments. They are the same arguments as for
1403 * `command_reply' client operation callback in SilcClientOperations.
1405 * If `status' is SILC_STATUS_OK only one reply was received and error
1406 * did not occur. If it is SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
1407 * or SILC_STATUS_LIST_END, there are will be two or more replies. The
1408 * first reply is SILC_STATUS_LIST_START and last one SILC_STATUS_LIST_END.
1410 * If FALSE is returned in this function this callback will not be called
1411 * again for `command' even if there are more comand replies. By returning
1412 * FALSE the caller my stop the command reply handling when needed.
1415 typedef SilcBool (*SilcClientCommandReply)(SilcClient client,
1416 SilcClientConnection conn,
1417 SilcCommand command,
1423 /****f* silcclient/SilcClientAPI/silc_client_command_send
1427 * SilcUInt16 silc_client_command_send(SilcClient client,
1428 * SilcClientConnection conn,
1429 * SilcCommand command,
1430 * SilcClientCommandReply reply,
1431 * void *reply_context,
1432 * SilcUInt32 argc, ...);
1436 * Generic function to send any command. The arguments must be given
1437 * already encoded into correct format and in correct order. If application
1438 * wants to perform the commands by itself, it can do so and send the data
1439 * directly to the server using this function. If application is using
1440 * the silc_client_command_call, this function is usually not used.
1441 * Programmer should get familiar with the SILC protocol commands
1442 * specification when using this function, as the arguments needs to
1443 * be encoded as specified in the protocol.
1445 * The variable arguments are a set of { type, data, data_length },
1446 * and the `argc' is the number of these sets.
1448 * The `reply' callback must be provided, and it is called when the
1449 * command reply is received from the server. Note that, when using this
1450 * function the default `command_reply' client operation callback will not
1451 * be called when reply is received.
1453 * Returns command identifier for this sent command. It can be used
1454 * to additionally attach to the command reply using the function
1455 * silc_client_command_pending, if needed. Returns 0 on error.
1459 * silc_client_command_send(client, conn, SILC_COMMAND_WHOIS,
1460 * my_whois_command_reply, cmd_ctx,
1461 * 1, 1, nickname, strlen(nickname));
1464 SilcUInt16 silc_client_command_send(SilcClient client,
1465 SilcClientConnection conn,
1466 SilcCommand command,
1467 SilcClientCommandReply reply,
1468 void *reply_context,
1469 SilcUInt32 argc, ...);
1471 /****f* silcclient/SilcClientAPI/silc_client_command_pending
1475 * void silc_client_command_pending(SilcClientConnection conn,
1476 * SilcCommand command,
1477 * SilcUInt16 cmd_ident,
1478 * SilcClientCommandReply reply,
1483 * This function can be used to add pending command callback to be
1484 * called when an command reply is received to an earlier sent command.
1485 * The `command' is the command that must be received in order for
1486 * the pending command callback indicated by `callback' to be called.
1488 * The `cmd_ident' is a command identifier which was set for the earlier
1489 * sent command. The command reply will include the same identifier
1490 * and pending command callback will be called when the reply is
1491 * received with the same command identifier. It is possible to
1492 * add multiple pending command callbacks for same command and for
1495 * Application may use this function to add its own command reply
1496 * handlers if it wishes not to use the standard `command_reply'
1499 * Note also that the application is notified about the received command
1500 * reply through the `command_reply' client operation before calling
1501 * the `callback` pending command callback. That is the normal
1502 * command reply handling, and is called regardless whether pending
1503 * command callbacks are used or not.
1507 * SilcUInt16 cmd_ident;
1508 * cmd_ident = silc_client_command_call(client, conn,
1509 * "PING silc.silcnet.org");
1510 * silc_client_command_pending(conn, SILC_COMMAND_PING, cmd_ident,
1511 * my_ping_handler, my_ping_context);
1514 SilcBool silc_client_command_pending(SilcClientConnection conn,
1515 SilcCommand command,
1516 SilcUInt16 cmd_ident,
1517 SilcClientCommandReply reply,
1521 /* Private Message key management */
1523 /****f* silcclient/SilcClientAPI/silc_client_add_private_message_key
1528 * silc_client_add_private_message_key(SilcClient client,
1529 * SilcClientConnection conn,
1530 * SilcClientEntry client_entry,
1531 * const char *cipher,
1533 * unsigned char *key,
1534 * SilcUInt32 key_len);
1538 * Adds a static private message key to the client library. The key
1539 * will be used to encrypt all private message between the client and
1540 * the remote client indicated by the `client_entry'. The `key' can
1541 * be for example a pre-shared-key, passphrase or similar shared secret
1542 * string. The `cipher' and `hmac' MAY be provided but SHOULD be NULL
1543 * to assure that the requirements of the SILC protocol are met. The
1544 * API, however, allows to allocate any cipher and HMAC.
1546 * If the private message key is added to client without first receiving
1547 * a request for it from the remote `client_entry' this function will
1548 * send the request to `client_entry'. Note that, the actual key is
1549 * not sent to the network.
1551 * It is not necessary to set key for normal private message usage. If the
1552 * key is not set then the private messages are encrypted using normal
1553 * session keys. Setting the private key, however, increases security.
1555 * Returns FALSE if the key is already set for the `client_entry', TRUE
1559 SilcBool silc_client_add_private_message_key(SilcClient client,
1560 SilcClientConnection conn,
1561 SilcClientEntry client_entry,
1565 SilcUInt32 key_len);
1567 /****f* silcclient/SilcClientAPI/silc_client_add_private_message_key_ske
1572 * silc_client_add_private_message_key_ske(SilcClient client,
1573 * SilcClientConnection conn,
1574 * SilcClientEntry client_entry,
1575 * const char *cipher,
1577 * SilcSKEKeyMaterial key);
1581 * Same as silc_client_add_private_message_key but takes the key material
1582 * from the SKE key material structure. This structure is received if
1583 * the application uses the silc_client_send_key_agreement to negotiate
1584 * the key material. The `cipher' and `hmac' SHOULD be provided as it is
1585 * negotiated also in the SKE protocol.
1588 SilcBool silc_client_add_private_message_key_ske(SilcClient client,
1589 SilcClientConnection conn,
1590 SilcClientEntry client_entry,
1593 SilcSKEKeyMaterial key);
1595 /****f* silcclient/SilcClientAPI/silc_client_del_private_message_key
1600 * silc_client_del_private_message_key(SilcClient client,
1601 * SilcClientConnection conn,
1602 * SilcClientEntry client_entry);
1606 * Removes the private message from the library. The key won't be used
1607 * after this to protect the private messages with the remote `client_entry'
1608 * client. Returns FALSE on error, TRUE otherwise.
1611 SilcBool silc_client_del_private_message_key(SilcClient client,
1612 SilcClientConnection conn,
1613 SilcClientEntry client_entry);
1615 /****f* silcclient/SilcClientAPI/silc_client_list_private_message_keys
1619 * SilcPrivateMessageKeys
1620 * silc_client_list_private_message_keys(SilcClient client,
1621 * SilcClientConnection conn,
1622 * SilcUInt32 *key_count);
1626 * Returns array of set private message keys associated to the connection
1627 * `conn'. Returns allocated SilcPrivateMessageKeys array and the array
1628 * count to the `key_count' argument. The array must be freed by the caller
1629 * by calling the silc_client_free_private_message_keys function. Note:
1630 * the keys returned in the array is in raw format. It might not be desired
1631 * to show the keys as is. The application might choose not to show the keys
1632 * at all or to show the fingerprints of the keys.
1635 SilcPrivateMessageKeys
1636 silc_client_list_private_message_keys(SilcClient client,
1637 SilcClientConnection conn,
1638 SilcUInt32 *key_count);
1640 /****f* silcclient/SilcClientAPI/silc_client_free_private_message_keys
1644 * void silc_client_free_private_message_keys(SilcPrivateMessageKeys keys,
1645 * SilcUInt32 key_count);
1649 * Frees the SilcPrivateMessageKeys array returned by the function
1650 * silc_client_list_private_message_keys.
1653 void silc_client_free_private_message_keys(SilcPrivateMessageKeys keys,
1654 SilcUInt32 key_count);
1656 /****f* silcclient/SilcClientAPI/silc_client_private_message_key_is_set
1661 * silc_client_private_message_key_is_set(SilcClient client,
1662 * SilcClientConnection conn,
1663 * SilcClientEntry client_entry);
1667 * Returns TRUE if the private message key has been set for the client
1668 * entry indicated by `client_entry'.
1672 silc_client_private_message_key_is_set(SilcClient client,
1673 SilcClientConnection conn,
1674 SilcClientEntry client_entry);
1677 /* Channel private key management */
1679 /****f* silcclient/SilcClientAPI/silc_client_add_channel_private_key
1684 * silc_client_add_channel_private_key(SilcClient client,
1685 * SilcClientConnection conn,
1686 * SilcChannelEntry channel,
1690 * unsigned char *key,
1691 * SilcUInt32 key_len,
1692 * SilcChannelPrivateKey *ret_key);
1696 * Adds private key for channel. When channel has private key then the
1697 * messages are encrypted using that key. All clients on the channel
1698 * must also know the key in order to decrypt the messages. However,
1699 * it is possible to have several private keys per one channel. In this
1700 * case only some of the clients on the channel may know the one key
1701 * and only some the other key. The `name' can be application given
1702 * name for the key. This returns the created key to the 'ret_key'
1703 * pointer if it is non-NULL;
1705 * If `cipher' and/or `hmac' is NULL then default values will be used
1706 * (aes-256-cbc for cipher and hmac-sha1-96 for hmac).
1708 * The private key for channel is optional. If it is not set then the
1709 * channel messages are encrypted using the channel key generated by the
1710 * server. However, setting the private key (or keys) for the channel
1711 * significantly adds security. If more than one key is set the library
1712 * will automatically try all keys at the message decryption phase. Note:
1713 * setting many keys slows down the decryption phase as all keys has to
1714 * be tried in order to find the correct decryption key. However, setting
1715 * a few keys does not have big impact to the decryption performace.
1719 * NOTE: This is entirely local setting. The key set using this function
1720 * is not sent to the network at any phase.
1722 * NOTE: If the key material was originated by the SKE protocol (using
1723 * silc_client_send_key_agreement) then the `key' MUST be the
1724 * key->send_enc_key as this is dictated by the SILC protocol. However,
1725 * currently it is not expected that the SKE key material would be used
1726 * as channel private key. However, this API allows it.
1729 SilcBool silc_client_add_channel_private_key(SilcClient client,
1730 SilcClientConnection conn,
1731 SilcChannelEntry channel,
1737 SilcChannelPrivateKey *ret_key);
1739 /****f* silcclient/SilcClientAPI/silc_client_del_channel_private_keys
1743 * SilcBool silc_client_del_channel_private_keys(SilcClient client,
1744 * SilcClientConnection conn,
1745 * SilcChannelEntry channel);
1749 * Removes all private keys from the `channel'. The old channel key is used
1750 * after calling this to protect the channel messages. Returns FALSE on
1751 * on error, TRUE otherwise.
1754 SilcBool silc_client_del_channel_private_keys(SilcClient client,
1755 SilcClientConnection conn,
1756 SilcChannelEntry channel);
1758 /****f* silcclient/SilcClientAPI/silc_client_del_channel_private_key
1762 * SilcBool silc_client_del_channel_private_key(SilcClient client,
1763 * SilcClientConnection conn,
1764 * SilcChannelEntry channel,
1765 * SilcChannelPrivateKey key);
1769 * Removes and frees private key `key' from the channel `channel'.
1770 * The `key' is retrieved by calling the function
1771 * silc_client_list_channel_private_keys. The key is not used after
1772 * this. If the key was last private key then the old channel key is
1773 * used hereafter to protect the channel messages. This returns FALSE
1774 * on error, TRUE otherwise.
1777 SilcBool silc_client_del_channel_private_key(SilcClient client,
1778 SilcClientConnection conn,
1779 SilcChannelEntry channel,
1780 SilcChannelPrivateKey key);
1782 /****f* silcclient/SilcClientAPI/silc_client_list_channel_private_keys
1787 * silc_client_list_channel_private_keys(SilcClient client,
1788 * SilcClientConnection conn,
1789 * SilcChannelEntry channel);
1793 * Returns list of private keys associated to the `channel'. The caller
1794 * must free the returned list with silc_dlist_uninit. The pointers in
1795 * the list may be used to delete the specific key by giving the pointer
1796 * as argument to the function silc_client_del_channel_private_key. Each
1797 * entry in the list is SilcChannelPrivateKey.
1800 SilcDList silc_client_list_channel_private_keys(SilcClient client,
1801 SilcClientConnection conn,
1802 SilcChannelEntry channel);
1804 /****f* silcclient/SilcClientAPI/silc_client_current_channel_private_key
1808 * void silc_client_current_channel_private_key(SilcClient client,
1809 * SilcClientConnection conn,
1810 * SilcChannelEntry channel,
1811 * SilcChannelPrivateKey key);
1815 * Sets the `key' to be used as current channel private key on the
1816 * `channel'. Packet sent after calling this function will be secured
1820 void silc_client_current_channel_private_key(SilcClient client,
1821 SilcClientConnection conn,
1822 SilcChannelEntry channel,
1823 SilcChannelPrivateKey key);
1826 /* Key Agreement routines */
1828 /****f* silcclient/SilcClientAPI/silc_client_send_key_agreement
1832 * void silc_client_send_key_agreement(SilcClient client,
1833 * SilcClientConnection conn,
1834 * SilcClientEntry client_entry,
1835 * SilcClientConnectionParams *params,
1836 * SilcPublicKey public_key,
1837 * SilcPrivateKey private_key,
1838 * SilcKeyAgreementCallback completion,
1843 * Sends key agreement request to the remote client indicated by the
1846 * If `params' is non-NULL and it has the `local_ip' and `local_port' set
1847 * the caller will provide the connection endpoint for the key agreement
1848 * connection. The `bind_ip' can be used to bind to that IP instead of
1849 * `local_ip'. If the `udp' is set to TRUE the connection will be UDP
1850 * instead of TCP. Caller may also set the `repository', `verify_notfound'
1851 * and `timeout_secs' fields in `params'. Other fields are ignored.
1852 * If `params' is NULL, then the `client_entry' is expected to provide
1853 * the connection endpoint for us. It is recommended the `timeout_secs'
1854 * is specified in case the remote client does not reply anything to
1857 * The `public_key' and `private_key' is our identity in the key agreement.
1859 * In case we do not provide the connection endpoint, we will receive
1860 * the `key_agreement' client operation when the remote send its own
1861 * key agreement request packet. We may then there start the key
1862 * agreement with silc_client_perform_key_agreement. If we provided the
1863 * the connection endpoint, the client operation will not be called.
1865 * There can be only one active key agreement for `client_entry'. Old
1866 * key agreement may be aborted by calling silc_client_abort_key_agreement.
1870 * // Send key agreement request (we don't provide connection endpoint)
1871 * silc_client_send_key_agreement(client, conn, remote_client,
1872 * NULL, public_key, private_key,
1873 * my_keyagr_completion, my_context);
1875 * // Another example where we provide connection endpoint (TCP).
1876 * SilcClientConnectionParams params;
1877 * memset(¶ms, 0, sizeof(params));
1878 * params.local_ip = local_ip;
1879 * params.local_port = local_port;
1880 * params.timeout_secs = 60;
1881 * silc_client_send_key_agreement(client, conn, remote_client,
1882 * ¶ms, public_key, private_key,
1883 * my_keyagr_completion, my_context);
1886 void silc_client_send_key_agreement(SilcClient client,
1887 SilcClientConnection conn,
1888 SilcClientEntry client_entry,
1889 SilcClientConnectionParams *params,
1890 SilcPublicKey public_key,
1891 SilcPrivateKey private_key,
1892 SilcKeyAgreementCallback completion,
1895 /****f* silcclient/SilcClientAPI/silc_client_perform_key_agreement
1900 * silc_client_perform_key_agreement(SilcClient client,
1901 * SilcClientConnection conn,
1902 * SilcClientEntry client_entry,
1903 * SilcClientConnectionParams *params,
1904 * SilcPublicKey public_key,
1905 * SilcPrivateKey private_key,
1906 * char *hostname, int port,
1907 * SilcKeyAgreementCallback completion,
1912 * Performs the key agreement protocol. Application may use this to
1913 * initiate the key agreement protocol. Usually this is called after
1914 * receiving the `key_agreement' client operation.
1916 * The `hostname' is the remote hostname (or IP address) and the `port'
1917 * is the remote port. The `completion' callback with the `context' will
1918 * be called after the key agreement protocol.
1920 * The `params' is connection parameters and it may be used to define
1921 * the key agreement connection related parameters. It may be NULL.
1924 void silc_client_perform_key_agreement(SilcClient client,
1925 SilcClientConnection conn,
1926 SilcClientEntry client_entry,
1927 SilcClientConnectionParams *params,
1928 SilcPublicKey public_key,
1929 SilcPrivateKey private_key,
1930 char *hostname, int port,
1931 SilcKeyAgreementCallback completion,
1934 /****f* silcclient/SilcClientAPI/silc_client_perform_key_agreement_stream
1939 * silc_client_perform_key_agreement_stream(
1940 * SilcClient client,
1941 * SilcClientConnection conn,
1942 * SilcClientEntry client_entry,
1943 * SilcClientConnectionParams *params,
1944 * SilcPublicKey public_key,
1945 * SilcPrivateKey private_key,
1946 * SilcStream stream,
1947 * SilcKeyAgreementCallback completion,
1952 * Same as silc_client_perform_key_agreement but the caller has created
1953 * the connection to remote client. The `stream' is the created
1958 silc_client_perform_key_agreement_stream(SilcClient client,
1959 SilcClientConnection conn,
1960 SilcClientEntry client_entry,
1961 SilcClientConnectionParams *params,
1962 SilcPublicKey public_key,
1963 SilcPrivateKey private_key,
1965 SilcKeyAgreementCallback completion,
1968 /****f* silcclient/SilcClientAPI/silc_client_abort_key_agreement
1972 * void silc_client_abort_key_agreement(SilcClient client,
1973 * SilcClientConnection conn,
1974 * SilcClientEntry client_entry);
1978 * This function can be called to unbind the hostname and the port for
1979 * the key agreement protocol. However, this function has effect only
1980 * before the key agreement protocol has been performed. After it has
1981 * been performed the library will automatically unbind the port. The
1982 * `client_entry' is the client to which we sent the key agreement
1983 * request. The key agreement completion callback will be called
1984 * with SILC_KEY_AGREEMENT_ABORTED status.
1987 void silc_client_abort_key_agreement(SilcClient client,
1988 SilcClientConnection conn,
1989 SilcClientEntry client_entry);
1992 /* Misc functions */
1994 /****f* silcclient/SilcClientAPI/silc_client_set_away_message
1998 * SilcBool silc_client_set_away_message(SilcClient client,
1999 * SilcClientConnection conn,
2004 * Sets away `message'. The away message may be set when the client's
2005 * mode is changed to SILC_UMODE_GONE and the client whishes to reply
2006 * to anyone who sends private message. The `message' will be sent
2007 * automatically back to the the client who send private message. If
2008 * away message is already set this replaces the old message with the
2009 * new one. If `message' is NULL the old away message is removed.
2010 * The sender may freely free the memory of the `message'. Returns
2014 SilcBool silc_client_set_away_message(SilcClient client,
2015 SilcClientConnection conn,
2018 /****d* silcclient/SilcClientAPI/SilcClientMonitorStatus
2022 * typedef enum { ... } SilcClientMonitorStatus;
2026 * File transmission session status types. These will indicate
2027 * the status of the file transmission session.
2029 * The SILC_CLIENT_FILE_MONITOR_KEY_AGREEMENT is called when session
2030 * is key exchange phase.
2032 * The SILC_CLIENT_FILE_MONITOR_SEND is called when data is being sent
2035 * The SILC_CLIENT_FILE_MONITOR_RECEIVE is called when data is being
2036 * recieved from remote client.
2038 * The SILC_CLIENT_FILE_MONITOR_CLOSED will be called when the user
2039 * issues silc_client_file_close. If needed, it may be ignored in the
2042 * The SILC_CLIENT_FILE_MONITOR_DISCONNECT will be called if remote
2043 * disconnects the session connection. The silc_client_file_close must
2044 * be called when this status is received. The session is over when
2047 * The SILC_CLIENLT_FILE_MONITOR_ERROR is called in case some error
2048 * occured. The SilcClientFileError will indicate more detailed error
2049 * condition. The silc_client_file_close must be called when this status
2050 * is received. The session is over when this is received.
2055 SILC_CLIENT_FILE_MONITOR_KEY_AGREEMENT, /* In key agreemenet phase */
2056 SILC_CLIENT_FILE_MONITOR_SEND, /* Sending file */
2057 SILC_CLIENT_FILE_MONITOR_RECEIVE, /* Receiving file */
2058 SILC_CLIENT_FILE_MONITOR_GET, /* Unsupported */
2059 SILC_CLIENT_FILE_MONITOR_PUT, /* Unsupported */
2060 SILC_CLIENT_FILE_MONITOR_CLOSED, /* Session closed */
2061 SILC_CLIENT_FILE_MONITOR_DISCONNECT, /* Session disconnected */
2062 SILC_CLIENT_FILE_MONITOR_ERROR, /* Error during session */
2063 } SilcClientMonitorStatus;
2066 /****d* silcclient/SilcClientAPI/SilcClientFileError
2070 * typedef enum { ... } SilcClientFileError;
2074 * File transmission error types. These types are returned by
2075 * some of the file transmission functions, and by the monitor
2076 * callback to indicate error.
2081 SILC_CLIENT_FILE_OK,
2082 SILC_CLIENT_FILE_ERROR, /* Generic error */
2083 SILC_CLIENT_FILE_UNKNOWN_SESSION, /* Unknown session ID */
2084 SILC_CLIENT_FILE_ALREADY_STARTED, /* Session already started */
2085 SILC_CLIENT_FILE_NO_SUCH_FILE, /* No such file */
2086 SILC_CLIENT_FILE_PERMISSION_DENIED, /* Permission denied */
2087 SILC_CLIENT_FILE_KEY_AGREEMENT_FAILED, /* Key exchange failed */
2088 SILC_CLIENT_FILE_CONNECT_FAILED, /* Error during connecting */
2089 SILC_CLIENT_FILE_TIMEOUT, /* Connecting timedout */
2090 SILC_CLIENT_FILE_NO_MEMORY, /* System out of memory */
2091 } SilcClientFileError;
2094 /****f* silcclient/SilcClientAPI/SilcClientFileMonitor
2098 * typedef void (*SilcClientFileMonitor)(SilcClient client,
2099 * SilcClientConnection conn,
2100 * SilcClientMonitorStatus status,
2101 * SilcClientFileError error,
2102 * SilcUInt64 offset,
2103 * SilcUInt64 filesize,
2104 * SilcClientEntry client_entry,
2105 * SilcUInt32 session_id,
2106 * const char *filepath,
2111 * Monitor callback that is called during the file transmission to
2112 * monitor the transmission process. The `status' indicates the current
2113 * monitoring process. The `error' will indicate the error type
2114 * if `status' is SILC_CLIENT_FILE_MONITOR_ERROR. The `offset' is the
2115 * currently transmitted amount of total `filesize'. The `client_entry'
2116 * indicates the remote client, and the transmission session ID is the
2117 * `session_id'. The filename being transmitted is indicated by the
2118 * `filepath'. The `conn' is NULL if the connection to remote client
2119 * does not exist yet.
2122 typedef void (*SilcClientFileMonitor)(SilcClient client,
2123 SilcClientConnection conn,
2124 SilcClientMonitorStatus status,
2125 SilcClientFileError error,
2127 SilcUInt64 filesize,
2128 SilcClientEntry client_entry,
2129 SilcUInt32 session_id,
2130 const char *filepath,
2133 /****f* silcclient/SilcClientAPI/SilcClientFileName
2137 * typedef void (*SilcClientFileName)(const char *filepath,
2142 * Completion callback for the SilcClientFileAskName callback function.
2143 * Application calls this to deliver the filepath and filename where
2144 * the downloaded file is to be saved.
2147 typedef void (*SilcClientFileName)(const char *filepath,
2150 /****f* silcclient/SilcClientAPI/SilcClientFileAskName
2154 * typedef void (*SilcClientFileAskName)(SilcClient client,
2155 * SilcClientConnection conn,
2156 * SilcUInt32 session_id,
2157 * const char *remote_filename,
2158 * SilcClientFileName completion,
2159 * void *completion_context,
2164 * File name asking callback that is called if it is given to the
2165 * silc_client_file_receive and the path given to that as argument was
2166 * NULL. The library calls this to ask the filename and filepath to
2167 * where the file is to be saved. The 'remote_filename' is the file
2168 * that is being downloaded. Application must call the 'completion'
2169 * with 'completion_context' to continue with the file downloading.
2170 * It is not mandatory to provide this to the silc_client_file_receive.
2173 typedef void (*SilcClientFileAskName)(SilcClient client,
2174 SilcClientConnection conn,
2175 SilcUInt32 session_id,
2176 const char *remote_filename,
2177 SilcClientFileName completion,
2178 void *completion_context,
2181 /****f* silcclient/SilcClientAPI/silc_client_file_send
2185 * SilcClientFileError
2186 * silc_client_file_send(SilcClient client,
2187 * SilcClientConnection conn,
2188 * SilcClientEntry client_entry,
2189 * SilcClientConnectionParams *params,
2190 * SilcPublicKey public_key,
2191 * SilcPrivateKey private_key,
2192 * SilcClientFileMonitor monitor,
2193 * void *monitor_context,
2194 * const char *filepath,
2195 * SilcUInt32 *session_id);
2199 * Sends a file indicated by the `filepath' to the remote client
2200 * indicated by the `client_entry'. This will negotiate a secret key
2201 * with the remote client before actually starting the transmission of
2202 * the file. The `monitor' callback will be called to monitor the
2203 * transmission of the file.
2205 * This returns a file session ID for the file transmission to the
2206 * `session_id' pointer. It can be used to close the session (and
2207 * abort the file transmission) by calling the silc_client_file_close
2208 * function. The session ID is also returned in the `monitor' callback.
2210 * If `params' is non-NULL and it has the `local_ip' and `local_port' set
2211 * the caller will provide the connection endpoint for the key agreement
2212 * connection. The `bind_ip' can be used to bind to that IP instead of
2213 * `local_ip'. Caller may also set the `repository', `verify_notfound'
2214 * and `timeout_secs' fields in `params'. Other fields are ignored.
2215 * If `params' is NULL, then the `client_entry' is expected to provide
2216 * the connection endpoint for us. It is recommended the `timeout_secs'
2217 * is specified in case the remote client does not reply anything to
2220 * The `public_key' and `private_key' is our identity in the key agreement.
2222 * If error will occur during the file transfer process the error status
2223 * will be returned in the monitor callback. In this case the application
2224 * must call silc_client_file_close to close the session.
2228 silc_client_file_send(SilcClient client,
2229 SilcClientConnection conn,
2230 SilcClientEntry client_entry,
2231 SilcClientConnectionParams *params,
2232 SilcPublicKey public_key,
2233 SilcPrivateKey private_key,
2234 SilcClientFileMonitor monitor,
2235 void *monitor_context,
2236 const char *filepath,
2237 SilcUInt32 *session_id);
2239 /****f* silcclient/SilcClientAPI/silc_client_file_receive
2243 * SilcClientFileError
2244 * silc_client_file_receive(SilcClient client,
2245 * SilcClientConnection conn,
2246 * SilcClientConnectionParams *params,
2247 * SilcPublicKey public_key,
2248 * SilcPrivateKey private_key,
2249 * SilcClientFileMonitor monitor,
2250 * void *monitor_context,
2252 * SilcUInt32 session_id,
2253 * SilcClientFileAskName ask_name,
2254 * void *ask_name_context);
2258 * Receives a file from a client indicated by the `client_entry'. The
2259 * `session_id' indicates the file transmission session and it has been
2260 * received in the `ftp' client operation callback. This will actually
2261 * perform the key agreement protocol with the remote client before
2262 * actually starting the file transmission. The `monitor' callback
2263 * will be called to monitor the transmission. If `path' is non-NULL
2264 * the file will be saved into that directory. If NULL the file is
2265 * saved in the current working directory, unless the 'ask_name'
2266 * callback is non-NULL. In this case the callback is called to ask
2267 * the path and filename from application.
2269 * The `params' is the connection related parameters. If the remote client
2270 * provided connection point the `params' will be used when creating
2271 * connection to the remote client. If remote client did not provide
2272 * connection point the `params' is used to provide connection point
2273 * locally for the remote client. See silc_client_file_send for more
2274 * information on providing connection point for remote client.
2276 * The `public_key' and `private_key' is our identity in the key agreement.
2278 * If error will occur during the file transfer process the error status
2279 * will be returned in the monitor callback. In this case the application
2280 * must call silc_client_file_close to close the session.
2284 silc_client_file_receive(SilcClient client,
2285 SilcClientConnection conn,
2286 SilcClientConnectionParams *params,
2287 SilcPublicKey public_key,
2288 SilcPrivateKey private_key,
2289 SilcClientFileMonitor monitor,
2290 void *monitor_context,
2292 SilcUInt32 session_id,
2293 SilcClientFileAskName ask_name,
2294 void *ask_name_context);
2296 /****f* silcclient/SilcClientAPI/silc_client_file_close
2300 * SilcClientFileError silc_client_file_close(SilcClient client,
2301 * SilcClientConnection conn,
2302 * SilcUInt32 session_id);
2306 * Closes file transmission session indicated by the `session_id'.
2307 * If file transmission is being conducted it will be aborted
2308 * automatically. This function is also used to close the session
2309 * after successful file transmission. This function can be used
2310 * also to reject incoming file transmission request. If the
2311 * session was already started and the monitor callback was set
2312 * the monitor callback will be called with the monitor status
2313 * SILC_CLIENT_FILE_MONITOR_CLOSED.
2316 SilcClientFileError silc_client_file_close(SilcClient client,
2317 SilcClientConnection conn,
2318 SilcUInt32 session_id);
2320 /****f* silcclient/SilcClientAPI/silc_client_attribute_add
2324 * SilcAttributePayload
2325 * silc_client_attribute_add(SilcClient client,
2326 * SilcClientConnection conn,
2327 * SilcAttribute attribute,
2329 * SilcUInt32 object_size);
2333 * Add new Requsted Attribute for WHOIS command to the client library.
2334 * The `attribute' object indicated by `object' is added and allocated
2335 * SilcAttributePayload is returned. The `object' must be of correct
2336 * type and of correct size. See the SilcAttribute for object types
2337 * for different attributes. You may also get all added attributes
2338 * from the client with silc_client_attributes_get function.
2340 * Requested Attributes are different personal information about the
2341 * user, status information and other information which other users
2342 * may query with WHOIS command. Application may set these so that
2343 * if someone sends WHOIS query these attributes will be replied back
2344 * to the sender. The library always puts the public key to the
2345 * Requested Attributes, but if application wishes to add additional
2346 * public keys (or certificates) it can be done with this interface.
2347 * Library also always computes digital signature of the attributes
2348 * automatically, so application does not need to do that.
2351 SilcAttributePayload silc_client_attribute_add(SilcClient client,
2352 SilcClientConnection conn,
2353 SilcAttribute attribute,
2355 SilcUInt32 object_size);
2357 /****f* silcclient/SilcClientAPI/silc_client_attribute_del
2361 * SilcBool silc_client_attribute_del(SilcClient client,
2362 * SilcClientConnection conn,
2363 * SilcAttribute attribute,
2364 * SilcAttributePayload attr);
2368 * Delete a Requested Attribute from the client. If the `attribute'
2369 * is non-zero then all attributes of that type are deleted and the
2370 * `attr' is ignored. If `attr' is non-NULL then that specific
2371 * attribute is deleted and `attribute' is ignored.
2373 * You may get all added attributes with the function
2374 * silc_client_attributes_get and to get the SilcAttributePayload.
2375 * This function Returns TRUE if the attribute was found and deleted.
2378 SilcBool silc_client_attribute_del(SilcClient client,
2379 SilcClientConnection conn,
2380 SilcAttribute attribute,
2381 SilcAttributePayload attr);
2383 /****f* silcclient/SilcClientAPI/silc_client_attributes_get
2387 * const SilcHashTable
2388 * silc_client_attributes_get(SilcClient client,
2389 * SilcClientConnection conn);
2393 * Returns pointer to the SilcHashTable which includes all the added
2394 * Requested Attributes. The caller must not free the hash table.
2395 * The caller may use SilcHashTableList and silc_hash_table_list to
2396 * traverse the table. Each entry in the hash table is one added
2397 * SilcAttributePayload. It is possible to delete a attribute
2398 * payload while traversing the table.
2401 SilcHashTable silc_client_attributes_get(SilcClient client,
2402 SilcClientConnection conn);
2404 /****f* silcclient/SilcClientAPI/silc_client_attributes_request
2408 * SilcBuffer silc_client_attributes_request(SilcAttribute attribute, ...);
2412 * Constructs a Requested Attributes buffer. If the `attribute' is zero (0)
2413 * then all attributes are requested. Alternatively, `attribute' and
2414 * all variable arguments can each be requested attribute. In this case
2415 * the last must be set to zero (0) to complete the variable list of
2416 * requested attributes. See SilcAttribute for all attributes.
2417 * You can give the returned buffer as argument to for example
2418 * silc_client_get_client_by_id_resolve function.
2422 * Request all attributes
2423 * buffer = silc_client_attributes_request(0);
2425 * Request only the following attributes
2426 * buffer = silc_client_attributes_request(SILC_ATTRIBUTE_USER_INFO,
2427 * SILC_ATTRIBUTE_SERVICE,
2428 * SILC_ATTRIBUTE_MOOD, 0);
2431 SilcBuffer silc_client_attributes_request(SilcAttribute attribute, ...);
2433 /****f* silcclient/SilcClientAPI/silc_client_nickname_format
2438 * silc_client_nickname_format(SilcClient client,
2439 * SilcClientConnection conn,
2440 * SilcClientEntry client_entry,
2441 * SilcBool priority);
2445 * Formats the nickname of `client_entry' according to the nickname
2446 * formatting rules set in SilcClientParams. If the `priority' is TRUE
2447 * then the `client_entry' will always get the unformatted nickname.
2448 * If FALSE and there are more than one same nicknames in the client
2449 * the nickname will be formatted.
2451 * This returns NULL on error. Otherwise, the client entry that was
2452 * formatted is returned. If `priority' is FALSE this always returns
2453 * the `client_entry'. If it is TRUE, this may return the client entry
2454 * that was formatted after giving the `client_entry' the unformatted
2457 * Usually application does not need to call this function, as the library
2458 * automatically formats nicknames. However, if application wants to
2459 * for example force the `client_entry' to always have the unformatted
2460 * nickname it may call this function to do so.
2463 SilcClientEntry silc_client_nickname_format(SilcClient client,
2464 SilcClientConnection conn,
2465 SilcClientEntry client_entry,
2468 /****f* silcclient/SilcClientAPI/silc_client_nickname_parse
2472 * SilcBool silc_client_nickname_parse(SilcClient client,
2473 * SilcClientConnection conn,
2479 * Parses the `nickname' according to the format string given in the
2480 * SilcClientParams. Returns the parsed nickname into the `ret_nick'.
2481 * The caller must free the returned pointer. Returns FALSE if error
2482 * occurred during parsing. Returns TRUE if the nickname was parsed,
2483 * it was not formatted or if the format string has not been specified
2484 * in SilcClientParams.
2487 SilcBool silc_client_nickname_parse(SilcClient client,
2488 SilcClientConnection conn,
2496 #endif /* SILCCLIENT_H */