lib/silcclient/client_prvmsg.c

   1 /*
   2
   3   client_prvmsg.c
   4
   5   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
   6
   7   Copyright (C) 1997 - 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 private message sending and receiving routines
  22    and private message key handling routines. */
  23
  24 #include "clientlibincludes.h"
  25 #include "client_internal.h"
  26
  27 /* Sends private message to remote client. If private message key has
  28    not been set with this client then the message will be encrypted using
  29    normal session keys. Private messages are special packets in SILC
  30    network hence we need this own function for them. This is similiar
  31    to silc_client_packet_send_to_channel except that we send private
  32    message. The `data' is the private message. If the `force_send' is
  33    TRUE the packet is sent immediately. */
  34
  35 void silc_client_send_private_message(SilcClient client,
  36                                       SilcClientConnection conn,
  37                                       SilcClientEntry client_entry,
  38                                       SilcMessageFlags flags,
  39                                       unsigned char *data,
  40                                       uint32 data_len,
  41                                       int force_send)
  42 {
  43   SilcSocketConnection sock = conn->sock;
  44   SilcBuffer buffer;
  45   SilcPacketContext packetdata;
  46   SilcCipher cipher;
  47   SilcHmac hmac;
  48   int block_len;
  49
  50   SILC_LOG_DEBUG(("Sending private message"));
  51
  52   /* Encode private message payload */
  53   buffer = silc_private_message_payload_encode(flags,
  54                                                data_len, data,
  55                                                client_entry->send_key);
  56
  57   /* If we don't have private message specific key then private messages
  58      are just as any normal packet thus call normal packet sending.  If
  59      the key exist then the encryption process is a bit different and
  60      will be done in the rest of this function. */
  61   if (!client_entry->send_key) {
  62     silc_client_packet_send(client, sock, SILC_PACKET_PRIVATE_MESSAGE,
  63                             client_entry->id, SILC_ID_CLIENT, NULL, NULL,
  64                             buffer->data, buffer->len, force_send);
  65     goto out;
  66   }
  67
  68   /* We have private message specific key */
  69
  70   /* Get data used in the encryption */
  71   cipher = client_entry->send_key;
  72   hmac = conn->hmac_send;
  73   block_len = silc_cipher_get_block_len(cipher);
  74
  75   /* Set the packet context pointers. */
  76   packetdata.flags = SILC_PACKET_FLAG_PRIVMSG_KEY;
  77   packetdata.type = SILC_PACKET_PRIVATE_MESSAGE;
  78   packetdata.src_id = conn->local_id_data;
  79   packetdata.src_id_len = silc_id_get_len(conn->local_id, SILC_ID_CLIENT);
  80   packetdata.src_id_type = SILC_ID_CLIENT;
  81   packetdata.dst_id = silc_id_id2str(client_entry->id, SILC_ID_CLIENT);
  82   packetdata.dst_id_len = silc_id_get_len(client_entry->id, SILC_ID_CLIENT);
  83   packetdata.dst_id_type = SILC_ID_CLIENT;
  84   packetdata.truelen = buffer->len + SILC_PACKET_HEADER_LEN +
  85     packetdata.src_id_len + packetdata.dst_id_len;
  86   packetdata.padlen = SILC_PACKET_PADLEN((SILC_PACKET_HEADER_LEN +
  87                                           packetdata.src_id_len +
  88                                           packetdata.dst_id_len), block_len);
  89
  90   /* Prepare outgoing data buffer for packet sending */
  91   silc_packet_send_prepare(sock,
  92                            SILC_PACKET_HEADER_LEN +
  93                            packetdata.src_id_len +
  94                            packetdata.dst_id_len,
  95                            packetdata.padlen,
  96                            buffer->len);
  97
  98   packetdata.buffer = sock->outbuf;
  99
 100   /* Put the actual encrypted message payload data into the buffer. */
 101   silc_buffer_put(sock->outbuf, buffer->data, buffer->len);
 102
 103   /* Create the outgoing packet */
 104   silc_packet_assemble(&packetdata, cipher);
 105
 106   /* Encrypt the header and padding of the packet. */
 107   cipher = conn->send_key;
 108   silc_packet_encrypt(cipher, hmac, conn->psn_send++,
 109                       sock->outbuf, SILC_PACKET_HEADER_LEN +
 110                       packetdata.src_id_len + packetdata.dst_id_len +
 111                       packetdata.padlen);
 112
 113   SILC_LOG_HEXDUMP(("Private message packet, len %d", sock->outbuf->len),
 114                    sock->outbuf->data, sock->outbuf->len);
 115
 116   /* Now actually send the packet */
 117   silc_client_packet_send_real(client, sock, force_send);
 118   silc_free(packetdata.dst_id);
 119
 120  out:
 121   silc_buffer_free(buffer);
 122 }
 123
 124 static void silc_client_private_message_cb(SilcClient client,
 125                                            SilcClientConnection conn,
 126                                            SilcClientEntry *clients,
 127                                            uint32 clients_count,
 128                                            void *context)
 129 {
 130   SilcPacketContext *packet = (SilcPacketContext *)context;
 131
 132   if (!clients) {
 133     silc_packet_context_free(packet);
 134     return;
 135   }
 136
 137   silc_client_private_message(client, conn->sock, packet);
 138   silc_packet_context_free(packet);
 139 }
 140
 141 /* Private message received. This processes the private message and
 142    finally displays it on the screen. */
 143
 144 void silc_client_private_message(SilcClient client,
 145                                  SilcSocketConnection sock,
 146                                  SilcPacketContext *packet)
 147 {
 148   SilcClientConnection conn = (SilcClientConnection)sock->user_data;
 149   SilcPrivateMessagePayload payload = NULL;
 150   SilcIDCacheEntry id_cache = NULL;
 151   SilcClientID *remote_id = NULL;
 152   SilcClientEntry remote_client;
 153   SilcMessageFlags flags;
 154
 155   if (packet->src_id_type != SILC_ID_CLIENT)
 156     goto out;
 157
 158   remote_id = silc_id_str2id(packet->src_id, packet->src_id_len,
 159                              SILC_ID_CLIENT);
 160   if (!remote_id)
 161     goto out;
 162
 163   /* Check whether we know this client already */
 164   if (!silc_idcache_find_by_id_one_ext(conn->client_cache, (void *)remote_id,
 165                                        NULL, NULL,
 166                                        silc_hash_client_id_compare, NULL,
 167                                        &id_cache) ||
 168       ((SilcClientEntry)id_cache->context)->nickname == NULL) {
 169
 170     if (id_cache && id_cache->context) {
 171       remote_client = (SilcClientEntry)id_cache->context;
 172       if (remote_client->status & SILC_CLIENT_STATUS_RESOLVING) {
 173         remote_client->status &= ~SILC_CLIENT_STATUS_RESOLVING;
 174         goto out;
 175       }
 176       remote_client->status |= SILC_CLIENT_STATUS_RESOLVING;
 177     }
 178
 179     /* Resolve the client info */
 180     silc_client_get_client_by_id_resolve(client, conn, remote_id,
 181                                          silc_client_private_message_cb,
 182                                          silc_packet_context_dup(packet));
 183     return;
 184   }
 185
 186   remote_client = (SilcClientEntry)id_cache->context;
 187
 188   /* Parse the payload and decrypt it also if private message key is set */
 189   payload = silc_private_message_payload_parse(packet->buffer->data,
 190                                                packet->buffer->len,
 191                                                remote_client->receive_key);
 192   if (!payload) {
 193     silc_free(remote_id);
 194     return;
 195   }
 196
 197   flags = silc_private_message_get_flags(payload);
 198
 199   /* Pass the private message to application */
 200   client->ops->private_message(client, conn, remote_client, flags,
 201                                silc_private_message_get_message(payload,
 202                                                                 NULL));
 203
 204   /* See if we are away (gone). If we are away we will reply to the
 205      sender with the set away message. */
 206   if (conn->away && conn->away->away && !(flags & SILC_MESSAGE_FLAG_NOREPLY)) {
 207     /* If it's me, ignore */
 208     if (SILC_ID_CLIENT_COMPARE(remote_id, conn->local_id))
 209       goto out;
 210
 211     /* Send the away message */
 212     silc_client_send_private_message(client, conn, remote_client,
 213                                      SILC_MESSAGE_FLAG_AUTOREPLY |
 214                                      SILC_MESSAGE_FLAG_NOREPLY,
 215                                      conn->away->away,
 216                                      strlen(conn->away->away), TRUE);
 217   }
 218
 219  out:
 220   if (payload)
 221     silc_private_message_payload_free(payload);
 222   silc_free(remote_id);
 223 }
 224
 225 /* Function that actually employes the received private message key */
 226
 227 static void silc_client_private_message_key_cb(SilcClient client,
 228                                                SilcClientConnection conn,
 229                                                SilcClientEntry *clients,
 230                                                uint32 clients_count,
 231                                                void *context)
 232 {
 233   SilcPacketContext *packet = (SilcPacketContext *)context;
 234   unsigned char *key;
 235   uint16 key_len;
 236   unsigned char *cipher;
 237   int ret;
 238
 239   if (!clients)
 240     goto out;
 241
 242   /* Parse the private message key payload */
 243   ret = silc_buffer_unformat(packet->buffer,
 244                              SILC_STR_UI16_NSTRING(&key, &key_len),
 245                              SILC_STR_UI16_STRING(&cipher),
 246                              SILC_STR_END);
 247   if (!ret)
 248     goto out;
 249
 250   if (key_len > packet->buffer->len)
 251     goto out;
 252
 253   /* Now take the key in use */
 254   if (!silc_client_add_private_message_key(client, conn, clients[0],
 255                                            cipher, key, key_len, FALSE, TRUE))
 256     goto out;
 257
 258   /* Print some info for application */
 259   client->ops->say(client, conn, SILC_CLIENT_MESSAGE_AUDIT,
 260                    "Received private message key from %s%s%s %s%s%s",
 261                    clients[0]->nickname,
 262                    clients[0]->server ? "@" : "",
 263                    clients[0]->server ? clients[0]->server : "",
 264                    clients[0]->username ? "(" : "",
 265                    clients[0]->username ? clients[0]->username : "",
 266                    clients[0]->username ? ")" : "");
 267
 268  out:
 269   silc_packet_context_free(packet);
 270 }
 271
 272 /* Processes incoming Private Message Key payload. The libary always
 273    accepts the key and takes it into use. */
 274
 275 void silc_client_private_message_key(SilcClient client,
 276                                      SilcSocketConnection sock,
 277                                      SilcPacketContext *packet)
 278 {
 279   SilcClientID *remote_id;
 280
 281   if (packet->src_id_type != SILC_ID_CLIENT)
 282     return;
 283
 284   remote_id = silc_id_str2id(packet->src_id, packet->src_id_len,
 285                              SILC_ID_CLIENT);
 286   if (!remote_id)
 287     return;
 288
 289   silc_client_get_client_by_id_resolve(client, sock->user_data, remote_id,
 290                                        silc_client_private_message_key_cb,
 291                                        silc_packet_context_dup(packet));
 292   silc_free(remote_id);
 293 }
 294
 295 /* Adds private message key to the client library. The key will be used to
 296    encrypt all private message between the client and the remote client
 297    indicated by the `client_entry'. If the `key' is NULL and the boolean
 298    value `generate_key' is TRUE the library will generate random key.
 299    The `key' maybe for example pre-shared-key, passphrase or similar.
 300    The `cipher' MAY be provided but SHOULD be NULL to assure that the
 301    requirements of the SILC protocol are met. The API, however, allows
 302    to allocate any cipher.
 303
 304    If `responder' is TRUE then the sending and receiving keys will be
 305    set according the client being the receiver of the private key.  If
 306    FALSE the client is being the sender (or negotiator) of the private
 307    key.
 308
 309    It is not necessary to set key for normal private message usage. If the
 310    key is not set then the private messages are encrypted using normal
 311    session keys. Setting the private key, however, increases the security.
 312
 313    Returns FALSE if the key is already set for the `client_entry', TRUE
 314    otherwise. */
 315
 316 int silc_client_add_private_message_key(SilcClient client,
 317                                         SilcClientConnection conn,
 318                                         SilcClientEntry client_entry,
 319                                         char *cipher,
 320                                         unsigned char *key,
 321                                         uint32 key_len,
 322                                         bool generate_key,
 323                                         bool responder)
 324 {
 325   unsigned char private_key[32];
 326   uint32 len;
 327   int i;
 328   SilcSKEKeyMaterial *keymat;
 329
 330   assert(client_entry);
 331
 332   /* Return FALSE if key already set */
 333   if (client_entry->send_key && client_entry->receive_key)
 334     return FALSE;
 335
 336   if (!cipher)
 337     cipher = SILC_DEFAULT_CIPHER;
 338
 339   /* Check the requested cipher */
 340   if (!silc_cipher_is_supported(cipher))
 341     return FALSE;
 342
 343   /* Generate key if not provided */
 344   if (generate_key == TRUE) {
 345     len = 32;
 346     for (i = 0; i < len; i++) private_key[i] = silc_rng_get_byte(client->rng);
 347     key = private_key;
 348     key_len = len;
 349     client_entry->generated = TRUE;
 350   }
 351
 352   /* Save the key */
 353   client_entry->key = silc_calloc(key_len, sizeof(*client_entry->key));
 354   memcpy(client_entry->key, key, key_len);
 355   client_entry->key_len = key_len;
 356
 357   /* Produce the key material as the protocol defines */
 358   keymat = silc_calloc(1, sizeof(*keymat));
 359   if (silc_ske_process_key_material_data(key, key_len, 16, 256, 16,
 360                                          client->md5hash, keymat)
 361       != SILC_SKE_STATUS_OK)
 362     return FALSE;
 363
 364   /* Allocate the ciphers */
 365   silc_cipher_alloc(cipher, &client_entry->send_key);
 366   silc_cipher_alloc(cipher, &client_entry->receive_key);
 367
 368   /* Set the keys */
 369   if (responder == TRUE) {
 370     silc_cipher_set_key(client_entry->send_key, keymat->receive_enc_key,
 371                         keymat->enc_key_len);
 372     silc_cipher_set_iv(client_entry->send_key, keymat->receive_iv);
 373     silc_cipher_set_key(client_entry->receive_key, keymat->send_enc_key,
 374                         keymat->enc_key_len);
 375     silc_cipher_set_iv(client_entry->receive_key, keymat->send_iv);
 376   } else {
 377     silc_cipher_set_key(client_entry->send_key, keymat->send_enc_key,
 378                         keymat->enc_key_len);
 379     silc_cipher_set_iv(client_entry->send_key, keymat->send_iv);
 380     silc_cipher_set_key(client_entry->receive_key, keymat->receive_enc_key,
 381                         keymat->enc_key_len);
 382     silc_cipher_set_iv(client_entry->receive_key, keymat->receive_iv);
 383   }
 384
 385   /* Free the key material */
 386   silc_ske_free_key_material(keymat);
 387
 388   return TRUE;
 389 }
 390
 391 /* Same as above but takes the key material from the SKE key material
 392    structure. This structure is received if the application uses the
 393    silc_client_send_key_agreement to negotiate the key material. The
 394    `cipher' SHOULD be provided as it is negotiated also in the SKE
 395    protocol. */
 396
 397 int silc_client_add_private_message_key_ske(SilcClient client,
 398                                             SilcClientConnection conn,
 399                                             SilcClientEntry client_entry,
 400                                             char *cipher,
 401                                             SilcSKEKeyMaterial *key,
 402                                             bool responder)
 403 {
 404   assert(client_entry);
 405
 406   /* Return FALSE if key already set */
 407   if (client_entry->send_key && client_entry->receive_key)
 408     return FALSE;
 409
 410   if (!cipher)
 411     cipher = SILC_DEFAULT_CIPHER;
 412
 413   /* Check the requested cipher */
 414   if (!silc_cipher_is_supported(cipher))
 415     return FALSE;
 416
 417   /* Allocate the ciphers */
 418   silc_cipher_alloc(cipher, &client_entry->send_key);
 419   silc_cipher_alloc(cipher, &client_entry->receive_key);
 420
 421   /* Set the keys */
 422   if (responder == TRUE) {
 423     silc_cipher_set_key(client_entry->send_key, key->receive_enc_key,
 424                         key->enc_key_len);
 425     silc_cipher_set_iv(client_entry->send_key, key->receive_iv);
 426     silc_cipher_set_key(client_entry->receive_key, key->send_enc_key,
 427                         key->enc_key_len);
 428     silc_cipher_set_iv(client_entry->receive_key, key->send_iv);
 429   } else {
 430     silc_cipher_set_key(client_entry->send_key, key->send_enc_key,
 431                         key->enc_key_len);
 432     silc_cipher_set_iv(client_entry->send_key, key->send_iv);
 433     silc_cipher_set_key(client_entry->receive_key, key->receive_enc_key,
 434                         key->enc_key_len);
 435     silc_cipher_set_iv(client_entry->receive_key, key->receive_iv);
 436   }
 437
 438   return TRUE;
 439 }
 440
 441 /* Sends private message key payload to the remote client indicated by
 442    the `client_entry'. If the `force_send' is TRUE the packet is sent
 443    immediately. Returns FALSE if error occurs, TRUE otherwise. The
 444    application should call this function after setting the key to the
 445    client.
 446
 447    Note that the key sent using this function is sent to the remote client
 448    through the SILC network. The packet is protected using normal session
 449    keys. */
 450
 451 int silc_client_send_private_message_key(SilcClient client,
 452                                          SilcClientConnection conn,
 453                                          SilcClientEntry client_entry,
 454                                          int force_send)
 455 {
 456   SilcSocketConnection sock = conn->sock;
 457   SilcBuffer buffer;
 458   int cipher_len;
 459
 460   if (!client_entry->send_key || !client_entry->key)
 461     return FALSE;
 462
 463   SILC_LOG_DEBUG(("Sending private message key"));
 464
 465   cipher_len = strlen(client_entry->send_key->cipher->name);
 466
 467   /* Create private message key payload */
 468   buffer = silc_buffer_alloc(2 + client_entry->key_len);
 469   silc_buffer_pull_tail(buffer, SILC_BUFFER_END(buffer));
 470   silc_buffer_format(buffer,
 471                      SILC_STR_UI_SHORT(client_entry->key_len),
 472                      SILC_STR_UI_XNSTRING(client_entry->key,
 473                                           client_entry->key_len),
 474                      SILC_STR_UI_SHORT(cipher_len),
 475                      SILC_STR_UI_XNSTRING(client_entry->send_key->cipher->name,
 476                                           cipher_len),
 477                      SILC_STR_END);
 478
 479   /* Send the packet */
 480   silc_client_packet_send(client, sock, SILC_PACKET_PRIVATE_MESSAGE_KEY,
 481                           client_entry->id, SILC_ID_CLIENT, NULL, NULL,
 482                           buffer->data, buffer->len, force_send);
 483   silc_free(buffer);
 484
 485   return TRUE;
 486 }
 487
 488 /* Removes the private message from the library. The key won't be used
 489    after this to protect the private messages with the remote `client_entry'
 490    client. Returns FALSE on error, TRUE otherwise. */
 491
 492 int silc_client_del_private_message_key(SilcClient client,
 493                                         SilcClientConnection conn,
 494                                         SilcClientEntry client_entry)
 495 {
 496   assert(client_entry);
 497
 498   if (!client_entry->send_key && !client_entry->receive_key)
 499     return FALSE;
 500
 501   silc_cipher_free(client_entry->send_key);
 502   silc_cipher_free(client_entry->receive_key);
 503
 504   if (client_entry->key) {
 505     memset(client_entry->key, 0, client_entry->key_len);
 506     silc_free(client_entry->key);
 507   }
 508
 509   client_entry->send_key = NULL;
 510   client_entry->receive_key = NULL;
 511   client_entry->key = NULL;
 512
 513   return TRUE;
 514 }
 515
 516 /* Returns array of set private message keys associated to the connection
 517    `conn'. Returns allocated SilcPrivateMessageKeys array and the array
 518    count to the `key_count' argument. The array must be freed by the caller
 519    by calling the silc_client_free_private_message_keys function. Note:
 520    the keys returned in the array is in raw format. It might not be desired
 521    to show the keys as is. The application might choose not to show the keys
 522    at all or to show the fingerprints of the keys. */
 523
 524 SilcPrivateMessageKeys
 525 silc_client_list_private_message_keys(SilcClient client,
 526                                       SilcClientConnection conn,
 527                                       uint32 *key_count)
 528 {
 529   SilcPrivateMessageKeys keys;
 530   uint32 count = 0;
 531   SilcIDCacheEntry id_cache;
 532   SilcIDCacheList list;
 533   SilcClientEntry entry;
 534
 535   if (!silc_idcache_get_all(conn->client_cache, &list))
 536     return NULL;
 537
 538   if (!silc_idcache_list_count(list)) {
 539     silc_idcache_list_free(list);
 540     return NULL;
 541   }
 542
 543   keys = silc_calloc(silc_idcache_list_count(list), sizeof(*keys));
 544
 545   silc_idcache_list_first(list, &id_cache);
 546   while (id_cache) {
 547     entry = (SilcClientEntry)id_cache->context;
 548
 549     if (entry->send_key) {
 550       keys[count].client_entry = entry;
 551       keys[count].cipher = entry->send_key->cipher->name;
 552       keys[count].key = entry->generated == FALSE ? entry->key : NULL;
 553       keys[count].key_len = entry->generated == FALSE ? entry->key_len : 0;
 554       count++;
 555     }
 556
 557     if (!silc_idcache_list_next(list, &id_cache))
 558       break;
 559   }
 560
 561   if (key_count)
 562     *key_count = count;
 563
 564   return keys;
 565 }
 566
 567 /* Frees the SilcPrivateMessageKeys array returned by the function
 568    silc_client_list_private_message_keys. */
 569
 570 void silc_client_free_private_message_keys(SilcPrivateMessageKeys keys,
 571                                            uint32 key_count)
 572 {
 573   silc_free(keys);
 574 }
 575
 576 /* Sets away `message'.  The away message may be set when the client's
 577    mode is changed to SILC_UMODE_GONE and the client whishes to reply
 578    to anyone who sends private message.  The `message' will be sent
 579    automatically back to the the client who send private message.  If
 580    away message is already set this replaces the old message with the
 581    new one.  If `message' is NULL the old away message is removed.
 582    The sender may freely free the memory of the `message'. */
 583
 584 void silc_client_set_away_message(SilcClient client,
 585                                   SilcClientConnection conn,
 586                                   char *message)
 587 {
 588   if (!message && conn->away) {
 589     silc_free(conn->away->away);
 590     silc_free(conn->away);
 591     conn->away = NULL;
 592   }
 593
 594   if (message) {
 595     if (!conn->away)
 596       conn->away = silc_calloc(1, sizeof(*conn->away));
 597     if (conn->away->away)
 598       silc_free(conn->away->away);
 599     conn->away->away = strdup(message);
 600   }
 601 }