5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2004 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.
21 #include "silcincludes.h"
22 #include "silcclient.h"
23 #include "client_internal.h"
25 /* Static task callback prototypes */
26 SILC_TASK_CALLBACK(silc_client_connect_to_server_start);
27 SILC_TASK_CALLBACK(silc_client_connect_to_server_second);
28 SILC_TASK_CALLBACK(silc_client_connect_to_server_final);
29 SILC_TASK_CALLBACK(silc_client_rekey_final);
31 static bool silc_client_packet_parse(SilcPacketParserContext *parser_context,
33 static void silc_client_packet_parse_type(SilcClient client,
34 SilcSocketConnection sock,
35 SilcPacketContext *packet);
36 void silc_client_resolve_auth_method(bool success,
37 SilcProtocolAuthMeth auth_meth,
38 const unsigned char *auth_data,
39 SilcUInt32 auth_data_len, void *context);
41 /* Allocates new client object. This has to be done before client may
42 work. After calling this one must call silc_client_init to initialize
43 the client. The `application' is application specific user data pointer
44 and caller must free it. */
46 SilcClient silc_client_alloc(SilcClientOperations *ops,
47 SilcClientParams *params,
49 const char *version_string)
51 SilcClient new_client;
53 new_client = silc_calloc(1, sizeof(*new_client));
54 new_client->application = application;
56 new_client->internal = silc_calloc(1, sizeof(*new_client->internal));
57 new_client->internal->ops = ops;
58 new_client->internal->params =
59 silc_calloc(1, sizeof(*new_client->internal->params));
61 version_string = silc_version_string;
62 new_client->internal->silc_client_version = strdup(version_string);
65 memcpy(new_client->internal->params, params, sizeof(*params));
67 if (!new_client->internal->params->task_max)
68 new_client->internal->params->task_max = 200;
70 if (!new_client->internal->params->rekey_secs)
71 new_client->internal->params->rekey_secs = 3600;
73 if (!new_client->internal->params->connauth_request_secs)
74 new_client->internal->params->connauth_request_secs = 2;
76 new_client->internal->params->
77 nickname_format[sizeof(new_client->internal->
78 params->nickname_format) - 1] = 0;
83 /* Frees client object and its internals. */
85 void silc_client_free(SilcClient client)
89 silc_rng_free(client->rng);
91 silc_cipher_unregister_all();
92 silc_pkcs_unregister_all();
93 silc_hash_unregister_all();
94 silc_hmac_unregister_all();
96 silc_hash_free(client->md5hash);
97 silc_hash_free(client->sha1hash);
98 silc_hmac_free(client->internal->md5hmac);
99 silc_hmac_free(client->internal->sha1hmac);
100 silc_cipher_free(client->internal->none_cipher);
101 silc_free(client->internal->params);
102 silc_free(client->internal->silc_client_version);
103 silc_free(client->internal);
108 /* Initializes the client. This makes all the necessary steps to make
109 the client ready to be run. One must call silc_client_run to run the
110 client. Returns FALSE if error occured, TRUE otherwise. */
112 bool silc_client_init(SilcClient client)
114 SILC_LOG_DEBUG(("Initializing client"));
117 assert(client->username);
118 assert(client->hostname);
119 assert(client->realname);
121 /* Initialize the crypto library. If application has done this already
122 this has no effect. Also, we will not be overriding something
123 application might have registered earlier. */
124 silc_cipher_register_default();
125 silc_pkcs_register_default();
126 silc_hash_register_default();
127 silc_hmac_register_default();
129 /* Initialize hash functions for client to use */
130 silc_hash_alloc("md5", &client->md5hash);
131 silc_hash_alloc("sha1", &client->sha1hash);
133 /* Initialize none cipher */
134 silc_cipher_alloc("none", &client->internal->none_cipher);
136 /* Initialize random number generator */
137 client->rng = silc_rng_alloc();
138 silc_rng_init(client->rng);
139 silc_rng_global_init(client->rng);
141 /* Register protocols */
142 silc_client_protocols_register();
144 /* Initialize the scheduler */
146 silc_schedule_init(client->internal->params->task_max ?
147 client->internal->params->task_max : 200, client);
148 if (!client->schedule)
151 /* Register commands */
152 silc_client_commands_register(client);
157 /* Stops the client. This is called to stop the client and thus to stop
160 void silc_client_stop(SilcClient client)
162 SILC_LOG_DEBUG(("Stopping client"));
164 silc_schedule_stop(client->schedule);
165 silc_schedule_uninit(client->schedule);
167 silc_client_protocols_unregister();
168 silc_client_commands_unregister(client);
170 SILC_LOG_DEBUG(("Client stopped"));
173 /* Runs the client. This starts the scheduler from the utility library.
174 When this functions returns the execution of the appliation is over. */
176 void silc_client_run(SilcClient client)
178 SILC_LOG_DEBUG(("Running client"));
181 assert(client->pkcs);
182 assert(client->public_key);
183 assert(client->private_key);
185 /* Start the scheduler, the heart of the SILC client. When this returns
186 the program will be terminated. */
187 silc_schedule(client->schedule);
190 /* Runs the client and returns immeadiately. This function is used when
191 the SILC Client object indicated by the `client' is run under some
192 other scheduler, or event loop or main loop. On GUI applications,
193 for example this may be desired to use to run the client under the
194 GUI application's main loop. Typically the GUI application would
195 register an idle task that calls this function multiple times in
196 a second to quickly process the SILC specific data. */
198 void silc_client_run_one(SilcClient client)
200 /* Run the scheduler once. */
201 silc_schedule_one(client->schedule, 0);
204 static void silc_client_entry_destructor(SilcIDCache cache,
205 SilcIDCacheEntry entry)
207 silc_free(entry->name);
210 /* Allocates and adds new connection to the client. This adds the allocated
211 connection to the connection table and returns a pointer to it. A client
212 can have multiple connections to multiple servers. Every connection must
213 be added to the client using this function. User data `context' may
214 be sent as argument. This function is normally used only if the
215 application performed the connecting outside the library. The library
216 however may use this internally. */
219 silc_client_add_connection(SilcClient client,
220 SilcClientConnectionParams *params,
221 char *hostname, int port, void *context)
223 SilcClientConnection conn;
226 SILC_LOG_DEBUG(("Adding new connection to %s:%d", hostname, port));
228 conn = silc_calloc(1, sizeof(*conn));
229 conn->internal = silc_calloc(1, sizeof(*conn->internal));
231 /* Initialize ID caches */
232 conn->client = client;
233 conn->remote_host = strdup(hostname);
234 conn->remote_port = port;
235 conn->context = context;
236 conn->internal->client_cache =
237 silc_idcache_alloc(0, SILC_ID_CLIENT, silc_client_entry_destructor);
238 conn->internal->channel_cache = silc_idcache_alloc(0, SILC_ID_CHANNEL, NULL);
239 conn->internal->server_cache = silc_idcache_alloc(0, SILC_ID_SERVER, NULL);
240 conn->internal->pending_commands = silc_dlist_init();
241 conn->internal->ftp_sessions = silc_dlist_init();
244 if (params->detach_data)
245 conn->internal->params.detach_data =
246 silc_memdup(params->detach_data,
247 params->detach_data_len);
248 conn->internal->params.detach_data_len = params->detach_data_len;
251 /* Add the connection to connections table */
252 for (i = 0; i < client->internal->conns_count; i++)
253 if (client->internal->conns && !client->internal->conns[i]) {
254 client->internal->conns[i] = conn;
258 client->internal->conns =
259 silc_realloc(client->internal->conns, sizeof(*client->internal->conns)
260 * (client->internal->conns_count + 1));
261 client->internal->conns[client->internal->conns_count] = conn;
262 client->internal->conns_count++;
267 /* Removes connection from client. Frees all memory. */
269 void silc_client_del_connection(SilcClient client, SilcClientConnection conn)
273 for (i = 0; i < client->internal->conns_count; i++)
274 if (client->internal->conns[i] == conn) {
275 /* Free all cache entries */
276 SilcIDCacheList list;
277 SilcIDCacheEntry entry;
278 SilcClientCommandPending *r;
281 if (silc_idcache_get_all(conn->internal->client_cache, &list)) {
282 ret = silc_idcache_list_first(list, &entry);
284 silc_client_del_client(client, conn, entry->context);
285 ret = silc_idcache_list_next(list, &entry);
287 silc_idcache_list_free(list);
290 if (silc_idcache_get_all(conn->internal->channel_cache, &list)) {
291 ret = silc_idcache_list_first(list, &entry);
293 silc_client_del_channel(client, conn, entry->context);
294 ret = silc_idcache_list_next(list, &entry);
296 silc_idcache_list_free(list);
299 if (silc_idcache_get_all(conn->internal->server_cache, &list)) {
300 ret = silc_idcache_list_first(list, &entry);
302 silc_client_del_server(client, conn, entry->context);
303 ret = silc_idcache_list_next(list, &entry);
305 silc_idcache_list_free(list);
308 /* Clear ID caches */
309 if (conn->internal->client_cache)
310 silc_idcache_free(conn->internal->client_cache);
311 if (conn->internal->channel_cache)
312 silc_idcache_free(conn->internal->channel_cache);
313 if (conn->internal->server_cache)
314 silc_idcache_free(conn->internal->server_cache);
316 /* Free data (my ID is freed in above silc_client_del_client).
317 conn->nickname is freed when freeing the local_entry->nickname. */
318 silc_free(conn->remote_host);
319 silc_free(conn->local_id_data);
320 if (conn->internal->send_key)
321 silc_cipher_free(conn->internal->send_key);
322 if (conn->internal->receive_key)
323 silc_cipher_free(conn->internal->receive_key);
324 if (conn->internal->hmac_send)
325 silc_hmac_free(conn->internal->hmac_send);
326 if (conn->internal->hmac_receive)
327 silc_hmac_free(conn->internal->hmac_receive);
328 silc_free(conn->internal->rekey);
330 if (conn->internal->active_session) {
332 conn->sock->user_data = NULL;
333 silc_client_ftp_session_free(conn->internal->active_session);
334 conn->internal->active_session = NULL;
337 silc_client_ftp_free_sessions(client, conn);
339 if (conn->internal->pending_commands) {
340 silc_dlist_start(conn->internal->pending_commands);
341 while ((r = silc_dlist_get(conn->internal->pending_commands))
343 silc_dlist_del(conn->internal->pending_commands, r);
344 silc_dlist_uninit(conn->internal->pending_commands);
347 silc_free(conn->internal);
348 memset(conn, 0, sizeof(*conn));
351 client->internal->conns[i] = NULL;
355 /* Adds listener socket to the listener sockets table. This function is
356 used to add socket objects that are listeners to the client. This should
357 not be used to add other connection objects. */
359 void silc_client_add_socket(SilcClient client, SilcSocketConnection sock)
363 if (!client->internal->sockets) {
364 client->internal->sockets =
365 silc_calloc(1, sizeof(*client->internal->sockets));
366 client->internal->sockets[0] = silc_socket_dup(sock);
367 client->internal->sockets_count = 1;
371 for (i = 0; i < client->internal->sockets_count; i++) {
372 if (client->internal->sockets[i] == NULL) {
373 client->internal->sockets[i] = silc_socket_dup(sock);
378 client->internal->sockets =
379 silc_realloc(client->internal->sockets,
380 sizeof(*client->internal->sockets) *
381 (client->internal->sockets_count + 1));
382 client->internal->sockets[client->internal->sockets_count] =
383 silc_socket_dup(sock);
384 client->internal->sockets_count++;
387 /* Deletes listener socket from the listener sockets table. */
389 void silc_client_del_socket(SilcClient client, SilcSocketConnection sock)
393 if (!client->internal->sockets)
396 for (i = 0; i < client->internal->sockets_count; i++) {
397 if (client->internal->sockets[i] == sock) {
398 silc_socket_free(sock);
399 client->internal->sockets[i] = NULL;
406 silc_client_connect_to_server_internal(SilcClientInternalConnectContext *ctx)
410 /* XXX In the future we should give up this non-blocking connect all
411 together and use threads instead. */
412 /* Create connection to server asynchronously */
413 sock = silc_net_create_connection_async(NULL, ctx->port, ctx->host);
417 /* Register task that will receive the async connect and will
419 ctx->task = silc_schedule_task_add(ctx->client->schedule, sock,
420 silc_client_connect_to_server_start,
423 SILC_TASK_PRI_NORMAL);
424 silc_schedule_set_listen_fd(ctx->client->schedule, sock, SILC_TASK_WRITE,
432 /* Connects to remote server. This is the main routine used to connect
433 to SILC server. Returns -1 on error and the created socket otherwise.
434 The `context' is user context that is saved into the SilcClientConnection
435 that is created after the connection is created. Note that application
436 may handle the connecting process outside the library. If this is the
437 case then this function is not used at all. When the connecting is
438 done the `connect' client operation is called. */
440 int silc_client_connect_to_server(SilcClient client,
441 SilcClientConnectionParams *params,
442 int port, char *host, void *context)
444 SilcClientInternalConnectContext *ctx;
445 SilcClientConnection conn;
448 SILC_LOG_DEBUG(("Connecting to port %d of server %s",
451 conn = silc_client_add_connection(client, params, host, port, context);
453 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_AUDIT,
454 "Connecting to port %d of server %s", port, host);
456 /* Allocate internal context for connection process. This is
457 needed as we are doing async connecting. */
458 ctx = silc_calloc(1, sizeof(*ctx));
459 ctx->client = client;
461 ctx->host = strdup(host);
462 ctx->port = port ? port : 706;
465 /* Do the actual connecting process */
466 sock = silc_client_connect_to_server_internal(ctx);
468 silc_client_del_connection(client, conn);
472 /* Socket hostname and IP lookup callback that is called before actually
473 starting the key exchange. The lookup is called from the function
474 silc_client_start_key_exchange. */
476 static void silc_client_start_key_exchange_cb(SilcSocketConnection sock,
479 SilcClientConnection conn = (SilcClientConnection)context;
480 SilcClient client = conn->client;
481 SilcProtocol protocol;
482 SilcClientKEInternalContext *proto_ctx;
484 SILC_LOG_DEBUG(("Start"));
486 if (conn->sock->hostname) {
487 silc_free(conn->remote_host);
488 conn->remote_host = strdup(conn->sock->hostname);
490 conn->sock->hostname = strdup(conn->remote_host);
493 conn->sock->ip = strdup(conn->sock->hostname);
494 conn->sock->port = conn->remote_port;
496 /* Allocate internal Key Exchange context. This is sent to the
497 protocol as context. */
498 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
499 proto_ctx->client = (void *)client;
500 proto_ctx->sock = silc_socket_dup(conn->sock);
501 proto_ctx->rng = client->rng;
502 proto_ctx->responder = FALSE;
503 proto_ctx->send_packet = silc_client_protocol_ke_send_packet;
504 proto_ctx->verify = silc_client_protocol_ke_verify_key;
506 /* Perform key exchange protocol. silc_client_connect_to_server_final
507 will be called after the protocol is finished. */
508 silc_protocol_alloc(SILC_PROTOCOL_CLIENT_KEY_EXCHANGE,
509 &protocol, (void *)proto_ctx,
510 silc_client_connect_to_server_second);
512 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
513 "Error: Could not start key exchange protocol");
514 silc_net_close_connection(conn->sock->sock);
515 client->internal->ops->connected(client, conn, SILC_CLIENT_CONN_ERROR);
518 conn->sock->protocol = protocol;
520 /* Register the connection for network input and output. This sets
521 that scheduler will listen for incoming packets for this connection
522 and sets that outgoing packets may be sent to this connection as well.
523 However, this doesn't set the scheduler for outgoing traffic, it will
524 be set separately by calling SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT,
525 later when outgoing data is available. */
526 context = (void *)client;
527 SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(conn->sock->sock);
529 /* Execute the protocol */
530 silc_protocol_execute(protocol, client->schedule, 0, 0);
533 /* Start SILC Key Exchange (SKE) protocol to negotiate shared secret
534 key material between client and server. This function can be called
535 directly if application is performing its own connecting and does not
536 use the connecting provided by this library. This function is normally
537 used only if the application performed the connecting outside the library.
538 The library however may use this internally. */
540 void silc_client_start_key_exchange(SilcClient client,
541 SilcClientConnection conn,
544 assert(client->pkcs);
545 assert(client->public_key);
546 assert(client->private_key);
548 /* Allocate new socket connection object */
549 silc_socket_alloc(fd, SILC_SOCKET_TYPE_SERVER, (void *)conn, &conn->sock);
551 /* Sometimes when doing quick reconnects the new socket may be same as
552 the old one and there might be pending stuff for the old socket.
553 If new one is same then those pending sutff might cause problems.
554 Make sure they do not do that. */
555 silc_schedule_task_del_by_fd(client->schedule, fd);
557 conn->nickname = (client->nickname ? strdup(client->nickname) :
558 strdup(client->username));
560 /* Resolve the remote hostname and IP address for our socket connection */
561 silc_socket_host_lookup(conn->sock, FALSE, silc_client_start_key_exchange_cb,
562 conn, client->schedule);
565 /* Callback called when error has occurred during connecting (KE) to
566 the server. The `connect' client operation will be called. */
568 SILC_TASK_CALLBACK(silc_client_connect_failure)
570 SilcClientKEInternalContext *ctx =
571 (SilcClientKEInternalContext *)context;
572 SilcClient client = (SilcClient)ctx->client;
574 client->internal->ops->connected(client, ctx->sock->user_data,
575 SILC_CLIENT_CONN_ERROR_KE);
577 silc_packet_context_free(ctx->packet);
581 /* Callback called when error has occurred during connecting (auth) to
582 the server. The `connect' client operation will be called. */
584 SILC_TASK_CALLBACK(silc_client_connect_failure_auth)
586 SilcClientConnAuthInternalContext *ctx =
587 (SilcClientConnAuthInternalContext *)context;
588 SilcClient client = (SilcClient)ctx->client;
590 client->internal->ops->connected(client, ctx->sock->user_data, ctx->status);
594 /* Start of the connection to the remote server. This is called after
595 succesful TCP/IP connection has been established to the remote host. */
597 SILC_TASK_CALLBACK(silc_client_connect_to_server_start)
599 SilcClientInternalConnectContext *ctx =
600 (SilcClientInternalConnectContext *)context;
601 SilcClient client = ctx->client;
602 SilcClientConnection conn = ctx->conn;
603 int opt, opt_len = sizeof(opt);
605 SILC_LOG_DEBUG(("Start"));
607 /* Check the socket status as it might be in error */
608 silc_net_get_socket_opt(fd, SOL_SOCKET, SO_ERROR, &opt, &opt_len);
610 if (ctx->tries < 2) {
611 /* Connection failed but lets try again */
612 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
613 "Could not connect to server %s: %s",
614 ctx->host, strerror(opt));
615 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_AUDIT,
616 "Connecting to port %d of server %s resumed",
617 ctx->port, ctx->host);
619 /* Unregister old connection try */
620 silc_schedule_unset_listen_fd(client->schedule, fd);
621 silc_net_close_connection(fd);
622 silc_schedule_task_del(client->schedule, ctx->task);
625 silc_client_connect_to_server_internal(ctx);
628 /* Connection failed and we won't try anymore */
629 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
630 "Could not connect to server %s: %s",
631 ctx->host, strerror(opt));
632 silc_schedule_unset_listen_fd(client->schedule, fd);
633 silc_net_close_connection(fd);
634 silc_schedule_task_del(client->schedule, ctx->task);
637 /* Notify application of failure */
638 client->internal->ops->connected(client, conn,
639 SILC_CLIENT_CONN_ERROR_TIMEOUT);
644 silc_schedule_unset_listen_fd(client->schedule, fd);
645 silc_schedule_task_del(client->schedule, ctx->task);
648 silc_client_start_key_exchange(client, conn, fd);
651 /* Second part of the connecting to the server. This executed
652 authentication protocol. */
654 SILC_TASK_CALLBACK(silc_client_connect_to_server_second)
656 SilcProtocol protocol = (SilcProtocol)context;
657 SilcClientKEInternalContext *ctx =
658 (SilcClientKEInternalContext *)protocol->context;
659 SilcClient client = (SilcClient)ctx->client;
660 SilcSocketConnection sock = NULL;
661 SilcClientConnAuthInternalContext *proto_ctx;
663 SILC_LOG_DEBUG(("Start"));
665 if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
666 protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
667 /* Error occured during protocol */
668 SILC_LOG_DEBUG(("Error during KE protocol"));
669 silc_protocol_free(protocol);
670 silc_ske_free_key_material(ctx->keymat);
672 silc_ske_free(ctx->ske);
674 silc_free(ctx->dest_id);
675 ctx->sock->protocol = NULL;
676 silc_socket_free(ctx->sock);
678 /* Notify application of failure */
679 silc_schedule_task_add(client->schedule, ctx->sock->sock,
680 silc_client_connect_failure, ctx,
681 0, 1, SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
685 /* We now have the key material as the result of the key exchange
686 protocol. Take the key material into use. Free the raw key material
687 as soon as we've set them into use. */
688 silc_client_protocol_ke_set_keys(ctx->ske, ctx->sock, ctx->keymat,
689 ctx->ske->prop->cipher,
690 ctx->ske->prop->pkcs,
691 ctx->ske->prop->hash,
692 ctx->ske->prop->hmac,
693 ctx->ske->prop->group,
695 silc_ske_free_key_material(ctx->keymat);
697 /* Allocate internal context for the authentication protocol. This
698 is sent as context for the protocol. */
699 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
700 proto_ctx->client = (void *)client;
701 proto_ctx->sock = sock = ctx->sock;
702 proto_ctx->ske = ctx->ske; /* Save SKE object from previous protocol */
703 proto_ctx->dest_id_type = ctx->dest_id_type;
704 proto_ctx->dest_id = ctx->dest_id;
706 /* Free old protocol as it is finished now */
707 silc_protocol_free(protocol);
709 silc_packet_context_free(ctx->packet);
712 sock->protocol = NULL;
714 /* Resolve the authentication method to be used in this connection. The
715 completion callback is called after the application has resolved
716 the authentication method. */
717 client->internal->ops->get_auth_method(client, sock->user_data,
720 silc_client_resolve_auth_method,
724 /* Authentication method resolving callback. Application calls this function
725 after we've called the client->internal->ops->get_auth_method
726 client operation to resolve the authentication method. We will continue
727 the executiong of the protocol in this function. */
729 void silc_client_resolve_auth_method(bool success,
730 SilcProtocolAuthMeth auth_meth,
731 const unsigned char *auth_data,
732 SilcUInt32 auth_data_len, void *context)
734 SilcClientConnAuthInternalContext *proto_ctx =
735 (SilcClientConnAuthInternalContext *)context;
736 SilcClient client = (SilcClient)proto_ctx->client;
739 auth_meth = SILC_AUTH_NONE;
741 proto_ctx->auth_meth = auth_meth;
743 if (success && auth_data && auth_data_len) {
745 /* Passphrase must be UTF-8 encoded, if it isn't encode it */
746 if (auth_meth == SILC_AUTH_PASSWORD &&
747 !silc_utf8_valid(auth_data, auth_data_len)) {
749 unsigned char *autf8 = NULL;
750 payload_len = silc_utf8_encoded_len(auth_data, auth_data_len,
752 autf8 = silc_calloc(payload_len, sizeof(*autf8));
753 auth_data_len = silc_utf8_encode(auth_data, auth_data_len,
754 SILC_STRING_ASCII, autf8, payload_len);
758 proto_ctx->auth_data = silc_memdup(auth_data, auth_data_len);
759 proto_ctx->auth_data_len = auth_data_len;
762 /* Allocate the authenteication protocol and execute it. */
763 silc_protocol_alloc(SILC_PROTOCOL_CLIENT_CONNECTION_AUTH,
764 &proto_ctx->sock->protocol, (void *)proto_ctx,
765 silc_client_connect_to_server_final);
767 /* Execute the protocol */
768 silc_protocol_execute(proto_ctx->sock->protocol, client->schedule, 0, 0);
771 /* Finalizes the connection to the remote SILC server. This is called
772 after authentication protocol has been completed. This send our
773 user information to the server to receive our client ID from
776 SILC_TASK_CALLBACK(silc_client_connect_to_server_final)
778 SilcProtocol protocol = (SilcProtocol)context;
779 SilcClientConnAuthInternalContext *ctx =
780 (SilcClientConnAuthInternalContext *)protocol->context;
781 SilcClient client = (SilcClient)ctx->client;
782 SilcClientConnection conn = (SilcClientConnection)ctx->sock->user_data;
785 SILC_LOG_DEBUG(("Start"));
787 if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
788 protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
789 /* Error occured during protocol */
790 SILC_LOG_DEBUG(("Error during authentication protocol"));
791 ctx->status = SILC_CLIENT_CONN_ERROR_AUTH;
795 if (conn->internal->params.detach_data) {
796 /* Send RESUME_CLIENT packet to the server, which is used to resume
797 old detached session back. */
799 SilcClientID *old_client_id;
800 unsigned char *old_id;
801 SilcUInt16 old_id_len;
803 if (!silc_client_process_detach_data(client, conn, &old_id, &old_id_len)) {
804 ctx->status = SILC_CLIENT_CONN_ERROR_RESUME;
808 old_client_id = silc_id_str2id(old_id, old_id_len, SILC_ID_CLIENT);
809 if (!old_client_id) {
811 ctx->status = SILC_CLIENT_CONN_ERROR_RESUME;
815 /* Generate authentication data that server will verify */
816 auth = silc_auth_public_key_auth_generate(client->public_key,
819 conn->internal->hash,
820 old_client_id, SILC_ID_CLIENT);
822 silc_free(old_client_id);
824 ctx->status = SILC_CLIENT_CONN_ERROR_RESUME;
828 packet = silc_buffer_alloc_size(2 + old_id_len + auth->len);
829 silc_buffer_format(packet,
830 SILC_STR_UI_SHORT(old_id_len),
831 SILC_STR_UI_XNSTRING(old_id, old_id_len),
832 SILC_STR_UI_XNSTRING(auth->data, auth->len),
835 /* Send the packet */
836 silc_client_packet_send(client, ctx->sock, SILC_PACKET_RESUME_CLIENT,
838 packet->data, packet->len, TRUE);
839 silc_buffer_free(packet);
840 silc_buffer_free(auth);
841 silc_free(old_client_id);
844 /* Send NEW_CLIENT packet to the server. We will become registered
845 to the SILC network after sending this packet and we will receive
846 client ID from the server. */
847 packet = silc_buffer_alloc(2 + 2 + strlen(client->username) +
848 strlen(client->realname));
849 silc_buffer_pull_tail(packet, SILC_BUFFER_END(packet));
850 silc_buffer_format(packet,
851 SILC_STR_UI_SHORT(strlen(client->username)),
852 SILC_STR_UI_XNSTRING(client->username,
853 strlen(client->username)),
854 SILC_STR_UI_SHORT(strlen(client->realname)),
855 SILC_STR_UI_XNSTRING(client->realname,
856 strlen(client->realname)),
859 /* Send the packet */
860 silc_client_packet_send(client, ctx->sock, SILC_PACKET_NEW_CLIENT,
862 packet->data, packet->len, TRUE);
863 silc_buffer_free(packet);
866 /* Save remote ID. */
867 conn->remote_id = ctx->dest_id;
868 conn->remote_id_data = silc_id_id2str(ctx->dest_id, SILC_ID_SERVER);
869 conn->remote_id_data_len = silc_id_get_len(ctx->dest_id, SILC_ID_SERVER);
871 /* Register re-key timeout */
872 conn->internal->rekey->timeout = client->internal->params->rekey_secs;
873 conn->internal->rekey->context = (void *)client;
874 silc_schedule_task_add(client->schedule, conn->sock->sock,
875 silc_client_rekey_callback,
876 (void *)conn->sock, conn->internal->rekey->timeout, 0,
877 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
879 silc_protocol_free(protocol);
880 silc_free(ctx->auth_data);
882 silc_ske_free(ctx->ske);
883 silc_socket_free(ctx->sock);
885 conn->sock->protocol = NULL;
889 silc_protocol_free(protocol);
890 silc_free(ctx->auth_data);
891 silc_free(ctx->dest_id);
893 silc_ske_free(ctx->ske);
894 conn->sock->protocol = NULL;
895 silc_socket_free(ctx->sock);
897 /* Notify application of failure */
898 silc_schedule_task_add(client->schedule, ctx->sock->sock,
899 silc_client_connect_failure_auth, ctx,
900 0, 1, SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
903 /* Internal routine that sends packet or marks packet to be sent. This
904 is used directly only in special cases. Normal cases should use
905 silc_server_packet_send. Returns < 0 on error. */
907 int silc_client_packet_send_real(SilcClient client,
908 SilcSocketConnection sock,
913 /* If rekey protocol is active we must assure that all packets are
914 sent through packet queue. */
915 if (SILC_CLIENT_IS_REKEY(sock))
918 /* If outbound data is already pending do not force send */
919 if (SILC_IS_OUTBUF_PENDING(sock))
922 /* Send the packet */
923 ret = silc_packet_send(sock, force_send);
927 /* Mark that there is some outgoing data available for this connection.
928 This call sets the connection both for input and output (the input
929 is set always and this call keeps the input setting, actually).
930 Actual data sending is performed by silc_client_packet_process. */
931 SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(client->schedule, sock->sock);
933 /* Mark to socket that data is pending in outgoing buffer. This flag
934 is needed if new data is added to the buffer before the earlier
935 put data is sent to the network. */
936 SILC_SET_OUTBUF_PENDING(sock);
941 /* Packet processing callback. This is used to send and receive packets
942 from network. This is generic task. */
944 SILC_TASK_CALLBACK_GLOBAL(silc_client_packet_process)
946 SilcClient client = (SilcClient)context;
947 SilcSocketConnection sock = NULL;
948 SilcClientConnection conn;
951 SILC_LOG_DEBUG(("Processing packet"));
953 SILC_CLIENT_GET_SOCK(client, fd, sock);
957 conn = (SilcClientConnection)sock->user_data;
960 if (type == SILC_TASK_WRITE) {
961 /* Do not send data to disconnected connection */
962 if (SILC_IS_DISCONNECTED(sock))
965 ret = silc_packet_send(sock, TRUE);
967 /* If returned -2 could not write to connection now, will do
976 /* The packet has been sent and now it is time to set the connection
977 back to only for input. When there is again some outgoing data
978 available for this connection it will be set for output as well.
979 This call clears the output setting and sets it only for input. */
980 SILC_CLIENT_SET_CONNECTION_FOR_INPUT(client->schedule, fd);
981 SILC_UNSET_OUTBUF_PENDING(sock);
983 silc_buffer_clear(sock->outbuf);
987 /* Packet receiving */
988 if (type == SILC_TASK_READ) {
989 /* Read data from network */
990 ret = silc_packet_receive(sock);
996 SILC_LOG_DEBUG(("Read EOF"));
998 /* If connection is disconnecting already we will finally
999 close the connection */
1000 if (SILC_IS_DISCONNECTING(sock)) {
1001 if (sock == conn->sock && sock->type != SILC_SOCKET_TYPE_CLIENT)
1002 client->internal->ops->disconnected(client, conn, 0, NULL);
1003 silc_client_close_connection_real(client, sock, conn);
1007 SILC_LOG_DEBUG(("EOF from connection %d", sock->sock));
1008 if (sock == conn->sock && sock->type != SILC_SOCKET_TYPE_CLIENT)
1009 client->internal->ops->disconnected(client, conn, 0, NULL);
1010 silc_client_close_connection_real(client, sock, conn);
1014 /* Process the packet. This will call the parser that will then
1015 decrypt and parse the packet. */
1016 if (sock->type != SILC_SOCKET_TYPE_UNKNOWN)
1017 silc_packet_receive_process(sock, FALSE, conn->internal->receive_key,
1018 conn->internal->hmac_receive,
1019 conn->internal->psn_receive,
1020 silc_client_packet_parse, client);
1022 silc_packet_receive_process(sock, FALSE, NULL, NULL, 0,
1023 silc_client_packet_parse, client);
1027 /* Parser callback called by silc_packet_receive_process. Thie merely
1028 registers timeout that will handle the actual parsing when appropriate. */
1030 static bool silc_client_packet_parse(SilcPacketParserContext *parser_context,
1033 SilcClient client = (SilcClient)context;
1034 SilcSocketConnection sock = parser_context->sock;
1035 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1036 SilcPacketContext *packet = parser_context->packet;
1039 if (conn && conn->internal->hmac_receive && conn->sock == sock)
1040 conn->internal->psn_receive = parser_context->packet->sequence + 1;
1042 /* Parse the packet immediately */
1043 if (parser_context->normal)
1044 ret = silc_packet_parse(packet, conn->internal->receive_key);
1046 ret = silc_packet_parse_special(packet, conn->internal->receive_key);
1048 if (ret == SILC_PACKET_NONE) {
1049 silc_packet_context_free(packet);
1050 silc_free(parser_context);
1054 /* If protocol for this connection is key exchange or rekey then we'll
1055 process all packets synchronously, since there might be packets in
1056 queue that we are not able to decrypt without first processing the
1057 packets before them. */
1058 if (sock->protocol && sock->protocol->protocol &&
1059 (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1060 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)) {
1062 /* Parse the incoming packet type */
1063 silc_client_packet_parse_type(client, sock, packet);
1065 /* Reprocess the buffer since we'll return FALSE. This is because
1066 the `conn->internal->receive_key' might have become valid by processing
1067 the previous packet */
1068 if (sock->type != SILC_SOCKET_TYPE_UNKNOWN)
1069 silc_packet_receive_process(sock, FALSE, conn->internal->receive_key,
1070 conn->internal->hmac_receive,
1071 conn->internal->psn_receive,
1072 silc_client_packet_parse, client);
1074 silc_packet_receive_process(sock, FALSE, NULL, NULL, 0,
1075 silc_client_packet_parse, client);
1077 silc_packet_context_free(packet);
1078 silc_free(parser_context);
1083 /* Parse the incoming packet type */
1084 silc_client_packet_parse_type(client, sock, packet);
1085 silc_packet_context_free(packet);
1086 silc_free(parser_context);
1090 /* Parses the packet type and calls what ever routines the packet type
1091 requires. This is done for all incoming packets. */
1093 void silc_client_packet_parse_type(SilcClient client,
1094 SilcSocketConnection sock,
1095 SilcPacketContext *packet)
1097 SilcBuffer buffer = packet->buffer;
1098 SilcPacketType type = packet->type;
1100 SILC_LOG_DEBUG(("Parsing %s packet", silc_get_packet_name(type)));
1102 /* Parse the packet type */
1105 case SILC_PACKET_DISCONNECT:
1106 silc_client_disconnected_by_server(client, sock, buffer);
1109 case SILC_PACKET_SUCCESS:
1111 * Success received for something. For now we can have only
1112 * one protocol for connection executing at once hence this
1113 * success message is for whatever protocol is executing currently.
1116 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1119 case SILC_PACKET_FAILURE:
1121 * Failure received for some protocol. Set the protocol state to
1122 * error and call the protocol callback. This fill cause error on
1123 * protocol and it will call the final callback.
1125 silc_client_process_failure(client, sock, packet);
1128 case SILC_PACKET_REJECT:
1131 case SILC_PACKET_NOTIFY:
1133 * Received notify message
1135 silc_client_notify_by_server(client, sock, packet);
1138 case SILC_PACKET_ERROR:
1140 * Received error message
1142 silc_client_error_by_server(client, sock, buffer);
1145 case SILC_PACKET_CHANNEL_MESSAGE:
1147 * Received message to (from, actually) a channel
1149 silc_client_channel_message(client, sock, packet);
1152 case SILC_PACKET_CHANNEL_KEY:
1154 * Received key for a channel. By receiving this key the client will be
1155 * able to talk to the channel it has just joined. This can also be
1156 * a new key for existing channel as keys expire peridiocally.
1158 silc_client_receive_channel_key(client, sock, buffer);
1161 case SILC_PACKET_PRIVATE_MESSAGE:
1163 * Received private message
1165 silc_client_private_message(client, sock, packet);
1168 case SILC_PACKET_PRIVATE_MESSAGE_KEY:
1170 * Received private message key
1174 case SILC_PACKET_COMMAND:
1176 * Received command packet, a special case since normally client
1177 * does not receive commands.
1179 silc_client_command_process(client, sock, packet);
1182 case SILC_PACKET_COMMAND_REPLY:
1184 * Recived reply for a command
1186 silc_client_command_reply_process(client, sock, packet);
1189 case SILC_PACKET_KEY_EXCHANGE:
1190 if (sock->protocol && sock->protocol->protocol &&
1191 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE) {
1192 SilcClientKEInternalContext *proto_ctx =
1193 (SilcClientKEInternalContext *)sock->protocol->context;
1195 proto_ctx->packet = silc_packet_context_dup(packet);
1196 proto_ctx->dest_id_type = packet->src_id_type;
1197 proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
1198 packet->src_id_type);
1199 if (!proto_ctx->dest_id)
1202 /* Let the protocol handle the packet */
1203 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1205 SILC_LOG_ERROR(("Received Key Exchange packet but no key exchange "
1206 "protocol active, packet dropped."));
1210 case SILC_PACKET_KEY_EXCHANGE_1:
1211 if (sock->protocol && sock->protocol->protocol &&
1212 (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1213 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)) {
1215 if (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1216 SilcClientRekeyInternalContext *proto_ctx =
1217 (SilcClientRekeyInternalContext *)sock->protocol->context;
1219 if (proto_ctx->packet)
1220 silc_packet_context_free(proto_ctx->packet);
1222 proto_ctx->packet = silc_packet_context_dup(packet);
1224 /* Let the protocol handle the packet */
1225 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1227 SilcClientKEInternalContext *proto_ctx =
1228 (SilcClientKEInternalContext *)sock->protocol->context;
1230 if (proto_ctx->packet)
1231 silc_packet_context_free(proto_ctx->packet);
1233 proto_ctx->packet = silc_packet_context_dup(packet);
1234 proto_ctx->dest_id_type = packet->src_id_type;
1235 proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
1236 packet->src_id_type);
1237 if (!proto_ctx->dest_id)
1240 /* Let the protocol handle the packet */
1241 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1244 SILC_LOG_ERROR(("Received Key Exchange 1 packet but no key exchange "
1245 "protocol active, packet dropped."));
1249 case SILC_PACKET_KEY_EXCHANGE_2:
1250 if (sock->protocol && sock->protocol->protocol &&
1251 (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1252 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)) {
1254 if (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1255 SilcClientRekeyInternalContext *proto_ctx =
1256 (SilcClientRekeyInternalContext *)sock->protocol->context;
1258 if (proto_ctx->packet)
1259 silc_packet_context_free(proto_ctx->packet);
1261 proto_ctx->packet = silc_packet_context_dup(packet);
1263 /* Let the protocol handle the packet */
1264 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1266 SilcClientKEInternalContext *proto_ctx =
1267 (SilcClientKEInternalContext *)sock->protocol->context;
1269 if (proto_ctx->packet)
1270 silc_packet_context_free(proto_ctx->packet);
1271 if (proto_ctx->dest_id)
1272 silc_free(proto_ctx->dest_id);
1273 proto_ctx->packet = silc_packet_context_dup(packet);
1274 proto_ctx->dest_id_type = packet->src_id_type;
1275 proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
1276 packet->src_id_type);
1277 if (!proto_ctx->dest_id)
1280 /* Let the protocol handle the packet */
1281 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1284 SILC_LOG_ERROR(("Received Key Exchange 2 packet but no key exchange "
1285 "protocol active, packet dropped."));
1289 case SILC_PACKET_NEW_ID:
1292 * Received new ID from server. This packet is received at
1293 * the connection to the server. New ID is also received when
1294 * user changes nickname but in that case the new ID is received
1295 * as command reply and not as this packet type.
1299 idp = silc_id_payload_parse(buffer->data, buffer->len);
1302 if (silc_id_payload_get_type(idp) != SILC_ID_CLIENT)
1305 silc_client_receive_new_id(client, sock, idp);
1306 silc_id_payload_free(idp);
1310 case SILC_PACKET_HEARTBEAT:
1312 * Received heartbeat packet
1314 SILC_LOG_DEBUG(("Heartbeat packet"));
1317 case SILC_PACKET_KEY_AGREEMENT:
1319 * Received key agreement packet
1321 SILC_LOG_DEBUG(("Key agreement packet"));
1322 silc_client_key_agreement(client, sock, packet);
1325 case SILC_PACKET_REKEY:
1326 SILC_LOG_DEBUG(("Re-key packet"));
1327 /* We ignore this for now */
1330 case SILC_PACKET_REKEY_DONE:
1331 SILC_LOG_DEBUG(("Re-key done packet"));
1333 if (sock->protocol && sock->protocol->protocol &&
1334 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1336 SilcClientRekeyInternalContext *proto_ctx =
1337 (SilcClientRekeyInternalContext *)sock->protocol->context;
1339 if (proto_ctx->packet)
1340 silc_packet_context_free(proto_ctx->packet);
1342 proto_ctx->packet = silc_packet_context_dup(packet);
1344 /* Let the protocol handle the packet */
1345 if (proto_ctx->responder == FALSE)
1346 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1348 /* Let the protocol handle the packet */
1349 silc_protocol_execute(sock->protocol, client->schedule,
1352 SILC_LOG_ERROR(("Received Re-key done packet but no re-key "
1353 "protocol active, packet dropped."));
1357 case SILC_PACKET_CONNECTION_AUTH_REQUEST:
1359 * Reveived reply to our connection authentication method request
1360 * packet. This is used to resolve the authentication method for the
1361 * current session from the server if the client does not know it.
1363 silc_client_connection_auth_request(client, sock, packet);
1366 case SILC_PACKET_FTP:
1367 /* Received file transfer packet. */
1368 silc_client_ftp(client, sock, packet);
1372 SILC_LOG_DEBUG(("Incorrect packet type %d, packet dropped", type));
1377 /* Sends packet. This doesn't actually send the packet instead it assembles
1378 it and marks it to be sent. However, if force_send is TRUE the packet
1379 is sent immediately. if dst_id, cipher and hmac are NULL those parameters
1380 will be derived from sock argument. Otherwise the valid arguments sent
1383 void silc_client_packet_send(SilcClient client,
1384 SilcSocketConnection sock,
1385 SilcPacketType type,
1387 SilcIdType dst_id_type,
1390 unsigned char *data,
1391 SilcUInt32 data_len,
1394 SilcPacketContext packetdata;
1395 const SilcBufferStruct packet;
1397 SilcUInt32 sequence = 0;
1402 SILC_LOG_DEBUG(("Sending packet, type %d", type));
1404 /* Get data used in the packet sending, keys and stuff */
1405 if ((!cipher || !hmac || !dst_id) && sock->user_data) {
1406 if (!cipher && ((SilcClientConnection)sock->user_data)->internal->send_key)
1407 cipher = ((SilcClientConnection)sock->user_data)->internal->send_key;
1409 if (!hmac && ((SilcClientConnection)sock->user_data)->internal->hmac_send)
1410 hmac = ((SilcClientConnection)sock->user_data)->internal->hmac_send;
1412 if (!dst_id && ((SilcClientConnection)sock->user_data)->remote_id) {
1413 dst_id = ((SilcClientConnection)sock->user_data)->remote_id;
1414 dst_id_type = SILC_ID_SERVER;
1418 sequence = ((SilcClientConnection)sock->user_data)->internal->psn_send++;
1420 /* Check for mandatory rekey */
1421 if (sequence == SILC_CLIENT_REKEY_THRESHOLD)
1422 silc_schedule_task_add(client->schedule, sock->sock,
1423 silc_client_rekey_callback, sock, 0, 1,
1424 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
1427 block_len = cipher ? silc_cipher_get_block_len(cipher) : 0;
1429 /* Set the packet context pointers */
1430 packetdata.flags = 0;
1431 packetdata.type = type;
1432 if (sock->user_data &&
1433 ((SilcClientConnection)sock->user_data)->local_id_data) {
1434 packetdata.src_id = ((SilcClientConnection)sock->user_data)->local_id_data;
1435 packetdata.src_id_len =
1436 silc_id_get_len(((SilcClientConnection)sock->user_data)->local_id,
1439 packetdata.src_id = silc_calloc(SILC_ID_CLIENT_LEN, sizeof(unsigned char));
1440 packetdata.src_id_len = SILC_ID_CLIENT_LEN;
1442 packetdata.src_id_type = SILC_ID_CLIENT;
1444 packetdata.dst_id = silc_id_id2str(dst_id, dst_id_type);
1445 packetdata.dst_id_len = silc_id_get_len(dst_id, dst_id_type);
1446 packetdata.dst_id_type = dst_id_type;
1448 packetdata.dst_id = NULL;
1449 packetdata.dst_id_len = 0;
1450 packetdata.dst_id_type = SILC_ID_NONE;
1452 data_len = SILC_PACKET_DATALEN(data_len, (SILC_PACKET_HEADER_LEN +
1453 packetdata.src_id_len +
1454 packetdata.dst_id_len));
1455 packetdata.truelen = data_len + SILC_PACKET_HEADER_LEN +
1456 packetdata.src_id_len + packetdata.dst_id_len;
1457 if (type == SILC_PACKET_CONNECTION_AUTH)
1458 SILC_PACKET_PADLEN_MAX(packetdata.truelen, block_len, packetdata.padlen);
1460 SILC_PACKET_PADLEN(packetdata.truelen, block_len, packetdata.padlen);
1462 /* Create the outgoing packet */
1463 if (!silc_packet_assemble(&packetdata, client->rng, cipher, hmac, sock,
1464 data, data_len, (const SilcBuffer)&packet)) {
1465 SILC_LOG_ERROR(("Error assembling packet"));
1469 /* Encrypt the packet */
1471 silc_packet_encrypt(cipher, hmac, sequence, (SilcBuffer)&packet,
1474 SILC_LOG_HEXDUMP(("Packet (%d), len %d", sequence, packet.len),
1475 packet.data, packet.len);
1477 /* Now actually send the packet */
1478 silc_client_packet_send_real(client, sock, force_send);
1481 /* Packet sending routine for application. This is the only routine that
1482 is provided for application to send SILC packets. */
1484 bool silc_client_send_packet(SilcClient client,
1485 SilcClientConnection conn,
1486 SilcPacketType type,
1487 const unsigned char *data,
1488 SilcUInt32 data_len)
1495 silc_client_packet_send(client, conn->sock, type, NULL, 0, NULL, NULL,
1496 (unsigned char *)data, data_len, TRUE);
1500 void silc_client_packet_queue_purge(SilcClient client,
1501 SilcSocketConnection sock)
1503 if (sock && SILC_IS_OUTBUF_PENDING(sock) &&
1504 !(SILC_IS_DISCONNECTED(sock))) {
1507 ret = silc_packet_send(sock, TRUE);
1509 if (sock->outbuf && sock->outbuf->len > 0) {
1510 /* Couldn't send all data, put the queue back up, we'll send
1512 SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(client->schedule, sock->sock);
1513 SILC_SET_OUTBUF_PENDING(sock);
1518 /* Purged all data */
1519 SILC_UNSET_OUTBUF_PENDING(sock);
1520 SILC_CLIENT_SET_CONNECTION_FOR_INPUT(client->schedule, sock->sock);
1521 silc_buffer_clear(sock->outbuf);
1525 /* Closes connection to remote end. Free's all allocated data except
1526 for some information such as nickname etc. that are valid at all time.
1527 If the `sock' is NULL then the conn->sock will be used. If `sock' is
1528 provided it will be checked whether the sock and `conn->sock' are the
1529 same (they can be different, ie. a socket can use `conn' as its
1530 connection but `conn->sock' might be actually a different connection
1531 than the `sock'). */
1533 void silc_client_close_connection_real(SilcClient client,
1534 SilcSocketConnection sock,
1535 SilcClientConnection conn)
1539 SILC_LOG_DEBUG(("Start"));
1544 if (!sock || (sock && conn->sock == sock))
1551 silc_client_del_connection(client, conn);
1555 /* We won't listen for this connection anymore */
1556 silc_schedule_unset_listen_fd(client->schedule, sock->sock);
1558 /* Unregister all tasks */
1559 silc_schedule_task_del_by_fd(client->schedule, sock->sock);
1561 /* Close the actual connection */
1562 silc_net_close_connection(sock->sock);
1564 /* Cancel any active protocol */
1565 if (sock->protocol) {
1566 if (sock->protocol->protocol->type ==
1567 SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1568 sock->protocol->protocol->type ==
1569 SILC_PROTOCOL_CLIENT_CONNECTION_AUTH) {
1570 sock->protocol->state = SILC_PROTOCOL_STATE_ERROR;
1571 silc_protocol_execute_final(sock->protocol, client->schedule);
1572 /* The application will recall this function with these protocols
1573 (the ops->connected client operation). */
1576 sock->protocol->state = SILC_PROTOCOL_STATE_ERROR;
1577 silc_protocol_execute_final(sock->protocol, client->schedule);
1578 sock->protocol = NULL;
1582 /* Free everything */
1583 if (del && sock->user_data)
1584 silc_client_del_connection(client, conn);
1586 silc_socket_free(sock);
1589 /* Closes the connection to the remote end */
1591 void silc_client_close_connection(SilcClient client,
1592 SilcClientConnection conn)
1594 silc_client_close_connection_real(client, NULL, conn);
1597 /* Called when we receive disconnection packet from server. This
1598 closes our end properly and displays the reason of the disconnection
1601 SILC_TASK_CALLBACK(silc_client_disconnected_by_server_later)
1603 SilcClient client = (SilcClient)context;
1604 SilcSocketConnection sock;
1606 SILC_CLIENT_GET_SOCK(client, fd, sock);
1610 silc_client_close_connection_real(client, sock, sock->user_data);
1613 /* Called when we receive disconnection packet from server. This
1614 closes our end properly and displays the reason of the disconnection
1617 void silc_client_disconnected_by_server(SilcClient client,
1618 SilcSocketConnection sock,
1621 SilcClientConnection conn;
1623 char *message = NULL;
1625 SILC_LOG_DEBUG(("Server disconnected us, sock %d", sock->sock));
1627 if (packet->len < 1)
1630 status = (SilcStatus)packet->data[0];
1632 if (packet->len > 1 &&
1633 silc_utf8_valid(packet->data + 1, packet->len - 1))
1634 message = silc_memdup(packet->data + 1, packet->len - 1);
1636 conn = (SilcClientConnection)sock->user_data;
1637 if (sock == conn->sock && sock->type != SILC_SOCKET_TYPE_CLIENT)
1638 client->internal->ops->disconnected(client, conn, status, message);
1642 SILC_SET_DISCONNECTED(sock);
1644 /* Close connection through scheduler. */
1645 silc_schedule_task_add(client->schedule, sock->sock,
1646 silc_client_disconnected_by_server_later,
1647 client, 0, 1, SILC_TASK_TIMEOUT,
1648 SILC_TASK_PRI_NORMAL);
1651 /* Received error message from server. Display it on the screen.
1652 We don't take any action what so ever of the error message. */
1654 void silc_client_error_by_server(SilcClient client,
1655 SilcSocketConnection sock,
1660 msg = silc_memdup(message->data, message->len);
1661 client->internal->ops->say(client, sock->user_data,
1662 SILC_CLIENT_MESSAGE_AUDIT, msg);
1666 /* Auto-nicking callback to send NICK command to server. */
1668 SILC_TASK_CALLBACK(silc_client_send_auto_nick)
1670 SilcClientConnection conn = (SilcClientConnection)context;
1671 SilcClient client = conn->client;
1673 silc_client_command_send(client, conn, SILC_COMMAND_NICK,
1674 ++conn->cmd_ident, 1, 1,
1675 client->nickname, strlen(client->nickname));
1678 /* Client session resuming callback. If the session was resumed
1679 this callback is called after the resuming is completed. This
1680 will call the `connect' client operation to the application
1681 since it has not been called yet. */
1683 static void silc_client_resume_session_cb(SilcClient client,
1684 SilcClientConnection conn,
1690 /* Notify application that connection is created to server */
1691 client->internal->ops->connected(client, conn, success ?
1692 SILC_CLIENT_CONN_SUCCESS_RESUME :
1693 SILC_CLIENT_CONN_ERROR_RESUME);
1696 /* Issue INFO command to fetch the real server name and server
1697 information and other stuff. */
1698 silc_client_command_register(client, SILC_COMMAND_INFO, NULL, NULL,
1699 silc_client_command_reply_info_i, 0,
1701 sidp = silc_id_payload_encode(conn->remote_id, SILC_ID_SERVER);
1702 silc_client_command_send(client, conn, SILC_COMMAND_INFO,
1703 conn->cmd_ident, 1, 2, sidp->data, sidp->len);
1704 silc_buffer_free(sidp);
1708 /* Processes the received new Client ID from server. Old Client ID is
1709 deleted from cache and new one is added. */
1711 void silc_client_receive_new_id(SilcClient client,
1712 SilcSocketConnection sock,
1715 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1716 int connecting = FALSE;
1717 SilcClientID *client_id = silc_id_payload_get_id(idp);
1719 if (!conn->local_entry)
1722 /* Delete old ID from ID cache */
1723 if (conn->local_id) {
1724 /* Check whether they are different */
1725 if (SILC_ID_CLIENT_COMPARE(conn->local_id, client_id)) {
1726 silc_free(client_id);
1730 silc_idcache_del_by_context(conn->internal->client_cache,
1732 silc_free(conn->local_id);
1735 /* Save the new ID */
1737 if (conn->local_id_data)
1738 silc_free(conn->local_id_data);
1740 conn->local_id = client_id;
1741 conn->local_id_data = silc_id_payload_get_data(idp);
1742 conn->local_id_data_len = silc_id_payload_get_len(idp);;
1744 if (!conn->local_entry)
1745 conn->local_entry = silc_calloc(1, sizeof(*conn->local_entry));
1747 conn->local_entry->nickname = conn->nickname;
1748 if (!conn->local_entry->username)
1749 conn->local_entry->username = strdup(client->username);
1750 if (!conn->local_entry->server)
1751 conn->local_entry->server = strdup(conn->remote_host);
1752 conn->local_entry->id = conn->local_id;
1753 conn->local_entry->valid = TRUE;
1754 if (!conn->local_entry->channels)
1755 conn->local_entry->channels = silc_hash_table_alloc(1, silc_hash_ptr,
1760 /* Put it to the ID cache */
1761 silc_idcache_add(conn->internal->client_cache,
1762 strdup(conn->nickname), conn->local_id,
1763 (void *)conn->local_entry, 0, NULL);
1768 /* Issue IDENTIFY command for itself to get resolved hostname
1769 correctly from server. */
1770 silc_client_command_register(client, SILC_COMMAND_IDENTIFY, NULL, NULL,
1771 silc_client_command_reply_identify_i, 0,
1773 sidp = silc_id_payload_encode(conn->local_entry->id, SILC_ID_CLIENT);
1774 silc_client_command_send(client, conn, SILC_COMMAND_IDENTIFY,
1775 conn->cmd_ident, 1, 5, sidp->data, sidp->len);
1776 silc_buffer_free(sidp);
1778 if (!conn->internal->params.detach_data) {
1779 /* Send NICK command if the nickname was set by the application (and is
1780 not same as the username). Send this with little timeout. */
1781 if (client->nickname && strcmp(client->nickname, client->username))
1782 silc_schedule_task_add(client->schedule, 0,
1783 silc_client_send_auto_nick, conn,
1784 1, 0, SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
1786 /* Notify application of successful connection. We do it here now that
1787 we've received the Client ID and are allowed to send traffic. */
1788 client->internal->ops->connected(client, conn, SILC_CLIENT_CONN_SUCCESS);
1790 /* Issue INFO command to fetch the real server name and server
1791 information and other stuff. */
1792 silc_client_command_register(client, SILC_COMMAND_INFO, NULL, NULL,
1793 silc_client_command_reply_info_i, 0,
1795 sidp = silc_id_payload_encode(conn->remote_id, SILC_ID_SERVER);
1796 silc_client_command_send(client, conn, SILC_COMMAND_INFO,
1797 conn->cmd_ident, 1, 2, sidp->data, sidp->len);
1798 silc_buffer_free(sidp);
1800 /* We are resuming session. Start resolving informations from the
1801 server we need to set the client libary in the state before
1802 detaching the session. The connect client operation is called
1803 after this is successfully completed */
1804 silc_client_resume_session(client, conn, silc_client_resume_session_cb,
1810 /* Removes a client entry from all channels it has joined. */
1812 void silc_client_remove_from_channels(SilcClient client,
1813 SilcClientConnection conn,
1814 SilcClientEntry client_entry)
1816 SilcHashTableList htl;
1817 SilcChannelUser chu;
1819 silc_hash_table_list(client_entry->channels, &htl);
1820 while (silc_hash_table_get(&htl, NULL, (void *)&chu)) {
1821 silc_hash_table_del(chu->client->channels, chu->channel);
1822 silc_hash_table_del(chu->channel->user_list, chu->client);
1826 silc_hash_table_list_reset(&htl);
1829 /* Replaces `old' client entries from all channels to `new' client entry.
1830 This can be called for example when nickname changes and old ID entry
1831 is replaced from ID cache with the new one. If the old ID entry is only
1832 updated, then this fucntion needs not to be called. */
1834 void silc_client_replace_from_channels(SilcClient client,
1835 SilcClientConnection conn,
1836 SilcClientEntry old,
1837 SilcClientEntry new)
1839 SilcHashTableList htl;
1840 SilcChannelUser chu;
1842 silc_hash_table_list(old->channels, &htl);
1843 while (silc_hash_table_get(&htl, NULL, (void *)&chu)) {
1844 /* Replace client entry */
1845 silc_hash_table_del(chu->client->channels, chu->channel);
1846 silc_hash_table_del(chu->channel->user_list, chu->client);
1849 silc_hash_table_add(chu->channel->user_list, chu->client, chu);
1850 silc_hash_table_add(chu->client->channels, chu->channel, chu);
1852 silc_hash_table_list_reset(&htl);
1855 /* Registers failure timeout to process the received failure packet
1858 void silc_client_process_failure(SilcClient client,
1859 SilcSocketConnection sock,
1860 SilcPacketContext *packet)
1862 SilcUInt32 failure = 0;
1864 if (sock->protocol) {
1865 if (packet->buffer->len >= 4)
1866 SILC_GET32_MSB(failure, packet->buffer->data);
1868 /* Notify application */
1869 client->internal->ops->failure(client, sock->user_data, sock->protocol,
1870 SILC_32_TO_PTR(failure));
1874 /* A timeout callback for the re-key. We will be the initiator of the
1877 SILC_TASK_CALLBACK_GLOBAL(silc_client_rekey_callback)
1879 SilcSocketConnection sock = (SilcSocketConnection)context;
1880 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1881 SilcClient client = (SilcClient)conn->internal->rekey->context;
1882 SilcProtocol protocol;
1883 SilcClientRekeyInternalContext *proto_ctx;
1885 SILC_LOG_DEBUG(("Start"));
1887 /* If rekey protocol is active already wait for it to finish */
1888 if (sock->protocol && sock->protocol->protocol &&
1889 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)
1892 /* Allocate internal protocol context. This is sent as context
1894 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
1895 proto_ctx->client = (void *)client;
1896 proto_ctx->sock = silc_socket_dup(sock);
1897 proto_ctx->responder = FALSE;
1898 proto_ctx->pfs = conn->internal->rekey->pfs;
1900 /* Perform rekey protocol. Will call the final callback after the
1901 protocol is over. */
1902 silc_protocol_alloc(SILC_PROTOCOL_CLIENT_REKEY,
1903 &protocol, proto_ctx, silc_client_rekey_final);
1904 sock->protocol = protocol;
1906 /* Run the protocol */
1907 silc_protocol_execute(protocol, client->schedule, 0, 0);
1910 /* The final callback for the REKEY protocol. This will actually take the
1911 new key material into use. */
1913 SILC_TASK_CALLBACK(silc_client_rekey_final)
1915 SilcProtocol protocol = (SilcProtocol)context;
1916 SilcClientRekeyInternalContext *ctx =
1917 (SilcClientRekeyInternalContext *)protocol->context;
1918 SilcClient client = (SilcClient)ctx->client;
1919 SilcSocketConnection sock = ctx->sock;
1920 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1922 SILC_LOG_DEBUG(("Start"));
1924 if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
1925 protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
1926 /* Error occured during protocol */
1927 silc_protocol_cancel(protocol, client->schedule);
1928 silc_protocol_free(protocol);
1929 sock->protocol = NULL;
1931 silc_packet_context_free(ctx->packet);
1933 silc_ske_free(ctx->ske);
1934 silc_socket_free(ctx->sock);
1939 /* Purge the outgoing data queue to assure that all rekey packets really
1940 go to the network before we quit the protocol. */
1941 silc_client_packet_queue_purge(client, sock);
1943 /* Re-register re-key timeout */
1944 if (ctx->responder == FALSE)
1945 silc_schedule_task_add(client->schedule, sock->sock,
1946 silc_client_rekey_callback,
1947 sock, conn->internal->rekey->timeout, 0,
1948 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
1951 silc_protocol_free(protocol);
1952 sock->protocol = NULL;
1954 silc_packet_context_free(ctx->packet);
1956 silc_ske_free(ctx->ske);
1957 silc_socket_free(ctx->sock);
1961 /* Processes incoming connection authentication method request packet.
1962 It is a reply to our previously sent request. The packet can be used
1963 to resolve the authentication method for the current session if the
1964 client does not know it beforehand. */
1966 void silc_client_connection_auth_request(SilcClient client,
1967 SilcSocketConnection sock,
1968 SilcPacketContext *packet)
1970 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1971 SilcUInt16 conn_type, auth_meth;
1974 /* If we haven't send our request then ignore this one. */
1975 if (!conn->internal->connauth)
1978 /* Parse the payload */
1979 ret = silc_buffer_unformat(packet->buffer,
1980 SILC_STR_UI_SHORT(&conn_type),
1981 SILC_STR_UI_SHORT(&auth_meth),
1984 auth_meth = SILC_AUTH_NONE;
1986 /* Call the request callback to notify application for received
1987 authentication method information. */
1988 if (conn->internal->connauth->callback)
1989 (*conn->internal->connauth->callback)(client, conn, auth_meth,
1990 conn->internal->connauth->context);
1992 silc_schedule_task_del(client->schedule, conn->internal->connauth->timeout);
1994 silc_free(conn->internal->connauth);
1995 conn->internal->connauth = NULL;
1998 /* Timeout task callback called if the server does not reply to our
1999 connection authentication method request in the specified time interval. */
2001 SILC_TASK_CALLBACK(silc_client_request_authentication_method_timeout)
2003 SilcClientConnection conn = (SilcClientConnection)context;
2004 SilcClient client = conn->client;
2006 if (!conn->internal->connauth)
2009 /* Call the request callback to notify application */
2010 if (conn->internal->connauth->callback)
2011 (*conn->internal->connauth->callback)(client, conn, SILC_AUTH_NONE,
2012 conn->internal->connauth->context);
2014 silc_free(conn->internal->connauth);
2015 conn->internal->connauth = NULL;
2018 /* This function can be used to request the current authentication method
2019 from the server. This may be called when connecting to the server
2020 and the client library requests the authentication data from the
2021 application. If the application does not know the current authentication
2022 method it can request it from the server using this function.
2023 The `callback' with `context' will be called after the server has
2024 replied back with the current authentication method. */
2027 silc_client_request_authentication_method(SilcClient client,
2028 SilcClientConnection conn,
2029 SilcConnectionAuthRequest callback,
2032 SilcClientConnAuthRequest connauth;
2035 assert(client && conn);
2036 connauth = silc_calloc(1, sizeof(*connauth));
2037 connauth->callback = callback;
2038 connauth->context = context;
2040 if (conn->internal->connauth)
2041 silc_free(conn->internal->connauth);
2043 conn->internal->connauth = connauth;
2045 /* Assemble the request packet and send it to the server */
2046 packet = silc_buffer_alloc(4);
2047 silc_buffer_pull_tail(packet, SILC_BUFFER_END(packet));
2048 silc_buffer_format(packet,
2049 SILC_STR_UI_SHORT(SILC_SOCKET_TYPE_CLIENT),
2050 SILC_STR_UI_SHORT(SILC_AUTH_NONE),
2052 silc_client_packet_send(client, conn->sock,
2053 SILC_PACKET_CONNECTION_AUTH_REQUEST,
2054 NULL, 0, NULL, NULL,
2055 packet->data, packet->len, FALSE);
2056 silc_buffer_free(packet);
2058 /* Register a timeout in case server does not reply anything back. */
2060 silc_schedule_task_add(client->schedule, conn->sock->sock,
2061 silc_client_request_authentication_method_timeout,
2063 client->internal->params->connauth_request_secs, 0,
2064 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);