lib/silcclient/client.c

   1 /*
   2
   3   client.c
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 2002 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; version 2 of the License.
  12
  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.
  17
  18 */
  19 /* $Id$ */
  20
  21 #include "silcincludes.h"
  22 #include "silcclient.h"
  23 #include "client_internal.h"
  24
  25 /* Static task callback prototypes */
  26 SILC_TASK_CALLBACK(silc_client_connect_to_server_start);
  27 SILC_TASK_CALLBACK(silc_client_connect_to_server_second);
  28 SILC_TASK_CALLBACK(silc_client_connect_to_server_final);
  29 SILC_TASK_CALLBACK(silc_client_rekey_callback);
  30 SILC_TASK_CALLBACK(silc_client_rekey_final);
  31
  32 static bool silc_client_packet_parse(SilcPacketParserContext *parser_context,
  33                                      void *context);
  34 static void silc_client_packet_parse_type(SilcClient client,
  35                                           SilcSocketConnection sock,
  36                                           SilcPacketContext *packet);
  37 void silc_client_resolve_auth_method(bool success,
  38                                      SilcProtocolAuthMeth auth_meth,
  39                                      const unsigned char *auth_data,
  40                                      SilcUInt32 auth_data_len, void *context);
  41
  42 /* Allocates new client object. This has to be done before client may
  43    work. After calling this one must call silc_client_init to initialize
  44    the client. The `application' is application specific user data pointer
  45    and caller must free it. */
  46
  47 SilcClient silc_client_alloc(SilcClientOperations *ops,
  48                              SilcClientParams *params,
  49                              void *application,
  50                              const char *silc_version)
  51 {
  52   SilcClient new_client;
  53
  54   new_client = silc_calloc(1, sizeof(*new_client));
  55   new_client->application = application;
  56
  57   new_client->internal = silc_calloc(1, sizeof(*new_client->internal));
  58   new_client->internal->ops = ops;
  59   new_client->internal->params =
  60     silc_calloc(1, sizeof(*new_client->internal->params));
  61   new_client->internal->silc_client_version = strdup(silc_version);
  62
  63   if (params)
  64     memcpy(new_client->internal->params, params, sizeof(*params));
  65
  66   if (!new_client->internal->params->task_max)
  67     new_client->internal->params->task_max = 200;
  68
  69   if (!new_client->internal->params->rekey_secs)
  70     new_client->internal->params->rekey_secs = 3600;
  71
  72   if (!new_client->internal->params->connauth_request_secs)
  73     new_client->internal->params->connauth_request_secs = 2;
  74
  75   new_client->internal->params->
  76     nickname_format[sizeof(new_client->internal->
  77                            params->nickname_format) - 1] = 0;
  78
  79   return new_client;
  80 }
  81
  82 /* Frees client object and its internals. */
  83
  84 void silc_client_free(SilcClient client)
  85 {
  86   if (client) {
  87     if (client->rng)
  88       silc_rng_free(client->rng);
  89
  90     silc_free(client->internal->params);
  91     silc_free(client->internal->silc_client_version);
  92     silc_free(client->internal);
  93     silc_free(client);
  94   }
  95 }
  96
  97 /* Initializes the client. This makes all the necessary steps to make
  98    the client ready to be run. One must call silc_client_run to run the
  99    client. Returns FALSE if error occured, TRUE otherwise. */
 100
 101 int silc_client_init(SilcClient client)
 102 {
 103   SILC_LOG_DEBUG(("Initializing client"));
 104
 105   /* Initialize hash functions for client to use */
 106   silc_hash_alloc("md5", &client->internal->md5hash);
 107   silc_hash_alloc("sha1", &client->internal->sha1hash);
 108
 109   /* Initialize none cipher */
 110   silc_cipher_alloc("none", &client->internal->none_cipher);
 111
 112   /* Initialize random number generator */
 113   client->rng = silc_rng_alloc();
 114   silc_rng_init(client->rng);
 115   silc_rng_global_init(client->rng);
 116
 117   /* Register protocols */
 118   silc_client_protocols_register();
 119
 120   /* Initialize the scheduler */
 121   client->schedule =
 122     silc_schedule_init(client->internal->params->task_max ?
 123                        client->internal->params->task_max : 200);
 124   if (!client->schedule)
 125     return FALSE;
 126
 127   /* Register commands */
 128   silc_client_commands_register(client);
 129
 130   return TRUE;
 131 }
 132
 133 /* Stops the client. This is called to stop the client and thus to stop
 134    the program. */
 135
 136 void silc_client_stop(SilcClient client)
 137 {
 138   SILC_LOG_DEBUG(("Stopping client"));
 139
 140   silc_schedule_stop(client->schedule);
 141   silc_schedule_uninit(client->schedule);
 142
 143   silc_client_protocols_unregister();
 144   silc_client_commands_unregister(client);
 145
 146   SILC_LOG_DEBUG(("Client stopped"));
 147 }
 148
 149 /* Runs the client. This starts the scheduler from the utility library.
 150    When this functions returns the execution of the appliation is over. */
 151
 152 void silc_client_run(SilcClient client)
 153 {
 154   SILC_LOG_DEBUG(("Running client"));
 155
 156   /* Start the scheduler, the heart of the SILC client. When this returns
 157      the program will be terminated. */
 158   silc_schedule(client->schedule);
 159 }
 160
 161 /* Runs the client and returns immeadiately. This function is used when
 162    the SILC Client object indicated by the `client' is run under some
 163    other scheduler, or event loop or main loop.  On GUI applications,
 164    for example this may be desired to use to run the client under the
 165    GUI application's main loop.  Typically the GUI application would
 166    register an idle task that calls this function multiple times in
 167    a second to quickly process the SILC specific data. */
 168
 169 void silc_client_run_one(SilcClient client)
 170 {
 171   /* Run the scheduler once. */
 172   silc_schedule_one(client->schedule, 0);
 173 }
 174
 175 static void silc_client_entry_destructor(SilcIDCache cache,
 176                                          SilcIDCacheEntry entry)
 177 {
 178   silc_free(entry->name);
 179 }
 180
 181 /* Allocates and adds new connection to the client. This adds the allocated
 182    connection to the connection table and returns a pointer to it. A client
 183    can have multiple connections to multiple servers. Every connection must
 184    be added to the client using this function. User data `context' may
 185    be sent as argument. This function is normally used only if the
 186    application performed the connecting outside the library. The library
 187    however may use this internally. */
 188
 189 SilcClientConnection silc_client_add_connection(SilcClient client,
 190                                                 char *hostname,
 191                                                 int port,
 192                                                 void *context)
 193 {
 194   SilcClientConnection conn;
 195   int i;
 196
 197   conn = silc_calloc(1, sizeof(*conn));
 198
 199   /* Initialize ID caches */
 200   conn->client_cache = silc_idcache_alloc(0, SILC_ID_CLIENT,
 201                                           silc_client_entry_destructor);
 202   conn->channel_cache = silc_idcache_alloc(0, SILC_ID_CHANNEL, NULL);
 203   conn->server_cache = silc_idcache_alloc(0, SILC_ID_SERVER, NULL);
 204   conn->client = client;
 205   conn->remote_host = strdup(hostname);
 206   conn->remote_port = port;
 207   conn->context = context;
 208   conn->pending_commands = silc_dlist_init();
 209   conn->ftp_sessions = silc_dlist_init();
 210
 211   /* Add the connection to connections table */
 212   for (i = 0; i < client->internal->conns_count; i++)
 213     if (client->internal->conns && !client->internal->conns[i]) {
 214       client->internal->conns[i] = conn;
 215       return conn;
 216     }
 217
 218   client->internal->conns =
 219     silc_realloc(client->internal->conns, sizeof(*client->internal->conns)
 220                  * (client->internal->conns_count + 1));
 221   client->internal->conns[client->internal->conns_count] = conn;
 222   client->internal->conns_count++;
 223
 224   return conn;
 225 }
 226
 227 /* Removes connection from client. Frees all memory. */
 228
 229 void silc_client_del_connection(SilcClient client, SilcClientConnection conn)
 230 {
 231   int i;
 232
 233   for (i = 0; i < client->internal->conns_count; i++)
 234     if (client->internal->conns[i] == conn) {
 235
 236       silc_idcache_free(conn->client_cache);
 237       silc_idcache_free(conn->channel_cache);
 238       silc_idcache_free(conn->server_cache);
 239       if (conn->pending_commands)
 240         silc_dlist_uninit(conn->pending_commands);
 241       silc_free(conn->remote_host);
 242       silc_dlist_uninit(conn->ftp_sessions);
 243       silc_free(conn);
 244
 245       client->internal->conns[i] = NULL;
 246     }
 247 }
 248
 249 /* Adds listener socket to the listener sockets table. This function is
 250    used to add socket objects that are listeners to the client.  This should
 251    not be used to add other connection objects. */
 252
 253 void silc_client_add_socket(SilcClient client, SilcSocketConnection sock)
 254 {
 255   int i;
 256
 257   if (!client->internal->sockets) {
 258     client->internal->sockets =
 259       silc_calloc(1, sizeof(*client->internal->sockets));
 260     client->internal->sockets[0] = silc_socket_dup(sock);
 261     client->internal->sockets_count = 1;
 262     return;
 263   }
 264
 265   for (i = 0; i < client->internal->sockets_count; i++) {
 266     if (client->internal->sockets[i] == NULL) {
 267       client->internal->sockets[i] = silc_socket_dup(sock);
 268       return;
 269     }
 270   }
 271
 272   client->internal->sockets =
 273     silc_realloc(client->internal->sockets,
 274                  sizeof(*client->internal->sockets) *
 275                  (client->internal->sockets_count + 1));
 276   client->internal->sockets[client->internal->sockets_count] =
 277     silc_socket_dup(sock);
 278   client->internal->sockets_count++;
 279 }
 280
 281 /* Deletes listener socket from the listener sockets table. */
 282
 283 void silc_client_del_socket(SilcClient client, SilcSocketConnection sock)
 284 {
 285   int i;
 286
 287   if (!client->internal->sockets)
 288     return;
 289
 290   for (i = 0; i < client->internal->sockets_count; i++) {
 291     if (client->internal->sockets[i] == sock) {
 292       silc_socket_free(sock);
 293       client->internal->sockets[i] = NULL;
 294       return;
 295     }
 296   }
 297 }
 298
 299 static int
 300 silc_client_connect_to_server_internal(SilcClientInternalConnectContext *ctx)
 301 {
 302   int sock;
 303
 304   /* XXX In the future we should give up this non-blocking connect all
 305      together and use threads instead. */
 306   /* Create connection to server asynchronously */
 307   sock = silc_net_create_connection_async(NULL, ctx->port, ctx->host);
 308   if (sock < 0)
 309     return -1;
 310
 311   /* Register task that will receive the async connect and will
 312      read the result. */
 313   ctx->task = silc_schedule_task_add(ctx->client->schedule, sock,
 314                                      silc_client_connect_to_server_start,
 315                                      (void *)ctx, 0, 0,
 316                                      SILC_TASK_FD,
 317                                      SILC_TASK_PRI_NORMAL);
 318   silc_schedule_set_listen_fd(ctx->client->schedule, sock, SILC_TASK_WRITE);
 319
 320   ctx->sock = sock;
 321
 322   return sock;
 323 }
 324
 325 /* Connects to remote server. This is the main routine used to connect
 326    to SILC server. Returns -1 on error and the created socket otherwise.
 327    The `context' is user context that is saved into the SilcClientConnection
 328    that is created after the connection is created. Note that application
 329    may handle the connecting process outside the library. If this is the
 330    case then this function is not used at all. When the connecting is
 331    done the `connect' client operation is called. */
 332
 333 int silc_client_connect_to_server(SilcClient client, int port,
 334                                   char *host, void *context)
 335 {
 336   SilcClientInternalConnectContext *ctx;
 337   SilcClientConnection conn;
 338   int sock;
 339
 340   SILC_LOG_DEBUG(("Connecting to port %d of server %s",
 341                   port, host));
 342
 343   conn = silc_client_add_connection(client, host, port, context);
 344
 345   client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_AUDIT,
 346                              "Connecting to port %d of server %s", port, host);
 347
 348   /* Allocate internal context for connection process. This is
 349      needed as we are doing async connecting. */
 350   ctx = silc_calloc(1, sizeof(*ctx));
 351   ctx->client = client;
 352   ctx->conn = conn;
 353   ctx->host = strdup(host);
 354   ctx->port = port;
 355   ctx->tries = 0;
 356
 357   /* Do the actual connecting process */
 358   sock = silc_client_connect_to_server_internal(ctx);
 359   if (sock == -1)
 360     silc_client_del_connection(client, conn);
 361   return sock;
 362 }
 363
 364 /* Socket hostname and IP lookup callback that is called before actually
 365    starting the key exchange.  The lookup is called from the function
 366    silc_client_start_key_exchange. */
 367
 368 static void silc_client_start_key_exchange_cb(SilcSocketConnection sock,
 369                                               void *context)
 370 {
 371   SilcClientConnection conn = (SilcClientConnection)context;
 372   SilcClient client = conn->client;
 373   SilcProtocol protocol;
 374   SilcClientKEInternalContext *proto_ctx;
 375
 376   SILC_LOG_DEBUG(("Start"));
 377
 378   /* XXX We should most likely use the resolved host name instead of the
 379      one user provided for us. */
 380   silc_free(conn->sock->hostname);
 381   conn->sock->hostname = strdup(conn->remote_host);
 382   if (!conn->sock->ip)
 383     conn->sock->ip = strdup(conn->remote_host);
 384   conn->sock->port = conn->remote_port;
 385
 386   /* Allocate internal Key Exchange context. This is sent to the
 387      protocol as context. */
 388   proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
 389   proto_ctx->client = (void *)client;
 390   proto_ctx->sock = silc_socket_dup(conn->sock);
 391   proto_ctx->rng = client->rng;
 392   proto_ctx->responder = FALSE;
 393   proto_ctx->send_packet = silc_client_protocol_ke_send_packet;
 394   proto_ctx->verify = silc_client_protocol_ke_verify_key;
 395
 396   /* Perform key exchange protocol. silc_client_connect_to_server_final
 397      will be called after the protocol is finished. */
 398   silc_protocol_alloc(SILC_PROTOCOL_CLIENT_KEY_EXCHANGE,
 399                       &protocol, (void *)proto_ctx,
 400                       silc_client_connect_to_server_second);
 401   if (!protocol) {
 402     client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
 403                                "Error: Could not start key exchange protocol");
 404     silc_net_close_connection(conn->sock->sock);
 405     client->internal->ops->connect(client, conn, FALSE);
 406     return;
 407   }
 408   conn->sock->protocol = protocol;
 409
 410   /* Register the connection for network input and output. This sets
 411      that scheduler will listen for incoming packets for this connection
 412      and sets that outgoing packets may be sent to this connection as well.
 413      However, this doesn't set the scheduler for outgoing traffic, it will
 414      be set separately by calling SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT,
 415      later when outgoing data is available. */
 416   context = (void *)client;
 417   SILC_CLIENT_REGISTER_CONNECTION_FOR_IO(conn->sock->sock);
 418
 419   /* Execute the protocol */
 420   silc_protocol_execute(protocol, client->schedule, 0, 0);
 421 }
 422
 423 /* Start SILC Key Exchange (SKE) protocol to negotiate shared secret
 424    key material between client and server.  This function can be called
 425    directly if application is performing its own connecting and does not
 426    use the connecting provided by this library. This function is normally
 427    used only if the application performed the connecting outside the library.
 428    The library however may use this internally. */
 429
 430 void silc_client_start_key_exchange(SilcClient client,
 431                                     SilcClientConnection conn,
 432                                     int fd)
 433 {
 434   /* Allocate new socket connection object */
 435   silc_socket_alloc(fd, SILC_SOCKET_TYPE_SERVER, (void *)conn, &conn->sock);
 436
 437   /* Sometimes when doing quick reconnects the new socket may be same as
 438      the old one and there might be pending stuff for the old socket.
 439      If new one is same then those pending sutff might cause problems.
 440      Make sure they do not do that. */
 441   silc_schedule_task_del_by_fd(client->schedule, fd);
 442
 443   conn->nickname = (client->nickname ? strdup(client->nickname) :
 444                     strdup(client->username));
 445
 446   /* Resolve the remote hostname and IP address for our socket connection */
 447   silc_socket_host_lookup(conn->sock, FALSE, silc_client_start_key_exchange_cb,
 448                           conn, client->schedule);
 449 }
 450
 451 /* Callback called when error has occurred during connecting to the server.
 452    The `connect' client operation will be called. */
 453
 454 SILC_TASK_CALLBACK(silc_client_connect_failure)
 455 {
 456   SilcClientKEInternalContext *ctx =
 457     (SilcClientKEInternalContext *)context;
 458   SilcClient client = (SilcClient)ctx->client;
 459
 460   client->internal->ops->connect(client, ctx->sock->user_data, FALSE);
 461   if (ctx->packet)
 462     silc_packet_context_free(ctx->packet);
 463   silc_free(ctx);
 464 }
 465
 466 /* Start of the connection to the remote server. This is called after
 467    succesful TCP/IP connection has been established to the remote host. */
 468
 469 SILC_TASK_CALLBACK(silc_client_connect_to_server_start)
 470 {
 471   SilcClientInternalConnectContext *ctx =
 472     (SilcClientInternalConnectContext *)context;
 473   SilcClient client = ctx->client;
 474   SilcClientConnection conn = ctx->conn;
 475   int opt, opt_len = sizeof(opt);
 476
 477   SILC_LOG_DEBUG(("Start"));
 478
 479   /* Check the socket status as it might be in error */
 480   silc_net_get_socket_opt(fd, SOL_SOCKET, SO_ERROR, &opt, &opt_len);
 481   if (opt != 0) {
 482     if (ctx->tries < 2) {
 483       /* Connection failed but lets try again */
 484       client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
 485                                  "Could not connect to server %s: %s",
 486                                  ctx->host, strerror(opt));
 487       client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_AUDIT,
 488                                  "Connecting to port %d of server %s resumed",
 489                                  ctx->port, ctx->host);
 490
 491       /* Unregister old connection try */
 492       silc_schedule_unset_listen_fd(client->schedule, fd);
 493       silc_net_close_connection(fd);
 494       silc_schedule_task_del(client->schedule, ctx->task);
 495
 496       /* Try again */
 497       silc_client_connect_to_server_internal(ctx);
 498       ctx->tries++;
 499     } else {
 500       /* Connection failed and we won't try anymore */
 501       client->internal->ops->say(client, conn, SILC_CLIENT_MESSAGE_ERROR,
 502                                  "Could not connect to server %s: %s",
 503                                  ctx->host, strerror(opt));
 504       silc_schedule_unset_listen_fd(client->schedule, fd);
 505       silc_net_close_connection(fd);
 506       silc_schedule_task_del(client->schedule, ctx->task);
 507       silc_free(ctx);
 508
 509       /* Notify application of failure */
 510       client->internal->ops->connect(client, conn, FALSE);
 511       silc_client_del_connection(client, conn);
 512     }
 513     return;
 514   }
 515
 516   silc_schedule_unset_listen_fd(client->schedule, fd);
 517   silc_schedule_task_del(client->schedule, ctx->task);
 518   silc_free(ctx);
 519
 520   silc_client_start_key_exchange(client, conn, fd);
 521 }
 522
 523 /* Second part of the connecting to the server. This executed
 524    authentication protocol. */
 525
 526 SILC_TASK_CALLBACK(silc_client_connect_to_server_second)
 527 {
 528   SilcProtocol protocol = (SilcProtocol)context;
 529   SilcClientKEInternalContext *ctx =
 530     (SilcClientKEInternalContext *)protocol->context;
 531   SilcClient client = (SilcClient)ctx->client;
 532   SilcSocketConnection sock = NULL;
 533   SilcClientConnAuthInternalContext *proto_ctx;
 534
 535   SILC_LOG_DEBUG(("Start"));
 536
 537   if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
 538       protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
 539     /* Error occured during protocol */
 540     SILC_LOG_DEBUG(("Error during KE protocol"));
 541     silc_protocol_free(protocol);
 542     silc_ske_free_key_material(ctx->keymat);
 543     if (ctx->ske)
 544       silc_ske_free(ctx->ske);
 545     if (ctx->dest_id)
 546       silc_free(ctx->dest_id);
 547     ctx->sock->protocol = NULL;
 548     silc_socket_free(ctx->sock);
 549
 550     /* Notify application of failure */
 551     silc_schedule_task_add(client->schedule, ctx->sock->sock,
 552                            silc_client_connect_failure, ctx,
 553                            0, 1, SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
 554     return;
 555   }
 556
 557   /* We now have the key material as the result of the key exchange
 558      protocol. Take the key material into use. Free the raw key material
 559      as soon as we've set them into use. */
 560   silc_client_protocol_ke_set_keys(ctx->ske, ctx->sock, ctx->keymat,
 561                                    ctx->ske->prop->cipher,
 562                                    ctx->ske->prop->pkcs,
 563                                    ctx->ske->prop->hash,
 564                                    ctx->ske->prop->hmac,
 565                                    ctx->ske->prop->group,
 566                                    ctx->responder);
 567   silc_ske_free_key_material(ctx->keymat);
 568
 569   /* Allocate internal context for the authentication protocol. This
 570      is sent as context for the protocol. */
 571   proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
 572   proto_ctx->client = (void *)client;
 573   proto_ctx->sock = sock = ctx->sock;
 574   proto_ctx->ske = ctx->ske;    /* Save SKE object from previous protocol */
 575   proto_ctx->dest_id_type = ctx->dest_id_type;
 576   proto_ctx->dest_id = ctx->dest_id;
 577
 578   /* Free old protocol as it is finished now */
 579   silc_protocol_free(protocol);
 580   if (ctx->packet)
 581     silc_packet_context_free(ctx->packet);
 582   silc_free(ctx);
 583   sock->protocol = NULL;
 584
 585   /* Resolve the authentication method to be used in this connection. The
 586      completion callback is called after the application has resolved
 587      the authentication method. */
 588   client->internal->ops->get_auth_method(client, sock->user_data,
 589                                          sock->hostname,
 590                                          sock->port,
 591                                          silc_client_resolve_auth_method,
 592                                          proto_ctx);
 593 }
 594
 595 /* Authentication method resolving callback. Application calls this function
 596    after we've called the client->internal->ops->get_auth_method
 597    client operation to resolve the authentication method. We will continue
 598    the executiong of the protocol in this function. */
 599
 600 void silc_client_resolve_auth_method(bool success,
 601                                      SilcProtocolAuthMeth auth_meth,
 602                                      const unsigned char *auth_data,
 603                                      SilcUInt32 auth_data_len, void *context)
 604 {
 605   SilcClientConnAuthInternalContext *proto_ctx =
 606     (SilcClientConnAuthInternalContext *)context;
 607   SilcClient client = (SilcClient)proto_ctx->client;
 608
 609   if (!success)
 610     auth_meth = SILC_AUTH_NONE;
 611
 612   proto_ctx->auth_meth = auth_meth;
 613
 614   if (auth_data && auth_data_len) {
 615     proto_ctx->auth_data = silc_memdup(auth_data, auth_data_len);
 616     proto_ctx->auth_data_len = auth_data_len;
 617   }
 618
 619   /* Allocate the authenteication protocol and execute it. */
 620   silc_protocol_alloc(SILC_PROTOCOL_CLIENT_CONNECTION_AUTH,
 621                       &proto_ctx->sock->protocol, (void *)proto_ctx,
 622                       silc_client_connect_to_server_final);
 623
 624   /* Execute the protocol */
 625   silc_protocol_execute(proto_ctx->sock->protocol, client->schedule, 0, 0);
 626 }
 627
 628 /* Finalizes the connection to the remote SILC server. This is called
 629    after authentication protocol has been completed. This send our
 630    user information to the server to receive our client ID from
 631    server. */
 632
 633 SILC_TASK_CALLBACK(silc_client_connect_to_server_final)
 634 {
 635   SilcProtocol protocol = (SilcProtocol)context;
 636   SilcClientConnAuthInternalContext *ctx =
 637     (SilcClientConnAuthInternalContext *)protocol->context;
 638   SilcClient client = (SilcClient)ctx->client;
 639   SilcClientConnection conn = (SilcClientConnection)ctx->sock->user_data;
 640   SilcBuffer packet;
 641
 642   SILC_LOG_DEBUG(("Start"));
 643
 644   if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
 645       protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
 646     /* Error occured during protocol */
 647     SILC_LOG_DEBUG(("Error during authentication protocol"));
 648     silc_protocol_free(protocol);
 649     if (ctx->auth_data)
 650       silc_free(ctx->auth_data);
 651     if (ctx->ske)
 652       silc_ske_free(ctx->ske);
 653     if (ctx->dest_id)
 654       silc_free(ctx->dest_id);
 655     conn->sock->protocol = NULL;
 656     silc_socket_free(ctx->sock);
 657
 658     /* Notify application of failure */
 659     silc_schedule_task_add(client->schedule, ctx->sock->sock,
 660                            silc_client_connect_failure, ctx,
 661                            0, 1, SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
 662     return;
 663   }
 664
 665   /* Send NEW_CLIENT packet to the server. We will become registered
 666      to the SILC network after sending this packet and we will receive
 667      client ID from the server. */
 668   packet = silc_buffer_alloc(2 + 2 + strlen(client->username) +
 669                              strlen(client->realname));
 670   silc_buffer_pull_tail(packet, SILC_BUFFER_END(packet));
 671   silc_buffer_format(packet,
 672                      SILC_STR_UI_SHORT(strlen(client->username)),
 673                      SILC_STR_UI_XNSTRING(client->username,
 674                                           strlen(client->username)),
 675                      SILC_STR_UI_SHORT(strlen(client->realname)),
 676                      SILC_STR_UI_XNSTRING(client->realname,
 677                                           strlen(client->realname)),
 678                      SILC_STR_END);
 679
 680   /* Send the packet */
 681   silc_client_packet_send(client, ctx->sock, SILC_PACKET_NEW_CLIENT,
 682                           NULL, 0, NULL, NULL,
 683                           packet->data, packet->len, TRUE);
 684   silc_buffer_free(packet);
 685
 686   /* Save remote ID. */
 687   conn->remote_id = ctx->dest_id;
 688   conn->remote_id_data = silc_id_id2str(ctx->dest_id, SILC_ID_SERVER);
 689   conn->remote_id_data_len = silc_id_get_len(ctx->dest_id, SILC_ID_SERVER);
 690
 691   /* Register re-key timeout */
 692   conn->rekey->timeout = client->internal->params->rekey_secs;
 693   conn->rekey->context = (void *)client;
 694   silc_schedule_task_add(client->schedule, conn->sock->sock,
 695                          silc_client_rekey_callback,
 696                          (void *)conn->sock, conn->rekey->timeout, 0,
 697                          SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
 698
 699   silc_protocol_free(protocol);
 700   if (ctx->auth_data)
 701     silc_free(ctx->auth_data);
 702   if (ctx->ske)
 703     silc_ske_free(ctx->ske);
 704   silc_socket_free(ctx->sock);
 705   silc_free(ctx);
 706   conn->sock->protocol = NULL;
 707 }
 708
 709 /* Internal routine that sends packet or marks packet to be sent. This
 710    is used directly only in special cases. Normal cases should use
 711    silc_server_packet_send. Returns < 0 on error. */
 712
 713 int silc_client_packet_send_real(SilcClient client,
 714                                  SilcSocketConnection sock,
 715                                  bool force_send)
 716 {
 717   int ret;
 718
 719   /* If rekey protocol is active we must assure that all packets are
 720      sent through packet queue. */
 721   if (SILC_CLIENT_IS_REKEY(sock))
 722     force_send = FALSE;
 723
 724   /* If outbound data is already pending do not force send */
 725   if (SILC_IS_OUTBUF_PENDING(sock))
 726     force_send = FALSE;
 727
 728   /* Send the packet */
 729   ret = silc_packet_send(sock, force_send);
 730   if (ret != -2)
 731     return ret;
 732
 733   /* Mark that there is some outgoing data available for this connection.
 734      This call sets the connection both for input and output (the input
 735      is set always and this call keeps the input setting, actually).
 736      Actual data sending is performed by silc_client_packet_process. */
 737   SILC_CLIENT_SET_CONNECTION_FOR_OUTPUT(client->schedule, sock->sock);
 738
 739   /* Mark to socket that data is pending in outgoing buffer. This flag
 740      is needed if new data is added to the buffer before the earlier
 741      put data is sent to the network. */
 742   SILC_SET_OUTBUF_PENDING(sock);
 743
 744   return 0;
 745 }
 746
 747 /* Packet processing callback. This is used to send and receive packets
 748    from network. This is generic task. */
 749
 750 SILC_TASK_CALLBACK_GLOBAL(silc_client_packet_process)
 751 {
 752   SilcClient client = (SilcClient)context;
 753   SilcSocketConnection sock = NULL;
 754   SilcClientConnection conn;
 755   int ret;
 756
 757   SILC_LOG_DEBUG(("Processing packet"));
 758
 759   SILC_CLIENT_GET_SOCK(client, fd, sock);
 760   if (sock == NULL)
 761     return;
 762
 763   conn = (SilcClientConnection)sock->user_data;
 764
 765   /* Packet sending */
 766   if (type == SILC_TASK_WRITE) {
 767     /* Do not send data to disconnected connection */
 768     if (SILC_IS_DISCONNECTED(sock))
 769       return;
 770
 771     ret = silc_packet_send(sock, TRUE);
 772
 773     /* If returned -2 could not write to connection now, will do
 774        it later. */
 775     if (ret == -2)
 776       return;
 777
 778     /* Error */
 779     if (ret == -1)
 780       return;
 781
 782     /* The packet has been sent and now it is time to set the connection
 783        back to only for input. When there is again some outgoing data
 784        available for this connection it will be set for output as well.
 785        This call clears the output setting and sets it only for input. */
 786     SILC_CLIENT_SET_CONNECTION_FOR_INPUT(client->schedule, fd);
 787     SILC_UNSET_OUTBUF_PENDING(sock);
 788
 789     silc_buffer_clear(sock->outbuf);
 790     return;
 791   }
 792
 793   /* Packet receiving */
 794   if (type == SILC_TASK_READ) {
 795     /* Read data from network */
 796     ret = silc_packet_receive(sock);
 797     if (ret < 0)
 798       return;
 799
 800     /* EOF */
 801     if (ret == 0) {
 802       SILC_LOG_DEBUG(("Read EOF"));
 803
 804       /* If connection is disconnecting already we will finally
 805          close the connection */
 806       if (SILC_IS_DISCONNECTING(sock)) {
 807         if (sock == conn->sock && sock->type != SILC_SOCKET_TYPE_CLIENT)
 808           client->internal->ops->disconnect(client, conn);
 809         silc_client_close_connection(client, sock, conn);
 810         return;
 811       }
 812
 813       SILC_LOG_DEBUG(("EOF from connection %d", sock->sock));
 814       if (sock == conn->sock && sock->type != SILC_SOCKET_TYPE_CLIENT)
 815         client->internal->ops->disconnect(client, conn);
 816       silc_client_close_connection(client, sock, conn);
 817       return;
 818     }
 819
 820     /* Process the packet. This will call the parser that will then
 821        decrypt and parse the packet. */
 822     if (sock->type != SILC_SOCKET_TYPE_UNKNOWN)
 823       silc_packet_receive_process(sock, FALSE, conn->receive_key,
 824                                   conn->hmac_receive, conn->psn_receive,
 825                                   silc_client_packet_parse, client);
 826     else
 827       silc_packet_receive_process(sock, FALSE, NULL, NULL, 0,
 828                                   silc_client_packet_parse, client);
 829   }
 830 }
 831
 832 /* Parser callback called by silc_packet_receive_process. Thie merely
 833    registers timeout that will handle the actual parsing when appropriate. */
 834
 835 static bool silc_client_packet_parse(SilcPacketParserContext *parser_context,
 836                                      void *context)
 837 {
 838   SilcClient client = (SilcClient)context;
 839   SilcSocketConnection sock = parser_context->sock;
 840   SilcClientConnection conn = (SilcClientConnection)sock->user_data;
 841   SilcPacketContext *packet = parser_context->packet;
 842   SilcPacketType ret;
 843
 844   if (conn && conn->hmac_receive && conn->sock == sock)
 845     conn->psn_receive = parser_context->packet->sequence + 1;
 846
 847   /* Parse the packet immediately */
 848   if (parser_context->normal)
 849     ret = silc_packet_parse(packet, conn->receive_key);
 850   else
 851     ret = silc_packet_parse_special(packet, conn->receive_key);
 852
 853   if (ret == SILC_PACKET_NONE) {
 854     silc_packet_context_free(packet);
 855     silc_free(parser_context);
 856     return FALSE;
 857   }
 858
 859   /* If protocol for this connection is key exchange or rekey then we'll
 860      process all packets synchronously, since there might be packets in
 861      queue that we are not able to decrypt without first processing the
 862      packets before them. */
 863   if ((ret == SILC_PACKET_REKEY || ret == SILC_PACKET_REKEY_DONE) ||
 864       (sock->protocol && sock->protocol->protocol &&
 865        (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
 866         sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY))) {
 867
 868     /* Parse the incoming packet type */
 869     silc_client_packet_parse_type(client, sock, packet);
 870     silc_packet_context_free(packet);
 871     silc_free(parser_context);
 872
 873     /* Reprocess the buffer since we'll return FALSE. This is because
 874        the `conn->receive_key' might have become valid by processing
 875        the previous packet */
 876     if (sock->type != SILC_SOCKET_TYPE_UNKNOWN)
 877       silc_packet_receive_process(sock, FALSE, conn->receive_key,
 878                                   conn->hmac_receive, conn->psn_receive,
 879                                   silc_client_packet_parse, client);
 880     else
 881       silc_packet_receive_process(sock, FALSE, NULL, NULL, 0,
 882                                   silc_client_packet_parse, client);
 883
 884     return FALSE;
 885   }
 886
 887   /* Parse the incoming packet type */
 888   silc_client_packet_parse_type(client, sock, packet);
 889   silc_packet_context_free(packet);
 890   silc_free(parser_context);
 891   return TRUE;
 892 }
 893
 894 /* Parses the packet type and calls what ever routines the packet type
 895    requires. This is done for all incoming packets. */
 896
 897 void silc_client_packet_parse_type(SilcClient client,
 898                                    SilcSocketConnection sock,
 899                                    SilcPacketContext *packet)
 900 {
 901   SilcBuffer buffer = packet->buffer;
 902   SilcPacketType type = packet->type;
 903
 904   SILC_LOG_DEBUG(("Parsing packet type %d", type));
 905
 906   /* Parse the packet type */
 907   switch(type) {
 908   case SILC_PACKET_DISCONNECT:
 909     silc_client_disconnected_by_server(client, sock, buffer);
 910     break;
 911   case SILC_PACKET_SUCCESS:
 912     /*
 913      * Success received for something. For now we can have only
 914      * one protocol for connection executing at once hence this
 915      * success message is for whatever protocol is executing currently.
 916      */
 917     if (sock->protocol)
 918       silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
 919     break;
 920   case SILC_PACKET_FAILURE:
 921     /*
 922      * Failure received for some protocol. Set the protocol state to
 923      * error and call the protocol callback. This fill cause error on
 924      * protocol and it will call the final callback.
 925      */
 926     silc_client_process_failure(client, sock, packet);
 927     break;
 928   case SILC_PACKET_REJECT:
 929     break;
 930
 931   case SILC_PACKET_NOTIFY:
 932     /*
 933      * Received notify message
 934      */
 935     silc_client_notify_by_server(client, sock, packet);
 936     break;
 937
 938   case SILC_PACKET_ERROR:
 939     /*
 940      * Received error message
 941      */
 942     silc_client_error_by_server(client, sock, buffer);
 943     break;
 944
 945   case SILC_PACKET_CHANNEL_MESSAGE:
 946     /*
 947      * Received message to (from, actually) a channel
 948      */
 949     silc_client_channel_message(client, sock, packet);
 950     break;
 951   case SILC_PACKET_CHANNEL_KEY:
 952     /*
 953      * Received key for a channel. By receiving this key the client will be
 954      * able to talk to the channel it has just joined. This can also be
 955      * a new key for existing channel as keys expire peridiocally.
 956      */
 957     silc_client_receive_channel_key(client, sock, buffer);
 958     break;
 959
 960   case SILC_PACKET_PRIVATE_MESSAGE:
 961     /*
 962      * Received private message
 963      */
 964     silc_client_private_message(client, sock, packet);
 965     break;
 966   case SILC_PACKET_PRIVATE_MESSAGE_KEY:
 967     /*
 968      * Received private message key
 969      */
 970     break;
 971
 972   case SILC_PACKET_COMMAND_REPLY:
 973     /*
 974      * Recived reply for a command
 975      */
 976     silc_client_command_reply_process(client, sock, packet);
 977     break;
 978
 979   case SILC_PACKET_KEY_EXCHANGE:
 980     if (sock->protocol && sock->protocol->protocol &&
 981         sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE) {
 982       SilcClientKEInternalContext *proto_ctx =
 983         (SilcClientKEInternalContext *)sock->protocol->context;
 984
 985       proto_ctx->packet = silc_packet_context_dup(packet);
 986       proto_ctx->dest_id_type = packet->src_id_type;
 987       proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
 988                                           packet->src_id_type);
 989       if (!proto_ctx->dest_id)
 990         break;
 991
 992       /* Let the protocol handle the packet */
 993       silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
 994     } else {
 995       SILC_LOG_ERROR(("Received Key Exchange packet but no key exchange "
 996                       "protocol active, packet dropped."));
 997     }
 998     break;
 999
1000   case SILC_PACKET_KEY_EXCHANGE_1:
1001     if (sock->protocol && sock->protocol->protocol &&
1002         (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1003          sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)) {
1004
1005       if (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1006         SilcClientRekeyInternalContext *proto_ctx =
1007           (SilcClientRekeyInternalContext *)sock->protocol->context;
1008
1009         if (proto_ctx->packet)
1010           silc_packet_context_free(proto_ctx->packet);
1011
1012         proto_ctx->packet = silc_packet_context_dup(packet);
1013
1014         /* Let the protocol handle the packet */
1015         silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1016       } else {
1017         SilcClientKEInternalContext *proto_ctx =
1018           (SilcClientKEInternalContext *)sock->protocol->context;
1019
1020         if (proto_ctx->packet)
1021           silc_packet_context_free(proto_ctx->packet);
1022
1023         proto_ctx->packet = silc_packet_context_dup(packet);
1024         proto_ctx->dest_id_type = packet->src_id_type;
1025         proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
1026                                             packet->src_id_type);
1027         if (!proto_ctx->dest_id)
1028           break;
1029
1030         /* Let the protocol handle the packet */
1031         silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1032       }
1033     } else {
1034       SILC_LOG_ERROR(("Received Key Exchange 1 packet but no key exchange "
1035                       "protocol active, packet dropped."));
1036     }
1037     break;
1038   case SILC_PACKET_KEY_EXCHANGE_2:
1039     if (sock->protocol && sock->protocol->protocol &&
1040         (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1041          sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY)) {
1042
1043       if (sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1044         SilcClientRekeyInternalContext *proto_ctx =
1045           (SilcClientRekeyInternalContext *)sock->protocol->context;
1046
1047         if (proto_ctx->packet)
1048           silc_packet_context_free(proto_ctx->packet);
1049
1050         proto_ctx->packet = silc_packet_context_dup(packet);
1051
1052         /* Let the protocol handle the packet */
1053         silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1054       } else {
1055         SilcClientKEInternalContext *proto_ctx =
1056           (SilcClientKEInternalContext *)sock->protocol->context;
1057
1058         if (proto_ctx->packet)
1059           silc_packet_context_free(proto_ctx->packet);
1060         if (proto_ctx->dest_id)
1061           silc_free(proto_ctx->dest_id);
1062         proto_ctx->packet = silc_packet_context_dup(packet);
1063         proto_ctx->dest_id_type = packet->src_id_type;
1064         proto_ctx->dest_id = silc_id_str2id(packet->src_id, packet->src_id_len,
1065                                             packet->src_id_type);
1066         if (!proto_ctx->dest_id)
1067           break;
1068
1069         /* Let the protocol handle the packet */
1070         silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1071       }
1072     } else {
1073       SILC_LOG_ERROR(("Received Key Exchange 2 packet but no key exchange "
1074                       "protocol active, packet dropped."));
1075     }
1076     break;
1077
1078   case SILC_PACKET_NEW_ID:
1079     {
1080       /*
1081        * Received new ID from server. This packet is received at
1082        * the connection to the server.  New ID is also received when
1083        * user changes nickname but in that case the new ID is received
1084        * as command reply and not as this packet type.
1085        */
1086       SilcIDPayload idp;
1087
1088       idp = silc_id_payload_parse(buffer->data, buffer->len);
1089       if (!idp)
1090         break;
1091       if (silc_id_payload_get_type(idp) != SILC_ID_CLIENT)
1092         break;
1093
1094       silc_client_receive_new_id(client, sock, idp);
1095       silc_id_payload_free(idp);
1096       break;
1097     }
1098
1099   case SILC_PACKET_HEARTBEAT:
1100     /*
1101      * Received heartbeat packet
1102      */
1103     SILC_LOG_DEBUG(("Heartbeat packet"));
1104     break;
1105
1106   case SILC_PACKET_KEY_AGREEMENT:
1107     /*
1108      * Received key agreement packet
1109      */
1110     SILC_LOG_DEBUG(("Key agreement packet"));
1111     silc_client_key_agreement(client, sock, packet);
1112     break;
1113
1114   case SILC_PACKET_REKEY:
1115     SILC_LOG_DEBUG(("Re-key packet"));
1116     /* We ignore this for now */
1117     break;
1118
1119   case SILC_PACKET_REKEY_DONE:
1120     SILC_LOG_DEBUG(("Re-key done packet"));
1121
1122     if (sock->protocol && sock->protocol->protocol &&
1123         sock->protocol->protocol->type == SILC_PROTOCOL_CLIENT_REKEY) {
1124
1125       SilcClientRekeyInternalContext *proto_ctx =
1126         (SilcClientRekeyInternalContext *)sock->protocol->context;
1127
1128       if (proto_ctx->packet)
1129         silc_packet_context_free(proto_ctx->packet);
1130
1131       proto_ctx->packet = silc_packet_context_dup(packet);
1132
1133       /* Let the protocol handle the packet */
1134       if (proto_ctx->responder == FALSE)
1135         silc_protocol_execute(sock->protocol, client->schedule, 0, 0);
1136       else
1137         /* Let the protocol handle the packet */
1138         silc_protocol_execute(sock->protocol, client->schedule,
1139                               0, 100000);
1140     } else {
1141       SILC_LOG_ERROR(("Received Re-key done packet but no re-key "
1142                       "protocol active, packet dropped."));
1143     }
1144     break;
1145
1146   case SILC_PACKET_CONNECTION_AUTH_REQUEST:
1147     /*
1148      * Reveived reply to our connection authentication method request
1149      * packet. This is used to resolve the authentication method for the
1150      * current session from the server if the client does not know it.
1151      */
1152     silc_client_connection_auth_request(client, sock, packet);
1153     break;
1154
1155   case SILC_PACKET_FTP:
1156     /* Received file transfer packet. */
1157     silc_client_ftp(client, sock, packet);
1158     break;
1159
1160   default:
1161     SILC_LOG_DEBUG(("Incorrect packet type %d, packet dropped", type));
1162     break;
1163   }
1164 }
1165
1166 /* Sends packet. This doesn't actually send the packet instead it assembles
1167    it and marks it to be sent. However, if force_send is TRUE the packet
1168    is sent immediately. if dst_id, cipher and hmac are NULL those parameters
1169    will be derived from sock argument. Otherwise the valid arguments sent
1170    are used. */
1171
1172 void silc_client_packet_send(SilcClient client,
1173                              SilcSocketConnection sock,
1174                              SilcPacketType type,
1175                              void *dst_id,
1176                              SilcIdType dst_id_type,
1177                              SilcCipher cipher,
1178                              SilcHmac hmac,
1179                              unsigned char *data,
1180                              SilcUInt32 data_len,
1181                              int force_send)
1182 {
1183   SilcPacketContext packetdata;
1184   const SilcBufferStruct packet;
1185   int block_len;
1186   SilcUInt32 sequence = 0;
1187
1188   if (!sock)
1189     return;
1190
1191   SILC_LOG_DEBUG(("Sending packet, type %d", type));
1192
1193   /* Get data used in the packet sending, keys and stuff */
1194   if ((!cipher || !hmac || !dst_id) && sock->user_data) {
1195     if (!cipher && ((SilcClientConnection)sock->user_data)->send_key)
1196       cipher = ((SilcClientConnection)sock->user_data)->send_key;
1197
1198     if (!hmac && ((SilcClientConnection)sock->user_data)->hmac_send)
1199       hmac = ((SilcClientConnection)sock->user_data)->hmac_send;
1200
1201     if (!dst_id && ((SilcClientConnection)sock->user_data)->remote_id) {
1202       dst_id = ((SilcClientConnection)sock->user_data)->remote_id;
1203       dst_id_type = SILC_ID_SERVER;
1204     }
1205
1206     if (hmac)
1207       sequence = ((SilcClientConnection)sock->user_data)->psn_send++;
1208   }
1209
1210   block_len = cipher ? silc_cipher_get_block_len(cipher) : 0;
1211
1212   /* Set the packet context pointers */
1213   packetdata.flags = 0;
1214   packetdata.type = type;
1215   if (sock->user_data &&
1216       ((SilcClientConnection)sock->user_data)->local_id_data) {
1217     packetdata.src_id = ((SilcClientConnection)sock->user_data)->local_id_data;
1218     packetdata.src_id_len =
1219       silc_id_get_len(((SilcClientConnection)sock->user_data)->local_id,
1220                       SILC_ID_CLIENT);
1221   } else {
1222     packetdata.src_id = silc_calloc(SILC_ID_CLIENT_LEN, sizeof(unsigned char));
1223     packetdata.src_id_len = SILC_ID_CLIENT_LEN;
1224   }
1225   packetdata.src_id_type = SILC_ID_CLIENT;
1226   if (dst_id) {
1227     packetdata.dst_id = silc_id_id2str(dst_id, dst_id_type);
1228     packetdata.dst_id_len = silc_id_get_len(dst_id, dst_id_type);
1229     packetdata.dst_id_type = dst_id_type;
1230   } else {
1231     packetdata.dst_id = NULL;
1232     packetdata.dst_id_len = 0;
1233     packetdata.dst_id_type = SILC_ID_NONE;
1234   }
1235   data_len = SILC_PACKET_DATALEN(data_len, (SILC_PACKET_HEADER_LEN +
1236                                             packetdata.src_id_len +
1237                                             packetdata.dst_id_len));
1238   packetdata.truelen = data_len + SILC_PACKET_HEADER_LEN +
1239     packetdata.src_id_len + packetdata.dst_id_len;
1240   packetdata.padlen = SILC_PACKET_PADLEN(packetdata.truelen, block_len);
1241
1242   /* Create the outgoing packet */
1243   if (!silc_packet_assemble(&packetdata, client->rng, cipher, hmac, sock,
1244                             data, data_len, (const SilcBuffer)&packet)) {
1245     SILC_LOG_ERROR(("Error assembling packet"));
1246     return;
1247   }
1248
1249   /* Encrypt the packet */
1250   if (cipher)
1251     silc_packet_encrypt(cipher, hmac, sequence, (SilcBuffer)&packet,
1252                         packet.len);
1253
1254   SILC_LOG_HEXDUMP(("Packet (%d), len %d", sequence, packet.len),
1255                    packet.data, packet.len);
1256
1257   /* Now actually send the packet */
1258   silc_client_packet_send_real(client, sock, force_send);
1259 }
1260
1261 void silc_client_packet_queue_purge(SilcClient client,
1262                                     SilcSocketConnection sock)
1263 {
1264   if (sock && SILC_IS_OUTBUF_PENDING(sock) &&
1265       (SILC_IS_DISCONNECTED(sock) == FALSE)) {
1266     if (sock->outbuf->data - sock->outbuf->head)
1267       silc_buffer_push(sock->outbuf, sock->outbuf->data - sock->outbuf->head);
1268
1269     silc_packet_send(sock, TRUE);
1270
1271     SILC_CLIENT_SET_CONNECTION_FOR_INPUT(client->schedule, sock->sock);
1272     SILC_UNSET_OUTBUF_PENDING(sock);
1273     silc_buffer_clear(sock->outbuf);
1274   }
1275 }
1276
1277 /* Closes connection to remote end. Free's all allocated data except
1278    for some information such as nickname etc. that are valid at all time.
1279    If the `sock' is NULL then the conn->sock will be used.  If `sock' is
1280    provided it will be checked whether the sock and `conn->sock' are the
1281    same (they can be different, ie. a socket can use `conn' as its
1282    connection but `conn->sock' might be actually a different connection
1283    than the `sock'). */
1284
1285 void silc_client_close_connection(SilcClient client,
1286                                   SilcSocketConnection sock,
1287                                   SilcClientConnection conn)
1288 {
1289   int del = FALSE;
1290
1291   SILC_LOG_DEBUG(("Start"));
1292
1293   if (!sock || (sock && conn->sock == sock))
1294     del = TRUE;
1295   if (!sock)
1296     sock = conn->sock;
1297
1298   /* We won't listen for this connection anymore */
1299   silc_schedule_unset_listen_fd(client->schedule, sock->sock);
1300
1301   /* Unregister all tasks */
1302   silc_schedule_task_del_by_fd(client->schedule, sock->sock);
1303   silc_schedule_task_del_by_fd(client->schedule, sock->sock);
1304
1305   /* Close the actual connection */
1306   silc_net_close_connection(sock->sock);
1307
1308   /* Cancel any active protocol */
1309   if (sock->protocol) {
1310     if (sock->protocol->protocol->type ==
1311         SILC_PROTOCOL_CLIENT_KEY_EXCHANGE ||
1312         sock->protocol->protocol->type ==
1313         SILC_PROTOCOL_CLIENT_CONNECTION_AUTH) {
1314       sock->protocol->state = SILC_PROTOCOL_STATE_ERROR;
1315       silc_protocol_execute_final(sock->protocol, client->schedule);
1316       /* The application will recall this function with these protocols
1317          (the ops->connect client operation). */
1318       return;
1319     } else {
1320       sock->protocol->state = SILC_PROTOCOL_STATE_ERROR;
1321       silc_protocol_execute_final(sock->protocol, client->schedule);
1322       sock->protocol = NULL;
1323     }
1324   }
1325
1326   /* Free everything */
1327   if (del && sock->user_data) {
1328     /* Free all cache entries */
1329     SilcIDCacheList list;
1330     SilcIDCacheEntry entry;
1331     bool ret;
1332
1333     if (silc_idcache_get_all(conn->client_cache, &list)) {
1334       ret = silc_idcache_list_first(list, &entry);
1335       while (ret) {
1336         silc_client_del_client(client, conn, entry->context);
1337         ret = silc_idcache_list_next(list, &entry);
1338       }
1339       silc_idcache_list_free(list);
1340     }
1341
1342     if (silc_idcache_get_all(conn->channel_cache, &list)) {
1343       ret = silc_idcache_list_first(list, &entry);
1344       while (ret) {
1345         silc_client_del_channel(client, conn, entry->context);
1346         ret = silc_idcache_list_next(list, &entry);
1347       }
1348       silc_idcache_list_free(list);
1349     }
1350
1351     if (silc_idcache_get_all(conn->server_cache, &list)) {
1352       ret = silc_idcache_list_first(list, &entry);
1353       while (ret) {
1354         silc_client_del_server(client, conn, entry->context);
1355         ret = silc_idcache_list_next(list, &entry);
1356       }
1357       silc_idcache_list_free(list);
1358     }
1359
1360     /* Clear ID caches */
1361     if (conn->client_cache)
1362       silc_idcache_free(conn->client_cache);
1363     if (conn->channel_cache)
1364       silc_idcache_free(conn->channel_cache);
1365     if (conn->server_cache)
1366       silc_idcache_free(conn->server_cache);
1367
1368     /* Free data (my ID is freed in above silc_client_del_client).
1369        conn->nickname is freed when freeing the local_entry->nickname. */
1370     if (conn->remote_host)
1371       silc_free(conn->remote_host);
1372     if (conn->local_id_data)
1373       silc_free(conn->local_id_data);
1374     if (conn->send_key)
1375       silc_cipher_free(conn->send_key);
1376     if (conn->receive_key)
1377       silc_cipher_free(conn->receive_key);
1378     if (conn->hmac_send)
1379       silc_hmac_free(conn->hmac_send);
1380     if (conn->hmac_receive)
1381       silc_hmac_free(conn->hmac_receive);
1382     if (conn->pending_commands)
1383       silc_dlist_uninit(conn->pending_commands);
1384     if (conn->rekey)
1385       silc_free(conn->rekey);
1386
1387     if (conn->active_session) {
1388       sock->user_data = NULL;
1389       silc_client_ftp_session_free(conn->active_session);
1390       conn->active_session = NULL;
1391     }
1392
1393     silc_client_ftp_free_sessions(client, conn);
1394
1395     memset(conn, 0, sizeof(*conn));
1396     silc_client_del_connection(client, conn);
1397   }
1398
1399   silc_socket_free(sock);
1400 }
1401
1402 /* Called when we receive disconnection packet from server. This
1403    closes our end properly and displays the reason of the disconnection
1404    on the screen. */
1405
1406 SILC_TASK_CALLBACK(silc_client_disconnected_by_server_later)
1407 {
1408   SilcClient client = (SilcClient)context;
1409   SilcSocketConnection sock;
1410
1411   SILC_CLIENT_GET_SOCK(client, fd, sock);
1412   if (sock == NULL)
1413     return;
1414
1415   silc_client_close_connection(client, sock, sock->user_data);
1416 }
1417
1418 /* Called when we receive disconnection packet from server. This
1419    closes our end properly and displays the reason of the disconnection
1420    on the screen. */
1421
1422 void silc_client_disconnected_by_server(SilcClient client,
1423                                         SilcSocketConnection sock,
1424                                         SilcBuffer message)
1425 {
1426   char *msg;
1427
1428   SILC_LOG_DEBUG(("Server disconnected us, sock %d", sock->sock));
1429
1430   msg = silc_memdup(message->data, message->len);
1431   client->internal->ops->say(client, sock->user_data,
1432                              SILC_CLIENT_MESSAGE_AUDIT, msg);
1433   silc_free(msg);
1434
1435   SILC_SET_DISCONNECTED(sock);
1436
1437   /* Close connection through scheduler. */
1438   silc_schedule_task_add(client->schedule, sock->sock,
1439                          silc_client_disconnected_by_server_later,
1440                          client, 0, 1, SILC_TASK_TIMEOUT,
1441                          SILC_TASK_PRI_NORMAL);
1442 }
1443
1444 /* Received error message from server. Display it on the screen.
1445    We don't take any action what so ever of the error message. */
1446
1447 void silc_client_error_by_server(SilcClient client,
1448                                  SilcSocketConnection sock,
1449                                  SilcBuffer message)
1450 {
1451   char *msg;
1452
1453   msg = silc_memdup(message->data, message->len);
1454   client->internal->ops->say(client, sock->user_data,
1455                              SILC_CLIENT_MESSAGE_AUDIT, msg);
1456   silc_free(msg);
1457 }
1458
1459 /* Auto-nicking callback to send NICK command to server. */
1460
1461 SILC_TASK_CALLBACK(silc_client_send_auto_nick)
1462 {
1463   SilcClientConnection conn = (SilcClientConnection)context;
1464   SilcClient client = conn->client;
1465
1466   silc_client_command_send(client, conn, SILC_COMMAND_NICK,
1467                            ++conn->cmd_ident, 1, 1,
1468                            client->nickname, strlen(client->nickname));
1469 }
1470
1471 /* Processes the received new Client ID from server. Old Client ID is
1472    deleted from cache and new one is added. */
1473
1474 void silc_client_receive_new_id(SilcClient client,
1475                                 SilcSocketConnection sock,
1476                                 SilcIDPayload idp)
1477 {
1478   SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1479   int connecting = FALSE;
1480   SilcClientID *client_id = silc_id_payload_get_id(idp);
1481   SilcBuffer sidp;
1482
1483   if (!conn->local_entry)
1484     connecting = TRUE;
1485
1486   /* Delete old ID from ID cache */
1487   if (conn->local_id) {
1488     /* Check whether they are different */
1489     if (SILC_ID_CLIENT_COMPARE(conn->local_id, client_id)) {
1490       silc_free(client_id);
1491       return;
1492     }
1493
1494     silc_idcache_del_by_context(conn->client_cache, conn->local_entry);
1495     silc_free(conn->local_id);
1496   }
1497
1498   /* Save the new ID */
1499
1500   if (conn->local_id_data)
1501     silc_free(conn->local_id_data);
1502
1503   conn->local_id = client_id;
1504   conn->local_id_data = silc_id_payload_get_data(idp);
1505   conn->local_id_data_len = silc_id_payload_get_len(idp);;
1506
1507   if (!conn->local_entry)
1508     conn->local_entry = silc_calloc(1, sizeof(*conn->local_entry));
1509
1510   conn->local_entry->nickname = conn->nickname;
1511   if (!conn->local_entry->username)
1512     conn->local_entry->username = strdup(client->username);
1513   if (!conn->local_entry->hostname)
1514     conn->local_entry->hostname = strdup(client->hostname);
1515   if (!conn->local_entry->server)
1516     conn->local_entry->server = strdup(conn->remote_host);
1517   conn->local_entry->id = conn->local_id;
1518   conn->local_entry->valid = TRUE;
1519   if (!conn->local_entry->channels)
1520     conn->local_entry->channels = silc_hash_table_alloc(1, silc_hash_ptr,
1521                                                         NULL, NULL,
1522                                                         NULL, NULL, NULL,
1523                                                         TRUE);
1524
1525   /* Put it to the ID cache */
1526   silc_idcache_add(conn->client_cache, strdup(conn->nickname), conn->local_id,
1527                    (void *)conn->local_entry, 0, NULL);
1528
1529   if (connecting) {
1530     /* Send NICK command if the nickname was set by the application (and is
1531        not same as the username). Send this with little timeout. */
1532     if (client->nickname && strcmp(client->nickname, client->username))
1533       silc_schedule_task_add(client->schedule, 0,
1534                              silc_client_send_auto_nick, conn,
1535                              1, 0, SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
1536
1537     /* Issue INFO command to fetch the real server name and server information
1538        and other stuff. */
1539     silc_client_command_register(client, SILC_COMMAND_INFO, NULL, NULL,
1540                                  silc_client_command_reply_info_i, 0,
1541                                  ++conn->cmd_ident);
1542     sidp = silc_id_payload_encode(conn->remote_id, SILC_ID_SERVER);
1543     silc_client_command_send(client, conn, SILC_COMMAND_INFO,
1544                              conn->cmd_ident, 1, 2, sidp->data, sidp->len);
1545     silc_buffer_free(sidp);
1546
1547     /* Notify application of successful connection. We do it here now that
1548        we've received the Client ID and are allowed to send traffic. */
1549     client->internal->ops->connect(client, conn, TRUE);
1550   }
1551 }
1552
1553 /* Removes a client entry from all channels it has joined. */
1554
1555 void silc_client_remove_from_channels(SilcClient client,
1556                                       SilcClientConnection conn,
1557                                       SilcClientEntry client_entry)
1558 {
1559   SilcHashTableList htl;
1560   SilcChannelUser chu;
1561
1562   silc_hash_table_list(client_entry->channels, &htl);
1563   while (silc_hash_table_get(&htl, NULL, (void *)&chu)) {
1564     silc_hash_table_del(chu->client->channels, chu->channel);
1565     silc_hash_table_del(chu->channel->user_list, chu->client);
1566     silc_free(chu);
1567   }
1568
1569   silc_hash_table_list_reset(&htl);
1570 }
1571
1572 /* Replaces `old' client entries from all channels to `new' client entry.
1573    This can be called for example when nickname changes and old ID entry
1574    is replaced from ID cache with the new one. If the old ID entry is only
1575    updated, then this fucntion needs not to be called. */
1576
1577 void silc_client_replace_from_channels(SilcClient client,
1578                                        SilcClientConnection conn,
1579                                        SilcClientEntry old,
1580                                        SilcClientEntry new)
1581 {
1582   SilcHashTableList htl;
1583   SilcChannelUser chu;
1584
1585   silc_hash_table_list(old->channels, &htl);
1586   while (silc_hash_table_get(&htl, NULL, (void *)&chu)) {
1587     /* Replace client entry */
1588     silc_hash_table_del(chu->client->channels, chu->channel);
1589     silc_hash_table_del(chu->channel->user_list, chu->client);
1590
1591     chu->client = new;
1592     silc_hash_table_add(chu->channel->user_list, chu->client, chu);
1593     silc_hash_table_add(chu->client->channels, chu->channel, chu);
1594   }
1595   silc_hash_table_list_reset(&htl);
1596 }
1597
1598 /* Registers failure timeout to process the received failure packet
1599    with timeout. */
1600
1601 void silc_client_process_failure(SilcClient client,
1602                                  SilcSocketConnection sock,
1603                                  SilcPacketContext *packet)
1604 {
1605   SilcUInt32 failure = 0;
1606
1607   if (sock->protocol) {
1608     if (packet->buffer->len >= 4)
1609       SILC_GET32_MSB(failure, packet->buffer->data);
1610
1611     /* Notify application */
1612     client->internal->ops->failure(client, sock->user_data, sock->protocol,
1613                                    (void *)failure);
1614   }
1615 }
1616
1617 /* A timeout callback for the re-key. We will be the initiator of the
1618    re-key protocol. */
1619
1620 SILC_TASK_CALLBACK(silc_client_rekey_callback)
1621 {
1622   SilcSocketConnection sock = (SilcSocketConnection)context;
1623   SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1624   SilcClient client = (SilcClient)conn->rekey->context;
1625   SilcProtocol protocol;
1626   SilcClientRekeyInternalContext *proto_ctx;
1627
1628   SILC_LOG_DEBUG(("Start"));
1629
1630   /* Allocate internal protocol context. This is sent as context
1631      to the protocol. */
1632   proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
1633   proto_ctx->client = (void *)client;
1634   proto_ctx->sock = silc_socket_dup(sock);
1635   proto_ctx->responder = FALSE;
1636   proto_ctx->pfs = conn->rekey->pfs;
1637
1638   /* Perform rekey protocol. Will call the final callback after the
1639      protocol is over. */
1640   silc_protocol_alloc(SILC_PROTOCOL_CLIENT_REKEY,
1641                       &protocol, proto_ctx, silc_client_rekey_final);
1642   sock->protocol = protocol;
1643
1644   /* Run the protocol */
1645   silc_protocol_execute(protocol, client->schedule, 0, 0);
1646
1647   /* Re-register re-key timeout */
1648   silc_schedule_task_add(client->schedule, sock->sock,
1649                          silc_client_rekey_callback,
1650                          context, conn->rekey->timeout, 0,
1651                          SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
1652 }
1653
1654 /* The final callback for the REKEY protocol. This will actually take the
1655    new key material into use. */
1656
1657 SILC_TASK_CALLBACK(silc_client_rekey_final)
1658 {
1659   SilcProtocol protocol = (SilcProtocol)context;
1660   SilcClientRekeyInternalContext *ctx =
1661     (SilcClientRekeyInternalContext *)protocol->context;
1662   SilcClient client = (SilcClient)ctx->client;
1663   SilcSocketConnection sock = ctx->sock;
1664
1665   SILC_LOG_DEBUG(("Start"));
1666
1667   if (protocol->state == SILC_PROTOCOL_STATE_ERROR ||
1668       protocol->state == SILC_PROTOCOL_STATE_FAILURE) {
1669     /* Error occured during protocol */
1670     silc_protocol_cancel(protocol, client->schedule);
1671     silc_protocol_free(protocol);
1672     sock->protocol = NULL;
1673     if (ctx->packet)
1674       silc_packet_context_free(ctx->packet);
1675     if (ctx->ske)
1676       silc_ske_free(ctx->ske);
1677     silc_socket_free(ctx->sock);
1678     silc_free(ctx);
1679     return;
1680   }
1681
1682   /* Purge the outgoing data queue to assure that all rekey packets really
1683      go to the network before we quit the protocol. */
1684   silc_client_packet_queue_purge(client, sock);
1685
1686   /* Cleanup */
1687   silc_protocol_free(protocol);
1688   sock->protocol = NULL;
1689   if (ctx->packet)
1690     silc_packet_context_free(ctx->packet);
1691   if (ctx->ske)
1692     silc_ske_free(ctx->ske);
1693   silc_socket_free(ctx->sock);
1694   silc_free(ctx);
1695 }
1696
1697 /* Processes incoming connection authentication method request packet.
1698    It is a reply to our previously sent request. The packet can be used
1699    to resolve the authentication method for the current session if the
1700    client does not know it beforehand. */
1701
1702 void silc_client_connection_auth_request(SilcClient client,
1703                                          SilcSocketConnection sock,
1704                                          SilcPacketContext *packet)
1705 {
1706   SilcClientConnection conn = (SilcClientConnection)sock->user_data;
1707   SilcUInt16 conn_type, auth_meth;
1708   int ret;
1709
1710   /* If we haven't send our request then ignore this one. */
1711   if (!conn->connauth)
1712     return;
1713
1714   /* Parse the payload */
1715   ret = silc_buffer_unformat(packet->buffer,
1716                              SILC_STR_UI_SHORT(&conn_type),
1717                              SILC_STR_UI_SHORT(&auth_meth),
1718                              SILC_STR_END);
1719   if (ret == -1)
1720     auth_meth = SILC_AUTH_NONE;
1721
1722   /* Call the request callback to notify application for received
1723      authentication method information. */
1724   if (conn->connauth->callback)
1725     (*conn->connauth->callback)(client, conn, auth_meth,
1726                                 conn->connauth->context);
1727
1728   silc_schedule_task_del(client->schedule, conn->connauth->timeout);
1729
1730   silc_free(conn->connauth);
1731   conn->connauth = NULL;
1732 }
1733
1734 /* Timeout task callback called if the server does not reply to our
1735    connection authentication method request in the specified time interval. */
1736
1737 SILC_TASK_CALLBACK(silc_client_request_authentication_method_timeout)
1738 {
1739   SilcClientConnection conn = (SilcClientConnection)context;
1740   SilcClient client = conn->client;
1741
1742   if (!conn->connauth)
1743     return;
1744
1745   /* Call the request callback to notify application */
1746   if (conn->connauth->callback)
1747     (*conn->connauth->callback)(client, conn, SILC_AUTH_NONE,
1748                                 conn->connauth->context);
1749
1750   silc_free(conn->connauth);
1751   conn->connauth = NULL;
1752 }
1753
1754 /* This function can be used to request the current authentication method
1755    from the server. This may be called when connecting to the server
1756    and the client library requests the authentication data from the
1757    application. If the application does not know the current authentication
1758    method it can request it from the server using this function.
1759    The `callback' with `context' will be called after the server has
1760    replied back with the current authentication method. */
1761
1762 void
1763 silc_client_request_authentication_method(SilcClient client,
1764                                           SilcClientConnection conn,
1765                                           SilcConnectionAuthRequest callback,
1766                                           void *context)
1767 {
1768   SilcClientConnAuthRequest connauth;
1769   SilcBuffer packet;
1770
1771   connauth = silc_calloc(1, sizeof(*connauth));
1772   connauth->callback = callback;
1773   connauth->context = context;
1774
1775   if (conn->connauth)
1776     silc_free(conn->connauth);
1777
1778   conn->connauth = connauth;
1779
1780   /* Assemble the request packet and send it to the server */
1781   packet = silc_buffer_alloc(4);
1782   silc_buffer_pull_tail(packet, SILC_BUFFER_END(packet));
1783   silc_buffer_format(packet,
1784                      SILC_STR_UI_SHORT(SILC_SOCKET_TYPE_CLIENT),
1785                      SILC_STR_UI_SHORT(SILC_AUTH_NONE),
1786                      SILC_STR_END);
1787   silc_client_packet_send(client, conn->sock,
1788                           SILC_PACKET_CONNECTION_AUTH_REQUEST,
1789                           NULL, 0, NULL, NULL,
1790                           packet->data, packet->len, FALSE);
1791   silc_buffer_free(packet);
1792
1793   /* Register a timeout in case server does not reply anything back. */
1794   connauth->timeout =
1795     silc_schedule_task_add(client->schedule, conn->sock->sock,
1796                            silc_client_request_authentication_method_timeout,
1797                            conn,
1798                            client->internal->params->connauth_request_secs, 0,
1799                            SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
1800 }