5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2002 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_callback);
30 SILC_TASK_CALLBACK(silc_client_rekey_final);
32 static bool silc_client_packet_parse(SilcPacketParserContext *parser_context,
34 static void silc_client_packet_parse_type(SilcClient client,
35 SilcSocketConnection sock,
36 SilcPacketContext *packet);
37 void silc_client_resolve_auth_method(bool success,
38 SilcProtocolAuthMeth auth_meth,
39 const unsigned char *auth_data,
40 SilcUInt32 auth_data_len, void *context);
42 /* Allocates new client object. This has to be done before client may
43 work. After calling this one must call silc_client_init to initialize
44 the client. The `application' is application specific user data pointer
45 and caller must free it. */
47 SilcClient silc_client_alloc(SilcClientOperations *ops,
48 SilcClientParams *params,
50 const char *silc_version)
52 SilcClient new_client;
54 new_client = silc_calloc(1, sizeof(*new_client));
55 new_client->application = application;
57 new_client->internal = silc_calloc(1, sizeof(*new_client->internal));
58 new_client->internal->ops = ops;
59 new_client->internal->params =
60 silc_calloc(1, sizeof(*new_client->internal->params));
61 new_client->internal->silc_client_version = strdup(silc_version);
64 memcpy(new_client->internal->params, params, sizeof(*params));
66 if (!new_client->internal->params->task_max)
67 new_client->internal->params->task_max = 200;
69 if (!new_client->internal->params->rekey_secs)
70 new_client->internal->params->rekey_secs = 3600;
72 if (!new_client->internal->params->connauth_request_secs)
73 new_client->internal->params->connauth_request_secs = 2;
75 new_client->internal->params->
76 nickname_format[sizeof(new_client->internal->
77 params->nickname_format) - 1] = 0;
82 /* Frees client object and its internals. */
84 void silc_client_free(SilcClient client)
88 silc_rng_free(client->rng);
90 silc_free(client->internal->params);
91 silc_free(client->internal->silc_client_version);
92 silc_free(client->internal);
97 /* Initializes the client. This makes all the necessary steps to make
98 the client ready to be run. One must call silc_client_run to run the
99 client. Returns FALSE if error occured, TRUE otherwise. */
101 int silc_client_init(SilcClient client)
103 SILC_LOG_DEBUG(("Initializing client"));
105 /* Initialize hash functions for client to use */
106 silc_hash_alloc("md5", &client->internal->md5hash);
107 silc_hash_alloc("sha1", &client->internal->sha1hash);
109 /* Initialize none cipher */
110 silc_cipher_alloc("none", &client->internal->none_cipher);
112 /* Initialize random number generator */
113 client->rng = silc_rng_alloc();
114 silc_rng_init(client->rng);
115 silc_rng_global_init(client->rng);
117 /* Register protocols */
118 silc_client_protocols_register();
120 /* Initialize the scheduler */
122 silc_schedule_init(client->internal->params->task_max ?
123 client->internal->params->task_max : 200);
124 if (!client->schedule)
127 /* Register commands */
128 silc_client_commands_register(client);
133 /* Stops the client. This is called to stop the client and thus to stop
136 void silc_client_stop(SilcClient client)
138 SILC_LOG_DEBUG(("Stopping client"));
140 silc_schedule_stop(client->schedule);
141 silc_schedule_uninit(client->schedule);
143 silc_client_protocols_unregister();
144 silc_client_commands_unregister(client);
146 SILC_LOG_DEBUG(("Client stopped"));
149 /* Runs the client. This starts the scheduler from the utility library.
150 When this functions returns the execution of the appliation is over. */
152 void silc_client_run(SilcClient client)
154 SILC_LOG_DEBUG(("Running client"));
156 /* Start the scheduler, the heart of the SILC client. When this returns
157 the program will be terminated. */
158 silc_schedule(client->schedule);
161 /* Runs the client and returns immeadiately. This function is used when
162 the SILC Client object indicated by the `client' is run under some
163 other scheduler, or event loop or main loop. On GUI applications,
164 for example this may be desired to use to run the client under the
165 GUI application's main loop. Typically the GUI application would
166 register an idle task that calls this function multiple times in
167 a second to quickly process the SILC specific data. */
169 void silc_client_run_one(SilcClient client)
171 /* Run the scheduler once. */
172 silc_schedule_one(client->schedule, 0);
175 static void silc_client_entry_destructor(SilcIDCache cache,
176 SilcIDCacheEntry entry)
178 silc_free(entry->name);
181 /* Allocates and adds new connection to the client. This adds the allocated
182 connection to the connection table and returns a pointer to it. A client
183 can have multiple connections to multiple servers. Every connection must
184 be added to the client using this function. User data `context' may
185 be sent as argument. This function is normally used only if the
186 application performed the connecting outside the library. The library
187 however may use this internally. */
190 silc_client_add_connection(SilcClient client,
191 SilcClientConnectionParams *params,
192 char *hostname, int port, void *context)
194 SilcClientConnection conn;
197 conn = silc_calloc(1, sizeof(*conn));
199 /* Initialize ID caches */
200 conn->client_cache = silc_idcache_alloc(0, SILC_ID_CLIENT,
201 silc_client_entry_destructor);
202 conn->channel_cache = silc_idcache_alloc(0, SILC_ID_CHANNEL, NULL);
203 conn->server_cache = silc_idcache_alloc(0, SILC_ID_SERVER, NULL);
204 conn->client = client;
205 conn->remote_host = strdup(hostname);
206 conn->remote_port = port;
207 conn->context = context;
208 conn->pending_commands = silc_dlist_init();
209 conn->ftp_sessions = silc_dlist_init();
212 if (params->detach_data)
213 conn->params.detach_data = silc_memdup(params->detach_data,
214 params->detach_data_len);
215 conn->params.detach_data_len = params->detach_data_len;
218 /* Add the connection to connections table */
219 for (i = 0; i < client->internal->conns_count; i++)
220 if (client->internal->conns && !client->internal->conns[i]) {
221 client->internal->conns[i] = conn;
225 client->internal->conns =
226 silc_realloc(client->internal->conns, sizeof(*client->internal->conns)
227 * (client->internal->conns_count + 1));
228 client->internal->conns[client->internal->conns_count] = conn;
229 client->internal->conns_count++;
234 /* Removes connection from client. Frees all memory. */
236 void silc_client_del_connection(SilcClient client, SilcClientConnection conn)
240 for (i = 0; i < client->internal->conns_count; i++)
241 if (client->internal->conns[i] == conn) {
243 silc_idcache_free(conn->client_cache);
244 silc_idcache_free(conn->channel_cache);
245 silc_idcache_free(conn->server_cache);
246 if (conn->pending_commands)
247 silc_dlist_uninit(conn->pending_commands);
248 silc_free(conn->remote_host);
249 silc_dlist_uninit(conn->ftp_sessions);
252 client->internal->conns[i] = NULL;
256 /* Adds listener socket to the listener sockets table. This function is
257 used to add socket objects that are listeners to the client. This should
258 not be used to add other connection objects. */
260 void silc_client_add_socket(SilcClient client, SilcSocketConnection sock)
264 if (!client->internal->sockets) {
265 client->internal->sockets =
266 silc_calloc(1, sizeof(*client->internal->sockets));
267 client->internal->sockets[0] = silc_socket_dup(sock);
268 client->internal->sockets_count = 1;
272 for (i = 0; i < client->internal->sockets_count; i++) {
273 if (client->internal->sockets[i] == NULL) {
274 client->internal->sockets[i] = silc_socket_dup(sock);
279 client->internal->sockets =
280 silc_realloc(client->internal->sockets,
281 sizeof(*client->internal->sockets) *
282 (client->internal->sockets_count + 1));
283 client->internal->sockets[client->internal->sockets_count] =
284 silc_socket_dup(sock);
285 client->internal->sockets_count++;
288 /* Deletes listener socket from the listener sockets table. */
290 void silc_client_del_socket(SilcClient client, SilcSocketConnection sock)
294 if (!client->internal->sockets)
297 for (i = 0; i < client->internal->sockets_count; i++) {
298 if (client->internal->sockets[i] == sock) {
299 silc_socket_free(sock);
300 client->internal->sockets[i] = NULL;
307 silc_client_connect_to_server_internal(SilcClientInternalConnectContext *ctx)
311 /* XXX In the future we should give up this non-blocking connect all
312 together and use threads instead. */
313 /* Create connection to server asynchronously */
314 sock = silc_net_create_connection_async(NULL, ctx->port, ctx->host);
318 /* Register task that will receive the async connect and will
320 ctx->task = silc_schedule_task_add(ctx->client->schedule, sock,
321 silc_client_connect_to_server_start,
324 SILC_TASK_PRI_NORMAL);
325 silc_schedule_set_listen_fd(ctx->client->schedule, sock, SILC_TASK_WRITE);
332 /* Connects to remote server. This is the main routine used to connect
333 to SILC server. Returns -1 on error and the created socket otherwise.
334 The `context' is user context that is saved into the SilcClientConnection
335 that is created after the connection is created. Note that application
336 may handle the connecting process outside the library. If this is the
337 case then this function is not used at all. When the connecting is
338 done the `connect' client operation is called. */
340 int silc_client_connect_to_server(SilcClient client,
341 SilcClientConnectionParams *params,
342 int port, char *host, void *context)
344 SilcClientInternalConnectContext *ctx;
345 SilcClientConnection conn;
348 SILC_LOG_DEBUG(("Connecting to port %d of server %s",
351 conn = silc_client_add_connection(client, params, host, port, context);
353 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_AUDIT,
354 "Connecting to port %d of server %s", port, host);
356 /* Allocate internal context for connection process. This is
357 needed as we are doing async connecting. */
358 ctx = silc_calloc(1, sizeof(*ctx));
359 ctx->client = client;
361 ctx->host = strdup(host);
365 /* Do the actual connecting process */
366 sock = silc_client_connect_to_server_internal(ctx);
368 silc_client_del_connection(client, conn);
372 /* Socket hostname and IP lookup callback that is called before actually
373 starting the key exchange. The lookup is called from the function
374 silc_client_start_key_exchange. */
376 static void silc_client_start_key_exchange_cb(SilcSocketConnection sock,
379 SilcClientConnection conn = (SilcClientConnection)context;
380 SilcClient client = conn->client;
381 SilcProtocol protocol;
382 SilcClientKEInternalContext *proto_ctx;
384 SILC_LOG_DEBUG(("Start"));
386 /* XXX We should most likely use the resolved host name instead of the
387 one user provided for us. */
388 silc_free(conn->sock->hostname);
389 conn->sock->hostname = strdup(conn->remote_host);
391 conn->sock->ip = strdup(conn->remote_host);
392 conn->sock->port = conn->remote_port;
394 /* Allocate internal Key Exchange context. This is sent to the
395 protocol as context. */
396 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
397 proto_ctx->client = (void *)client;
398 proto_ctx->sock = silc_socket_dup(conn->sock);
399 proto_ctx->rng = client->rng;
400 proto_ctx->responder = FALSE;
401 proto_ctx->send_packet = silc_client_protocol_ke_send_packet;
402 proto_ctx->verify = silc_client_protocol_ke_verify_key;
404 /* Perform key exchange protocol. silc_client_connect_to_server_final
405 will be called after the protocol is finished. */
406 silc_protocol_alloc(SILC_PROTOCOL_CLIENT_KEY_EXCHANGE,
407 &protocol, (void *)proto_ctx,
408 silc_client_connect_to_server_second);
410 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
411 "Error: Could not start key exchange protocol");
412 silc_net_close_connection(conn->sock->sock);
413 client->internal->ops->connect(client, conn, SILC_CLIENT_CONN_ERROR);
416 conn->sock->protocol = protocol;
418 /* Register the connection for network input and output. This sets
419 that scheduler will listen for incoming packets for this connection
420 and sets that outgoing packets may be sent to this connection as well.
421 However, this doesn't set the scheduler for outgoing traffic, it will
422 be set separately by calling SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT,
423 later when outgoing data is available. */
424 context = (void *)client;
425 SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(conn->sock->sock);
427 /* Execute the protocol */
428 silc_protocol_execute(protocol, client->schedule, 0, 0);
431 /* Start SILC Key Exchange (SKE) protocol to negotiate shared secret
432 key material between client and server. This function can be called
433 directly if application is performing its own connecting and does not
434 use the connecting provided by this library. This function is normally
435 used only if the application performed the connecting outside the library.
436 The library however may use this internally. */
438 void silc_client_start_key_exchange(SilcClient client,
439 SilcClientConnection conn,
442 /* Allocate new socket connection object */
443 silc_socket_alloc(fd, SILC_SOCKET_TYPE_SERVER, (void *)conn, &conn->sock);
445 /* Sometimes when doing quick reconnects the new socket may be same as
446 the old one and there might be pending stuff for the old socket.
447 If new one is same then those pending sutff might cause problems.
448 Make sure they do not do that. */
449 silc_schedule_task_del_by_fd(client->schedule, fd);
451 conn->nickname = (client->nickname ? strdup(client->nickname) :
452 strdup(client->username));
454 /* Resolve the remote hostname and IP address for our socket connection */
455 silc_socket_host_lookup(conn->sock, FALSE, silc_client_start_key_exchange_cb,
456 conn, client->schedule);
459 /* Callback called when error has occurred during connecting to the server.
460 The `connect' client operation will be called. */
462 SILC_TASK_CALLBACK(silc_client_connect_failure)
464 SilcClientKEInternalContext *ctx =
465 (SilcClientKEInternalContext *)context;
466 SilcClient client = (SilcClient)ctx->client;
468 client->internal->ops->connect(client, ctx->sock->user_data,
469 SILC_CLIENT_CONN_ERROR);
471 silc_packet_context_free(ctx->packet);
475 /* Start of the connection to the remote server. This is called after
476 succesful TCP/IP connection has been established to the remote host. */
478 SILC_TASK_CALLBACK(silc_client_connect_to_server_start)
480 SilcClientInternalConnectContext *ctx =
481 (SilcClientInternalConnectContext *)context;
482 SilcClient client = ctx->client;
483 SilcClientConnection conn = ctx->conn;
484 int opt, opt_len = sizeof(opt);
486 SILC_LOG_DEBUG(("Start"));
488 /* Check the socket status as it might be in error */
489 silc_net_get_socket_opt(fd, SOL_SOCKET, SO_ERROR, &opt, &opt_len);
491 if (ctx->tries < 2) {
492 /* Connection failed but lets try again */
493 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
494 "Could not connect to server %s: %s",
495 ctx->host, strerror(opt));
496 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_AUDIT,
497 "Connecting to port %d of server %s resumed",
498 ctx->port, ctx->host);
500 /* Unregister old connection try */
501 silc_schedule_unset_listen_fd(client->schedule, fd);
502 silc_net_close_connection(fd);
503 silc_schedule_task_del(client->schedule, ctx->task);
506 silc_client_connect_to_server_internal(ctx);
509 /* Connection failed and we won't try anymore */
510 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
511 "Could not connect to server %s: %s",
512 ctx->host, strerror(opt));
513 silc_schedule_unset_listen_fd(client->schedule, fd);
514 silc_net_close_connection(fd);
515 silc_schedule_task_del(client->schedule, ctx->task);
518 /* Notify application of failure */
519 client->internal->ops->connect(client, conn, SILC_CLIENT_CONN_ERROR);
520 silc_client_del_connection(client, conn);
525 silc_schedule_unset_listen_fd(client->schedule, fd);
526 silc_schedule_task_del(client->schedule, ctx->task);
529 silc_client_start_key_exchange(client, conn, fd);
532 /* Second part of the connecting to the server. This executed
533 authentication protocol. */
535 SILC_TASK_CALLBACK(silc_client_connect_to_server_second)
537 SilcProtocol protocol = (SilcProtocol)context;
538 SilcClientKEInternalContext *ctx =
539 (SilcClientKEInternalContext *)protocol->context;
540 SilcClient client = (SilcClient)ctx->client;
541 SilcSocketConnection sock = NULL;
542 SilcClientConnAuthInternalContext *proto_ctx;
544 SILC_LOG_DEBUG(("Start"));
546 if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
547 protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
548 /* Error occured during protocol */
549 SILC_LOG_DEBUG(("Error during KE protocol"));
550 silc_protocol_free(protocol);
551 silc_ske_free_key_material(ctx->keymat);
553 silc_ske_free(ctx->ske);
555 silc_free(ctx->dest_id);
556 ctx->sock->protocol = NULL;
557 silc_socket_free(ctx->sock);
559 /* Notify application of failure */
560 silc_schedule_task_add(client->schedule, ctx->sock->sock,
561 silc_client_connect_failure, ctx,
562 0, 1, SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
566 /* We now have the key material as the result of the key exchange
567 protocol. Take the key material into use. Free the raw key material
568 as soon as we've set them into use. */
569 silc_client_protocol_ke_set_keys(ctx->ske, ctx->sock, ctx->keymat,
570 ctx->ske->prop->cipher,
571 ctx->ske->prop->pkcs,
572 ctx->ske->prop->hash,
573 ctx->ske->prop->hmac,
574 ctx->ske->prop->group,
576 silc_ske_free_key_material(ctx->keymat);
578 /* Allocate internal context for the authentication protocol. This
579 is sent as context for the protocol. */
580 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
581 proto_ctx->client = (void *)client;
582 proto_ctx->sock = sock = ctx->sock;
583 proto_ctx->ske = ctx->ske; /* Save SKE object from previous protocol */
584 proto_ctx->dest_id_type = ctx->dest_id_type;
585 proto_ctx->dest_id = ctx->dest_id;
587 /* Free old protocol as it is finished now */
588 silc_protocol_free(protocol);
590 silc_packet_context_free(ctx->packet);
592 sock->protocol = NULL;
594 /* Resolve the authentication method to be used in this connection. The
595 completion callback is called after the application has resolved
596 the authentication method. */
597 client->internal->ops->get_auth_method(client, sock->user_data,
600 silc_client_resolve_auth_method,
604 /* Authentication method resolving callback. Application calls this function
605 after we've called the client->internal->ops->get_auth_method
606 client operation to resolve the authentication method. We will continue
607 the executiong of the protocol in this function. */
609 void silc_client_resolve_auth_method(bool success,
610 SilcProtocolAuthMeth auth_meth,
611 const unsigned char *auth_data,
612 SilcUInt32 auth_data_len, void *context)
614 SilcClientConnAuthInternalContext *proto_ctx =
615 (SilcClientConnAuthInternalContext *)context;
616 SilcClient client = (SilcClient)proto_ctx->client;
619 auth_meth = SILC_AUTH_NONE;
621 proto_ctx->auth_meth = auth_meth;
623 if (auth_data && auth_data_len) {
624 proto_ctx->auth_data = silc_memdup(auth_data, auth_data_len);
625 proto_ctx->auth_data_len = auth_data_len;
628 /* Allocate the authenteication protocol and execute it. */
629 silc_protocol_alloc(SILC_PROTOCOL_CLIENT_CONNECTION_AUTH,
630 &proto_ctx->sock->protocol, (void *)proto_ctx,
631 silc_client_connect_to_server_final);
633 /* Execute the protocol */
634 silc_protocol_execute(proto_ctx->sock->protocol, client->schedule, 0, 0);
637 /* Finalizes the connection to the remote SILC server. This is called
638 after authentication protocol has been completed. This send our
639 user information to the server to receive our client ID from
642 SILC_TASK_CALLBACK(silc_client_connect_to_server_final)
644 SilcProtocol protocol = (SilcProtocol)context;
645 SilcClientConnAuthInternalContext *ctx =
646 (SilcClientConnAuthInternalContext *)protocol->context;
647 SilcClient client = (SilcClient)ctx->client;
648 SilcClientConnection conn = (SilcClientConnection)ctx->sock->user_data;
651 SILC_LOG_DEBUG(("Start"));
653 if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
654 protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
655 /* Error occured during protocol */
656 SILC_LOG_DEBUG(("Error during authentication protocol"));
657 silc_protocol_free(protocol);
659 silc_free(ctx->auth_data);
661 silc_ske_free(ctx->ske);
663 silc_free(ctx->dest_id);
664 conn->sock->protocol = NULL;
665 silc_socket_free(ctx->sock);
667 /* Notify application of failure */
668 silc_schedule_task_add(client->schedule, ctx->sock->sock,
669 silc_client_connect_failure, ctx,
670 0, 1, SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
674 if (conn->params.detach_data) {
675 /* Send RESUME_CLIENT packet to the server, which is used to resume
676 old detached session back. */
678 SilcClientID *old_client_id;
679 unsigned char *old_id;
680 SilcUInt16 old_id_len;
682 if (!silc_client_process_detach_data(client, conn, &old_id, &old_id_len))
685 old_client_id = silc_id_str2id(old_id, old_id_len, SILC_ID_CLIENT);
686 if (!old_client_id) {
691 /* Generate authentication data that server will verify */
692 auth = silc_auth_public_key_auth_generate(client->public_key,
694 client->rng, conn->hash,
695 old_client_id, SILC_ID_CLIENT);
697 silc_free(old_client_id);
702 packet = silc_buffer_alloc_size(2 + old_id_len + auth->len);
703 silc_buffer_format(packet,
704 SILC_STR_UI_SHORT(old_id_len),
705 SILC_STR_UI_XNSTRING(old_id, old_id_len),
706 SILC_STR_UI_XNSTRING(auth->data, auth->len),
709 /* Send the packet */
710 silc_client_packet_send(client, ctx->sock, SILC_PACKET_RESUME_CLIENT,
712 packet->data, packet->len, TRUE);
713 silc_buffer_free(packet);
714 silc_buffer_free(auth);
715 silc_free(old_client_id);
718 /* Send NEW_CLIENT packet to the server. We will become registered
719 to the SILC network after sending this packet and we will receive
720 client ID from the server. */
721 packet = silc_buffer_alloc(2 + 2 + strlen(client->username) +
722 strlen(client->realname));
723 silc_buffer_pull_tail(packet, SILC_BUFFER_END(packet));
724 silc_buffer_format(packet,
725 SILC_STR_UI_SHORT(strlen(client->username)),
726 SILC_STR_UI_XNSTRING(client->username,
727 strlen(client->username)),
728 SILC_STR_UI_SHORT(strlen(client->realname)),
729 SILC_STR_UI_XNSTRING(client->realname,
730 strlen(client->realname)),
733 /* Send the packet */
734 silc_client_packet_send(client, ctx->sock, SILC_PACKET_NEW_CLIENT,
736 packet->data, packet->len, TRUE);
737 silc_buffer_free(packet);
740 /* Save remote ID. */
741 conn->remote_id = ctx->dest_id;
742 conn->remote_id_data = silc_id_id2str(ctx->dest_id, SILC_ID_SERVER);
743 conn->remote_id_data_len = silc_id_get_len(ctx->dest_id, SILC_ID_SERVER);
745 /* Register re-key timeout */
746 conn->rekey->timeout = client->internal->params->rekey_secs;
747 conn->rekey->context = (void *)client;
748 silc_schedule_task_add(client->schedule, conn->sock->sock,
749 silc_client_rekey_callback,
750 (void *)conn->sock, conn->rekey->timeout, 0,
751 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
753 silc_protocol_free(protocol);
755 silc_free(ctx->auth_data);
757 silc_ske_free(ctx->ske);
758 silc_socket_free(ctx->sock);
760 conn->sock->protocol = NULL;
763 /* Internal routine that sends packet or marks packet to be sent. This
764 is used directly only in special cases. Normal cases should use
765 silc_server_packet_send. Returns < 0 on error. */
767 int silc_client_packet_send_real(SilcClient client,
768 SilcSocketConnection sock,
773 /* If rekey protocol is active we must assure that all packets are
774 sent through packet queue. */
775 if (SILC_CLIENT_IS_REKEY(sock))
778 /* If outbound data is already pending do not force send */
779 if (SILC_IS_OUTBUF_PENDING(sock))
782 /* Send the packet */
783 ret = silc_packet_send(sock, force_send);
787 /* Mark that there is some outgoing data available for this connection.
788 This call sets the connection both for input and output (the input
789 is set always and this call keeps the input setting, actually).
790 Actual data sending is performed by silc_client_packet_process. */
791 SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(client->schedule, sock->sock);
793 /* Mark to socket that data is pending in outgoing buffer. This flag
794 is needed if new data is added to the buffer before the earlier
795 put data is sent to the network. */
796 SILC_SET_OUTBUF_PENDING(sock);
801 /* Packet processing callback. This is used to send and receive packets
802 from network. This is generic task. */
804 SILC_TASK_CALLBACK_GLOBAL(silc_client_packet_process)
806 SilcClient client = (SilcClient)context;
807 SilcSocketConnection sock = NULL;
808 SilcClientConnection conn;
811 SILC_LOG_DEBUG(("Processing packet"));
813 SILC_CLIENT_GET_SOCK(client, fd, sock);
817 conn = (SilcClientConnection)sock->user_data;
820 if (type == SILC_TASK_WRITE) {
821 /* Do not send data to disconnected connection */
822 if (SILC_IS_DISCONNECTED(sock))
825 ret = silc_packet_send(sock, TRUE);
827 /* If returned -2 could not write to connection now, will do
836 /* The packet has been sent and now it is time to set the connection
837 back to only for input. When there is again some outgoing data
838 available for this connection it will be set for output as well.
839 This call clears the output setting and sets it only for input. */
840 SILC_CLIENT_SET_CONNECTION_FOR_INPUT(client->schedule, fd);
841 SILC_UNSET_OUTBUF_PENDING(sock);
843 silc_buffer_clear(sock->outbuf);
847 /* Packet receiving */
848 if (type == SILC_TASK_READ) {
849 /* Read data from network */
850 ret = silc_packet_receive(sock);
856 SILC_LOG_DEBUG(("Read EOF"));
858 /* If connection is disconnecting already we will finally
859 close the connection */
860 if (SILC_IS_DISCONNECTING(sock)) {
861 if (sock == conn->sock && sock->type != SILC_SOCKET_TYPE_CLIENT)
862 client->internal->ops->disconnect(client, conn);
863 silc_client_close_connection_real(client, sock, conn);
867 SILC_LOG_DEBUG(("EOF from connection %d", sock->sock));
868 if (sock == conn->sock && sock->type != SILC_SOCKET_TYPE_CLIENT)
869 client->internal->ops->disconnect(client, conn);
870 silc_client_close_connection_real(client, sock, conn);
874 /* Process the packet. This will call the parser that will then
875 decrypt and parse the packet. */
876 if (sock->type != SILC_SOCKET_TYPE_UNKNOWN)
877 silc_packet_receive_process(sock, FALSE, conn->receive_key,
878 conn->hmac_receive, conn->psn_receive,
879 silc_client_packet_parse, client);
881 silc_packet_receive_process(sock, FALSE, NULL, NULL, 0,
882 silc_client_packet_parse, client);
886 /* Parser callback called by silc_packet_receive_process. Thie merely
887 registers timeout that will handle the actual parsing when appropriate. */
889 static bool silc_client_packet_parse(SilcPacketParserContext *parser_context,
892 SilcClient client = (SilcClient)context;
893 SilcSocketConnection sock = parser_context->sock;
894 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
895 SilcPacketContext *packet = parser_context->packet;
898 if (conn && conn->hmac_receive && conn->sock == sock)
899 conn->psn_receive = parser_context->packet->sequence + 1;
901 /* Parse the packet immediately */
902 if (parser_context->normal)
903 ret = silc_packet_parse(packet, conn->receive_key);
905 ret = silc_packet_parse_special(packet, conn->receive_key);
907 if (ret == SILC_PACKET_NONE) {
908 silc_packet_context_free(packet);
909 silc_free(parser_context);
913 /* If protocol for this connection is key exchange or rekey then we'll
914 process all packets synchronously, since there might be packets in
915 queue that we are not able to decrypt without first processing the
916 packets before them. */
917 if ((ret == SILC_PACKET_REKEY || ret == SILC_PACKET_REKEY_DONE) ||
918 (sock->protocol && sock->protocol->protocol &&
919 (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
920 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY))) {
922 /* Parse the incoming packet type */
923 silc_client_packet_parse_type(client, sock, packet);
924 silc_packet_context_free(packet);
925 silc_free(parser_context);
927 /* Reprocess the buffer since we'll return FALSE. This is because
928 the `conn->receive_key' might have become valid by processing
929 the previous packet */
930 if (sock->type != SILC_SOCKET_TYPE_UNKNOWN)
931 silc_packet_receive_process(sock, FALSE, conn->receive_key,
932 conn->hmac_receive, conn->psn_receive,
933 silc_client_packet_parse, client);
935 silc_packet_receive_process(sock, FALSE, NULL, NULL, 0,
936 silc_client_packet_parse, client);
941 /* Parse the incoming packet type */
942 silc_client_packet_parse_type(client, sock, packet);
943 silc_packet_context_free(packet);
944 silc_free(parser_context);
948 /* Parses the packet type and calls what ever routines the packet type
949 requires. This is done for all incoming packets. */
951 void silc_client_packet_parse_type(SilcClient client,
952 SilcSocketConnection sock,
953 SilcPacketContext *packet)
955 SilcBuffer buffer = packet->buffer;
956 SilcPacketType type = packet->type;
958 SILC_LOG_DEBUG(("Parsing packet type %d", type));
960 /* Parse the packet type */
962 case SILC_PACKET_DISCONNECT:
963 silc_client_disconnected_by_server(client, sock, buffer);
965 case SILC_PACKET_SUCCESS:
967 * Success received for something. For now we can have only
968 * one protocol for connection executing at once hence this
969 * success message is for whatever protocol is executing currently.
972 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
974 case SILC_PACKET_FAILURE:
976 * Failure received for some protocol. Set the protocol state to
977 * error and call the protocol callback. This fill cause error on
978 * protocol and it will call the final callback.
980 silc_client_process_failure(client, sock, packet);
982 case SILC_PACKET_REJECT:
985 case SILC_PACKET_NOTIFY:
987 * Received notify message
989 silc_client_notify_by_server(client, sock, packet);
992 case SILC_PACKET_ERROR:
994 * Received error message
996 silc_client_error_by_server(client, sock, buffer);
999 case SILC_PACKET_CHANNEL_MESSAGE:
1001 * Received message to (from, actually) a channel
1003 silc_client_channel_message(client, sock, packet);
1005 case SILC_PACKET_CHANNEL_KEY:
1007 * Received key for a channel. By receiving this key the client will be
1008 * able to talk to the channel it has just joined. This can also be
1009 * a new key for existing channel as keys expire peridiocally.
1011 silc_client_receive_channel_key(client, sock, buffer);
1014 case SILC_PACKET_PRIVATE_MESSAGE:
1016 * Received private message
1018 silc_client_private_message(client, sock, packet);
1020 case SILC_PACKET_PRIVATE_MESSAGE_KEY:
1022 * Received private message key
1026 case SILC_PACKET_COMMAND_REPLY:
1028 * Recived reply for a command
1030 silc_client_command_reply_process(client, sock, packet);
1033 case SILC_PACKET_KEY_EXCHANGE:
1034 if (sock->protocol && sock->protocol->protocol &&
1035 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE) {
1036 SilcClientKEInternalContext *proto_ctx =
1037 (SilcClientKEInternalContext *)sock->protocol->context;
1039 proto_ctx->packet = silc_packet_context_dup(packet);
1040 proto_ctx->dest_id_type = packet->src_id_type;
1041 proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
1042 packet->src_id_type);
1043 if (!proto_ctx->dest_id)
1046 /* Let the protocol handle the packet */
1047 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1049 SILC_LOG_ERROR(("Received Key Exchange packet but no key exchange "
1050 "protocol active, packet dropped."));
1054 case SILC_PACKET_KEY_EXCHANGE_1:
1055 if (sock->protocol && sock->protocol->protocol &&
1056 (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1057 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)) {
1059 if (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1060 SilcClientRekeyInternalContext *proto_ctx =
1061 (SilcClientRekeyInternalContext *)sock->protocol->context;
1063 if (proto_ctx->packet)
1064 silc_packet_context_free(proto_ctx->packet);
1066 proto_ctx->packet = silc_packet_context_dup(packet);
1068 /* Let the protocol handle the packet */
1069 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1071 SilcClientKEInternalContext *proto_ctx =
1072 (SilcClientKEInternalContext *)sock->protocol->context;
1074 if (proto_ctx->packet)
1075 silc_packet_context_free(proto_ctx->packet);
1077 proto_ctx->packet = silc_packet_context_dup(packet);
1078 proto_ctx->dest_id_type = packet->src_id_type;
1079 proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
1080 packet->src_id_type);
1081 if (!proto_ctx->dest_id)
1084 /* Let the protocol handle the packet */
1085 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1088 SILC_LOG_ERROR(("Received Key Exchange 1 packet but no key exchange "
1089 "protocol active, packet dropped."));
1092 case SILC_PACKET_KEY_EXCHANGE_2:
1093 if (sock->protocol && sock->protocol->protocol &&
1094 (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1095 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)) {
1097 if (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1098 SilcClientRekeyInternalContext *proto_ctx =
1099 (SilcClientRekeyInternalContext *)sock->protocol->context;
1101 if (proto_ctx->packet)
1102 silc_packet_context_free(proto_ctx->packet);
1104 proto_ctx->packet = silc_packet_context_dup(packet);
1106 /* Let the protocol handle the packet */
1107 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1109 SilcClientKEInternalContext *proto_ctx =
1110 (SilcClientKEInternalContext *)sock->protocol->context;
1112 if (proto_ctx->packet)
1113 silc_packet_context_free(proto_ctx->packet);
1114 if (proto_ctx->dest_id)
1115 silc_free(proto_ctx->dest_id);
1116 proto_ctx->packet = silc_packet_context_dup(packet);
1117 proto_ctx->dest_id_type = packet->src_id_type;
1118 proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
1119 packet->src_id_type);
1120 if (!proto_ctx->dest_id)
1123 /* Let the protocol handle the packet */
1124 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1127 SILC_LOG_ERROR(("Received Key Exchange 2 packet but no key exchange "
1128 "protocol active, packet dropped."));
1132 case SILC_PACKET_NEW_ID:
1135 * Received new ID from server. This packet is received at
1136 * the connection to the server. New ID is also received when
1137 * user changes nickname but in that case the new ID is received
1138 * as command reply and not as this packet type.
1142 idp = silc_id_payload_parse(buffer->data, buffer->len);
1145 if (silc_id_payload_get_type(idp) != SILC_ID_CLIENT)
1148 silc_client_receive_new_id(client, sock, idp);
1149 silc_id_payload_free(idp);
1153 case SILC_PACKET_HEARTBEAT:
1155 * Received heartbeat packet
1157 SILC_LOG_DEBUG(("Heartbeat packet"));
1160 case SILC_PACKET_KEY_AGREEMENT:
1162 * Received key agreement packet
1164 SILC_LOG_DEBUG(("Key agreement packet"));
1165 silc_client_key_agreement(client, sock, packet);
1168 case SILC_PACKET_REKEY:
1169 SILC_LOG_DEBUG(("Re-key packet"));
1170 /* We ignore this for now */
1173 case SILC_PACKET_REKEY_DONE:
1174 SILC_LOG_DEBUG(("Re-key done packet"));
1176 if (sock->protocol && sock->protocol->protocol &&
1177 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1179 SilcClientRekeyInternalContext *proto_ctx =
1180 (SilcClientRekeyInternalContext *)sock->protocol->context;
1182 if (proto_ctx->packet)
1183 silc_packet_context_free(proto_ctx->packet);
1185 proto_ctx->packet = silc_packet_context_dup(packet);
1187 /* Let the protocol handle the packet */
1188 if (proto_ctx->responder == FALSE)
1189 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1191 /* Let the protocol handle the packet */
1192 silc_protocol_execute(sock->protocol, client->schedule,
1195 SILC_LOG_ERROR(("Received Re-key done packet but no re-key "
1196 "protocol active, packet dropped."));
1200 case SILC_PACKET_CONNECTION_AUTH_REQUEST:
1202 * Reveived reply to our connection authentication method request
1203 * packet. This is used to resolve the authentication method for the
1204 * current session from the server if the client does not know it.
1206 silc_client_connection_auth_request(client, sock, packet);
1209 case SILC_PACKET_FTP:
1210 /* Received file transfer packet. */
1211 silc_client_ftp(client, sock, packet);
1215 SILC_LOG_DEBUG(("Incorrect packet type %d, packet dropped", type));
1220 /* Sends packet. This doesn't actually send the packet instead it assembles
1221 it and marks it to be sent. However, if force_send is TRUE the packet
1222 is sent immediately. if dst_id, cipher and hmac are NULL those parameters
1223 will be derived from sock argument. Otherwise the valid arguments sent
1226 void silc_client_packet_send(SilcClient client,
1227 SilcSocketConnection sock,
1228 SilcPacketType type,
1230 SilcIdType dst_id_type,
1233 unsigned char *data,
1234 SilcUInt32 data_len,
1237 SilcPacketContext packetdata;
1238 const SilcBufferStruct packet;
1240 SilcUInt32 sequence = 0;
1245 SILC_LOG_DEBUG(("Sending packet, type %d", type));
1247 /* Get data used in the packet sending, keys and stuff */
1248 if ((!cipher || !hmac || !dst_id) && sock->user_data) {
1249 if (!cipher && ((SilcClientConnection)sock->user_data)->send_key)
1250 cipher = ((SilcClientConnection)sock->user_data)->send_key;
1252 if (!hmac && ((SilcClientConnection)sock->user_data)->hmac_send)
1253 hmac = ((SilcClientConnection)sock->user_data)->hmac_send;
1255 if (!dst_id && ((SilcClientConnection)sock->user_data)->remote_id) {
1256 dst_id = ((SilcClientConnection)sock->user_data)->remote_id;
1257 dst_id_type = SILC_ID_SERVER;
1261 sequence = ((SilcClientConnection)sock->user_data)->psn_send++;
1264 block_len = cipher ? silc_cipher_get_block_len(cipher) : 0;
1266 /* Set the packet context pointers */
1267 packetdata.flags = 0;
1268 packetdata.type = type;
1269 if (sock->user_data &&
1270 ((SilcClientConnection)sock->user_data)->local_id_data) {
1271 packetdata.src_id = ((SilcClientConnection)sock->user_data)->local_id_data;
1272 packetdata.src_id_len =
1273 silc_id_get_len(((SilcClientConnection)sock->user_data)->local_id,
1276 packetdata.src_id = silc_calloc(SILC_ID_CLIENT_LEN, sizeof(unsigned char));
1277 packetdata.src_id_len = SILC_ID_CLIENT_LEN;
1279 packetdata.src_id_type = SILC_ID_CLIENT;
1281 packetdata.dst_id = silc_id_id2str(dst_id, dst_id_type);
1282 packetdata.dst_id_len = silc_id_get_len(dst_id, dst_id_type);
1283 packetdata.dst_id_type = dst_id_type;
1285 packetdata.dst_id = NULL;
1286 packetdata.dst_id_len = 0;
1287 packetdata.dst_id_type = SILC_ID_NONE;
1289 data_len = SILC_PACKET_DATALEN(data_len, (SILC_PACKET_HEADER_LEN +
1290 packetdata.src_id_len +
1291 packetdata.dst_id_len));
1292 packetdata.truelen = data_len + SILC_PACKET_HEADER_LEN +
1293 packetdata.src_id_len + packetdata.dst_id_len;
1294 packetdata.padlen = SILC_PACKET_PADLEN(packetdata.truelen, block_len);
1296 /* Create the outgoing packet */
1297 if (!silc_packet_assemble(&packetdata, client->rng, cipher, hmac, sock,
1298 data, data_len, (const SilcBuffer)&packet)) {
1299 SILC_LOG_ERROR(("Error assembling packet"));
1303 /* Encrypt the packet */
1305 silc_packet_encrypt(cipher, hmac, sequence, (SilcBuffer)&packet,
1308 SILC_LOG_HEXDUMP(("Packet (%d), len %d", sequence, packet.len),
1309 packet.data, packet.len);
1311 /* Now actually send the packet */
1312 silc_client_packet_send_real(client, sock, force_send);
1315 void silc_client_packet_queue_purge(SilcClient client,
1316 SilcSocketConnection sock)
1318 if (sock && SILC_IS_OUTBUF_PENDING(sock) &&
1319 (SILC_IS_DISCONNECTED(sock) == FALSE)) {
1320 silc_packet_send(sock, TRUE);
1321 SILC_CLIENT_SET_CONNECTION_FOR_INPUT(client->schedule, sock->sock);
1322 SILC_UNSET_OUTBUF_PENDING(sock);
1323 silc_buffer_clear(sock->outbuf);
1327 /* Closes connection to remote end. Free's all allocated data except
1328 for some information such as nickname etc. that are valid at all time.
1329 If the `sock' is NULL then the conn->sock will be used. If `sock' is
1330 provided it will be checked whether the sock and `conn->sock' are the
1331 same (they can be different, ie. a socket can use `conn' as its
1332 connection but `conn->sock' might be actually a different connection
1333 than the `sock'). */
1335 void silc_client_close_connection_real(SilcClient client,
1336 SilcSocketConnection sock,
1337 SilcClientConnection conn)
1341 SILC_LOG_DEBUG(("Start"));
1343 if (!sock || (sock && conn->sock == sock))
1348 /* We won't listen for this connection anymore */
1349 silc_schedule_unset_listen_fd(client->schedule, sock->sock);
1351 /* Unregister all tasks */
1352 silc_schedule_task_del_by_fd(client->schedule, sock->sock);
1353 silc_schedule_task_del_by_fd(client->schedule, sock->sock);
1355 /* Close the actual connection */
1356 silc_net_close_connection(sock->sock);
1358 /* Cancel any active protocol */
1359 if (sock->protocol) {
1360 if (sock->protocol->protocol->type ==
1361 SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1362 sock->protocol->protocol->type ==
1363 SILC_PROTOCOL_CLIENT_CONNECTION_AUTH) {
1364 sock->protocol->state = SILC_PROTOCOL_STATE_ERROR;
1365 silc_protocol_execute_final(sock->protocol, client->schedule);
1366 /* The application will recall this function with these protocols
1367 (the ops->connect client operation). */
1370 sock->protocol->state = SILC_PROTOCOL_STATE_ERROR;
1371 silc_protocol_execute_final(sock->protocol, client->schedule);
1372 sock->protocol = NULL;
1376 /* Free everything */
1377 if (del && sock->user_data) {
1378 /* Free all cache entries */
1379 SilcIDCacheList list;
1380 SilcIDCacheEntry entry;
1381 SilcClientCommandPending *r;
1384 if (silc_idcache_get_all(conn->client_cache, &list)) {
1385 ret = silc_idcache_list_first(list, &entry);
1387 silc_client_del_client(client, conn, entry->context);
1388 ret = silc_idcache_list_next(list, &entry);
1390 silc_idcache_list_free(list);
1393 if (silc_idcache_get_all(conn->channel_cache, &list)) {
1394 ret = silc_idcache_list_first(list, &entry);
1396 silc_client_del_channel(client, conn, entry->context);
1397 ret = silc_idcache_list_next(list, &entry);
1399 silc_idcache_list_free(list);
1402 if (silc_idcache_get_all(conn->server_cache, &list)) {
1403 ret = silc_idcache_list_first(list, &entry);
1405 silc_client_del_server(client, conn, entry->context);
1406 ret = silc_idcache_list_next(list, &entry);
1408 silc_idcache_list_free(list);
1411 /* Clear ID caches */
1412 if (conn->client_cache)
1413 silc_idcache_free(conn->client_cache);
1414 if (conn->channel_cache)
1415 silc_idcache_free(conn->channel_cache);
1416 if (conn->server_cache)
1417 silc_idcache_free(conn->server_cache);
1419 /* Free data (my ID is freed in above silc_client_del_client).
1420 conn->nickname is freed when freeing the local_entry->nickname. */
1421 if (conn->remote_host)
1422 silc_free(conn->remote_host);
1423 if (conn->local_id_data)
1424 silc_free(conn->local_id_data);
1426 silc_cipher_free(conn->send_key);
1427 if (conn->receive_key)
1428 silc_cipher_free(conn->receive_key);
1429 if (conn->hmac_send)
1430 silc_hmac_free(conn->hmac_send);
1431 if (conn->hmac_receive)
1432 silc_hmac_free(conn->hmac_receive);
1434 silc_free(conn->rekey);
1436 if (conn->active_session) {
1437 sock->user_data = NULL;
1438 silc_client_ftp_session_free(conn->active_session);
1439 conn->active_session = NULL;
1442 silc_client_ftp_free_sessions(client, conn);
1444 silc_dlist_start(conn->pending_commands);
1445 while ((r = silc_dlist_get(conn->pending_commands)) != SILC_LIST_END)
1446 silc_dlist_del(conn->pending_commands, r);
1447 if (conn->pending_commands)
1448 silc_dlist_uninit(conn->pending_commands);
1450 memset(conn, 0, sizeof(*conn));
1451 silc_client_del_connection(client, conn);
1454 silc_socket_free(sock);
1457 /* Closes the connection to the remote end */
1459 void silc_client_close_connection(SilcClient client,
1460 SilcClientConnection conn)
1462 silc_client_close_connection_real(client, NULL, conn);
1465 /* Called when we receive disconnection packet from server. This
1466 closes our end properly and displays the reason of the disconnection
1469 SILC_TASK_CALLBACK(silc_client_disconnected_by_server_later)
1471 SilcClient client = (SilcClient)context;
1472 SilcSocketConnection sock;
1474 SILC_CLIENT_GET_SOCK(client, fd, sock);
1478 silc_client_close_connection_real(client, sock, sock->user_data);
1481 /* Called when we receive disconnection packet from server. This
1482 closes our end properly and displays the reason of the disconnection
1485 void silc_client_disconnected_by_server(SilcClient client,
1486 SilcSocketConnection sock,
1490 char *message = NULL;
1492 SILC_LOG_DEBUG(("Server disconnected us, sock %d", sock->sock));
1494 if (packet->len < 1)
1497 status = (SilcStatus)packet->data[0];
1499 if (packet->len > 1 &&
1500 silc_utf8_valid(packet->data + 1, packet->len - 1))
1501 message = silc_memdup(packet->data + 1, packet->len - 1);
1503 client->internal->ops->say(client, sock->user_data,
1504 SILC_CLIENT_MESSAGE_AUDIT,
1505 "Server closed connection: %s (%d) %s",
1506 silc_get_status_message(status), status,
1507 message ? message : "");
1510 SILC_SET_DISCONNECTED(sock);
1512 /* Close connection through scheduler. */
1513 silc_schedule_task_add(client->schedule, sock->sock,
1514 silc_client_disconnected_by_server_later,
1515 client, 0, 1, SILC_TASK_TIMEOUT,
1516 SILC_TASK_PRI_NORMAL);
1519 /* Received error message from server. Display it on the screen.
1520 We don't take any action what so ever of the error message. */
1522 void silc_client_error_by_server(SilcClient client,
1523 SilcSocketConnection sock,
1528 msg = silc_memdup(message->data, message->len);
1529 client->internal->ops->say(client, sock->user_data,
1530 SILC_CLIENT_MESSAGE_AUDIT, msg);
1534 /* Auto-nicking callback to send NICK command to server. */
1536 SILC_TASK_CALLBACK(silc_client_send_auto_nick)
1538 SilcClientConnection conn = (SilcClientConnection)context;
1539 SilcClient client = conn->client;
1541 silc_client_command_send(client, conn, SILC_COMMAND_NICK,
1542 ++conn->cmd_ident, 1, 1,
1543 client->nickname, strlen(client->nickname));
1546 /* Client session resuming callback. If the session was resumed
1547 this callback is called after the resuming is completed. This
1548 will call the `connect' client operation to the application
1549 since it has not been called yet. */
1551 static void silc_client_resume_session_cb(SilcClient client,
1552 SilcClientConnection conn,
1558 /* Notify application that connection is created to server */
1559 client->internal->ops->connect(client, conn, success ?
1560 SILC_CLIENT_CONN_SUCCESS_RESUME :
1561 SILC_CLIENT_CONN_ERROR);
1564 /* Issue INFO command to fetch the real server name and server
1565 information and other stuff. */
1566 silc_client_command_register(client, SILC_COMMAND_INFO, NULL, NULL,
1567 silc_client_command_reply_info_i, 0,
1569 sidp = silc_id_payload_encode(conn->remote_id, SILC_ID_SERVER);
1570 silc_client_command_send(client, conn, SILC_COMMAND_INFO,
1571 conn->cmd_ident, 1, 2, sidp->data, sidp->len);
1572 silc_buffer_free(sidp);
1576 /* Processes the received new Client ID from server. Old Client ID is
1577 deleted from cache and new one is added. */
1579 void silc_client_receive_new_id(SilcClient client,
1580 SilcSocketConnection sock,
1583 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1584 int connecting = FALSE;
1585 SilcClientID *client_id = silc_id_payload_get_id(idp);
1587 if (!conn->local_entry)
1590 /* Delete old ID from ID cache */
1591 if (conn->local_id) {
1592 /* Check whether they are different */
1593 if (SILC_ID_CLIENT_COMPARE(conn->local_id, client_id)) {
1594 silc_free(client_id);
1598 silc_idcache_del_by_context(conn->client_cache, conn->local_entry);
1599 silc_free(conn->local_id);
1602 /* Save the new ID */
1604 if (conn->local_id_data)
1605 silc_free(conn->local_id_data);
1607 conn->local_id = client_id;
1608 conn->local_id_data = silc_id_payload_get_data(idp);
1609 conn->local_id_data_len = silc_id_payload_get_len(idp);;
1611 if (!conn->local_entry)
1612 conn->local_entry = silc_calloc(1, sizeof(*conn->local_entry));
1614 conn->local_entry->nickname = conn->nickname;
1615 if (!conn->local_entry->username)
1616 conn->local_entry->username = strdup(client->username);
1617 if (!conn->local_entry->hostname)
1618 conn->local_entry->hostname = strdup(client->hostname);
1619 if (!conn->local_entry->server)
1620 conn->local_entry->server = strdup(conn->remote_host);
1621 conn->local_entry->id = conn->local_id;
1622 conn->local_entry->valid = TRUE;
1623 if (!conn->local_entry->channels)
1624 conn->local_entry->channels = silc_hash_table_alloc(1, silc_hash_ptr,
1629 /* Put it to the ID cache */
1630 silc_idcache_add(conn->client_cache, strdup(conn->nickname), conn->local_id,
1631 (void *)conn->local_entry, 0, NULL);
1634 if (!conn->params.detach_data) {
1637 /* Send NICK command if the nickname was set by the application (and is
1638 not same as the username). Send this with little timeout. */
1639 if (client->nickname && strcmp(client->nickname, client->username))
1640 silc_schedule_task_add(client->schedule, 0,
1641 silc_client_send_auto_nick, conn,
1642 1, 0, SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
1644 /* Notify application of successful connection. We do it here now that
1645 we've received the Client ID and are allowed to send traffic. */
1646 client->internal->ops->connect(client, conn, SILC_CLIENT_CONN_SUCCESS);
1648 /* Issue INFO command to fetch the real server name and server
1649 information and other stuff. */
1650 silc_client_command_register(client, SILC_COMMAND_INFO, NULL, NULL,
1651 silc_client_command_reply_info_i, 0,
1653 sidp = silc_id_payload_encode(conn->remote_id, SILC_ID_SERVER);
1654 silc_client_command_send(client, conn, SILC_COMMAND_INFO,
1655 conn->cmd_ident, 1, 2, sidp->data, sidp->len);
1656 silc_buffer_free(sidp);
1658 /* We are resuming session. Start resolving informations from the
1659 server we need to set the client libary in the state before
1660 detaching the session. The connect client operation is called
1661 after this is successfully completed */
1662 silc_client_resume_session(client, conn, silc_client_resume_session_cb,
1668 /* Removes a client entry from all channels it has joined. */
1670 void silc_client_remove_from_channels(SilcClient client,
1671 SilcClientConnection conn,
1672 SilcClientEntry client_entry)
1674 SilcHashTableList htl;
1675 SilcChannelUser chu;
1677 silc_hash_table_list(client_entry->channels, &htl);
1678 while (silc_hash_table_get(&htl, NULL, (void **)&chu)) {
1679 silc_hash_table_del(chu->client->channels, chu->channel);
1680 silc_hash_table_del(chu->channel->user_list, chu->client);
1684 silc_hash_table_list_reset(&htl);
1687 /* Replaces `old' client entries from all channels to `new' client entry.
1688 This can be called for example when nickname changes and old ID entry
1689 is replaced from ID cache with the new one. If the old ID entry is only
1690 updated, then this fucntion needs not to be called. */
1692 void silc_client_replace_from_channels(SilcClient client,
1693 SilcClientConnection conn,
1694 SilcClientEntry old,
1695 SilcClientEntry new)
1697 SilcHashTableList htl;
1698 SilcChannelUser chu;
1700 silc_hash_table_list(old->channels, &htl);
1701 while (silc_hash_table_get(&htl, NULL, (void **)&chu)) {
1702 /* Replace client entry */
1703 silc_hash_table_del(chu->client->channels, chu->channel);
1704 silc_hash_table_del(chu->channel->user_list, chu->client);
1707 silc_hash_table_add(chu->channel->user_list, chu->client, chu);
1708 silc_hash_table_add(chu->client->channels, chu->channel, chu);
1710 silc_hash_table_list_reset(&htl);
1713 /* Registers failure timeout to process the received failure packet
1716 void silc_client_process_failure(SilcClient client,
1717 SilcSocketConnection sock,
1718 SilcPacketContext *packet)
1720 SilcUInt32 failure = 0;
1722 if (sock->protocol) {
1723 if (packet->buffer->len >= 4)
1724 SILC_GET32_MSB(failure, packet->buffer->data);
1726 /* Notify application */
1727 client->internal->ops->failure(client, sock->user_data, sock->protocol,
1732 /* A timeout callback for the re-key. We will be the initiator of the
1735 SILC_TASK_CALLBACK(silc_client_rekey_callback)
1737 SilcSocketConnection sock = (SilcSocketConnection)context;
1738 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1739 SilcClient client = (SilcClient)conn->rekey->context;
1740 SilcProtocol protocol;
1741 SilcClientRekeyInternalContext *proto_ctx;
1743 SILC_LOG_DEBUG(("Start"));
1745 /* Allocate internal protocol context. This is sent as context
1747 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
1748 proto_ctx->client = (void *)client;
1749 proto_ctx->sock = silc_socket_dup(sock);
1750 proto_ctx->responder = FALSE;
1751 proto_ctx->pfs = conn->rekey->pfs;
1753 /* Perform rekey protocol. Will call the final callback after the
1754 protocol is over. */
1755 silc_protocol_alloc(SILC_PROTOCOL_CLIENT_REKEY,
1756 &protocol, proto_ctx, silc_client_rekey_final);
1757 sock->protocol = protocol;
1759 /* Run the protocol */
1760 silc_protocol_execute(protocol, client->schedule, 0, 0);
1762 /* Re-register re-key timeout */
1763 silc_schedule_task_add(client->schedule, sock->sock,
1764 silc_client_rekey_callback,
1765 context, conn->rekey->timeout, 0,
1766 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
1769 /* The final callback for the REKEY protocol. This will actually take the
1770 new key material into use. */
1772 SILC_TASK_CALLBACK(silc_client_rekey_final)
1774 SilcProtocol protocol = (SilcProtocol)context;
1775 SilcClientRekeyInternalContext *ctx =
1776 (SilcClientRekeyInternalContext *)protocol->context;
1777 SilcClient client = (SilcClient)ctx->client;
1778 SilcSocketConnection sock = ctx->sock;
1780 SILC_LOG_DEBUG(("Start"));
1782 if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
1783 protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
1784 /* Error occured during protocol */
1785 silc_protocol_cancel(protocol, client->schedule);
1786 silc_protocol_free(protocol);
1787 sock->protocol = NULL;
1789 silc_packet_context_free(ctx->packet);
1791 silc_ske_free(ctx->ske);
1792 silc_socket_free(ctx->sock);
1797 /* Purge the outgoing data queue to assure that all rekey packets really
1798 go to the network before we quit the protocol. */
1799 silc_client_packet_queue_purge(client, sock);
1802 silc_protocol_free(protocol);
1803 sock->protocol = NULL;
1805 silc_packet_context_free(ctx->packet);
1807 silc_ske_free(ctx->ske);
1808 silc_socket_free(ctx->sock);
1812 /* Processes incoming connection authentication method request packet.
1813 It is a reply to our previously sent request. The packet can be used
1814 to resolve the authentication method for the current session if the
1815 client does not know it beforehand. */
1817 void silc_client_connection_auth_request(SilcClient client,
1818 SilcSocketConnection sock,
1819 SilcPacketContext *packet)
1821 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1822 SilcUInt16 conn_type, auth_meth;
1825 /* If we haven't send our request then ignore this one. */
1826 if (!conn->connauth)
1829 /* Parse the payload */
1830 ret = silc_buffer_unformat(packet->buffer,
1831 SILC_STR_UI_SHORT(&conn_type),
1832 SILC_STR_UI_SHORT(&auth_meth),
1835 auth_meth = SILC_AUTH_NONE;
1837 /* Call the request callback to notify application for received
1838 authentication method information. */
1839 if (conn->connauth->callback)
1840 (*conn->connauth->callback)(client, conn, auth_meth,
1841 conn->connauth->context);
1843 silc_schedule_task_del(client->schedule, conn->connauth->timeout);
1845 silc_free(conn->connauth);
1846 conn->connauth = NULL;
1849 /* Timeout task callback called if the server does not reply to our
1850 connection authentication method request in the specified time interval. */
1852 SILC_TASK_CALLBACK(silc_client_request_authentication_method_timeout)
1854 SilcClientConnection conn = (SilcClientConnection)context;
1855 SilcClient client = conn->client;
1857 if (!conn->connauth)
1860 /* Call the request callback to notify application */
1861 if (conn->connauth->callback)
1862 (*conn->connauth->callback)(client, conn, SILC_AUTH_NONE,
1863 conn->connauth->context);
1865 silc_free(conn->connauth);
1866 conn->connauth = NULL;
1869 /* This function can be used to request the current authentication method
1870 from the server. This may be called when connecting to the server
1871 and the client library requests the authentication data from the
1872 application. If the application does not know the current authentication
1873 method it can request it from the server using this function.
1874 The `callback' with `context' will be called after the server has
1875 replied back with the current authentication method. */
1878 silc_client_request_authentication_method(SilcClient client,
1879 SilcClientConnection conn,
1880 SilcConnectionAuthRequest callback,
1883 SilcClientConnAuthRequest connauth;
1886 connauth = silc_calloc(1, sizeof(*connauth));
1887 connauth->callback = callback;
1888 connauth->context = context;
1891 silc_free(conn->connauth);
1893 conn->connauth = connauth;
1895 /* Assemble the request packet and send it to the server */
1896 packet = silc_buffer_alloc(4);
1897 silc_buffer_pull_tail(packet, SILC_BUFFER_END(packet));
1898 silc_buffer_format(packet,
1899 SILC_STR_UI_SHORT(SILC_SOCKET_TYPE_CLIENT),
1900 SILC_STR_UI_SHORT(SILC_AUTH_NONE),
1902 silc_client_packet_send(client, conn->sock,
1903 SILC_PACKET_CONNECTION_AUTH_REQUEST,
1904 NULL, 0, NULL, NULL,
1905 packet->data, packet->len, FALSE);
1906 silc_buffer_free(packet);
1908 /* Register a timeout in case server does not reply anything back. */
1910 silc_schedule_task_add(client->schedule, conn->sock->sock,
1911 silc_client_request_authentication_method_timeout,
1913 client->internal->params->connauth_request_secs, 0,
1914 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);