kex.c

   1 /*
   2  * Copyright (c) 2000, 2001 Markus Friedl.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 #include "includes.h"
  26 RCSID("$OpenBSD: kex.c,v 1.66 2006/03/07 09:07:40 djm Exp $");
  27
  28 #include <openssl/crypto.h>
  29
  30 #include "ssh2.h"
  31 #include "xmalloc.h"
  32 #include "buffer.h"
  33 #include "bufaux.h"
  34 #include "packet.h"
  35 #include "compat.h"
  36 #include "cipher.h"
  37 #include "kex.h"
  38 #include "key.h"
  39 #include "log.h"
  40 #include "mac.h"
  41 #include "match.h"
  42 #include "dispatch.h"
  43 #include "monitor.h"
  44
  45 #define KEX_COOKIE_LEN  16
  46
  47 #ifdef HAVE_EVP_SHA256
  48 # define evp_ssh_sha256 EVP_sha256
  49 #else /* HAVE_EVP_SHA256 */
  50 extern const EVP_MD *evp_ssh_sha256(void);
  51 #endif /* HAVE_EVP_SHA256 */
  52
  53 /* prototype */
  54 static void kex_kexinit_finish(Kex *);
  55 static void kex_choose_conf(Kex *);
  56
  57 /* put algorithm proposal into buffer */
  58 static void
  59 kex_prop2buf(Buffer *b, char *proposal[PROPOSAL_MAX])
  60 {
  61         u_int i;
  62
  63         buffer_clear(b);
  64         /*
  65          * add a dummy cookie, the cookie will be overwritten by
  66          * kex_send_kexinit(), each time a kexinit is set
  67          */
  68         for (i = 0; i < KEX_COOKIE_LEN; i++)
  69                 buffer_put_char(b, 0);
  70         for (i = 0; i < PROPOSAL_MAX; i++)
  71                 buffer_put_cstring(b, proposal[i]);
  72         buffer_put_char(b, 0);                  /* first_kex_packet_follows */
  73         buffer_put_int(b, 0);                   /* uint32 reserved */
  74 }
  75
  76 /* parse buffer and return algorithm proposal */
  77 static char **
  78 kex_buf2prop(Buffer *raw, int *first_kex_follows)
  79 {
  80         Buffer b;
  81         int i;
  82         char **proposal;
  83
  84         proposal = xmalloc(PROPOSAL_MAX * sizeof(char *));
  85
  86         buffer_init(&b);
  87         buffer_append(&b, buffer_ptr(raw), buffer_len(raw));
  88         /* skip cookie */
  89         for (i = 0; i < KEX_COOKIE_LEN; i++)
  90                 buffer_get_char(&b);
  91         /* extract kex init proposal strings */
  92         for (i = 0; i < PROPOSAL_MAX; i++) {
  93                 proposal[i] = buffer_get_string(&b,NULL);
  94                 debug2("kex_parse_kexinit: %s", proposal[i]);
  95         }
  96         /* first kex follows / reserved */
  97         i = buffer_get_char(&b);
  98         if (first_kex_follows != NULL)
  99                 *first_kex_follows = i;
 100         debug2("kex_parse_kexinit: first_kex_follows %d ", i);
 101         i = buffer_get_int(&b);
 102         debug2("kex_parse_kexinit: reserved %d ", i);
 103         buffer_free(&b);
 104         return proposal;
 105 }
 106
 107 static void
 108 kex_prop_free(char **proposal)
 109 {
 110         u_int i;
 111
 112         for (i = 0; i < PROPOSAL_MAX; i++)
 113                 xfree(proposal[i]);
 114         xfree(proposal);
 115 }
 116
 117 static void
 118 kex_protocol_error(int type, u_int32_t seq, void *ctxt)
 119 {
 120         error("Hm, kex protocol error: type %d seq %u", type, seq);
 121 }
 122
 123 static void
 124 kex_reset_dispatch(void)
 125 {
 126         dispatch_range(SSH2_MSG_TRANSPORT_MIN,
 127             SSH2_MSG_TRANSPORT_MAX, &kex_protocol_error);
 128         dispatch_set(SSH2_MSG_KEXINIT, &kex_input_kexinit);
 129 }
 130
 131 void
 132 kex_finish(Kex *kex)
 133 {
 134         kex_reset_dispatch();
 135
 136         packet_start(SSH2_MSG_NEWKEYS);
 137         packet_send();
 138         /* packet_write_wait(); */
 139         debug("SSH2_MSG_NEWKEYS sent");
 140
 141         debug("expecting SSH2_MSG_NEWKEYS");
 142         packet_read_expect(SSH2_MSG_NEWKEYS);
 143         packet_check_eom();
 144         debug("SSH2_MSG_NEWKEYS received");
 145
 146         kex->done = 1;
 147         buffer_clear(&kex->peer);
 148         /* buffer_clear(&kex->my); */
 149         kex->flags &= ~KEX_INIT_SENT;
 150         xfree(kex->name);
 151         kex->name = NULL;
 152 }
 153
 154 void
 155 kex_send_kexinit(Kex *kex)
 156 {
 157         u_int32_t rnd = 0;
 158         u_char *cookie;
 159         u_int i;
 160
 161         if (kex == NULL) {
 162                 error("kex_send_kexinit: no kex, cannot rekey");
 163                 return;
 164         }
 165         if (kex->flags & KEX_INIT_SENT) {
 166                 debug("KEX_INIT_SENT");
 167                 return;
 168         }
 169         kex->done = 0;
 170
 171         /* generate a random cookie */
 172         if (buffer_len(&kex->my) < KEX_COOKIE_LEN)
 173                 fatal("kex_send_kexinit: kex proposal too short");
 174         cookie = buffer_ptr(&kex->my);
 175         for (i = 0; i < KEX_COOKIE_LEN; i++) {
 176                 if (i % 4 == 0)
 177                         rnd = arc4random();
 178                 cookie[i] = rnd;
 179                 rnd >>= 8;
 180         }
 181         packet_start(SSH2_MSG_KEXINIT);
 182         packet_put_raw(buffer_ptr(&kex->my), buffer_len(&kex->my));
 183         packet_send();
 184         debug("SSH2_MSG_KEXINIT sent");
 185         kex->flags |= KEX_INIT_SENT;
 186 }
 187
 188 void
 189 kex_input_kexinit(int type, u_int32_t seq, void *ctxt)
 190 {
 191         char *ptr;
 192         u_int i, dlen;
 193         Kex *kex = (Kex *)ctxt;
 194
 195         debug("SSH2_MSG_KEXINIT received");
 196         if (kex == NULL)
 197                 fatal("kex_input_kexinit: no kex, cannot rekey");
 198
 199         ptr = packet_get_raw(&dlen);
 200         buffer_append(&kex->peer, ptr, dlen);
 201
 202         /* discard packet */
 203         for (i = 0; i < KEX_COOKIE_LEN; i++)
 204                 packet_get_char();
 205         for (i = 0; i < PROPOSAL_MAX; i++)
 206                 xfree(packet_get_string(NULL));
 207         (void) packet_get_char();
 208         (void) packet_get_int();
 209         packet_check_eom();
 210
 211         kex_kexinit_finish(kex);
 212 }
 213
 214 Kex *
 215 kex_setup(char *proposal[PROPOSAL_MAX])
 216 {
 217         Kex *kex;
 218
 219         kex = xmalloc(sizeof(*kex));
 220         memset(kex, 0, sizeof(*kex));
 221         buffer_init(&kex->peer);
 222         buffer_init(&kex->my);
 223         kex_prop2buf(&kex->my, proposal);
 224         kex->done = 0;
 225
 226         kex_send_kexinit(kex);                                  /* we start */
 227         kex_reset_dispatch();
 228
 229         return kex;
 230 }
 231
 232 static void
 233 kex_kexinit_finish(Kex *kex)
 234 {
 235         if (!(kex->flags & KEX_INIT_SENT))
 236                 kex_send_kexinit(kex);
 237
 238         kex_choose_conf(kex);
 239
 240         if (kex->kex_type >= 0 && kex->kex_type < KEX_MAX &&
 241             kex->kex[kex->kex_type] != NULL) {
 242                 (kex->kex[kex->kex_type])(kex);
 243         } else {
 244                 fatal("Unsupported key exchange %d", kex->kex_type);
 245         }
 246 }
 247
 248 static void
 249 choose_enc(Enc *enc, char *client, char *server)
 250 {
 251         char *name = match_list(client, server, NULL);
 252         if (name == NULL)
 253                 fatal("no matching cipher found: client %s server %s", client, server);
 254         if ((enc->cipher = cipher_by_name(name)) == NULL)
 255                 fatal("matching cipher is not supported: %s", name);
 256         enc->name = name;
 257         enc->enabled = 0;
 258         enc->iv = NULL;
 259         enc->key = NULL;
 260         enc->key_len = cipher_keylen(enc->cipher);
 261         enc->block_size = cipher_blocksize(enc->cipher);
 262 }
 263 static void
 264 choose_mac(Mac *mac, char *client, char *server)
 265 {
 266         char *name = match_list(client, server, NULL);
 267         if (name == NULL)
 268                 fatal("no matching mac found: client %s server %s", client, server);
 269         if (mac_init(mac, name) < 0)
 270                 fatal("unsupported mac %s", name);
 271         /* truncate the key */
 272         if (datafellows & SSH_BUG_HMAC)
 273                 mac->key_len = 16;
 274         mac->name = name;
 275         mac->key = NULL;
 276         mac->enabled = 0;
 277 }
 278 static void
 279 choose_comp(Comp *comp, char *client, char *server)
 280 {
 281         char *name = match_list(client, server, NULL);
 282         if (name == NULL)
 283                 fatal("no matching comp found: client %s server %s", client, server);
 284         if (strcmp(name, "zlib@openssh.com") == 0) {
 285                 comp->type = COMP_DELAYED;
 286         } else if (strcmp(name, "zlib") == 0) {
 287                 comp->type = COMP_ZLIB;
 288         } else if (strcmp(name, "none") == 0) {
 289                 comp->type = COMP_NONE;
 290         } else {
 291                 fatal("unsupported comp %s", name);
 292         }
 293         comp->name = name;
 294 }
 295 static void
 296 choose_kex(Kex *k, char *client, char *server)
 297 {
 298         k->name = match_list(client, server, NULL);
 299         if (k->name == NULL)
 300                 fatal("no kex alg");
 301         if (strcmp(k->name, KEX_DH1) == 0) {
 302                 k->kex_type = KEX_DH_GRP1_SHA1;
 303                 k->evp_md = EVP_sha1();
 304         } else if (strcmp(k->name, KEX_DH14) == 0) {
 305                 k->kex_type = KEX_DH_GRP14_SHA1;
 306                 k->evp_md = EVP_sha1();
 307         } else if (strcmp(k->name, KEX_DHGEX_SHA1) == 0) {
 308                 k->kex_type = KEX_DH_GEX_SHA1;
 309                 k->evp_md = EVP_sha1();
 310         } else if (strcmp(k->name, KEX_DHGEX_SHA256) == 0) {
 311                 k->kex_type = KEX_DH_GEX_SHA256;
 312                 k->evp_md = evp_ssh_sha256();
 313         } else
 314                 fatal("bad kex alg %s", k->name);
 315 }
 316
 317 static void
 318 choose_hostkeyalg(Kex *k, char *client, char *server)
 319 {
 320         char *hostkeyalg = match_list(client, server, NULL);
 321         if (hostkeyalg == NULL)
 322                 fatal("no hostkey alg");
 323         k->hostkey_type = key_type_from_name(hostkeyalg);
 324         if (k->hostkey_type == KEY_UNSPEC)
 325                 fatal("bad hostkey alg '%s'", hostkeyalg);
 326         xfree(hostkeyalg);
 327 }
 328
 329 static int
 330 proposals_match(char *my[PROPOSAL_MAX], char *peer[PROPOSAL_MAX])
 331 {
 332         static int check[] = {
 333                 PROPOSAL_KEX_ALGS, PROPOSAL_SERVER_HOST_KEY_ALGS, -1
 334         };
 335         int *idx;
 336         char *p;
 337
 338         for (idx = &check[0]; *idx != -1; idx++) {
 339                 if ((p = strchr(my[*idx], ',')) != NULL)
 340                         *p = '\0';
 341                 if ((p = strchr(peer[*idx], ',')) != NULL)
 342                         *p = '\0';
 343                 if (strcmp(my[*idx], peer[*idx]) != 0) {
 344                         debug2("proposal mismatch: my %s peer %s",
 345                             my[*idx], peer[*idx]);
 346                         return (0);
 347                 }
 348         }
 349         debug2("proposals match");
 350         return (1);
 351 }
 352
 353 static void
 354 kex_choose_conf(Kex *kex)
 355 {
 356         Newkeys *newkeys;
 357         char **my, **peer;
 358         char **cprop, **sprop;
 359         int nenc, nmac, ncomp;
 360         u_int mode, ctos, need;
 361         int first_kex_follows, type;
 362
 363         my   = kex_buf2prop(&kex->my, NULL);
 364         peer = kex_buf2prop(&kex->peer, &first_kex_follows);
 365
 366         if (kex->server) {
 367                 cprop=peer;
 368                 sprop=my;
 369         } else {
 370                 cprop=my;
 371                 sprop=peer;
 372         }
 373
 374         /* Algorithm Negotiation */
 375         for (mode = 0; mode < MODE_MAX; mode++) {
 376                 newkeys = xmalloc(sizeof(*newkeys));
 377                 memset(newkeys, 0, sizeof(*newkeys));
 378                 kex->newkeys[mode] = newkeys;
 379                 ctos = (!kex->server && mode == MODE_OUT) || (kex->server && mode == MODE_IN);
 380                 nenc  = ctos ? PROPOSAL_ENC_ALGS_CTOS  : PROPOSAL_ENC_ALGS_STOC;
 381                 nmac  = ctos ? PROPOSAL_MAC_ALGS_CTOS  : PROPOSAL_MAC_ALGS_STOC;
 382                 ncomp = ctos ? PROPOSAL_COMP_ALGS_CTOS : PROPOSAL_COMP_ALGS_STOC;
 383                 choose_enc (&newkeys->enc,  cprop[nenc],  sprop[nenc]);
 384                 choose_mac (&newkeys->mac,  cprop[nmac],  sprop[nmac]);
 385                 choose_comp(&newkeys->comp, cprop[ncomp], sprop[ncomp]);
 386                 debug("kex: %s %s %s %s",
 387                     ctos ? "client->server" : "server->client",
 388                     newkeys->enc.name,
 389                     newkeys->mac.name,
 390                     newkeys->comp.name);
 391         }
 392         choose_kex(kex, cprop[PROPOSAL_KEX_ALGS], sprop[PROPOSAL_KEX_ALGS]);
 393         choose_hostkeyalg(kex, cprop[PROPOSAL_SERVER_HOST_KEY_ALGS],
 394             sprop[PROPOSAL_SERVER_HOST_KEY_ALGS]);
 395         need = 0;
 396         for (mode = 0; mode < MODE_MAX; mode++) {
 397                 newkeys = kex->newkeys[mode];
 398                 if (need < newkeys->enc.key_len)
 399                         need = newkeys->enc.key_len;
 400                 if (need < newkeys->enc.block_size)
 401                         need = newkeys->enc.block_size;
 402                 if (need < newkeys->mac.key_len)
 403                         need = newkeys->mac.key_len;
 404         }
 405         /* XXX need runden? */
 406         kex->we_need = need;
 407
 408         /* ignore the next message if the proposals do not match */
 409         if (first_kex_follows && !proposals_match(my, peer) &&
 410             !(datafellows & SSH_BUG_FIRSTKEX)) {
 411                 type = packet_read();
 412                 debug2("skipping next packet (type %u)", type);
 413         }
 414
 415         kex_prop_free(my);
 416         kex_prop_free(peer);
 417 }
 418
 419 static u_char *
 420 derive_key(Kex *kex, int id, u_int need, u_char *hash, u_int hashlen,
 421     BIGNUM *shared_secret)
 422 {
 423         Buffer b;
 424         EVP_MD_CTX md;
 425         char c = id;
 426         u_int have;
 427         int mdsz;
 428         u_char *digest;
 429
 430         if ((mdsz = EVP_MD_size(kex->evp_md)) <= 0)
 431                 fatal("bad kex md size %d", mdsz);
 432         digest = xmalloc(roundup(need, mdsz));
 433
 434         buffer_init(&b);
 435         buffer_put_bignum2(&b, shared_secret);
 436
 437         /* K1 = HASH(K || H || "A" || session_id) */
 438         EVP_DigestInit(&md, kex->evp_md);
 439         if (!(datafellows & SSH_BUG_DERIVEKEY))
 440                 EVP_DigestUpdate(&md, buffer_ptr(&b), buffer_len(&b));
 441         EVP_DigestUpdate(&md, hash, hashlen);
 442         EVP_DigestUpdate(&md, &c, 1);
 443         EVP_DigestUpdate(&md, kex->session_id, kex->session_id_len);
 444         EVP_DigestFinal(&md, digest, NULL);
 445
 446         /*
 447          * expand key:
 448          * Kn = HASH(K || H || K1 || K2 || ... || Kn-1)
 449          * Key = K1 || K2 || ... || Kn
 450          */
 451         for (have = mdsz; need > have; have += mdsz) {
 452                 EVP_DigestInit(&md, kex->evp_md);
 453                 if (!(datafellows & SSH_BUG_DERIVEKEY))
 454                         EVP_DigestUpdate(&md, buffer_ptr(&b), buffer_len(&b));
 455                 EVP_DigestUpdate(&md, hash, hashlen);
 456                 EVP_DigestUpdate(&md, digest, have);
 457                 EVP_DigestFinal(&md, digest + have, NULL);
 458         }
 459         buffer_free(&b);
 460 #ifdef DEBUG_KEX
 461         fprintf(stderr, "key '%c'== ", c);
 462         dump_digest("key", digest, need);
 463 #endif
 464         return digest;
 465 }
 466
 467 Newkeys *current_keys[MODE_MAX];
 468
 469 #define NKEYS   6
 470 void
 471 kex_derive_keys(Kex *kex, u_char *hash, u_int hashlen, BIGNUM *shared_secret)
 472 {
 473         u_char *keys[NKEYS];
 474         u_int i, mode, ctos;
 475
 476         for (i = 0; i < NKEYS; i++) {
 477                 keys[i] = derive_key(kex, 'A'+i, kex->we_need, hash, hashlen,
 478                     shared_secret);
 479         }
 480
 481         debug2("kex_derive_keys");
 482         for (mode = 0; mode < MODE_MAX; mode++) {
 483                 current_keys[mode] = kex->newkeys[mode];
 484                 kex->newkeys[mode] = NULL;
 485                 ctos = (!kex->server && mode == MODE_OUT) || (kex->server && mode == MODE_IN);
 486                 current_keys[mode]->enc.iv  = keys[ctos ? 0 : 1];
 487                 current_keys[mode]->enc.key = keys[ctos ? 2 : 3];
 488                 current_keys[mode]->mac.key = keys[ctos ? 4 : 5];
 489         }
 490 }
 491
 492 Newkeys *
 493 kex_get_newkeys(int mode)
 494 {
 495         Newkeys *ret;
 496
 497         ret = current_keys[mode];
 498         current_keys[mode] = NULL;
 499         return ret;
 500 }
 501
 502 void
 503 derive_ssh1_session_id(BIGNUM *host_modulus, BIGNUM *server_modulus,
 504     u_int8_t cookie[8], u_int8_t id[16])
 505 {
 506         const EVP_MD *evp_md = EVP_md5();
 507         EVP_MD_CTX md;
 508         u_int8_t nbuf[2048], obuf[EVP_MAX_MD_SIZE];
 509         int len;
 510
 511         EVP_DigestInit(&md, evp_md);
 512
 513         len = BN_num_bytes(host_modulus);
 514         if (len < (512 / 8) || (u_int)len > sizeof(nbuf))
 515                 fatal("%s: bad host modulus (len %d)", __func__, len);
 516         BN_bn2bin(host_modulus, nbuf);
 517         EVP_DigestUpdate(&md, nbuf, len);
 518
 519         len = BN_num_bytes(server_modulus);
 520         if (len < (512 / 8) || (u_int)len > sizeof(nbuf))
 521                 fatal("%s: bad server modulus (len %d)", __func__, len);
 522         BN_bn2bin(server_modulus, nbuf);
 523         EVP_DigestUpdate(&md, nbuf, len);
 524
 525         EVP_DigestUpdate(&md, cookie, 8);
 526
 527         EVP_DigestFinal(&md, obuf, NULL);
 528         memcpy(id, obuf, 16);
 529
 530         memset(nbuf, 0, sizeof(nbuf));
 531         memset(obuf, 0, sizeof(obuf));
 532         memset(&md, 0, sizeof(md));
 533 }
 534
 535 #if defined(DEBUG_KEX) || defined(DEBUG_KEXDH)
 536 void
 537 dump_digest(char *msg, u_char *digest, int len)
 538 {
 539         u_int i;
 540
 541         fprintf(stderr, "%s\n", msg);
 542         for (i = 0; i< len; i++) {
 543                 fprintf(stderr, "%02x", digest[i]);
 544                 if (i%32 == 31)
 545                         fprintf(stderr, "\n");
 546                 else if (i%8 == 7)
 547                         fprintf(stderr, " ");
 548         }
 549         fprintf(stderr, "\n");
 550 }
 551 #endif