updates.
[silc.git] / lib / silcclient / client_keyagr.c
1 /*
2
3   client_keyagr.c
4
5   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
6
7   Copyright (C) 2001 Pekka Riikonen
8
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.
13   
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.
18
19 */
20 /* $Id$ */
21 /* This file includes the Key Agreement packet processing and actual
22    key agreement routines. This file has nothing to do with the actual
23    connection key exchange protocol, it is implemented in the client.c
24    and in protocol.c. This file implements the client-to-client key 
25    agreement as defined by the SILC protocol. */
26
27 #include "clientlibincludes.h"
28 #include "client_internal.h"
29
30 SILC_TASK_CALLBACK(silc_client_key_agreement_final);
31 SILC_TASK_CALLBACK(silc_client_process_key_agreement);
32 SILC_TASK_CALLBACK(silc_client_key_agreement_timeout);
33 SILC_TASK_CALLBACK(silc_client_perform_key_agreement_start);
34
35 /* Key agreement context */
36 struct SilcClientKeyAgreementStruct {
37   SilcClient client;
38   SilcClientConnection conn;
39   int fd;                                 /* Listening/connection socket */
40   SilcSocketConnection sock;              /* Remote socket connection */
41   SilcClientEntry client_entry;           /* Destination client */
42   SilcKeyAgreementCallback completion;    /* Key agreement completion */
43   void *context;                          /* User context */
44   SilcTask timeout;                       /* Timeout task */
45   SilcClientKEInternalContext *proto_ctx; /* Key Exchange protocol context */
46 };
47
48 /* Packet sending function used by the SKE in the key agreement process. */
49
50 static void silc_client_key_agreement_send_packet(SilcSKE ske,
51                                                   SilcBuffer packet,
52                                                   SilcPacketType type,
53                                                   void *context)
54 {
55   SilcProtocol protocol = (SilcProtocol)context;
56   SilcClientKEInternalContext *ctx = 
57     (SilcClientKEInternalContext *)protocol->context;
58   void *tmp;
59
60   /* Send the packet immediately. We will assure that the packet is not
61      encrypted by setting the socket's user_data pointer to NULL. The
62      silc_client_packet_send would take the keys (wrong keys that is,
63      because user_data is the current SilcClientConnection) from it and
64      we cannot allow that. The packets are never encrypted when doing SKE
65      with another client. */
66   tmp = ske->sock->user_data;
67   ske->sock->user_data = NULL;
68   silc_client_packet_send(ctx->client, ske->sock, type, NULL, 0, NULL, NULL,
69                           packet->data, packet->len, TRUE);
70   ske->sock->user_data = tmp;
71 }
72
73 /* Timeout callback that is called to close the connection and free the
74    socket connection data. */
75
76 SILC_TASK_CALLBACK(silc_client_key_agreement_close)
77 {
78   SilcClientKeyAgreement ke = (SilcClientKeyAgreement)context;
79
80   silc_schedule_unset_listen_fd(ke->client->schedule, ke->sock->sock);
81   silc_schedule_unset_listen_fd(ke->client->schedule, ke->fd);
82   silc_net_close_connection(ke->sock->sock);
83   silc_net_close_connection(ke->fd);
84   silc_socket_free(ke->sock);
85   silc_free(ke);
86 }
87
88 /* This callback is called after the key agreement protocol has been
89    performed. This calls the final completion callback for the application. */
90
91 SILC_TASK_CALLBACK(silc_client_key_agreement_final)
92 {
93   SilcProtocol protocol = (SilcProtocol)context;
94   SilcClientKEInternalContext *ctx = 
95     (SilcClientKEInternalContext *)protocol->context;
96   SilcClient client = (SilcClient)ctx->client;
97   SilcClientKeyAgreement ke = (SilcClientKeyAgreement)ctx->context;
98
99   SILC_LOG_DEBUG(("Start"));
100
101   if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
102       protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
103     /* Error occured during protocol */
104     ke->client_entry->ke = NULL;
105     ke->completion(ke->client, ke->conn, ke->client_entry, 
106                    SILC_KEY_AGREEMENT_ERROR, NULL, ke->context);
107     silc_ske_free_key_material(ctx->keymat);
108     goto out;
109   }
110
111   /* Pass the negotiated key material to the application. The application
112      is responsible of freeing the key material. */
113   ke->client_entry->ke = NULL;
114   ke->completion(ke->client, ke->conn, ke->client_entry, 
115                  SILC_KEY_AGREEMENT_OK, ctx->keymat, ke->context);
116
117  out:
118   silc_protocol_free(protocol);
119   if (ctx->ske)
120     silc_ske_free(ctx->ske);
121   if (ctx->dest_id)
122     silc_free(ctx->dest_id);
123   silc_schedule_task_del_by_fd(client->schedule, ke->fd);
124   silc_schedule_unset_listen_fd(ke->client->schedule, ke->fd);
125   silc_net_close_connection(ke->fd);
126   if (ke->timeout)
127     silc_schedule_task_del(client->schedule, ke->timeout);
128   silc_client_del_socket(ke->client, ke->sock);
129
130   silc_schedule_task_add(client->schedule, 0, 
131                      silc_client_key_agreement_close,
132                      (void *)ke, 0, 1, 
133                      SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
134
135   silc_free(ctx);
136 }
137
138 /* Key agreement callback that is called when remote end has initiated
139    the key agreement protocol. This accepts the incoming TCP/IP connection
140    for the key agreement protocol. */
141
142 SILC_TASK_CALLBACK(silc_client_process_key_agreement)
143 {
144   SilcClientKeyAgreement ke = (SilcClientKeyAgreement)context;
145   SilcClient client = ke->client;
146   SilcClientConnection conn = ke->conn;
147   SilcSocketConnection newsocket;
148   SilcClientKEInternalContext *proto_ctx;
149   int sock;
150
151   SILC_LOG_DEBUG(("Start"));
152
153   sock = silc_net_accept_connection(ke->fd);
154   if (sock < 0) {
155     client->ops->say(client, conn, SILC_CLIENT_MESSAGE_AUDIT,
156                      "Could not accept key agreement connection: ", 
157                      strerror(errno));
158     ke->client_entry->ke = NULL;
159     ke->completion(ke->client, ke->conn, ke->client_entry, 
160                    SILC_KEY_AGREEMENT_ERROR, NULL, ke->context);
161     silc_schedule_task_del_by_fd(client->schedule, ke->fd);
162     silc_schedule_unset_listen_fd(ke->client->schedule, ke->fd);
163     silc_net_close_connection(ke->fd);
164     if (ke->timeout)
165       silc_schedule_task_del(client->schedule, ke->timeout);
166     silc_free(ke);
167     return;
168   }
169
170   /* Set socket options */
171   silc_net_set_socket_nonblock(sock);
172   silc_net_set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 1);
173
174   /* Create socket for this connection (it is of type UNKNOWN since this
175      really is not a real SILC connection. It is only for the key
176      agreement protocol). */
177   silc_socket_alloc(sock, SILC_SOCKET_TYPE_UNKNOWN, (void *)conn, &newsocket);
178   ke->sock = newsocket;
179
180   /* Perform name and address lookups for the remote host. */
181   silc_net_check_host_by_sock(sock, &newsocket->hostname, &newsocket->ip);
182   if (!newsocket->hostname && !newsocket->ip) {
183     client->ops->say(client, conn, SILC_CLIENT_MESSAGE_AUDIT, 
184                      "Could not resolve the remote IP or hostname");
185     ke->client_entry->ke = NULL;
186     ke->completion(ke->client, ke->conn, ke->client_entry, 
187                    SILC_KEY_AGREEMENT_ERROR, NULL, ke->context);
188     silc_schedule_task_del_by_fd(client->schedule, ke->fd);
189     silc_schedule_unset_listen_fd(ke->client->schedule, ke->fd);
190     silc_net_close_connection(ke->fd);
191     if (ke->timeout)
192       silc_schedule_task_del(client->schedule, ke->timeout);
193     silc_free(ke);
194     return;
195   }
196   if (!newsocket->hostname)
197     newsocket->hostname = strdup(newsocket->ip);
198   newsocket->port = silc_net_get_remote_port(sock);
199   silc_client_add_socket(client, newsocket);
200
201   /* Allocate internal context for key exchange protocol. This is
202      sent as context for the protocol. */
203   proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
204   proto_ctx->client = client;
205   proto_ctx->sock = silc_socket_dup(newsocket);
206   proto_ctx->rng = client->rng;
207   proto_ctx->responder = TRUE;
208   proto_ctx->context = context;
209   proto_ctx->send_packet = silc_client_key_agreement_send_packet;
210   proto_ctx->verify = silc_client_protocol_ke_verify_key;
211   ke->proto_ctx = proto_ctx;
212
213   /* Prepare the connection for key exchange protocol. We allocate the
214      protocol but will not start it yet. The connector will be the
215      initiator of the protocol thus we will wait for initiation from 
216      there before we start the protocol. */
217   silc_protocol_alloc(SILC_PROTOCOL_CLIENT_KEY_EXCHANGE, 
218                       &newsocket->protocol, proto_ctx, 
219                       silc_client_key_agreement_final);
220
221   /* Register the connection for network input and output. This sets
222      that scheduler will listen for incoming packets for this connection 
223      and sets that outgoing packets may be sent to this connection as well.
224      However, this doesn't set the scheduler for outgoing traffic, it
225      will be set separately by calling SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT,
226      later when outgoing data is available. */
227   context = (void *)client;
228   SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(sock);
229 }
230
231 /* Timeout occured during key agreement. This means that the key agreement
232    protocol was not completed in the specified timeout. We will call the 
233    completion callback. */
234
235 SILC_TASK_CALLBACK(silc_client_key_agreement_timeout)
236 {
237   SilcClientKeyAgreement ke = (SilcClientKeyAgreement)context;
238
239   ke->client_entry->ke = NULL;
240   ke->completion(ke->client, ke->conn, ke->client_entry, 
241                  SILC_KEY_AGREEMENT_TIMEOUT, NULL, ke->context);
242
243   if (ke->sock) {
244     silc_client_del_socket(ke->client, ke->sock);
245     silc_socket_free(ke->sock);
246   }
247   if (ke->proto_ctx && ke->proto_ctx->ske)
248     silc_ske_free(ke->proto_ctx->ske);
249   ke->client_entry->ke = NULL;
250   if (ke->fd)
251     silc_schedule_task_del_by_fd(ke->client->schedule, ke->fd);
252   silc_schedule_unset_listen_fd(ke->client->schedule, ke->fd);
253   silc_net_close_connection(ke->fd);
254   silc_free(ke);
255 }
256
257 /* Sends key agreement request to the remote client indicated by the
258    `client_entry'. If the caller provides the `hostname' and the `port'
259    arguments then the library will bind the client to that hostname and
260    that port for the key agreement protocol. It also sends the `hostname'
261    and the `port' in the key agreement packet to the remote client. This
262    would indicate that the remote client may initiate the key agreement
263    protocol to the `hostname' on the `port'.  If port is zero then the
264    bound port is undefined (the operating system defines it).
265
266    If the `hostname' and `port' is not provided then empty key agreement
267    packet is sent to the remote client. The remote client may reply with
268    the same packet including its hostname and port. If the library receives
269    the reply from the remote client the `key_agreement' client operation
270    callback will be called to verify whether the user wants to perform the
271    key agreement or not. 
272
273    NOTE: If the application provided the `hostname' and the `port' and the 
274    remote side initiates the key agreement protocol it is not verified
275    from the user anymore whether the protocol should be executed or not.
276    By setting the `hostname' and `port' the user gives permission to
277    perform the protocol (we are responder in this case).
278
279    NOTE: If the remote side decides not to initiate the key agreement
280    or decides not to reply with the key agreement packet then we cannot
281    perform the key agreement at all. If the key agreement protocol is
282    performed the `completion' callback with the `context' will be called.
283    If remote side decides to ignore the request the `completion' will be
284    called after the specified timeout, `timeout_secs'. 
285
286    NOTE: If the `hostname' and the `port' was not provided the `completion'
287    will not be called at all since this does nothing more than sending
288    a packet to the remote host.
289
290    NOTE: There can be only one active key agreement for one client entry.
291    Before setting new one, the old one must be finished (it is finished
292    after calling the completion callback) or the function 
293    silc_client_abort_key_agreement must be called. */
294
295 void silc_client_send_key_agreement(SilcClient client,
296                                     SilcClientConnection conn,
297                                     SilcClientEntry client_entry,
298                                     const char *hostname,
299                                     const char *bindhost,
300                                     int port,
301                                     uint32 timeout_secs,
302                                     SilcKeyAgreementCallback completion,
303                                     void *context)
304 {
305   SilcSocketConnection sock = conn->sock;
306   SilcClientKeyAgreement ke = NULL;
307   SilcBuffer buffer;
308
309   assert(client_entry);
310
311   if (client_entry->ke)
312     return;
313
314   /* Create the listener if hostname and port was provided.
315    * also, use bindhost if it was specified.
316    */
317    
318   if (hostname) {
319     ke = silc_calloc(1, sizeof(*ke));
320     
321     if (bindhost) {
322       ke->fd = silc_net_create_server(port, bindhost);
323     }
324     else {
325     ke->fd = silc_net_create_server(port, hostname);
326     }
327
328     if (ke->fd < 0) {
329       client->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR, 
330                        "Cannot create listener on %s on port %d: %s", 
331                        (bindhost) ? bindhost:hostname, port, strerror(errno));
332       completion(client, conn, client_entry, SILC_KEY_AGREEMENT_FAILURE,
333                  NULL, context);
334       silc_free(ke);
335
336       return;
337     }
338
339     ke->client = client;
340     ke->conn = conn;
341     ke->client_entry = client_entry;
342     ke->completion = completion;
343     ke->context = context;
344
345     /* Add listener task to the scheduler. This task receives the key 
346        negotiations. */
347     silc_schedule_task_add(client->schedule, ke->fd,
348                            silc_client_process_key_agreement,
349                            (void *)ke, 0, 0, 
350                            SILC_TASK_FD,
351                            SILC_TASK_PRI_NORMAL);
352
353     /* Register a timeout task that will be executed if the connector
354        will not start the key exchange protocol within the specified 
355        timeout. */
356     ke->timeout = silc_schedule_task_add(client->schedule, 0, 
357                                          silc_client_key_agreement_timeout,
358                                          (void *)ke, timeout_secs, 0, 
359                                          SILC_TASK_TIMEOUT, SILC_TASK_PRI_LOW);
360   }
361
362   /* Encode the key agreement payload */
363   buffer = silc_key_agreement_payload_encode(hostname, 
364                                              !ke ? port : 
365                                              silc_net_get_local_port(ke->fd));
366
367   /* Send the key agreement packet to the client */
368   silc_client_packet_send(client, sock, SILC_PACKET_KEY_AGREEMENT,
369                           client_entry->id, SILC_ID_CLIENT, NULL, NULL,
370                           buffer->data, buffer->len, FALSE);
371   silc_buffer_free(buffer);
372
373 }
374
375 static int 
376 silc_client_connect_to_client_internal(SilcClientInternalConnectContext *ctx)
377 {
378   int sock;
379
380   /* Create connection to server asynchronously */
381   sock = silc_net_create_connection_async(NULL, ctx->port, ctx->host);
382   if (sock < 0)
383     return -1;
384
385   /* Register task that will receive the async connect and will
386      read the result. */
387   ctx->task = silc_schedule_task_add(ctx->client->schedule, sock, 
388                                      silc_client_perform_key_agreement_start,
389                                      (void *)ctx, 0, 0, 
390                                      SILC_TASK_FD,
391                                      SILC_TASK_PRI_NORMAL);
392   silc_schedule_set_listen_fd(ctx->client->schedule, sock, SILC_TASK_WRITE);
393
394   ctx->sock = sock;
395
396   return sock;
397 }
398
399 /* Routine used by silc_client_perform_key_agreement to create connection
400    to the remote client on specified port. */
401
402 static int
403 silc_client_connect_to_client(SilcClient client, 
404                               SilcClientConnection conn, int port,
405                               char *host, void *context)
406 {
407   SilcClientInternalConnectContext *ctx;
408
409   /* Allocate internal context for connection process. This is
410      needed as we are doing async connecting. */
411   ctx = silc_calloc(1, sizeof(*ctx));
412   ctx->client = client;
413   ctx->conn = conn;
414   ctx->host = strdup(host);
415   ctx->port = port;
416   ctx->tries = 0;
417   ctx->context = context;
418
419   /* Do the actual connecting process */
420   return silc_client_connect_to_client_internal(ctx);
421 }
422
423 /* Callback that is called after connection has been created. This actually
424    starts the key agreement protocol. This is initiator function. */
425
426 SILC_TASK_CALLBACK(silc_client_perform_key_agreement_start)
427 {
428   SilcClientInternalConnectContext *ctx =
429     (SilcClientInternalConnectContext *)context;
430   SilcClient client = ctx->client;
431   SilcClientConnection conn = ctx->conn;
432   SilcClientKeyAgreement ke = (SilcClientKeyAgreement)ctx->context;
433   int opt, opt_len = sizeof(opt);
434
435   SILC_LOG_DEBUG(("Start"));
436
437   /* Check the socket status as it might be in error */
438   silc_net_get_socket_opt(fd, SOL_SOCKET, SO_ERROR, &opt, &opt_len);
439   if (opt != 0) {
440     if (ctx->tries < 2) {
441       /* Connection failed but lets try again */
442       client->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
443                        "Could not connect to client %s: %s",
444                        ctx->host, strerror(opt));
445       client->ops->say(client, conn, SILC_CLIENT_MESSAGE_AUDIT, 
446                        "Connecting to port %d of client %s resumed", 
447                        ctx->port, ctx->host);
448
449       /* Unregister old connection try */
450       silc_schedule_unset_listen_fd(client->schedule, fd);
451       silc_net_close_connection(fd);
452       silc_schedule_task_del(client->schedule, ctx->task);
453
454       /* Try again */
455       silc_client_connect_to_client_internal(ctx);
456       ctx->tries++;
457     } else {
458       /* Connection failed and we won't try anymore */
459       client->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
460                        "Could not connect to client %s: %s",
461                        ctx->host, strerror(opt));
462       silc_schedule_unset_listen_fd(client->schedule, fd);
463       silc_net_close_connection(fd);
464       silc_schedule_task_del(client->schedule, ctx->task);
465       silc_free(ctx->host);
466       silc_free(ctx);
467
468       /* Call the completion callback */
469       ke->completion(ke->client, ke->conn, ke->client_entry, 
470                      SILC_KEY_AGREEMENT_FAILURE, NULL, ke->context);
471       silc_free(ke);
472     }
473     return;
474   }
475
476   silc_schedule_unset_listen_fd(client->schedule, fd);
477   silc_schedule_task_del(client->schedule, ctx->task);
478
479   ke->fd = fd;
480
481   /* Now actually perform the key agreement protocol */
482   silc_client_perform_key_agreement_fd(ke->client, ke->conn,
483                                        ke->client_entry, ke->fd, ctx->host,
484                                        ke->completion, ke->context);
485   silc_free(ke);
486   silc_free(ctx->host);
487   silc_free(ctx);
488 }
489
490 /* Performs the actual key agreement protocol. Application may use this
491    to initiate the key agreement protocol. This can be called for example
492    after the application has received the `key_agreement' client operation,
493    and did not return TRUE from it.
494
495    The `hostname' is the remote hostname (or IP address) and the `port'
496    is the remote port. The `completion' callback with the `context' will
497    be called after the key agreement protocol.
498    
499    NOTE: If the application returns TRUE in the `key_agreement' client
500    operation the library will automatically start the key agreement. In this
501    case the application must not call this function. However, application
502    may choose to just ignore the `key_agreement' client operation (and
503    merely just print information about it on the screen) and call this
504    function when the user whishes to do so (by, for example, giving some
505    specific command). Thus, the API provides both, automatic and manual
506    initiation of the key agreement. Calling this function is the manual
507    initiation and returning TRUE in the `key_agreement' client operation
508    is the automatic initiation. */
509
510 void silc_client_perform_key_agreement(SilcClient client,
511                                        SilcClientConnection conn,
512                                        SilcClientEntry client_entry,
513                                        char *hostname,
514                                        int port,
515                                        SilcKeyAgreementCallback completion,
516                                        void *context)
517 {
518   SilcClientKeyAgreement ke;
519
520   SILC_LOG_DEBUG(("Start"));
521
522   assert(client_entry && hostname && port);
523
524   ke = silc_calloc(1, sizeof(*ke));
525   ke->client = client;
526   ke->conn = conn;
527   ke->client_entry = client_entry;
528   ke->completion = completion;
529   ke->context = context;
530
531   /* Connect to the remote client */
532   ke->fd = silc_client_connect_to_client(client, conn, port, hostname, ke);
533   if (ke->fd < 0) {
534     completion(client, conn, client_entry, SILC_KEY_AGREEMENT_FAILURE,
535                NULL, context);
536     silc_free(ke);
537     return;
538   }
539 }
540
541 /* Same as above but application has created already the connection to 
542    the remote host. The `sock' is the socket to the remote connection. 
543    Application can use this function if it does not want the client library
544    to create the connection. */
545
546 void silc_client_perform_key_agreement_fd(SilcClient client,
547                                           SilcClientConnection conn,
548                                           SilcClientEntry client_entry,
549                                           int sock,
550                                           char *hostname,
551                                           SilcKeyAgreementCallback completion,
552                                           void *context)
553 {
554   SilcClientKeyAgreement ke;
555   SilcClientKEInternalContext *proto_ctx;
556   SilcProtocol protocol;
557
558   SILC_LOG_DEBUG(("Start"));
559
560   assert(client_entry);
561
562   ke = silc_calloc(1, sizeof(*ke));
563   ke->client = client;
564   ke->conn = conn;
565   ke->client_entry = client_entry;
566   ke->fd = sock;
567   ke->completion = completion;
568   ke->context = context;
569
570   /* Allocate new socket connection object */
571   silc_socket_alloc(sock, SILC_SOCKET_TYPE_UNKNOWN, (void *)conn, &ke->sock);
572   silc_client_add_socket(client, ke->sock);
573   ke->sock->hostname = strdup(hostname);
574   ke->sock->port = silc_net_get_remote_port(sock);
575
576   /* Allocate internal context for key exchange protocol. This is
577      sent as context for the protocol. */
578   proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
579   proto_ctx->client = client;
580   proto_ctx->sock = silc_socket_dup(ke->sock);
581   proto_ctx->rng = client->rng;
582   proto_ctx->responder = FALSE;
583   proto_ctx->context = ke;
584   proto_ctx->send_packet = silc_client_key_agreement_send_packet;
585   proto_ctx->verify = silc_client_protocol_ke_verify_key;
586   ke->proto_ctx = proto_ctx;
587
588   /* Perform key exchange protocol. */
589   silc_protocol_alloc(SILC_PROTOCOL_CLIENT_KEY_EXCHANGE, 
590                       &protocol, (void *)proto_ctx,
591                       silc_client_key_agreement_final);
592   ke->sock->protocol = protocol;
593
594   /* Register the connection for network input and output. This sets
595      that scheduler will listen for incoming packets for this connection 
596      and sets that outgoing packets may be sent to this connection as well.
597      However, this doesn't set the scheduler for outgoing traffic, it will 
598      be set separately by calling SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT,
599      later when outgoing data is available. */
600   context = (void *)client;
601   SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(sock);
602
603   /* Execute the protocol */
604   silc_protocol_execute(protocol, client->schedule, 0, 0);
605 }
606
607 /* This function can be called to unbind the hostname and the port for
608    the key agreement protocol. However, this function has effect only 
609    before the key agreement protocol has been performed. After it has
610    been performed the library will automatically unbind the port. The 
611    `client_entry' is the client to which we sent the key agreement 
612    request. */
613
614 void silc_client_abort_key_agreement(SilcClient client,
615                                      SilcClientConnection conn,
616                                      SilcClientEntry client_entry)
617 {
618   assert(client_entry);
619
620   if (client_entry->ke) {
621     if (client_entry->ke->sock) {
622       silc_client_del_socket(client_entry->ke->client, client_entry->ke->sock);
623       silc_socket_free(client_entry->ke->sock);
624     }
625     client_entry->ke = NULL;
626     silc_schedule_task_del_by_fd(client->schedule, client_entry->ke->fd);
627     if (client_entry->ke->timeout)
628       silc_schedule_task_del(client->schedule, 
629                            client_entry->ke->timeout);
630     silc_free(client_entry->ke);
631   }
632 }
633
634 /* Callback function that is called after we've resolved the client 
635    information who sent us the key agreement packet from the server.
636    We actually call the key_agreement client operation now. */
637
638 static void 
639 silc_client_key_agreement_resolve_cb(SilcClient client,
640                                      SilcClientConnection conn,
641                                      SilcClientEntry *clients,
642                                      uint32 clients_count,
643                                      void *context)
644 {
645   SilcPacketContext *packet = (SilcPacketContext *)context;
646   SilcKeyAgreementPayload payload;
647   int ret;
648   SilcKeyAgreementCallback completion;
649   void *completion_context;
650
651   if (!clients)
652     goto out;
653
654   /* Parse the key agreement payload */
655   payload = silc_key_agreement_payload_parse(packet->buffer);
656   if (!payload)
657     goto out;
658
659   /* Call the key_agreement client operation */
660   ret = client->ops->key_agreement(client, conn, clients[0], 
661                                    silc_key_agreement_get_hostname(payload),
662                                    silc_key_agreement_get_port(payload),
663                                    &completion, &completion_context);
664
665   /* If the user returned TRUE then we'll start the key agreement right
666      here and right now. */
667   if (ret == TRUE)
668     silc_client_perform_key_agreement(client, conn, clients[0],
669                                       silc_key_agreement_get_hostname(payload),
670                                       silc_key_agreement_get_port(payload),
671                                       completion, completion_context);
672
673   silc_key_agreement_payload_free(payload);
674
675  out:
676   silc_packet_context_free(packet);
677 }
678
679 /* Received Key Agreement packet from remote client. Process the packet
680    and resolve the client information from the server before actually
681    letting the application know that we've received this packet.  Then 
682    call the key_agreement client operation and let the user decide
683    whether we perform the key agreement protocol now or not. */
684
685 void silc_client_key_agreement(SilcClient client,
686                                SilcSocketConnection sock,
687                                SilcPacketContext *packet)
688 {
689   SilcClientID *remote_id;
690
691   if (packet->src_id_type != SILC_ID_CLIENT)
692     return;
693
694   remote_id = silc_id_str2id(packet->src_id, packet->src_id_len, 
695                              SILC_ID_CLIENT);
696   if (!remote_id)
697     return;
698
699   silc_client_get_client_by_id_resolve(client, sock->user_data, remote_id,
700                                        silc_client_key_agreement_resolve_cb,
701                                        silc_packet_context_dup(packet));
702   silc_free(remote_id);
703 }