5 Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
7 Copyright (C) 1997 - 2000 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; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
22 #include "clientlibincludes.h"
24 /* Static task callback prototypes */
25 SILC_TASK_CALLBACK(silc_client_connect_to_server_start);
26 SILC_TASK_CALLBACK(silc_client_connect_to_server_second);
27 SILC_TASK_CALLBACK(silc_client_connect_to_server_final);
28 SILC_TASK_CALLBACK(silc_client_packet_process);
29 SILC_TASK_CALLBACK(silc_client_packet_parse_real);
31 static void silc_client_packet_parse(SilcPacketParserContext *parser_context);
32 static void silc_client_packet_parse_type(SilcClient client,
33 SilcSocketConnection sock,
34 SilcPacketContext *packet);
36 /* Allocates new client object. This has to be done before client may
37 work. After calling this one must call silc_client_init to initialize
38 the client. The `application' is application specific user data pointer
39 and caller must free it. */
41 SilcClient silc_client_alloc(SilcClientOperations *ops, void *application)
43 SilcClient new_client;
45 new_client = silc_calloc(1, sizeof(*new_client));
46 new_client->application = application;
47 new_client->ops = ops;
52 /* Free's client object */
54 void silc_client_free(SilcClient client)
61 /* Initializes the client. This makes all the necessary steps to make
62 the client ready to be run. One must call silc_client_run to run the
65 int silc_client_init(SilcClient client)
67 SILC_LOG_DEBUG(("Initializing client"));
69 /* Initialize hash functions for client to use */
70 silc_hash_alloc("md5", &client->md5hash);
71 silc_hash_alloc("sha1", &client->sha1hash);
73 /* Initialize none cipher */
74 silc_cipher_alloc("none", &client->none_cipher);
76 /* Initialize random number generator */
77 client->rng = silc_rng_alloc();
78 silc_rng_init(client->rng);
79 silc_math_primegen_init(); /* XXX */
81 /* Register protocols */
82 silc_client_protocols_register();
84 /* Initialize the scheduler */
85 silc_schedule_init(&client->io_queue, &client->timeout_queue,
86 &client->generic_queue, 5000);
91 /* Stops the client. This is called to stop the client and thus to stop
94 void silc_client_stop(SilcClient client)
96 SILC_LOG_DEBUG(("Stopping client"));
98 /* Stop the scheduler, although it might be already stopped. This
99 doesn't hurt anyone. This removes all the tasks and task queues,
101 silc_schedule_stop();
102 silc_schedule_uninit();
104 silc_client_protocols_unregister();
106 SILC_LOG_DEBUG(("Client stopped"));
109 /* Runs the client. */
111 void silc_client_run(SilcClient client)
113 SILC_LOG_DEBUG(("Running client"));
115 /* Start the scheduler, the heart of the SILC client. When this returns
116 the program will be terminated. */
120 /* Allocates and adds new connection to the client. This adds the allocated
121 connection to the connection table and returns a pointer to it. A client
122 can have multiple connections to multiple servers. Every connection must
123 be added to the client using this function. User data `context' may
124 be sent as argument. */
126 SilcClientConnection silc_client_add_connection(SilcClient client,
131 SilcClientConnection conn;
134 conn = silc_calloc(1, sizeof(*conn));
136 /* Initialize ID caches */
137 conn->client_cache = silc_idcache_alloc(0);
138 conn->channel_cache = silc_idcache_alloc(0);
139 conn->server_cache = silc_idcache_alloc(0);
140 conn->client = client;
141 conn->remote_host = strdup(hostname);
142 conn->remote_port = port;
143 conn->context = context;
144 conn->pending_commands = silc_dlist_init();
146 /* Add the connection to connections table */
147 for (i = 0; i < client->conns_count; i++)
148 if (client->conns && !client->conns[i]) {
149 client->conns[i] = conn;
153 client->conns = silc_realloc(client->conns, sizeof(*client->conns)
154 * (client->conns_count + 1));
155 client->conns[client->conns_count] = conn;
156 client->conns_count++;
161 /* Removes connection from client. */
163 void silc_client_del_connection(SilcClient client, SilcClientConnection conn)
167 for (i = 0; i < client->conns_count; i++)
168 if (client->conns[i] == conn) {
169 if (conn->pending_commands)
170 silc_dlist_uninit(conn->pending_commands);
172 client->conns[i] = NULL;
176 /* Internal context for connection process. This is needed as we
177 doing asynchronous connecting. */
180 SilcClientConnection conn;
186 } SilcClientInternalConnectContext;
189 silc_client_connect_to_server_internal(SilcClientInternalConnectContext *ctx)
193 /* XXX In the future we should give up this non-blocking connect all
194 together and use threads instead. */
195 /* Create connection to server asynchronously */
196 sock = silc_net_create_connection_async(ctx->port, ctx->host);
200 /* Register task that will receive the async connect and will
202 ctx->task = silc_task_register(ctx->client->io_queue, sock,
203 silc_client_connect_to_server_start,
206 SILC_TASK_PRI_NORMAL);
207 silc_task_reset_iotype(ctx->task, SILC_TASK_WRITE);
208 silc_schedule_set_listen_fd(sock, ctx->task->iomask);
215 /* Connects to remote server. This is the main routine used to connect
216 to SILC server. Returns -1 on error and the created socket otherwise.
217 The `context' is user context that is saved into the SilcClientConnection
218 that is created after the connection is created. */
220 int silc_client_connect_to_server(SilcClient client, int port,
221 char *host, void *context)
223 SilcClientInternalConnectContext *ctx;
224 SilcClientConnection conn;
227 SILC_LOG_DEBUG(("Connecting to port %d of server %s",
230 conn = silc_client_add_connection(client, host, port, context);
232 client->ops->say(client, conn,
233 "Connecting to port %d of server %s", port, host);
235 /* Allocate internal context for connection process. This is
236 needed as we are doing async connecting. */
237 ctx = silc_calloc(1, sizeof(*ctx));
238 ctx->client = client;
240 ctx->host = strdup(host);
244 /* Do the actual connecting process */
245 sock = silc_client_connect_to_server_internal(ctx);
247 silc_client_del_connection(client, conn);
251 /* Start SILC Key Exchange (SKE) protocol to negotiate shared secret
252 key material between client and server. This function can be called
253 directly if application is performing its own connecting and does not
254 use the connecting provided by this library. */
256 int silc_client_start_key_exchange(SilcClient client,
257 SilcClientConnection conn,
260 SilcProtocol protocol;
261 SilcClientKEInternalContext *proto_ctx;
264 /* Allocate new socket connection object */
265 silc_socket_alloc(fd, SILC_SOCKET_TYPE_SERVER, (void *)conn, &conn->sock);
266 if (conn->sock == NULL) {
267 client->ops->say(client, conn,
268 "Error: Could not allocate connection socket");
272 conn->nickname = strdup(client->username);
273 conn->sock->hostname = conn->remote_host;
274 conn->sock->port = conn->remote_port;
276 /* Allocate internal Key Exchange context. This is sent to the
277 protocol as context. */
278 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
279 proto_ctx->client = (void *)client;
280 proto_ctx->sock = conn->sock;
281 proto_ctx->rng = client->rng;
282 proto_ctx->responder = FALSE;
284 /* Perform key exchange protocol. silc_client_connect_to_server_final
285 will be called after the protocol is finished. */
286 silc_protocol_alloc(SILC_PROTOCOL_CLIENT_KEY_EXCHANGE,
287 &protocol, (void *)proto_ctx,
288 silc_client_connect_to_server_second);
290 client->ops->say(client, conn,
291 "Error: Could not start authentication protocol");
294 conn->sock->protocol = protocol;
296 /* Register the connection for network input and output. This sets
297 that scheduler will listen for incoming packets for this connection
298 and sets that outgoing packets may be sent to this connection as well.
299 However, this doesn't set the scheduler for outgoing traffic, it will
300 be set separately by calling SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT,
301 later when outgoing data is available. */
302 context = (void *)client;
303 SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(fd);
305 /* Execute the protocol */
306 protocol->execute(client->timeout_queue, 0, protocol, fd, 0, 0);
310 /* Start of the connection to the remote server. This is called after
311 succesful TCP/IP connection has been established to the remote host. */
313 SILC_TASK_CALLBACK(silc_client_connect_to_server_start)
315 SilcClientInternalConnectContext *ctx =
316 (SilcClientInternalConnectContext *)context;
317 SilcClient client = ctx->client;
318 SilcClientConnection conn = ctx->conn;
319 int opt, opt_len = sizeof(opt);
321 SILC_LOG_DEBUG(("Start"));
323 /* Check the socket status as it might be in error */
324 getsockopt(fd, SOL_SOCKET, SO_ERROR, &opt, &opt_len);
326 if (ctx->tries < 2) {
327 /* Connection failed but lets try again */
328 client->ops->say(client, conn, "Could not connect to server %s: %s",
329 ctx->host, strerror(opt));
330 client->ops->say(client, conn,
331 "Connecting to port %d of server %s resumed",
332 ctx->port, ctx->host);
334 /* Unregister old connection try */
335 silc_schedule_unset_listen_fd(fd);
336 silc_net_close_connection(fd);
337 silc_task_unregister(client->io_queue, ctx->task);
340 silc_client_connect_to_server_internal(ctx);
343 /* Connection failed and we won't try anymore */
344 client->ops->say(client, conn, "Could not connect to server %s: %s",
345 ctx->host, strerror(opt));
346 silc_schedule_unset_listen_fd(fd);
347 silc_net_close_connection(fd);
348 silc_task_unregister(client->io_queue, ctx->task);
351 /* Notify application of failure */
352 client->ops->connect(client, conn, FALSE);
353 silc_client_del_connection(client, conn);
358 silc_schedule_unset_listen_fd(fd);
359 silc_task_unregister(client->io_queue, ctx->task);
362 if (!silc_client_start_key_exchange(client, conn, fd)) {
363 silc_net_close_connection(fd);
364 client->ops->connect(client, conn, FALSE);
368 /* Second part of the connecting to the server. This executed
369 authentication protocol. */
371 SILC_TASK_CALLBACK(silc_client_connect_to_server_second)
373 SilcProtocol protocol = (SilcProtocol)context;
374 SilcClientKEInternalContext *ctx =
375 (SilcClientKEInternalContext *)protocol->context;
376 SilcClient client = (SilcClient)ctx->client;
377 SilcSocketConnection sock = NULL;
378 SilcClientConnAuthInternalContext *proto_ctx;
380 SILC_LOG_DEBUG(("Start"));
382 if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
383 protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
384 /* Error occured during protocol */
385 SILC_LOG_DEBUG(("Error during KE protocol"));
386 silc_protocol_free(protocol);
388 silc_ske_free(ctx->ske);
390 silc_free(ctx->dest_id);
391 ctx->sock->protocol = NULL;
393 /* Notify application of failure */
394 client->ops->connect(client, ctx->sock->user_data, FALSE);
399 /* Allocate internal context for the authentication protocol. This
400 is sent as context for the protocol. */
401 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
402 proto_ctx->client = (void *)client;
403 proto_ctx->sock = sock = ctx->sock;
404 proto_ctx->ske = ctx->ske; /* Save SKE object from previous protocol */
405 proto_ctx->dest_id_type = ctx->dest_id_type;
406 proto_ctx->dest_id = ctx->dest_id;
408 /* Resolve the authentication method to be used in this connection */
409 if (!client->ops->get_auth_method(client, sock->user_data, sock->hostname,
410 sock->port, &proto_ctx->auth_meth,
411 &proto_ctx->auth_data,
412 &proto_ctx->auth_data_len))
414 /* XXX do AUTH_REQUEST resolcing with server */
415 proto_ctx->auth_meth = SILC_PROTOCOL_CONN_AUTH_NONE;
418 /* Free old protocol as it is finished now */
419 silc_protocol_free(protocol);
421 silc_packet_context_free(ctx->packet);
423 /* silc_free(ctx->keymat....); */
424 sock->protocol = NULL;
426 /* Allocate the authentication protocol. This is allocated here
427 but we won't start it yet. We will be receiving party of this
428 protocol thus we will wait that connecting party will make
430 silc_protocol_alloc(SILC_PROTOCOL_CLIENT_CONNECTION_AUTH,
431 &sock->protocol, (void *)proto_ctx,
432 silc_client_connect_to_server_final);
434 /* Execute the protocol */
435 sock->protocol->execute(client->timeout_queue, 0, sock->protocol, fd, 0, 0);
438 /* Finalizes the connection to the remote SILC server. This is called
439 after authentication protocol has been completed. This send our
440 user information to the server to receive our client ID from
443 SILC_TASK_CALLBACK(silc_client_connect_to_server_final)
445 SilcProtocol protocol = (SilcProtocol)context;
446 SilcClientConnAuthInternalContext *ctx =
447 (SilcClientConnAuthInternalContext *)protocol->context;
448 SilcClient client = (SilcClient)ctx->client;
449 SilcClientConnection conn = (SilcClientConnection)ctx->sock->user_data;
452 SILC_LOG_DEBUG(("Start"));
454 if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
455 protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
456 /* Error occured during protocol */
457 SILC_LOG_DEBUG(("Error during authentication protocol"));
458 silc_protocol_free(protocol);
460 silc_free(ctx->auth_data);
462 silc_ske_free(ctx->ske);
464 silc_free(ctx->dest_id);
465 conn->sock->protocol = NULL;
467 /* Notify application of failure */
468 client->ops->connect(client, ctx->sock->user_data, FALSE);
473 /* Send NEW_CLIENT packet to the server. We will become registered
474 to the SILC network after sending this packet and we will receive
475 client ID from the server. */
476 packet = silc_buffer_alloc(2 + 2 + strlen(client->username) +
477 strlen(client->realname));
478 silc_buffer_pull_tail(packet, SILC_BUFFER_END(packet));
479 silc_buffer_format(packet,
480 SILC_STR_UI_SHORT(strlen(client->username)),
481 SILC_STR_UI_XNSTRING(client->username,
482 strlen(client->username)),
483 SILC_STR_UI_SHORT(strlen(client->realname)),
484 SILC_STR_UI_XNSTRING(client->realname,
485 strlen(client->realname)),
488 /* Send the packet */
489 silc_client_packet_send(client, ctx->sock, SILC_PACKET_NEW_CLIENT,
491 packet->data, packet->len, TRUE);
492 silc_buffer_free(packet);
494 /* Save remote ID. */
495 conn->remote_id = ctx->dest_id;
496 conn->remote_id_data = silc_id_id2str(ctx->dest_id, SILC_ID_SERVER);
497 conn->remote_id_data_len = SILC_ID_SERVER_LEN;
499 /* Notify application of successful connection */
500 client->ops->connect(client, conn, TRUE);
502 silc_protocol_free(protocol);
504 silc_free(ctx->auth_data);
506 silc_ske_free(ctx->ske);
508 conn->sock->protocol = NULL;
511 /* Internal routine that sends packet or marks packet to be sent. This
512 is used directly only in special cases. Normal cases should use
513 silc_server_packet_send. Returns < 0 on error. */
515 static int silc_client_packet_send_real(SilcClient client,
516 SilcSocketConnection sock,
521 /* Send the packet */
522 ret = silc_packet_send(sock, force_send);
526 /* Mark that there is some outgoing data available for this connection.
527 This call sets the connection both for input and output (the input
528 is set always and this call keeps the input setting, actually).
529 Actual data sending is performed by silc_client_packet_process. */
530 SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(sock->sock);
532 /* Mark to socket that data is pending in outgoing buffer. This flag
533 is needed if new data is added to the buffer before the earlier
534 put data is sent to the network. */
535 SILC_SET_OUTBUF_PENDING(sock);
540 /* Packet processing callback. This is used to send and receive packets
541 from network. This is generic task. */
543 SILC_TASK_CALLBACK(silc_client_packet_process)
545 SilcClient client = (SilcClient)context;
546 SilcSocketConnection sock = NULL;
547 SilcClientConnection conn;
550 SILC_LOG_DEBUG(("Processing packet"));
552 SILC_CLIENT_GET_SOCK(client, fd, sock);
556 conn = (SilcClientConnection)sock->user_data;
559 if (type == SILC_TASK_WRITE) {
560 SILC_LOG_DEBUG(("Writing data to connection"));
562 if (sock->outbuf->data - sock->outbuf->head)
563 silc_buffer_push(sock->outbuf,
564 sock->outbuf->data - sock->outbuf->head);
566 ret = silc_client_packet_send_real(client, sock, TRUE);
568 /* If returned -2 could not write to connection now, will do
573 /* The packet has been sent and now it is time to set the connection
574 back to only for input. When there is again some outgoing data
575 available for this connection it will be set for output as well.
576 This call clears the output setting and sets it only for input. */
577 SILC_CLIENT_SET_CONNECTION_FOR_INPUT(fd);
578 SILC_UNSET_OUTBUF_PENDING(sock);
580 silc_buffer_clear(sock->outbuf);
584 /* Packet receiving */
585 if (type == SILC_TASK_READ) {
586 SILC_LOG_DEBUG(("Reading data from connection"));
588 /* Read data from network */
589 ret = silc_packet_receive(sock);
595 SILC_LOG_DEBUG(("Read EOF"));
597 /* If connection is disconnecting already we will finally
598 close the connection */
599 if (SILC_IS_DISCONNECTING(sock)) {
600 client->ops->disconnect(client, conn);
601 silc_client_close_connection(client, sock);
605 client->ops->say(client, conn, "Connection closed: premature EOF");
606 SILC_LOG_DEBUG(("Premature EOF from connection %d", sock->sock));
607 client->ops->disconnect(client, conn);
608 silc_client_close_connection(client, sock);
612 /* Process the packet. This will call the parser that will then
613 decrypt and parse the packet. */
614 silc_packet_receive_process(sock, conn->receive_key, conn->hmac,
615 silc_client_packet_parse, client);
619 /* Parses whole packet, received earlier. */
621 SILC_TASK_CALLBACK(silc_client_packet_parse_real)
623 SilcPacketParserContext *parse_ctx = (SilcPacketParserContext *)context;
624 SilcClient client = (SilcClient)parse_ctx->context;
625 SilcPacketContext *packet = parse_ctx->packet;
626 SilcBuffer buffer = packet->buffer;
627 SilcSocketConnection sock = parse_ctx->sock;
628 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
631 SILC_LOG_DEBUG(("Start"));
633 /* Decrypt the received packet */
634 ret = silc_packet_decrypt(conn->receive_key, conn->hmac, buffer, packet);
639 /* Parse the packet. Packet type is returned. */
640 ret = silc_packet_parse(packet);
642 /* Parse the packet header in special way as this is "special"
644 ret = silc_packet_parse_special(packet);
647 if (ret == SILC_PACKET_NONE)
650 /* Parse the incoming packet type */
651 silc_client_packet_parse_type(client, sock, packet);
654 silc_buffer_clear(sock->inbuf);
655 silc_packet_context_free(packet);
656 silc_free(parse_ctx);
659 /* Parser callback called by silc_packet_receive_process. Thie merely
660 registers timeout that will handle the actual parsing when appropriate. */
662 void silc_client_packet_parse(SilcPacketParserContext *parser_context)
664 SilcClient client = (SilcClient)parser_context->context;
666 /* Parse the packet */
667 silc_task_register(client->timeout_queue, parser_context->sock->sock,
668 silc_client_packet_parse_real,
669 (void *)parser_context, 0, 1,
671 SILC_TASK_PRI_NORMAL);
674 /* Parses the packet type and calls what ever routines the packet type
675 requires. This is done for all incoming packets. */
677 void silc_client_packet_parse_type(SilcClient client,
678 SilcSocketConnection sock,
679 SilcPacketContext *packet)
681 SilcBuffer buffer = packet->buffer;
682 SilcPacketType type = packet->type;
684 SILC_LOG_DEBUG(("Parsing packet type %d", type));
686 /* Parse the packet type */
688 case SILC_PACKET_DISCONNECT:
689 silc_client_disconnected_by_server(client, sock, buffer);
691 case SILC_PACKET_SUCCESS:
693 * Success received for something. For now we can have only
694 * one protocol for connection executing at once hence this
695 * success message is for whatever protocol is executing currently.
697 if (sock->protocol) {
698 sock->protocol->execute(client->timeout_queue, 0,
699 sock->protocol, sock->sock, 0, 0);
702 case SILC_PACKET_FAILURE:
704 * Failure received for some protocol. Set the protocol state to
705 * error and call the protocol callback. This fill cause error on
706 * protocol and it will call the final callback.
708 if (sock->protocol) {
709 sock->protocol->state = SILC_PROTOCOL_STATE_FAILURE;
710 sock->protocol->execute(client->timeout_queue, 0,
711 sock->protocol, sock->sock, 0, 0);
713 /* XXX We have only two protocols currently thus we know what this
714 failure indication is. */
715 if (buffer->len >= 4) {
716 unsigned int failure;
718 SILC_GET32_MSB(failure, buffer->data);
720 /* Notify application */
721 client->ops->failure(client, sock->user_data, sock->protocol,
726 case SILC_PACKET_REJECT:
729 case SILC_PACKET_NOTIFY:
731 * Received notify message
733 silc_client_notify_by_server(client, sock, packet);
736 case SILC_PACKET_ERROR:
738 * Received error message
740 silc_client_error_by_server(client, sock, buffer);
743 case SILC_PACKET_CHANNEL_MESSAGE:
745 * Received message to (from, actually) a channel
747 silc_client_channel_message(client, sock, packet);
749 case SILC_PACKET_CHANNEL_KEY:
751 * Received key for a channel. By receiving this key the client will be
752 * able to talk to the channel it has just joined. This can also be
753 * a new key for existing channel as keys expire peridiocally.
755 silc_client_receive_channel_key(client, sock, buffer);
758 case SILC_PACKET_PRIVATE_MESSAGE:
760 * Received private message
762 silc_client_private_message(client, sock, packet);
764 case SILC_PACKET_PRIVATE_MESSAGE_KEY:
766 * Received private message key
770 case SILC_PACKET_COMMAND_REPLY:
772 * Recived reply for a command
774 silc_client_command_reply_process(client, sock, packet);
777 case SILC_PACKET_KEY_EXCHANGE:
778 if (sock->protocol) {
779 SilcClientKEInternalContext *proto_ctx =
780 (SilcClientKEInternalContext *)sock->protocol->context;
782 proto_ctx->packet = silc_packet_context_dup(packet);
783 proto_ctx->dest_id_type = packet->src_id_type;
784 proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
785 packet->src_id_type);
786 if (!proto_ctx->dest_id)
789 /* Let the protocol handle the packet */
790 sock->protocol->execute(client->timeout_queue, 0,
791 sock->protocol, sock->sock, 0, 0);
793 SILC_LOG_ERROR(("Received Key Exchange packet but no key exchange "
794 "protocol active, packet dropped."));
796 /* XXX Trigger KE protocol?? Rekey actually! */
800 case SILC_PACKET_KEY_EXCHANGE_1:
801 if (sock->protocol) {
804 SILC_LOG_ERROR(("Received Key Exchange 1 packet but no key exchange "
805 "protocol active, packet dropped."));
808 case SILC_PACKET_KEY_EXCHANGE_2:
809 if (sock->protocol) {
810 SilcClientKEInternalContext *proto_ctx =
811 (SilcClientKEInternalContext *)sock->protocol->context;
813 if (proto_ctx->packet)
814 silc_packet_context_free(proto_ctx->packet);
816 proto_ctx->packet = silc_packet_context_dup(packet);
817 proto_ctx->dest_id_type = packet->src_id_type;
818 proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
819 packet->src_id_type);
820 if (!proto_ctx->dest_id)
823 /* Let the protocol handle the packet */
824 sock->protocol->execute(client->timeout_queue, 0,
825 sock->protocol, sock->sock, 0, 0);
827 SILC_LOG_ERROR(("Received Key Exchange 2 packet but no key exchange "
828 "protocol active, packet dropped."));
832 case SILC_PACKET_NEW_ID:
835 * Received new ID from server. This packet is received at
836 * the connection to the server. New ID is also received when
837 * user changes nickname but in that case the new ID is received
838 * as command reply and not as this packet type.
842 idp = silc_id_payload_parse(buffer);
845 if (silc_id_payload_get_type(idp) != SILC_ID_CLIENT)
848 silc_client_receive_new_id(client, sock, idp);
849 silc_id_payload_free(idp);
853 case SILC_PACKET_HEARTBEAT:
855 * Received heartbeat packet
857 SILC_LOG_DEBUG(("Heartbeat packet"));
861 SILC_LOG_DEBUG(("Incorrect packet type %d, packet dropped", type));
866 /* Sends packet. This doesn't actually send the packet instead it assembles
867 it and marks it to be sent. However, if force_send is TRUE the packet
868 is sent immediately. if dst_id, cipher and hmac are NULL those parameters
869 will be derived from sock argument. Otherwise the valid arguments sent
872 void silc_client_packet_send(SilcClient client,
873 SilcSocketConnection sock,
876 SilcIdType dst_id_type,
880 unsigned int data_len,
883 SilcPacketContext packetdata;
885 SILC_LOG_DEBUG(("Sending packet, type %d", type));
887 /* Get data used in the packet sending, keys and stuff */
888 if ((!cipher || !hmac || !dst_id) && sock->user_data) {
889 if (!cipher && ((SilcClientConnection)sock->user_data)->send_key)
890 cipher = ((SilcClientConnection)sock->user_data)->send_key;
892 if (!hmac && ((SilcClientConnection)sock->user_data)->hmac)
893 hmac = ((SilcClientConnection)sock->user_data)->hmac;
895 if (!dst_id && ((SilcClientConnection)sock->user_data)->remote_id) {
896 dst_id = ((SilcClientConnection)sock->user_data)->remote_id;
897 dst_id_type = SILC_ID_SERVER;
901 /* Set the packet context pointers */
902 packetdata.flags = 0;
903 packetdata.type = type;
904 if (((SilcClientConnection)sock->user_data)->local_id_data)
905 packetdata.src_id = ((SilcClientConnection)sock->user_data)->local_id_data;
907 packetdata.src_id = silc_calloc(SILC_ID_CLIENT_LEN, sizeof(unsigned char));
908 packetdata.src_id_len = SILC_ID_CLIENT_LEN;
909 packetdata.src_id_type = SILC_ID_CLIENT;
911 packetdata.dst_id = silc_id_id2str(dst_id, dst_id_type);
912 packetdata.dst_id_len = silc_id_get_len(dst_id_type);
913 packetdata.dst_id_type = dst_id_type;
915 packetdata.dst_id = NULL;
916 packetdata.dst_id_len = 0;
917 packetdata.dst_id_type = SILC_ID_NONE;
919 packetdata.rng = client->rng;
920 packetdata.truelen = data_len + SILC_PACKET_HEADER_LEN +
921 packetdata.src_id_len + packetdata.dst_id_len;
922 packetdata.padlen = SILC_PACKET_PADLEN(packetdata.truelen);
924 /* Prepare outgoing data buffer for packet sending */
925 silc_packet_send_prepare(sock,
926 SILC_PACKET_HEADER_LEN +
927 packetdata.src_id_len +
928 packetdata.dst_id_len,
932 SILC_LOG_DEBUG(("Putting data to outgoing buffer, len %d", data_len));
934 packetdata.buffer = sock->outbuf;
936 /* Put the data to the buffer */
937 if (data && data_len)
938 silc_buffer_put(sock->outbuf, data, data_len);
940 /* Create the outgoing packet */
941 silc_packet_assemble(&packetdata);
943 /* Encrypt the packet */
945 silc_packet_encrypt(cipher, hmac, sock->outbuf, sock->outbuf->len);
947 SILC_LOG_HEXDUMP(("Packet, len %d", sock->outbuf->len),
948 sock->outbuf->data, sock->outbuf->len);
950 /* Now actually send the packet */
951 silc_client_packet_send_real(client, sock, force_send);
954 /* Sends packet to a channel. Packet to channel is always encrypted
955 differently from "normal" packets. SILC header of the packet is
956 encrypted with the next receiver's key and the rest of the packet is
957 encrypted with the channel specific key. Padding and HMAC is computed
958 with the next receiver's key. */
960 void silc_client_packet_send_to_channel(SilcClient client,
961 SilcSocketConnection sock,
962 SilcChannelEntry channel,
964 unsigned int data_len,
968 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
970 SilcPacketContext packetdata;
973 unsigned char *id_string;
975 SILC_LOG_DEBUG(("Sending packet to channel"));
977 if (!channel || !channel->key) {
978 client->ops->say(client, conn,
979 "Cannot talk to channel: key does not exist");
985 for (i = 0; i < 16; i++) channel->iv[i] = silc_rng_get_byte(client->rng);
987 silc_hash_make(client->md5hash, channel->iv, 16, channel->iv);
989 /* Encode the channel payload */
990 payload = silc_channel_payload_encode(data_len, data, 16, channel->iv,
993 client->ops->say(client, conn,
994 "Error: Could not create packet to be sent to channel");
998 /* Get data used in packet header encryption, keys and stuff. Rest
999 of the packet (the payload) is, however, encrypted with the
1000 specified channel key. */
1001 cipher = conn->send_key;
1003 id_string = silc_id_id2str(channel->id, SILC_ID_CHANNEL);
1005 /* Set the packet context pointers. The destination ID is always
1006 the Channel ID of the channel. Server and router will handle the
1007 distribution of the packet. */
1008 packetdata.flags = 0;
1009 packetdata.type = SILC_PACKET_CHANNEL_MESSAGE;
1010 packetdata.src_id = conn->local_id_data;
1011 packetdata.src_id_len = SILC_ID_CLIENT_LEN;
1012 packetdata.src_id_type = SILC_ID_CLIENT;
1013 packetdata.dst_id = id_string;
1014 packetdata.dst_id_len = SILC_ID_CHANNEL_LEN;
1015 packetdata.dst_id_type = SILC_ID_CHANNEL;
1016 packetdata.rng = client->rng;
1017 packetdata.truelen = payload->len + SILC_PACKET_HEADER_LEN +
1018 packetdata.src_id_len + packetdata.dst_id_len;
1019 packetdata.padlen = SILC_PACKET_PADLEN((SILC_PACKET_HEADER_LEN +
1020 packetdata.src_id_len +
1021 packetdata.dst_id_len));
1023 /* Prepare outgoing data buffer for packet sending */
1024 silc_packet_send_prepare(sock,
1025 SILC_PACKET_HEADER_LEN +
1026 packetdata.src_id_len +
1027 packetdata.dst_id_len,
1031 packetdata.buffer = sock->outbuf;
1033 /* Encrypt payload of the packet. This is encrypted with the channel key. */
1034 channel->channel_key->cipher->encrypt(channel->channel_key->context,
1035 payload->data, payload->data,
1036 payload->len - 16, /* -IV_LEN */
1039 /* Put the actual encrypted payload data into the buffer. */
1040 silc_buffer_put(sock->outbuf, payload->data, payload->len);
1042 /* Create the outgoing packet */
1043 silc_packet_assemble(&packetdata);
1045 /* Encrypt the header and padding of the packet. This is encrypted
1046 with normal session key shared with our server. */
1047 silc_packet_encrypt(cipher, hmac, sock->outbuf, SILC_PACKET_HEADER_LEN +
1048 packetdata.src_id_len + packetdata.dst_id_len +
1051 SILC_LOG_HEXDUMP(("Packet to channel, len %d", sock->outbuf->len),
1052 sock->outbuf->data, sock->outbuf->len);
1054 /* Now actually send the packet */
1055 silc_client_packet_send_real(client, sock, force_send);
1056 silc_buffer_free(payload);
1057 silc_free(id_string);
1060 /* Sends private message to remote client. If private message key has
1061 not been set with this client then the message will be encrypted using
1062 normal session keys. Private messages are special packets in SILC
1063 network hence we need this own function for them. This is similiar
1064 to silc_client_packet_send_to_channel except that we send private
1067 void silc_client_packet_send_private_message(SilcClient client,
1068 SilcSocketConnection sock,
1069 SilcClientEntry client_entry,
1070 unsigned char *data,
1071 unsigned int data_len,
1074 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1076 SilcPacketContext packetdata;
1077 unsigned int nick_len;
1081 SILC_LOG_DEBUG(("Sending private message"));
1083 /* Create private message payload */
1084 nick_len = strlen(conn->nickname);
1085 buffer = silc_buffer_alloc(2 + nick_len + data_len);
1086 silc_buffer_pull_tail(buffer, SILC_BUFFER_END(buffer));
1087 silc_buffer_format(buffer,
1088 SILC_STR_UI_SHORT(nick_len),
1089 SILC_STR_UI_XNSTRING(conn->nickname,
1091 SILC_STR_UI_XNSTRING(data, data_len),
1094 /* If we don't have private message specific key then private messages
1095 are just as any normal packet thus call normal packet sending. If
1096 the key exist then the encryption process is a bit different and
1097 will be done in the rest of this function. */
1098 if (!client_entry->send_key) {
1099 silc_client_packet_send(client, sock, SILC_PACKET_PRIVATE_MESSAGE,
1100 client_entry->id, SILC_ID_CLIENT, NULL, NULL,
1101 buffer->data, buffer->len, force_send);
1105 /* We have private message specific key */
1107 /* Get data used in the encryption */
1108 cipher = client_entry->send_key;
1111 /* Set the packet context pointers. */
1112 packetdata.flags = 0;
1113 packetdata.type = SILC_PACKET_PRIVATE_MESSAGE;
1114 packetdata.src_id = conn->local_id_data;
1115 packetdata.src_id_len = SILC_ID_CLIENT_LEN;
1116 packetdata.src_id_type = SILC_ID_CLIENT;
1118 packetdata.dst_id = silc_id_id2str(client_entry->id, SILC_ID_CLIENT);
1120 packetdata.dst_id = conn->local_id_data;
1121 packetdata.dst_id_len = SILC_ID_CLIENT_LEN;
1122 packetdata.dst_id_type = SILC_ID_CLIENT;
1123 packetdata.rng = client->rng;
1124 packetdata.truelen = buffer->len + SILC_PACKET_HEADER_LEN +
1125 packetdata.src_id_len + packetdata.dst_id_len;
1126 packetdata.padlen = SILC_PACKET_PADLEN((SILC_PACKET_HEADER_LEN +
1127 packetdata.src_id_len +
1128 packetdata.dst_id_len));
1130 /* Prepare outgoing data buffer for packet sending */
1131 silc_packet_send_prepare(sock,
1132 SILC_PACKET_HEADER_LEN +
1133 packetdata.src_id_len +
1134 packetdata.dst_id_len,
1138 packetdata.buffer = sock->outbuf;
1140 /* Encrypt payload of the packet. Encrypt with private message specific
1141 key if it exist, otherwise with session key. */
1142 cipher->cipher->encrypt(cipher->context, buffer->data, buffer->data,
1143 buffer->len, cipher->iv);
1145 /* Put the actual encrypted payload data into the buffer. */
1146 silc_buffer_put(sock->outbuf, buffer->data, buffer->len);
1148 /* Create the outgoing packet */
1149 silc_packet_assemble(&packetdata);
1151 /* Encrypt the header and padding of the packet. */
1152 silc_packet_encrypt(cipher, hmac, sock->outbuf, SILC_PACKET_HEADER_LEN +
1153 packetdata.src_id_len + packetdata.dst_id_len +
1156 SILC_LOG_HEXDUMP(("Private message packet, len %d", sock->outbuf->len),
1157 sock->outbuf->data, sock->outbuf->len);
1159 /* Now actually send the packet */
1160 silc_client_packet_send_real(client, sock, force_send);
1161 silc_free(packetdata.dst_id);
1167 /* Closes connection to remote end. Free's all allocated data except
1168 for some information such as nickname etc. that are valid at all time. */
1170 void silc_client_close_connection(SilcClient client,
1171 SilcSocketConnection sock)
1173 SilcClientConnection conn;
1175 /* We won't listen for this connection anymore */
1176 silc_schedule_unset_listen_fd(sock->sock);
1178 /* Unregister all tasks */
1179 silc_task_unregister_by_fd(client->io_queue, sock->sock);
1180 silc_task_unregister_by_fd(client->timeout_queue, sock->sock);
1182 /* Close the actual connection */
1183 silc_net_close_connection(sock->sock);
1185 client->ops->say(client, sock->user_data,
1186 "Closed connection to host %s", sock->hostname ?
1187 sock->hostname : sock->ip);
1189 /* Free everything */
1190 if (sock->user_data) {
1191 conn = (SilcClientConnection)sock->user_data;
1193 /* XXX Free all client entries and channel entries. */
1195 /* Clear ID caches */
1196 silc_idcache_del_all(conn->client_cache);
1197 silc_idcache_del_all(conn->channel_cache);
1200 if (conn->remote_host)
1201 silc_free(conn->remote_host);
1203 silc_free(conn->local_id);
1204 if (conn->local_id_data)
1205 silc_free(conn->local_id_data);
1207 silc_cipher_free(conn->send_key);
1208 if (conn->receive_key)
1209 silc_cipher_free(conn->receive_key);
1211 silc_hmac_free(conn->hmac);
1212 if (conn->hmac_key) {
1213 memset(conn->hmac_key, 0, conn->hmac_key_len);
1214 silc_free(conn->hmac_key);
1216 if (conn->pending_commands)
1217 silc_dlist_uninit(conn->pending_commands);
1220 conn->remote_port = 0;
1221 conn->remote_type = 0;
1222 conn->send_key = NULL;
1223 conn->receive_key = NULL;
1225 conn->hmac_key = NULL;
1226 conn->hmac_key_len = 0;
1227 conn->local_id = NULL;
1228 conn->local_id_data = NULL;
1229 conn->remote_host = NULL;
1230 conn->current_channel = NULL;
1231 conn->pending_commands = NULL;
1233 silc_client_del_connection(client, conn);
1236 if (sock->protocol) {
1237 silc_protocol_free(sock->protocol);
1238 sock->protocol = NULL;
1240 silc_socket_free(sock);
1243 /* Called when we receive disconnection packet from server. This
1244 closes our end properly and displays the reason of the disconnection
1247 void silc_client_disconnected_by_server(SilcClient client,
1248 SilcSocketConnection sock,
1253 SILC_LOG_DEBUG(("Server disconnected us, sock %d", sock->sock));
1255 msg = silc_calloc(message->len + 1, sizeof(char));
1256 memcpy(msg, message->data, message->len);
1257 client->ops->say(client, sock->user_data, msg);
1260 SILC_SET_DISCONNECTED(sock);
1261 silc_client_close_connection(client, sock);
1264 /* Received error message from server. Display it on the screen.
1265 We don't take any action what so ever of the error message. */
1267 void silc_client_error_by_server(SilcClient client,
1268 SilcSocketConnection sock,
1273 msg = silc_calloc(message->len + 1, sizeof(char));
1274 memcpy(msg, message->data, message->len);
1275 client->ops->say(client, sock->user_data, msg);
1279 /* Called when notify is received and some async operation (such as command)
1280 is required before processing the notify message. This calls again the
1281 silc_client_notify_by_server and reprocesses the original notify packet. */
1283 static void silc_client_notify_by_server_pending(void *context)
1285 SilcPacketContext *p = (SilcPacketContext *)context;
1286 silc_client_notify_by_server(p->context, p->sock, p);
1287 silc_packet_context_free(p);
1290 /* Received notify message from server */
1292 void silc_client_notify_by_server(SilcClient client,
1293 SilcSocketConnection sock,
1294 SilcPacketContext *packet)
1296 SilcBuffer buffer = packet->buffer;
1297 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1298 SilcNotifyPayload payload;
1299 SilcNotifyType type;
1300 SilcArgumentPayload args;
1302 SilcClientID *client_id = NULL;
1303 SilcChannelID *channel_id = NULL;
1304 SilcClientEntry client_entry;
1305 SilcClientEntry client_entry2;
1306 SilcChannelEntry channel;
1307 SilcChannelUser chu;
1308 SilcIDCacheEntry id_cache = NULL;
1310 unsigned int tmp_len, mode;
1312 payload = silc_notify_payload_parse(buffer);
1316 type = silc_notify_get_type(payload);
1317 args = silc_notify_get_args(payload);
1322 case SILC_NOTIFY_TYPE_NONE:
1323 /* Notify application */
1324 client->ops->notify(client, conn, type,
1325 silc_argument_get_arg_type(args, 1, NULL));
1328 case SILC_NOTIFY_TYPE_INVITE:
1330 * Someone invited me to a channel. Find Client and Channel entries
1331 * for the application.
1335 tmp = silc_argument_get_arg_type(args, 1, &tmp_len);
1339 client_id = silc_id_payload_parse_id(tmp, tmp_len);
1343 /* Find Client entry and if not found query it */
1344 client_entry = silc_idlist_get_client_by_id(client, conn, client_id, TRUE);
1345 if (!client_entry) {
1346 SilcPacketContext *p = silc_packet_context_dup(packet);
1347 p->context = (void *)client;
1349 silc_client_command_pending(conn, SILC_COMMAND_WHOIS, SILC_IDLIST_IDENT,
1350 silc_client_notify_by_server_pending, p);
1354 /* Get Channel ID */
1355 tmp = silc_argument_get_arg_type(args, 2, &tmp_len);
1359 channel_id = silc_id_payload_parse_id(tmp, tmp_len);
1363 /* XXX Will ALWAYS fail because currently we don't have way to resolve
1364 channel information for channel that we're not joined to. */
1365 /* XXX ways to fix: use (extended) LIST command, or define the channel
1366 name to the notfy type when name resolving is not mandatory. */
1367 /* Find channel entry */
1368 if (!silc_idcache_find_by_id_one(conn->channel_cache, (void *)channel_id,
1369 SILC_ID_CHANNEL, &id_cache))
1372 channel = (SilcChannelEntry)id_cache->context;
1374 /* Notify application */
1375 client->ops->notify(client, conn, type, client_entry, channel);
1378 case SILC_NOTIFY_TYPE_JOIN:
1380 * Someone has joined to a channel. Get their ID and nickname and
1381 * cache them for later use.
1385 tmp = silc_argument_get_arg_type(args, 1, &tmp_len);
1389 client_id = silc_id_payload_parse_id(tmp, tmp_len);
1393 /* Find Client entry and if not found query it */
1394 client_entry = silc_idlist_get_client_by_id(client, conn, client_id, TRUE);
1395 if (!client_entry) {
1396 SilcPacketContext *p = silc_packet_context_dup(packet);
1397 p->context = (void *)client;
1399 silc_client_command_pending(conn, SILC_COMMAND_WHOIS, SILC_IDLIST_IDENT,
1400 silc_client_notify_by_server_pending, p);
1404 /* If nickname or username hasn't been resolved, do so */
1405 if (!client_entry->nickname || !client_entry->username) {
1406 SilcPacketContext *p = silc_packet_context_dup(packet);
1407 SilcBuffer idp = silc_id_payload_encode(client_id, SILC_ID_CLIENT);
1408 silc_client_send_command(client, conn, SILC_COMMAND_WHOIS,
1409 SILC_IDLIST_IDENT, 1,
1410 3, idp->data, idp->len);
1411 p->context = (void *)client;
1413 silc_client_command_pending(conn, SILC_COMMAND_WHOIS, SILC_IDLIST_IDENT,
1414 silc_client_notify_by_server_pending, p);
1418 /* Get channel entry */
1419 channel_id = silc_id_str2id(packet->dst_id, packet->dst_id_len,
1423 if (!silc_idcache_find_by_id_one(conn->channel_cache, (void *)channel_id,
1424 SILC_ID_CHANNEL, &id_cache))
1427 channel = (SilcChannelEntry)id_cache->context;
1429 /* Add client to channel */
1430 chu = silc_calloc(1, sizeof(*chu));
1431 chu->client = client_entry;
1432 silc_list_add(channel->clients, chu);
1434 /* XXX add support for multiple same nicks on same channel. Check
1437 /* Notify application. The channel entry is sent last as this notify
1438 is for channel but application don't know it from the arguments
1440 client->ops->notify(client, conn, type, client_entry, channel);
1443 case SILC_NOTIFY_TYPE_LEAVE:
1445 * Someone has left a channel. We will remove it from the channel but
1446 * we'll keep it in the cache in case we'll need it later.
1450 tmp = silc_argument_get_arg_type(args, 1, &tmp_len);
1454 client_id = silc_id_payload_parse_id(tmp, tmp_len);
1458 /* Find Client entry */
1460 silc_idlist_get_client_by_id(client, conn, client_id, FALSE);
1464 /* Get channel entry */
1465 channel_id = silc_id_str2id(packet->dst_id, packet->dst_id_len,
1469 if (!silc_idcache_find_by_id_one(conn->channel_cache, (void *)channel_id,
1470 SILC_ID_CHANNEL, &id_cache))
1473 channel = (SilcChannelEntry)id_cache->context;
1475 /* Remove client from channel */
1476 silc_list_start(channel->clients);
1477 while ((chu = silc_list_get(channel->clients)) != SILC_LIST_END) {
1478 if (chu->client == client_entry) {
1479 silc_list_del(channel->clients, chu);
1485 /* Notify application. The channel entry is sent last as this notify
1486 is for channel but application don't know it from the arguments
1488 client->ops->notify(client, conn, type, client_entry, channel);
1491 case SILC_NOTIFY_TYPE_SIGNOFF:
1493 * Someone left SILC. We'll remove it from all channels and from cache.
1497 tmp = silc_argument_get_arg_type(args, 1, &tmp_len);
1501 client_id = silc_id_payload_parse_id(tmp, tmp_len);
1505 /* Find Client entry */
1507 silc_idlist_get_client_by_id(client, conn, client_id, FALSE);
1511 /* Remove from all channels */
1512 silc_client_remove_from_channels(client, conn, client_entry);
1514 /* Remove from cache */
1515 silc_idcache_del_by_id(conn->client_cache, SILC_ID_CLIENT,
1518 /* Notify application */
1519 client->ops->notify(client, conn, type, client_entry);
1522 if (client_entry->nickname)
1523 silc_free(client_entry->nickname);
1524 if (client_entry->server)
1525 silc_free(client_entry->server);
1526 if (client_entry->id)
1527 silc_free(client_entry->id);
1528 if (client_entry->send_key)
1529 silc_cipher_free(client_entry->send_key);
1530 if (client_entry->receive_key)
1531 silc_cipher_free(client_entry->receive_key);
1534 case SILC_NOTIFY_TYPE_TOPIC_SET:
1536 * Someone set the topic on a channel.
1540 tmp = silc_argument_get_arg_type(args, 1, &tmp_len);
1544 client_id = silc_id_payload_parse_id(tmp, tmp_len);
1548 /* Find Client entry */
1550 silc_idlist_get_client_by_id(client, conn, client_id, FALSE);
1555 tmp = silc_argument_get_arg_type(args, 2, &tmp_len);
1559 /* Get channel entry */
1560 channel_id = silc_id_str2id(packet->dst_id, packet->dst_id_len,
1564 if (!silc_idcache_find_by_id_one(conn->channel_cache, (void *)channel_id,
1565 SILC_ID_CHANNEL, &id_cache))
1568 channel = (SilcChannelEntry)id_cache->context;
1570 /* Notify application. The channel entry is sent last as this notify
1571 is for channel but application don't know it from the arguments
1573 client->ops->notify(client, conn, type, client_entry, tmp, channel);
1576 case SILC_NOTIFY_TYPE_NICK_CHANGE:
1578 * Someone changed their nickname. If we don't have entry for the new
1579 * ID we will query it and return here after it's done. After we've
1580 * returned we fetch the old entry and free it and notify the
1584 /* Get new Client ID */
1585 tmp = silc_argument_get_arg_type(args, 2, &tmp_len);
1589 client_id = silc_id_payload_parse_id(tmp, tmp_len);
1594 if (!SILC_ID_CLIENT_COMPARE(client_id, conn->local_id))
1597 /* Find Client entry and if not found query it */
1599 silc_idlist_get_client_by_id(client, conn, client_id, TRUE);
1600 if (!client_entry2) {
1601 SilcPacketContext *p = silc_packet_context_dup(packet);
1602 p->context = (void *)client;
1604 silc_client_command_pending(conn, SILC_COMMAND_WHOIS, SILC_IDLIST_IDENT,
1605 silc_client_notify_by_server_pending, p);
1608 silc_free(client_id);
1610 /* Get old Client ID */
1611 tmp = silc_argument_get_arg_type(args, 1, &tmp_len);
1615 client_id = silc_id_payload_parse_id(tmp, tmp_len);
1619 /* Find old Client entry */
1621 silc_idlist_get_client_by_id(client, conn, client_id, FALSE);
1625 /* Remove the old from cache */
1626 silc_idcache_del_by_id(conn->client_cache, SILC_ID_CLIENT,
1629 /* Replace old ID entry with new one on all channels. */
1630 silc_client_replace_from_channels(client, conn, client_entry,
1633 /* Notify application */
1634 client->ops->notify(client, conn, type, client_entry, client_entry2);
1637 if (client_entry->nickname)
1638 silc_free(client_entry->nickname);
1639 if (client_entry->server)
1640 silc_free(client_entry->server);
1641 if (client_entry->id)
1642 silc_free(client_entry->id);
1643 if (client_entry->send_key)
1644 silc_cipher_free(client_entry->send_key);
1645 if (client_entry->receive_key)
1646 silc_cipher_free(client_entry->receive_key);
1649 case SILC_NOTIFY_TYPE_CMODE_CHANGE:
1651 * Someone changed a channel mode
1655 tmp = silc_argument_get_arg_type(args, 1, &tmp_len);
1659 client_id = silc_id_payload_parse_id(tmp, tmp_len);
1663 /* Find Client entry */
1665 silc_idlist_get_client_by_id(client, conn, client_id, FALSE);
1670 tmp = silc_argument_get_arg_type(args, 2, &tmp_len);
1674 SILC_GET32_MSB(mode, tmp);
1676 /* Get channel entry */
1677 channel_id = silc_id_str2id(packet->dst_id, packet->dst_id_len,
1681 if (!silc_idcache_find_by_id_one(conn->channel_cache, (void *)channel_id,
1682 SILC_ID_CHANNEL, &id_cache))
1685 channel = (SilcChannelEntry)id_cache->context;
1687 /* Save the new mode */
1688 channel->mode = mode;
1690 /* Notify application. The channel entry is sent last as this notify
1691 is for channel but application don't know it from the arguments
1693 client->ops->notify(client, conn, type, client_entry, mode, channel);
1696 case SILC_NOTIFY_TYPE_CUMODE_CHANGE:
1698 * Someone changed user's mode on a channel
1702 tmp = silc_argument_get_arg_type(args, 1, &tmp_len);
1706 client_id = silc_id_payload_parse_id(tmp, tmp_len);
1710 /* Find Client entry */
1712 silc_idlist_get_client_by_id(client, conn, client_id, FALSE);
1717 tmp = silc_argument_get_arg_type(args, 2, &tmp_len);
1721 SILC_GET32_MSB(mode, tmp);
1723 /* Get target Client ID */
1724 tmp = silc_argument_get_arg_type(args, 3, &tmp_len);
1728 silc_free(client_id);
1729 client_id = silc_id_payload_parse_id(tmp, tmp_len);
1733 /* Find target Client entry */
1735 silc_idlist_get_client_by_id(client, conn, client_id, FALSE);
1739 /* Get channel entry */
1740 channel_id = silc_id_str2id(packet->dst_id, packet->dst_id_len,
1744 if (!silc_idcache_find_by_id_one(conn->channel_cache, (void *)channel_id,
1745 SILC_ID_CHANNEL, &id_cache))
1748 channel = (SilcChannelEntry)id_cache->context;
1751 silc_list_start(channel->clients);
1752 while ((chu = silc_list_get(channel->clients)) != SILC_LIST_END) {
1753 if (chu->client == client_entry) {
1759 /* Notify application. The channel entry is sent last as this notify
1760 is for channel but application don't know it from the arguments
1762 client->ops->notify(client, conn, type, client_entry, mode,
1763 client_entry2, channel);
1766 case SILC_NOTIFY_TYPE_MOTD:
1768 * Received Message of the day
1772 tmp = silc_argument_get_arg_type(args, 1, &tmp_len);
1776 /* Notify application */
1777 client->ops->notify(client, conn, type, tmp);
1780 case SILC_NOTIFY_TYPE_CHANNEL_CHANGE:
1782 * Router has enforced a new ID to a channel. Let's change the old
1783 * ID to the one provided here.
1786 /* Get the old ID */
1787 tmp = silc_argument_get_arg_type(args, 1, &tmp_len);
1790 channel_id = silc_id_payload_parse_id(tmp, tmp_len);
1794 /* Get the channel entry */
1795 if (!silc_idcache_find_by_id_one(conn->channel_cache, (void *)channel_id,
1796 SILC_ID_CHANNEL, &id_cache))
1799 channel = (SilcChannelEntry)id_cache->context;
1801 /* Free the old ID */
1802 silc_free(channel_id);
1803 silc_free(channel->id);
1805 /* Get the new ID */
1806 tmp = silc_argument_get_arg_type(args, 2, &tmp_len);
1809 channel->id = silc_id_payload_parse_id(tmp, tmp_len);
1813 id_cache->id = (void *)channel->id;
1815 /* Notify application */
1816 client->ops->notify(client, conn, type, channel, channel);
1824 silc_notify_payload_free(payload);
1826 silc_free(client_id);
1828 silc_free(channel_id);
1831 /* Processes the received new Client ID from server. Old Client ID is
1832 deleted from cache and new one is added. */
1834 void silc_client_receive_new_id(SilcClient client,
1835 SilcSocketConnection sock,
1838 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1840 /* Delete old ID from ID cache */
1841 silc_idcache_del_by_id(conn->client_cache, SILC_ID_CLIENT, conn->local_id);
1843 /* Save the new ID */
1845 silc_free(conn->local_id);
1846 if (conn->local_id_data)
1847 silc_free(conn->local_id_data);
1849 conn->local_id = silc_id_payload_get_id(idp);
1850 conn->local_id_data = silc_id_payload_get_data(idp);
1851 conn->local_id_data_len = silc_id_payload_get_len(idp);;
1853 if (!conn->local_entry)
1854 conn->local_entry = silc_calloc(1, sizeof(*conn->local_entry));
1856 conn->local_entry->nickname = conn->nickname;
1857 if (!conn->local_entry->username) {
1858 conn->local_entry->username =
1859 silc_calloc(strlen(client->username) + strlen(client->hostname) + 1,
1860 sizeof(conn->local_entry->username));
1861 sprintf(conn->local_entry->username, "%s@%s", client->username,
1864 conn->local_entry->server = strdup(conn->remote_host);
1865 conn->local_entry->id = conn->local_id;
1867 /* Put it to the ID cache */
1868 silc_idcache_add(conn->client_cache, conn->nickname, SILC_ID_CLIENT,
1869 conn->local_id, (void *)conn->local_entry, TRUE);
1872 /* Processed received Channel ID for a channel. This is called when client
1873 joins to channel and server replies with channel ID. The ID is cached. */
1875 void silc_client_new_channel_id(SilcClient client,
1876 SilcSocketConnection sock,
1878 unsigned int mode, SilcIDPayload idp)
1880 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1881 SilcChannelEntry channel;
1883 SILC_LOG_DEBUG(("New channel ID"));
1885 channel = silc_calloc(1, sizeof(*channel));
1886 channel->channel_name = channel_name;
1887 channel->id = silc_id_payload_get_id(idp);
1888 channel->mode = mode;
1889 silc_list_init(channel->clients, struct SilcChannelUserStruct, next);
1891 conn->current_channel = channel;
1893 /* Put it to the ID cache */
1894 silc_idcache_add(conn->channel_cache, channel_name, SILC_ID_CHANNEL,
1895 (void *)channel->id, (void *)channel, TRUE);
1898 /* Saves channel key from encoded `key_payload'. This is used when we
1899 receive Channel Key Payload and when we are processing JOIN command
1902 void silc_client_save_channel_key(SilcClientConnection conn,
1903 SilcBuffer key_payload,
1904 SilcChannelEntry channel)
1906 unsigned char *id_string, *key, *cipher;
1907 unsigned int tmp_len;
1909 SilcIDCacheEntry id_cache = NULL;
1910 SilcChannelKeyPayload payload;
1912 payload = silc_channel_key_payload_parse(key_payload);
1916 id_string = silc_channel_key_get_id(payload, &tmp_len);
1918 silc_channel_key_payload_free(payload);
1922 id = silc_id_str2id(id_string, tmp_len, SILC_ID_CHANNEL);
1924 silc_channel_key_payload_free(payload);
1930 if (!silc_idcache_find_by_id_one(conn->channel_cache, (void *)id,
1931 SILC_ID_CHANNEL, &id_cache))
1934 /* Get channel entry */
1935 channel = (SilcChannelEntry)id_cache->context;
1939 key = silc_channel_key_get_key(payload, &tmp_len);
1940 cipher = silc_channel_key_get_cipher(payload, NULL);
1941 channel->key_len = tmp_len;
1942 channel->key = silc_calloc(tmp_len, sizeof(*channel->key));
1943 memcpy(channel->key, key, tmp_len);
1945 if (!silc_cipher_alloc(cipher, &channel->channel_key)) {
1946 conn->client->ops->say(conn->client, conn,
1947 "Cannot talk to channel: unsupported cipher %s", cipher);
1950 channel->channel_key->cipher->set_key(channel->channel_key->context,
1953 /* Client is now joined to the channel */
1954 channel->on_channel = TRUE;
1958 silc_channel_key_payload_free(payload);
1961 /* Processes received key for channel. The received key will be used
1962 to protect the traffic on the channel for now on. Client must receive
1963 the key to the channel before talking on the channel is possible.
1964 This is the key that server has generated, this is not the channel
1965 private key, it is entirely local setting. */
1967 void silc_client_receive_channel_key(SilcClient client,
1968 SilcSocketConnection sock,
1971 SILC_LOG_DEBUG(("Received key for channel"));
1974 silc_client_save_channel_key(sock->user_data, packet, NULL);
1977 /* Process received message to a channel (or from a channel, really). This
1978 decrypts the channel message with channel specific key and parses the
1979 channel payload. Finally it displays the message on the screen. */
1981 void silc_client_channel_message(SilcClient client,
1982 SilcSocketConnection sock,
1983 SilcPacketContext *packet)
1985 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1986 SilcBuffer buffer = packet->buffer;
1987 SilcChannelPayload payload = NULL;
1988 SilcChannelID *id = NULL;
1989 SilcChannelEntry channel;
1990 SilcChannelUser chu;
1991 SilcIDCacheEntry id_cache = NULL;
1992 SilcClientID *client_id = NULL;
1996 if (packet->dst_id_type != SILC_ID_CHANNEL)
1999 client_id = silc_id_str2id(packet->src_id, packet->src_id_len,
2003 id = silc_id_str2id(packet->dst_id, packet->dst_id_len, SILC_ID_CHANNEL);
2007 /* Find the channel entry from channels on this connection */
2008 if (!silc_idcache_find_by_id_one(conn->channel_cache, (void *)id,
2009 SILC_ID_CHANNEL, &id_cache))
2012 channel = (SilcChannelEntry)id_cache->context;
2014 /* Decrypt the channel message payload. Push the IV out of the way,
2015 since it is not encrypted (after pushing buffer->tail has the IV). */
2016 silc_buffer_push_tail(buffer, 16);
2017 channel->channel_key->cipher->decrypt(channel->channel_key->context,
2018 buffer->data, buffer->data,
2019 buffer->len, buffer->tail);
2020 silc_buffer_pull_tail(buffer, 16);
2022 /* Parse the channel message payload */
2023 payload = silc_channel_payload_parse(buffer);
2028 nickname = "[unknown]";
2029 silc_list_start(channel->clients);
2030 while ((chu = silc_list_get(channel->clients)) != SILC_LIST_END) {
2031 if (!SILC_ID_CLIENT_COMPARE(chu->client->id, client_id)) {
2032 nickname = chu->client->nickname;
2037 /* Pass the message to application */
2038 client->ops->channel_message(client, conn, nickname,
2039 channel->channel_name,
2040 silc_channel_get_data(payload, NULL));
2046 silc_free(client_id);
2048 silc_channel_payload_free(payload);
2051 /* Private message received. This processes the private message and
2052 finally displays it on the screen. */
2054 void silc_client_private_message(SilcClient client,
2055 SilcSocketConnection sock,
2056 SilcPacketContext *packet)
2058 SilcClientConnection conn = (SilcClientConnection)sock->user_data;
2059 SilcBuffer buffer = packet->buffer;
2060 unsigned short nick_len;
2061 unsigned char *nickname, *message;
2065 ret = silc_buffer_unformat(buffer,
2066 SILC_STR_UI16_NSTRING_ALLOC(&nickname, &nick_len),
2071 silc_buffer_pull(buffer, 2 + nick_len);
2073 message = silc_calloc(buffer->len + 1, sizeof(char));
2074 memcpy(message, buffer->data, buffer->len);
2076 /* Pass the private message to application */
2077 client->ops->private_message(client, conn, nickname, message);
2079 /* See if we are away (gone). If we are away we will reply to the
2080 sender with the set away message. */
2081 if (conn->away && conn->away->away) {
2082 SilcClientID *remote_id;
2083 SilcClientEntry remote_client;
2084 SilcIDCacheEntry id_cache;
2086 if (packet->src_id_type != SILC_ID_CLIENT)
2089 remote_id = silc_id_str2id(packet->src_id, packet->src_id_len,
2094 /* If it's me, ignore */
2095 if (!SILC_ID_CLIENT_COMPARE(remote_id, conn->local_id))
2098 /* Check whether we know this client already */
2099 if (!silc_idcache_find_by_id_one(conn->client_cache, remote_id,
2100 SILC_ID_CLIENT, &id_cache))
2102 /* Allocate client entry */
2103 remote_client = silc_calloc(1, sizeof(*remote_client));
2104 remote_client->id = remote_id;
2105 silc_parse_nickname(nickname, &remote_client->nickname,
2106 &remote_client->server, &remote_client->num);
2108 /* Save the client to cache */
2109 silc_idcache_add(conn->client_cache, remote_client->nickname,
2110 SILC_ID_CLIENT, remote_client->id, remote_client,
2113 silc_free(remote_id);
2114 remote_client = (SilcClientEntry)id_cache->context;
2117 /* Send the away message */
2118 silc_client_packet_send_private_message(client, sock, remote_client,
2120 strlen(conn->away->away), TRUE);
2124 memset(message, 0, buffer->len);
2126 silc_free(nickname);
2129 /* Removes a client entry from all channel it has joined. This really is
2130 a performance killer (client_entry should have pointers to channel
2133 void silc_client_remove_from_channels(SilcClient client,
2134 SilcClientConnection conn,
2135 SilcClientEntry client_entry)
2137 SilcIDCacheEntry id_cache;
2138 SilcIDCacheList list;
2139 SilcChannelEntry channel;
2140 SilcChannelUser chu;
2142 if (!silc_idcache_find_by_id(conn->channel_cache, SILC_ID_CACHE_ANY,
2143 SILC_ID_CHANNEL, &list))
2146 silc_idcache_list_first(list, &id_cache);
2147 channel = (SilcChannelEntry)id_cache->context;
2151 /* Remove client from channel */
2152 silc_list_start(channel->clients);
2153 while ((chu = silc_list_get(channel->clients)) != SILC_LIST_END) {
2154 if (chu->client == client_entry) {
2155 silc_list_del(channel->clients, chu);
2161 if (!silc_idcache_list_next(list, &id_cache))
2164 channel = (SilcChannelEntry)id_cache->context;
2167 silc_idcache_list_free(list);
2170 /* Replaces `old' client entries from all channels to `new' client entry.
2171 This can be called for example when nickname changes and old ID entry
2172 is replaced from ID cache with the new one. If the old ID entry is only
2173 updated, then this fucntion needs not to be called. */
2175 void silc_client_replace_from_channels(SilcClient client,
2176 SilcClientConnection conn,
2177 SilcClientEntry old,
2178 SilcClientEntry new)
2180 SilcIDCacheEntry id_cache;
2181 SilcIDCacheList list;
2182 SilcChannelEntry channel;
2183 SilcChannelUser chu;
2185 if (!silc_idcache_find_by_id(conn->channel_cache, SILC_ID_CACHE_ANY,
2186 SILC_ID_CHANNEL, &list))
2189 silc_idcache_list_first(list, &id_cache);
2190 channel = (SilcChannelEntry)id_cache->context;
2194 /* Replace client entry */
2195 silc_list_start(channel->clients);
2196 while ((chu = silc_list_get(channel->clients)) != SILC_LIST_END) {
2197 if (chu->client == old) {
2203 if (!silc_idcache_list_next(list, &id_cache))
2206 channel = (SilcChannelEntry)id_cache->context;
2209 silc_idcache_list_free(list);
2212 /* Parses mode mask and returns the mode as string. */
2214 char *silc_client_chmode(unsigned int mode)
2221 memset(string, 0, sizeof(string));
2223 if (mode & SILC_CHANNEL_MODE_PRIVATE)
2224 strncat(string, "p", 1);
2226 if (mode & SILC_CHANNEL_MODE_SECRET)
2227 strncat(string, "s", 1);
2229 if (mode & SILC_CHANNEL_MODE_PRIVKEY)
2230 strncat(string, "k", 1);
2232 if (mode & SILC_CHANNEL_MODE_INVITE)
2233 strncat(string, "i", 1);
2235 if (mode & SILC_CHANNEL_MODE_TOPIC)
2236 strncat(string, "t", 1);
2238 if (mode & SILC_CHANNEL_MODE_ULIMIT)
2239 strncat(string, "l", 1);
2241 if (mode & SILC_CHANNEL_MODE_PASSPHRASE)
2242 strncat(string, "a", 1);
2244 /* Rest of mode is ignored */
2246 return strdup(string);
2249 /* Parses channel user mode mask and returns te mode as string */
2251 char *silc_client_chumode(unsigned int mode)
2258 memset(string, 0, sizeof(string));
2260 if (mode & SILC_CHANNEL_UMODE_CHANFO)
2261 strncat(string, "f", 1);
2263 if (mode & SILC_CHANNEL_UMODE_CHANOP)
2264 strncat(string, "o", 1);
2266 return strdup(string);
2269 /* Parses channel user mode and returns it as special mode character. */
2271 char *silc_client_chumode_char(unsigned int mode)
2278 memset(string, 0, sizeof(string));
2280 if (mode & SILC_CHANNEL_UMODE_CHANFO)
2281 strncat(string, "*", 1);
2283 if (mode & SILC_CHANNEL_UMODE_CHANOP)
2284 strncat(string, "@", 1);
2286 return strdup(string);