5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2003 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);
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,
591 SILC_CLIENT_CONN_ERROR);
595 /* Start of the connection to the remote server. This is called after
596 succesful TCP/IP connection has been established to the remote host. */
598 SILC_TASK_CALLBACK(silc_client_connect_to_server_start)
600 SilcClientInternalConnectContext *ctx =
601 (SilcClientInternalConnectContext *)context;
602 SilcClient client = ctx->client;
603 SilcClientConnection conn = ctx->conn;
604 int opt, opt_len = sizeof(opt);
606 SILC_LOG_DEBUG(("Start"));
608 /* Check the socket status as it might be in error */
609 silc_net_get_socket_opt(fd, SOL_SOCKET, SO_ERROR, &opt, &opt_len);
611 if (ctx->tries < 2) {
612 /* Connection failed but lets try again */
613 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
614 "Could not connect to server %s: %s",
615 ctx->host, strerror(opt));
616 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_AUDIT,
617 "Connecting to port %d of server %s resumed",
618 ctx->port, ctx->host);
620 /* Unregister old connection try */
621 silc_schedule_unset_listen_fd(client->schedule, fd);
622 silc_net_close_connection(fd);
623 silc_schedule_task_del(client->schedule, ctx->task);
626 silc_client_connect_to_server_internal(ctx);
629 /* Connection failed and we won't try anymore */
630 client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
631 "Could not connect to server %s: %s",
632 ctx->host, strerror(opt));
633 silc_schedule_unset_listen_fd(client->schedule, fd);
634 silc_net_close_connection(fd);
635 silc_schedule_task_del(client->schedule, ctx->task);
638 /* Notify application of failure */
639 client->internal->ops->connected(client, conn, SILC_CLIENT_CONN_ERROR);
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"));
794 if (conn->internal->params.detach_data) {
795 /* Send RESUME_CLIENT packet to the server, which is used to resume
796 old detached session back. */
798 SilcClientID *old_client_id;
799 unsigned char *old_id;
800 SilcUInt16 old_id_len;
802 if (!silc_client_process_detach_data(client, conn, &old_id, &old_id_len))
805 old_client_id = silc_id_str2id(old_id, old_id_len, SILC_ID_CLIENT);
806 if (!old_client_id) {
811 /* Generate authentication data that server will verify */
812 auth = silc_auth_public_key_auth_generate(client->public_key,
815 conn->internal->hash,
816 old_client_id, SILC_ID_CLIENT);
818 silc_free(old_client_id);
823 packet = silc_buffer_alloc_size(2 + old_id_len + auth->len);
824 silc_buffer_format(packet,
825 SILC_STR_UI_SHORT(old_id_len),
826 SILC_STR_UI_XNSTRING(old_id, old_id_len),
827 SILC_STR_UI_XNSTRING(auth->data, auth->len),
830 /* Send the packet */
831 silc_client_packet_send(client, ctx->sock, SILC_PACKET_RESUME_CLIENT,
833 packet->data, packet->len, TRUE);
834 silc_buffer_free(packet);
835 silc_buffer_free(auth);
836 silc_free(old_client_id);
839 /* Send NEW_CLIENT packet to the server. We will become registered
840 to the SILC network after sending this packet and we will receive
841 client ID from the server. */
842 packet = silc_buffer_alloc(2 + 2 + strlen(client->username) +
843 strlen(client->realname));
844 silc_buffer_pull_tail(packet, SILC_BUFFER_END(packet));
845 silc_buffer_format(packet,
846 SILC_STR_UI_SHORT(strlen(client->username)),
847 SILC_STR_UI_XNSTRING(client->username,
848 strlen(client->username)),
849 SILC_STR_UI_SHORT(strlen(client->realname)),
850 SILC_STR_UI_XNSTRING(client->realname,
851 strlen(client->realname)),
854 /* Send the packet */
855 silc_client_packet_send(client, ctx->sock, SILC_PACKET_NEW_CLIENT,
857 packet->data, packet->len, TRUE);
858 silc_buffer_free(packet);
861 /* Save remote ID. */
862 conn->remote_id = ctx->dest_id;
863 conn->remote_id_data = silc_id_id2str(ctx->dest_id, SILC_ID_SERVER);
864 conn->remote_id_data_len = silc_id_get_len(ctx->dest_id, SILC_ID_SERVER);
866 /* Register re-key timeout */
867 conn->internal->rekey->timeout = client->internal->params->rekey_secs;
868 conn->internal->rekey->context = (void *)client;
869 silc_schedule_task_add(client->schedule, conn->sock->sock,
870 silc_client_rekey_callback,
871 (void *)conn->sock, conn->internal->rekey->timeout, 0,
872 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
874 silc_protocol_free(protocol);
875 silc_free(ctx->auth_data);
877 silc_ske_free(ctx->ske);
878 silc_socket_free(ctx->sock);
880 conn->sock->protocol = NULL;
884 silc_protocol_free(protocol);
885 silc_free(ctx->auth_data);
886 silc_free(ctx->dest_id);
888 silc_ske_free(ctx->ske);
889 conn->sock->protocol = NULL;
890 silc_socket_free(ctx->sock);
892 /* Notify application of failure */
893 silc_schedule_task_add(client->schedule, ctx->sock->sock,
894 silc_client_connect_failure_auth, ctx,
895 0, 1, SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
898 /* Internal routine that sends packet or marks packet to be sent. This
899 is used directly only in special cases. Normal cases should use
900 silc_server_packet_send. Returns < 0 on error. */
902 int silc_client_packet_send_real(SilcClient client,
903 SilcSocketConnection sock,
908 /* If rekey protocol is active we must assure that all packets are
909 sent through packet queue. */
910 if (SILC_CLIENT_IS_REKEY(sock))
913 /* If outbound data is already pending do not force send */
914 if (SILC_IS_OUTBUF_PENDING(sock))
917 /* Send the packet */
918 ret = silc_packet_send(sock, force_send);
922 /* Mark that there is some outgoing data available for this connection.
923 This call sets the connection both for input and output (the input
924 is set always and this call keeps the input setting, actually).
925 Actual data sending is performed by silc_client_packet_process. */
926 SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(client->schedule, sock->sock);
928 /* Mark to socket that data is pending in outgoing buffer. This flag
929 is needed if new data is added to the buffer before the earlier
930 put data is sent to the network. */
931 SILC_SET_OUTBUF_PENDING(sock);
936 /* Packet processing callback. This is used to send and receive packets
937 from network. This is generic task. */
939 SILC_TASK_CALLBACK_GLOBAL(silc_client_packet_process)
941 SilcClient client = (SilcClient)context;
942 SilcSocketConnection sock = NULL;
943 SilcClientConnection conn;
946 SILC_LOG_DEBUG(("Processing packet"));
948 SILC_CLIENT_GET_SOCK(client, fd, sock);
952 conn = (SilcClientConnection)sock->user_data;
955 if (type == SILC_TASK_WRITE) {
956 /* Do not send data to disconnected connection */
957 if (SILC_IS_DISCONNECTED(sock))
960 ret = silc_packet_send(sock, TRUE);
962 /* If returned -2 could not write to connection now, will do
971 /* The packet has been sent and now it is time to set the connection
972 back to only for input. When there is again some outgoing data
973 available for this connection it will be set for output as well.
974 This call clears the output setting and sets it only for input. */
975 SILC_CLIENT_SET_CONNECTION_FOR_INPUT(client->schedule, fd);
976 SILC_UNSET_OUTBUF_PENDING(sock);
978 silc_buffer_clear(sock->outbuf);
982 /* Packet receiving */
983 if (type == SILC_TASK_READ) {
984 /* Read data from network */
985 ret = silc_packet_receive(sock);
991 SILC_LOG_DEBUG(("Read EOF"));
993 /* If connection is disconnecting already we will finally
994 close the connection */
995 if (SILC_IS_DISCONNECTING(sock)) {
996 if (sock == conn->sock && sock->type != SILC_SOCKET_TYPE_CLIENT)
997 client->internal->ops->disconnected(client, conn, 0, NULL);
998 silc_client_close_connection_real(client, sock, conn);
1002 SILC_LOG_DEBUG(("EOF from connection %d", sock->sock));
1003 if (sock == conn->sock && sock->type != SILC_SOCKET_TYPE_CLIENT)
1004 client->internal->ops->disconnected(client, conn, 0, NULL);
1005 silc_client_close_connection_real(client, sock, conn);
1009 /* Process the packet. This will call the parser that will then
1010 decrypt and parse the packet. */
1011 if (sock->type != SILC_SOCKET_TYPE_UNKNOWN)
1012 silc_packet_receive_process(sock, FALSE, conn->internal->receive_key,
1013 conn->internal->hmac_receive,
1014 conn->internal->psn_receive,
1015 silc_client_packet_parse, client);
1017 silc_packet_receive_process(sock, FALSE, NULL, NULL, 0,
1018 silc_client_packet_parse, client);
1022 /* Parser callback called by silc_packet_receive_process. Thie merely
1023 registers timeout that will handle the actual parsing when appropriate. */
1025 static bool silc_client_packet_parse(SilcPacketParserContext *parser_context,
1028 SilcClient client = (SilcClient)context;
1029 SilcSocketConnection sock = parser_context->sock;
1030 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1031 SilcPacketContext *packet = parser_context->packet;
1034 if (conn && conn->internal->hmac_receive && conn->sock == sock)
1035 conn->internal->psn_receive = parser_context->packet->sequence + 1;
1037 /* Parse the packet immediately */
1038 if (parser_context->normal)
1039 ret = silc_packet_parse(packet, conn->internal->receive_key);
1041 ret = silc_packet_parse_special(packet, conn->internal->receive_key);
1043 if (ret == SILC_PACKET_NONE) {
1044 silc_packet_context_free(packet);
1045 silc_free(parser_context);
1049 /* If protocol for this connection is key exchange or rekey then we'll
1050 process all packets synchronously, since there might be packets in
1051 queue that we are not able to decrypt without first processing the
1052 packets before them. */
1053 if (sock->protocol && sock->protocol->protocol &&
1054 (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1055 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)) {
1057 /* Parse the incoming packet type */
1058 silc_client_packet_parse_type(client, sock, packet);
1059 silc_packet_context_free(packet);
1060 silc_free(parser_context);
1062 /* Reprocess the buffer since we'll return FALSE. This is because
1063 the `conn->internal->receive_key' might have become valid by processing
1064 the previous packet */
1065 if (sock->type != SILC_SOCKET_TYPE_UNKNOWN)
1066 silc_packet_receive_process(sock, FALSE, conn->internal->receive_key,
1067 conn->internal->hmac_receive,
1068 conn->internal->psn_receive,
1069 silc_client_packet_parse, client);
1071 silc_packet_receive_process(sock, FALSE, NULL, NULL, 0,
1072 silc_client_packet_parse, client);
1077 /* Parse the incoming packet type */
1078 silc_client_packet_parse_type(client, sock, packet);
1079 silc_packet_context_free(packet);
1080 silc_free(parser_context);
1084 /* Parses the packet type and calls what ever routines the packet type
1085 requires. This is done for all incoming packets. */
1087 void silc_client_packet_parse_type(SilcClient client,
1088 SilcSocketConnection sock,
1089 SilcPacketContext *packet)
1091 SilcBuffer buffer = packet->buffer;
1092 SilcPacketType type = packet->type;
1094 SILC_LOG_DEBUG(("Parsing %s packet", silc_get_packet_name(type)));
1096 /* Parse the packet type */
1099 case SILC_PACKET_DISCONNECT:
1100 silc_client_disconnected_by_server(client, sock, buffer);
1103 case SILC_PACKET_SUCCESS:
1105 * Success received for something. For now we can have only
1106 * one protocol for connection executing at once hence this
1107 * success message is for whatever protocol is executing currently.
1110 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1113 case SILC_PACKET_FAILURE:
1115 * Failure received for some protocol. Set the protocol state to
1116 * error and call the protocol callback. This fill cause error on
1117 * protocol and it will call the final callback.
1119 silc_client_process_failure(client, sock, packet);
1122 case SILC_PACKET_REJECT:
1125 case SILC_PACKET_NOTIFY:
1127 * Received notify message
1129 silc_client_notify_by_server(client, sock, packet);
1132 case SILC_PACKET_ERROR:
1134 * Received error message
1136 silc_client_error_by_server(client, sock, buffer);
1139 case SILC_PACKET_CHANNEL_MESSAGE:
1141 * Received message to (from, actually) a channel
1143 silc_client_channel_message(client, sock, packet);
1146 case SILC_PACKET_CHANNEL_KEY:
1148 * Received key for a channel. By receiving this key the client will be
1149 * able to talk to the channel it has just joined. This can also be
1150 * a new key for existing channel as keys expire peridiocally.
1152 silc_client_receive_channel_key(client, sock, buffer);
1155 case SILC_PACKET_PRIVATE_MESSAGE:
1157 * Received private message
1159 silc_client_private_message(client, sock, packet);
1162 case SILC_PACKET_PRIVATE_MESSAGE_KEY:
1164 * Received private message key
1168 case SILC_PACKET_COMMAND:
1170 * Received command packet, a special case since normally client
1171 * does not receive commands.
1173 silc_client_command_process(client, sock, packet);
1176 case SILC_PACKET_COMMAND_REPLY:
1178 * Recived reply for a command
1180 silc_client_command_reply_process(client, sock, packet);
1183 case SILC_PACKET_KEY_EXCHANGE:
1184 if (sock->protocol && sock->protocol->protocol &&
1185 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE) {
1186 SilcClientKEInternalContext *proto_ctx =
1187 (SilcClientKEInternalContext *)sock->protocol->context;
1189 proto_ctx->packet = silc_packet_context_dup(packet);
1190 proto_ctx->dest_id_type = packet->src_id_type;
1191 proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
1192 packet->src_id_type);
1193 if (!proto_ctx->dest_id)
1196 /* Let the protocol handle the packet */
1197 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1199 SILC_LOG_ERROR(("Received Key Exchange packet but no key exchange "
1200 "protocol active, packet dropped."));
1204 case SILC_PACKET_KEY_EXCHANGE_1:
1205 if (sock->protocol && sock->protocol->protocol &&
1206 (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1207 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)) {
1209 if (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1210 SilcClientRekeyInternalContext *proto_ctx =
1211 (SilcClientRekeyInternalContext *)sock->protocol->context;
1213 if (proto_ctx->packet)
1214 silc_packet_context_free(proto_ctx->packet);
1216 proto_ctx->packet = silc_packet_context_dup(packet);
1218 /* Let the protocol handle the packet */
1219 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1221 SilcClientKEInternalContext *proto_ctx =
1222 (SilcClientKEInternalContext *)sock->protocol->context;
1224 if (proto_ctx->packet)
1225 silc_packet_context_free(proto_ctx->packet);
1227 proto_ctx->packet = silc_packet_context_dup(packet);
1228 proto_ctx->dest_id_type = packet->src_id_type;
1229 proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
1230 packet->src_id_type);
1231 if (!proto_ctx->dest_id)
1234 /* Let the protocol handle the packet */
1235 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1238 SILC_LOG_ERROR(("Received Key Exchange 1 packet but no key exchange "
1239 "protocol active, packet dropped."));
1243 case SILC_PACKET_KEY_EXCHANGE_2:
1244 if (sock->protocol && sock->protocol->protocol &&
1245 (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1246 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)) {
1248 if (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1249 SilcClientRekeyInternalContext *proto_ctx =
1250 (SilcClientRekeyInternalContext *)sock->protocol->context;
1252 if (proto_ctx->packet)
1253 silc_packet_context_free(proto_ctx->packet);
1255 proto_ctx->packet = silc_packet_context_dup(packet);
1257 /* Let the protocol handle the packet */
1258 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1260 SilcClientKEInternalContext *proto_ctx =
1261 (SilcClientKEInternalContext *)sock->protocol->context;
1263 if (proto_ctx->packet)
1264 silc_packet_context_free(proto_ctx->packet);
1265 if (proto_ctx->dest_id)
1266 silc_free(proto_ctx->dest_id);
1267 proto_ctx->packet = silc_packet_context_dup(packet);
1268 proto_ctx->dest_id_type = packet->src_id_type;
1269 proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
1270 packet->src_id_type);
1271 if (!proto_ctx->dest_id)
1274 /* Let the protocol handle the packet */
1275 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1278 SILC_LOG_ERROR(("Received Key Exchange 2 packet but no key exchange "
1279 "protocol active, packet dropped."));
1283 case SILC_PACKET_NEW_ID:
1286 * Received new ID from server. This packet is received at
1287 * the connection to the server. New ID is also received when
1288 * user changes nickname but in that case the new ID is received
1289 * as command reply and not as this packet type.
1293 idp = silc_id_payload_parse(buffer->data, buffer->len);
1296 if (silc_id_payload_get_type(idp) != SILC_ID_CLIENT)
1299 silc_client_receive_new_id(client, sock, idp);
1300 silc_id_payload_free(idp);
1304 case SILC_PACKET_HEARTBEAT:
1306 * Received heartbeat packet
1308 SILC_LOG_DEBUG(("Heartbeat packet"));
1311 case SILC_PACKET_KEY_AGREEMENT:
1313 * Received key agreement packet
1315 SILC_LOG_DEBUG(("Key agreement packet"));
1316 silc_client_key_agreement(client, sock, packet);
1319 case SILC_PACKET_REKEY:
1320 SILC_LOG_DEBUG(("Re-key packet"));
1321 /* We ignore this for now */
1324 case SILC_PACKET_REKEY_DONE:
1325 SILC_LOG_DEBUG(("Re-key done packet"));
1327 if (sock->protocol && sock->protocol->protocol &&
1328 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1330 SilcClientRekeyInternalContext *proto_ctx =
1331 (SilcClientRekeyInternalContext *)sock->protocol->context;
1333 if (proto_ctx->packet)
1334 silc_packet_context_free(proto_ctx->packet);
1336 proto_ctx->packet = silc_packet_context_dup(packet);
1338 /* Let the protocol handle the packet */
1339 if (proto_ctx->responder == FALSE)
1340 silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1342 /* Let the protocol handle the packet */
1343 silc_protocol_execute(sock->protocol, client->schedule,
1346 SILC_LOG_ERROR(("Received Re-key done packet but no re-key "
1347 "protocol active, packet dropped."));
1351 case SILC_PACKET_CONNECTION_AUTH_REQUEST:
1353 * Reveived reply to our connection authentication method request
1354 * packet. This is used to resolve the authentication method for the
1355 * current session from the server if the client does not know it.
1357 silc_client_connection_auth_request(client, sock, packet);
1360 case SILC_PACKET_FTP:
1361 /* Received file transfer packet. */
1362 silc_client_ftp(client, sock, packet);
1366 SILC_LOG_DEBUG(("Incorrect packet type %d, packet dropped", type));
1371 /* Sends packet. This doesn't actually send the packet instead it assembles
1372 it and marks it to be sent. However, if force_send is TRUE the packet
1373 is sent immediately. if dst_id, cipher and hmac are NULL those parameters
1374 will be derived from sock argument. Otherwise the valid arguments sent
1377 void silc_client_packet_send(SilcClient client,
1378 SilcSocketConnection sock,
1379 SilcPacketType type,
1381 SilcIdType dst_id_type,
1384 unsigned char *data,
1385 SilcUInt32 data_len,
1388 SilcPacketContext packetdata;
1389 const SilcBufferStruct packet;
1391 SilcUInt32 sequence = 0;
1396 SILC_LOG_DEBUG(("Sending packet, type %d", type));
1398 /* Get data used in the packet sending, keys and stuff */
1399 if ((!cipher || !hmac || !dst_id) && sock->user_data) {
1400 if (!cipher && ((SilcClientConnection)sock->user_data)->internal->send_key)
1401 cipher = ((SilcClientConnection)sock->user_data)->internal->send_key;
1403 if (!hmac && ((SilcClientConnection)sock->user_data)->internal->hmac_send)
1404 hmac = ((SilcClientConnection)sock->user_data)->internal->hmac_send;
1406 if (!dst_id && ((SilcClientConnection)sock->user_data)->remote_id) {
1407 dst_id = ((SilcClientConnection)sock->user_data)->remote_id;
1408 dst_id_type = SILC_ID_SERVER;
1412 sequence = ((SilcClientConnection)sock->user_data)->internal->psn_send++;
1414 /* Check for mandatory rekey */
1415 if (sequence == SILC_CLIENT_REKEY_THRESHOLD)
1416 silc_schedule_task_add(client->schedule, sock->sock,
1417 silc_client_rekey_callback, sock, 0, 1,
1418 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
1421 block_len = cipher ? silc_cipher_get_block_len(cipher) : 0;
1423 /* Set the packet context pointers */
1424 packetdata.flags = 0;
1425 packetdata.type = type;
1426 if (sock->user_data &&
1427 ((SilcClientConnection)sock->user_data)->local_id_data) {
1428 packetdata.src_id = ((SilcClientConnection)sock->user_data)->local_id_data;
1429 packetdata.src_id_len =
1430 silc_id_get_len(((SilcClientConnection)sock->user_data)->local_id,
1433 packetdata.src_id = silc_calloc(SILC_ID_CLIENT_LEN, sizeof(unsigned char));
1434 packetdata.src_id_len = SILC_ID_CLIENT_LEN;
1436 packetdata.src_id_type = SILC_ID_CLIENT;
1438 packetdata.dst_id = silc_id_id2str(dst_id, dst_id_type);
1439 packetdata.dst_id_len = silc_id_get_len(dst_id, dst_id_type);
1440 packetdata.dst_id_type = dst_id_type;
1442 packetdata.dst_id = NULL;
1443 packetdata.dst_id_len = 0;
1444 packetdata.dst_id_type = SILC_ID_NONE;
1446 data_len = SILC_PACKET_DATALEN(data_len, (SILC_PACKET_HEADER_LEN +
1447 packetdata.src_id_len +
1448 packetdata.dst_id_len));
1449 packetdata.truelen = data_len + SILC_PACKET_HEADER_LEN +
1450 packetdata.src_id_len + packetdata.dst_id_len;
1451 if (type == SILC_PACKET_CONNECTION_AUTH)
1452 SILC_PACKET_PADLEN_MAX(packetdata.truelen, block_len, packetdata.padlen);
1454 SILC_PACKET_PADLEN(packetdata.truelen, block_len, packetdata.padlen);
1456 /* Create the outgoing packet */
1457 if (!silc_packet_assemble(&packetdata, client->rng, cipher, hmac, sock,
1458 data, data_len, (const SilcBuffer)&packet)) {
1459 SILC_LOG_ERROR(("Error assembling packet"));
1463 /* Encrypt the packet */
1465 silc_packet_encrypt(cipher, hmac, sequence, (SilcBuffer)&packet,
1468 SILC_LOG_HEXDUMP(("Packet (%d), len %d", sequence, packet.len),
1469 packet.data, packet.len);
1471 /* Now actually send the packet */
1472 silc_client_packet_send_real(client, sock, force_send);
1475 /* Packet sending routine for application. This is the only routine that
1476 is provided for application to send SILC packets. */
1478 bool silc_client_send_packet(SilcClient client,
1479 SilcClientConnection conn,
1480 SilcPacketType type,
1481 const unsigned char *data,
1482 SilcUInt32 data_len)
1489 silc_client_packet_send(client, conn->sock, type, NULL, 0, NULL, NULL,
1490 (unsigned char *)data, data_len, TRUE);
1494 void silc_client_packet_queue_purge(SilcClient client,
1495 SilcSocketConnection sock)
1497 if (sock && SILC_IS_OUTBUF_PENDING(sock) &&
1498 (SILC_IS_DISCONNECTED(sock) == FALSE)) {
1499 silc_packet_send(sock, TRUE);
1500 SILC_UNSET_OUTBUF_PENDING(sock);
1501 SILC_CLIENT_SET_CONNECTION_FOR_INPUT(client->schedule, sock->sock);
1502 silc_buffer_clear(sock->outbuf);
1506 /* Closes connection to remote end. Free's all allocated data except
1507 for some information such as nickname etc. that are valid at all time.
1508 If the `sock' is NULL then the conn->sock will be used. If `sock' is
1509 provided it will be checked whether the sock and `conn->sock' are the
1510 same (they can be different, ie. a socket can use `conn' as its
1511 connection but `conn->sock' might be actually a different connection
1512 than the `sock'). */
1514 void silc_client_close_connection_real(SilcClient client,
1515 SilcSocketConnection sock,
1516 SilcClientConnection conn)
1520 SILC_LOG_DEBUG(("Start"));
1525 if (!sock || (sock && conn->sock == sock))
1532 silc_client_del_connection(client, conn);
1536 /* We won't listen for this connection anymore */
1537 silc_schedule_unset_listen_fd(client->schedule, sock->sock);
1539 /* Unregister all tasks */
1540 silc_schedule_task_del_by_fd(client->schedule, sock->sock);
1542 /* Close the actual connection */
1543 silc_net_close_connection(sock->sock);
1545 /* Cancel any active protocol */
1546 if (sock->protocol) {
1547 if (sock->protocol->protocol->type ==
1548 SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1549 sock->protocol->protocol->type ==
1550 SILC_PROTOCOL_CLIENT_CONNECTION_AUTH) {
1551 sock->protocol->state = SILC_PROTOCOL_STATE_ERROR;
1552 silc_protocol_execute_final(sock->protocol, client->schedule);
1553 /* The application will recall this function with these protocols
1554 (the ops->connected client operation). */
1557 sock->protocol->state = SILC_PROTOCOL_STATE_ERROR;
1558 silc_protocol_execute_final(sock->protocol, client->schedule);
1559 sock->protocol = NULL;
1563 /* Free everything */
1564 if (del && sock->user_data)
1565 silc_client_del_connection(client, conn);
1567 silc_socket_free(sock);
1570 /* Closes the connection to the remote end */
1572 void silc_client_close_connection(SilcClient client,
1573 SilcClientConnection conn)
1575 silc_client_close_connection_real(client, NULL, conn);
1578 /* Called when we receive disconnection packet from server. This
1579 closes our end properly and displays the reason of the disconnection
1582 SILC_TASK_CALLBACK(silc_client_disconnected_by_server_later)
1584 SilcClient client = (SilcClient)context;
1585 SilcSocketConnection sock;
1587 SILC_CLIENT_GET_SOCK(client, fd, sock);
1591 silc_client_close_connection_real(client, sock, sock->user_data);
1594 /* Called when we receive disconnection packet from server. This
1595 closes our end properly and displays the reason of the disconnection
1598 void silc_client_disconnected_by_server(SilcClient client,
1599 SilcSocketConnection sock,
1602 SilcClientConnection conn;
1604 char *message = NULL;
1606 SILC_LOG_DEBUG(("Server disconnected us, sock %d", sock->sock));
1608 if (packet->len < 1)
1611 status = (SilcStatus)packet->data[0];
1613 if (packet->len > 1 &&
1614 silc_utf8_valid(packet->data + 1, packet->len - 1))
1615 message = silc_memdup(packet->data + 1, packet->len - 1);
1617 conn = (SilcClientConnection)sock->user_data;
1618 if (sock == conn->sock && sock->type != SILC_SOCKET_TYPE_CLIENT)
1619 client->internal->ops->disconnected(client, conn, status, message);
1623 SILC_SET_DISCONNECTED(sock);
1625 /* Close connection through scheduler. */
1626 silc_schedule_task_add(client->schedule, sock->sock,
1627 silc_client_disconnected_by_server_later,
1628 client, 0, 1, SILC_TASK_TIMEOUT,
1629 SILC_TASK_PRI_NORMAL);
1632 /* Received error message from server. Display it on the screen.
1633 We don't take any action what so ever of the error message. */
1635 void silc_client_error_by_server(SilcClient client,
1636 SilcSocketConnection sock,
1641 msg = silc_memdup(message->data, message->len);
1642 client->internal->ops->say(client, sock->user_data,
1643 SILC_CLIENT_MESSAGE_AUDIT, msg);
1647 /* Auto-nicking callback to send NICK command to server. */
1649 SILC_TASK_CALLBACK(silc_client_send_auto_nick)
1651 SilcClientConnection conn = (SilcClientConnection)context;
1652 SilcClient client = conn->client;
1654 silc_client_command_send(client, conn, SILC_COMMAND_NICK,
1655 ++conn->cmd_ident, 1, 1,
1656 client->nickname, strlen(client->nickname));
1659 /* Client session resuming callback. If the session was resumed
1660 this callback is called after the resuming is completed. This
1661 will call the `connect' client operation to the application
1662 since it has not been called yet. */
1664 static void silc_client_resume_session_cb(SilcClient client,
1665 SilcClientConnection conn,
1671 /* Notify application that connection is created to server */
1672 client->internal->ops->connected(client, conn, success ?
1673 SILC_CLIENT_CONN_SUCCESS_RESUME :
1674 SILC_CLIENT_CONN_ERROR);
1677 /* Issue INFO command to fetch the real server name and server
1678 information and other stuff. */
1679 silc_client_command_register(client, SILC_COMMAND_INFO, NULL, NULL,
1680 silc_client_command_reply_info_i, 0,
1682 sidp = silc_id_payload_encode(conn->remote_id, SILC_ID_SERVER);
1683 silc_client_command_send(client, conn, SILC_COMMAND_INFO,
1684 conn->cmd_ident, 1, 2, sidp->data, sidp->len);
1685 silc_buffer_free(sidp);
1689 /* Processes the received new Client ID from server. Old Client ID is
1690 deleted from cache and new one is added. */
1692 void silc_client_receive_new_id(SilcClient client,
1693 SilcSocketConnection sock,
1696 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1697 int connecting = FALSE;
1698 SilcClientID *client_id = silc_id_payload_get_id(idp);
1700 if (!conn->local_entry)
1703 /* Delete old ID from ID cache */
1704 if (conn->local_id) {
1705 /* Check whether they are different */
1706 if (SILC_ID_CLIENT_COMPARE(conn->local_id, client_id)) {
1707 silc_free(client_id);
1711 silc_idcache_del_by_context(conn->internal->client_cache,
1713 silc_free(conn->local_id);
1716 /* Save the new ID */
1718 if (conn->local_id_data)
1719 silc_free(conn->local_id_data);
1721 conn->local_id = client_id;
1722 conn->local_id_data = silc_id_payload_get_data(idp);
1723 conn->local_id_data_len = silc_id_payload_get_len(idp);;
1725 if (!conn->local_entry)
1726 conn->local_entry = silc_calloc(1, sizeof(*conn->local_entry));
1728 conn->local_entry->nickname = conn->nickname;
1729 if (!conn->local_entry->username)
1730 conn->local_entry->username = strdup(client->username);
1731 if (!conn->local_entry->server)
1732 conn->local_entry->server = strdup(conn->remote_host);
1733 conn->local_entry->id = conn->local_id;
1734 conn->local_entry->valid = TRUE;
1735 if (!conn->local_entry->channels)
1736 conn->local_entry->channels = silc_hash_table_alloc(1, silc_hash_ptr,
1741 /* Put it to the ID cache */
1742 silc_idcache_add(conn->internal->client_cache,
1743 strdup(conn->nickname), conn->local_id,
1744 (void *)conn->local_entry, 0, NULL);
1749 /* Issue IDENTIFY command for itself to get resolved hostname
1750 correctly from server. */
1751 silc_client_command_register(client, SILC_COMMAND_IDENTIFY, NULL, NULL,
1752 silc_client_command_reply_identify_i, 0,
1754 sidp = silc_id_payload_encode(conn->local_entry->id, SILC_ID_CLIENT);
1755 silc_client_command_send(client, conn, SILC_COMMAND_IDENTIFY,
1756 conn->cmd_ident, 1, 5, sidp->data, sidp->len);
1757 silc_buffer_free(sidp);
1759 if (!conn->internal->params.detach_data) {
1760 /* Send NICK command if the nickname was set by the application (and is
1761 not same as the username). Send this with little timeout. */
1762 if (client->nickname && strcmp(client->nickname, client->username))
1763 silc_schedule_task_add(client->schedule, 0,
1764 silc_client_send_auto_nick, conn,
1765 1, 0, SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
1767 /* Notify application of successful connection. We do it here now that
1768 we've received the Client ID and are allowed to send traffic. */
1769 client->internal->ops->connected(client, conn, SILC_CLIENT_CONN_SUCCESS);
1771 /* Issue INFO command to fetch the real server name and server
1772 information and other stuff. */
1773 silc_client_command_register(client, SILC_COMMAND_INFO, NULL, NULL,
1774 silc_client_command_reply_info_i, 0,
1776 sidp = silc_id_payload_encode(conn->remote_id, SILC_ID_SERVER);
1777 silc_client_command_send(client, conn, SILC_COMMAND_INFO,
1778 conn->cmd_ident, 1, 2, sidp->data, sidp->len);
1779 silc_buffer_free(sidp);
1781 /* We are resuming session. Start resolving informations from the
1782 server we need to set the client libary in the state before
1783 detaching the session. The connect client operation is called
1784 after this is successfully completed */
1785 silc_client_resume_session(client, conn, silc_client_resume_session_cb,
1791 /* Removes a client entry from all channels it has joined. */
1793 void silc_client_remove_from_channels(SilcClient client,
1794 SilcClientConnection conn,
1795 SilcClientEntry client_entry)
1797 SilcHashTableList htl;
1798 SilcChannelUser chu;
1800 silc_hash_table_list(client_entry->channels, &htl);
1801 while (silc_hash_table_get(&htl, NULL, (void **)&chu)) {
1802 silc_hash_table_del(chu->client->channels, chu->channel);
1803 silc_hash_table_del(chu->channel->user_list, chu->client);
1807 silc_hash_table_list_reset(&htl);
1810 /* Replaces `old' client entries from all channels to `new' client entry.
1811 This can be called for example when nickname changes and old ID entry
1812 is replaced from ID cache with the new one. If the old ID entry is only
1813 updated, then this fucntion needs not to be called. */
1815 void silc_client_replace_from_channels(SilcClient client,
1816 SilcClientConnection conn,
1817 SilcClientEntry old,
1818 SilcClientEntry new)
1820 SilcHashTableList htl;
1821 SilcChannelUser chu;
1823 silc_hash_table_list(old->channels, &htl);
1824 while (silc_hash_table_get(&htl, NULL, (void **)&chu)) {
1825 /* Replace client entry */
1826 silc_hash_table_del(chu->client->channels, chu->channel);
1827 silc_hash_table_del(chu->channel->user_list, chu->client);
1830 silc_hash_table_add(chu->channel->user_list, chu->client, chu);
1831 silc_hash_table_add(chu->client->channels, chu->channel, chu);
1833 silc_hash_table_list_reset(&htl);
1836 /* Registers failure timeout to process the received failure packet
1839 void silc_client_process_failure(SilcClient client,
1840 SilcSocketConnection sock,
1841 SilcPacketContext *packet)
1843 SilcUInt32 failure = 0;
1845 if (sock->protocol) {
1846 if (packet->buffer->len >= 4)
1847 SILC_GET32_MSB(failure, packet->buffer->data);
1849 /* Notify application */
1850 client->internal->ops->failure(client, sock->user_data, sock->protocol,
1855 /* A timeout callback for the re-key. We will be the initiator of the
1858 SILC_TASK_CALLBACK_GLOBAL(silc_client_rekey_callback)
1860 SilcSocketConnection sock = (SilcSocketConnection)context;
1861 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1862 SilcClient client = (SilcClient)conn->internal->rekey->context;
1863 SilcProtocol protocol;
1864 SilcClientRekeyInternalContext *proto_ctx;
1866 SILC_LOG_DEBUG(("Start"));
1868 /* If rekey protocol is active already wait for it to finish */
1869 if (sock->protocol && sock->protocol->protocol &&
1870 sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)
1873 /* Allocate internal protocol context. This is sent as context
1875 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
1876 proto_ctx->client = (void *)client;
1877 proto_ctx->sock = silc_socket_dup(sock);
1878 proto_ctx->responder = FALSE;
1879 proto_ctx->pfs = conn->internal->rekey->pfs;
1881 /* Perform rekey protocol. Will call the final callback after the
1882 protocol is over. */
1883 silc_protocol_alloc(SILC_PROTOCOL_CLIENT_REKEY,
1884 &protocol, proto_ctx, silc_client_rekey_final);
1885 sock->protocol = protocol;
1887 /* Run the protocol */
1888 silc_protocol_execute(protocol, client->schedule, 0, 0);
1891 /* The final callback for the REKEY protocol. This will actually take the
1892 new key material into use. */
1894 SILC_TASK_CALLBACK(silc_client_rekey_final)
1896 SilcProtocol protocol = (SilcProtocol)context;
1897 SilcClientRekeyInternalContext *ctx =
1898 (SilcClientRekeyInternalContext *)protocol->context;
1899 SilcClient client = (SilcClient)ctx->client;
1900 SilcSocketConnection sock = ctx->sock;
1901 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1903 SILC_LOG_DEBUG(("Start"));
1905 if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
1906 protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
1907 /* Error occured during protocol */
1908 silc_protocol_cancel(protocol, client->schedule);
1909 silc_protocol_free(protocol);
1910 sock->protocol = NULL;
1912 silc_packet_context_free(ctx->packet);
1914 silc_ske_free(ctx->ske);
1915 silc_socket_free(ctx->sock);
1920 /* Purge the outgoing data queue to assure that all rekey packets really
1921 go to the network before we quit the protocol. */
1922 silc_client_packet_queue_purge(client, sock);
1924 /* Re-register re-key timeout */
1925 if (ctx->responder == FALSE)
1926 silc_schedule_task_add(client->schedule, sock->sock,
1927 silc_client_rekey_callback,
1928 sock, conn->internal->rekey->timeout, 0,
1929 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
1932 silc_protocol_free(protocol);
1933 sock->protocol = NULL;
1935 silc_packet_context_free(ctx->packet);
1937 silc_ske_free(ctx->ske);
1938 silc_socket_free(ctx->sock);
1942 /* Processes incoming connection authentication method request packet.
1943 It is a reply to our previously sent request. The packet can be used
1944 to resolve the authentication method for the current session if the
1945 client does not know it beforehand. */
1947 void silc_client_connection_auth_request(SilcClient client,
1948 SilcSocketConnection sock,
1949 SilcPacketContext *packet)
1951 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1952 SilcUInt16 conn_type, auth_meth;
1955 /* If we haven't send our request then ignore this one. */
1956 if (!conn->internal->connauth)
1959 /* Parse the payload */
1960 ret = silc_buffer_unformat(packet->buffer,
1961 SILC_STR_UI_SHORT(&conn_type),
1962 SILC_STR_UI_SHORT(&auth_meth),
1965 auth_meth = SILC_AUTH_NONE;
1967 /* Call the request callback to notify application for received
1968 authentication method information. */
1969 if (conn->internal->connauth->callback)
1970 (*conn->internal->connauth->callback)(client, conn, auth_meth,
1971 conn->internal->connauth->context);
1973 silc_schedule_task_del(client->schedule, conn->internal->connauth->timeout);
1975 silc_free(conn->internal->connauth);
1976 conn->internal->connauth = NULL;
1979 /* Timeout task callback called if the server does not reply to our
1980 connection authentication method request in the specified time interval. */
1982 SILC_TASK_CALLBACK(silc_client_request_authentication_method_timeout)
1984 SilcClientConnection conn = (SilcClientConnection)context;
1985 SilcClient client = conn->client;
1987 if (!conn->internal->connauth)
1990 /* Call the request callback to notify application */
1991 if (conn->internal->connauth->callback)
1992 (*conn->internal->connauth->callback)(client, conn, SILC_AUTH_NONE,
1993 conn->internal->connauth->context);
1995 silc_free(conn->internal->connauth);
1996 conn->internal->connauth = NULL;
1999 /* This function can be used to request the current authentication method
2000 from the server. This may be called when connecting to the server
2001 and the client library requests the authentication data from the
2002 application. If the application does not know the current authentication
2003 method it can request it from the server using this function.
2004 The `callback' with `context' will be called after the server has
2005 replied back with the current authentication method. */
2008 silc_client_request_authentication_method(SilcClient client,
2009 SilcClientConnection conn,
2010 SilcConnectionAuthRequest callback,
2013 SilcClientConnAuthRequest connauth;
2016 assert(client && conn);
2017 connauth = silc_calloc(1, sizeof(*connauth));
2018 connauth->callback = callback;
2019 connauth->context = context;
2021 if (conn->internal->connauth)
2022 silc_free(conn->internal->connauth);
2024 conn->internal->connauth = connauth;
2026 /* Assemble the request packet and send it to the server */
2027 packet = silc_buffer_alloc(4);
2028 silc_buffer_pull_tail(packet, SILC_BUFFER_END(packet));
2029 silc_buffer_format(packet,
2030 SILC_STR_UI_SHORT(SILC_SOCKET_TYPE_CLIENT),
2031 SILC_STR_UI_SHORT(SILC_AUTH_NONE),
2033 silc_client_packet_send(client, conn->sock,
2034 SILC_PACKET_CONNECTION_AUTH_REQUEST,
2035 NULL, 0, NULL, NULL,
2036 packet->data, packet->len, FALSE);
2037 silc_buffer_free(packet);
2039 /* Register a timeout in case server does not reply anything back. */
2041 silc_schedule_task_add(client->schedule, conn->sock->sock,
2042 silc_client_request_authentication_method_timeout,
2044 client->internal->params->connauth_request_secs, 0,
2045 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);