openssh/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.55 2003/04/01 10:31:26 markus 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 #ifdef GSSAPI
  46 #include "ssh-gss.h"
  47 #endif
  48
  49 #define KEX_COOKIE_LEN  16
  50
  51 /* prototype */
  52 static void kex_kexinit_finish(Kex *);
  53 static void kex_choose_conf(Kex *);
  54
  55 /* put algorithm proposal into buffer */
  56 static void
  57 kex_prop2buf(Buffer *b, char *proposal[PROPOSAL_MAX])
  58 {
  59         int i;
  60
  61         buffer_clear(b);
  62         /*
  63          * add a dummy cookie, the cookie will be overwritten by
  64          * kex_send_kexinit(), each time a kexinit is set
  65          */
  66         for (i = 0; i < KEX_COOKIE_LEN; i++)
  67                 buffer_put_char(b, 0);
  68         for (i = 0; i < PROPOSAL_MAX; i++)
  69                 buffer_put_cstring(b, proposal[i]);
  70         buffer_put_char(b, 0);                  /* first_kex_packet_follows */
  71         buffer_put_int(b, 0);                   /* uint32 reserved */
  72 }
  73
  74 /* parse buffer and return algorithm proposal */
  75 static char **
  76 kex_buf2prop(Buffer *raw, int *first_kex_follows)
  77 {
  78         Buffer b;
  79         int i;
  80         char **proposal;
  81
  82         proposal = xmalloc(PROPOSAL_MAX * sizeof(char *));
  83
  84         buffer_init(&b);
  85         buffer_append(&b, buffer_ptr(raw), buffer_len(raw));
  86         /* skip cookie */
  87         for (i = 0; i < KEX_COOKIE_LEN; i++)
  88                 buffer_get_char(&b);
  89         /* extract kex init proposal strings */
  90         for (i = 0; i < PROPOSAL_MAX; i++) {
  91                 proposal[i] = buffer_get_string(&b,NULL);
  92                 debug2("kex_parse_kexinit: %s", proposal[i]);
  93         }
  94         /* first kex follows / reserved */
  95         i = buffer_get_char(&b);
  96         if (first_kex_follows != NULL)
  97                 *first_kex_follows = i;
  98         debug2("kex_parse_kexinit: first_kex_follows %d ", i);
  99         i = buffer_get_int(&b);
 100         debug2("kex_parse_kexinit: reserved %d ", i);
 101         buffer_free(&b);
 102         return proposal;
 103 }
 104
 105 static void
 106 kex_prop_free(char **proposal)
 107 {
 108         int i;
 109
 110         for (i = 0; i < PROPOSAL_MAX; i++)
 111                 xfree(proposal[i]);
 112         xfree(proposal);
 113 }
 114
 115 static void
 116 kex_protocol_error(int type, u_int32_t seq, void *ctxt)
 117 {
 118         error("Hm, kex protocol error: type %d seq %u", type, seq);
 119 }
 120
 121 static void
 122 kex_reset_dispatch(void)
 123 {
 124         dispatch_range(SSH2_MSG_TRANSPORT_MIN,
 125             SSH2_MSG_TRANSPORT_MAX, &kex_protocol_error);
 126         dispatch_set(SSH2_MSG_KEXINIT, &kex_input_kexinit);
 127 }
 128
 129 void
 130 kex_finish(Kex *kex)
 131 {
 132         kex_reset_dispatch();
 133
 134         packet_start(SSH2_MSG_NEWKEYS);
 135         packet_send();
 136         /* packet_write_wait(); */
 137         debug("SSH2_MSG_NEWKEYS sent");
 138
 139         debug("expecting SSH2_MSG_NEWKEYS");
 140         packet_read_expect(SSH2_MSG_NEWKEYS);
 141         packet_check_eom();
 142         debug("SSH2_MSG_NEWKEYS received");
 143
 144         kex->done = 1;
 145         buffer_clear(&kex->peer);
 146         /* buffer_clear(&kex->my); */
 147         kex->flags &= ~KEX_INIT_SENT;
 148         xfree(kex->name);
 149         kex->name = NULL;
 150 }
 151
 152 void
 153 kex_send_kexinit(Kex *kex)
 154 {
 155         u_int32_t rand = 0;
 156         u_char *cookie;
 157         int i;
 158
 159         if (kex == NULL) {
 160                 error("kex_send_kexinit: no kex, cannot rekey");
 161                 return;
 162         }
 163         if (kex->flags & KEX_INIT_SENT) {
 164                 debug("KEX_INIT_SENT");
 165                 return;
 166         }
 167         kex->done = 0;
 168
 169         /* generate a random cookie */
 170         if (buffer_len(&kex->my) < KEX_COOKIE_LEN)
 171                 fatal("kex_send_kexinit: kex proposal too short");
 172         cookie = buffer_ptr(&kex->my);
 173         for (i = 0; i < KEX_COOKIE_LEN; i++) {
 174                 if (i % 4 == 0)
 175                         rand = arc4random();
 176                 cookie[i] = rand;
 177                 rand >>= 8;
 178         }
 179         packet_start(SSH2_MSG_KEXINIT);
 180         packet_put_raw(buffer_ptr(&kex->my), buffer_len(&kex->my));
 181         packet_send();
 182         debug("SSH2_MSG_KEXINIT sent");
 183         kex->flags |= KEX_INIT_SENT;
 184 }
 185
 186 void
 187 kex_input_kexinit(int type, u_int32_t seq, void *ctxt)
 188 {
 189         char *ptr;
 190         int dlen;
 191         int i;
 192         Kex *kex = (Kex *)ctxt;
 193
 194         debug("SSH2_MSG_KEXINIT received");
 195         if (kex == NULL)
 196                 fatal("kex_input_kexinit: no kex, cannot rekey");
 197
 198         ptr = packet_get_raw(&dlen);
 199         buffer_append(&kex->peer, ptr, dlen);
 200
 201         /* discard packet */
 202         for (i = 0; i < KEX_COOKIE_LEN; i++)
 203                 packet_get_char();
 204         for (i = 0; i < PROPOSAL_MAX; i++)
 205                 xfree(packet_get_string(NULL));
 206         (void) packet_get_char();
 207         (void) packet_get_int();
 208         packet_check_eom();
 209
 210         kex_kexinit_finish(kex);
 211 }
 212
 213 Kex *
 214 kex_setup(char *proposal[PROPOSAL_MAX])
 215 {
 216         Kex *kex;
 217
 218         kex = xmalloc(sizeof(*kex));
 219         memset(kex, 0, sizeof(*kex));
 220         buffer_init(&kex->peer);
 221         buffer_init(&kex->my);
 222         kex_prop2buf(&kex->my, proposal);
 223         kex->done = 0;
 224
 225         kex_send_kexinit(kex);                                  /* we start */
 226         kex_reset_dispatch();
 227
 228         return kex;
 229 }
 230
 231 static void
 232 kex_kexinit_finish(Kex *kex)
 233 {
 234         if (!(kex->flags & KEX_INIT_SENT))
 235                 kex_send_kexinit(kex);
 236
 237         kex_choose_conf(kex);
 238
 239         if (kex->kex_type >= 0 && kex->kex_type < KEX_MAX &&
 240             kex->kex[kex->kex_type] != NULL) {
 241                 (kex->kex[kex->kex_type])(kex);
 242         } else {
 243                 fatal("Unsupported key exchange %d", kex->kex_type);
 244         }
 245 }
 246
 247 static void
 248 choose_enc(Enc *enc, char *client, char *server)
 249 {
 250         char *name = match_list(client, server, NULL);
 251         if (name == NULL)
 252                 fatal("no matching cipher found: client %s server %s", client, server);
 253         if ((enc->cipher = cipher_by_name(name)) == NULL)
 254                 fatal("matching cipher is not supported: %s", name);
 255         enc->name = name;
 256         enc->enabled = 0;
 257         enc->iv = NULL;
 258         enc->key = NULL;
 259         enc->key_len = cipher_keylen(enc->cipher);
 260         enc->block_size = cipher_blocksize(enc->cipher);
 261 }
 262 static void
 263 choose_mac(Mac *mac, char *client, char *server)
 264 {
 265         char *name = match_list(client, server, NULL);
 266         if (name == NULL)
 267                 fatal("no matching mac found: client %s server %s", client, server);
 268         if (mac_init(mac, name) < 0)
 269                 fatal("unsupported mac %s", name);
 270         /* truncate the key */
 271         if (datafellows & SSH_BUG_HMAC)
 272                 mac->key_len = 16;
 273         mac->name = name;
 274         mac->key = NULL;
 275         mac->enabled = 0;
 276 }
 277 static void
 278 choose_comp(Comp *comp, char *client, char *server)
 279 {
 280         char *name = match_list(client, server, NULL);
 281         if (name == NULL)
 282                 fatal("no matching comp found: client %s server %s", client, server);
 283         if (strcmp(name, "zlib") == 0) {
 284                 comp->type = 1;
 285         } else if (strcmp(name, "none") == 0) {
 286                 comp->type = 0;
 287         } else {
 288                 fatal("unsupported comp %s", name);
 289         }
 290         comp->name = name;
 291 }
 292 static void
 293 choose_kex(Kex *k, char *client, char *server)
 294 {
 295         k->name = match_list(client, server, NULL);
 296         if (k->name == NULL)
 297                 fatal("No key exchange algorithm");
 298         if (strcmp(k->name, KEX_DH1) == 0) {
 299                 k->kex_type = KEX_DH_GRP1_SHA1;
 300         } else if (strcmp(k->name, KEX_DHGEX) == 0) {
 301                 k->kex_type = KEX_DH_GEX_SHA1;
 302 #ifdef GSSAPI
 303         } else if (strncmp(k->name, KEX_GSS_SHA1,
 304                            sizeof(KEX_GSS_SHA1)-1) == 0) {
 305                 k->kex_type = KEX_GSS_GRP1_SHA1;
 306 #endif
 307         } else
 308                 fatal("bad kex alg %s", k->name);
 309 }
 310 static void
 311 choose_hostkeyalg(Kex *k, char *client, char *server)
 312 {
 313         char *hostkeyalg = match_list(client, server, NULL);
 314         if (hostkeyalg == NULL)
 315                 fatal("no hostkey alg");
 316         k->hostkey_type = key_type_from_name(hostkeyalg);
 317         if (k->hostkey_type == KEY_UNSPEC)
 318                 fatal("bad hostkey alg '%s'", hostkeyalg);
 319         xfree(hostkeyalg);
 320 }
 321
 322 static int
 323 proposals_match(char *my[PROPOSAL_MAX], char *peer[PROPOSAL_MAX])
 324 {
 325         static int check[] = {
 326                 PROPOSAL_KEX_ALGS, PROPOSAL_SERVER_HOST_KEY_ALGS, -1
 327         };
 328         int *idx;
 329         char *p;
 330
 331         for (idx = &check[0]; *idx != -1; idx++) {
 332                 if ((p = strchr(my[*idx], ',')) != NULL)
 333                         *p = '\0';
 334                 if ((p = strchr(peer[*idx], ',')) != NULL)
 335                         *p = '\0';
 336                 if (strcmp(my[*idx], peer[*idx]) != 0) {
 337                         debug2("proposal mismatch: my %s peer %s",
 338                             my[*idx], peer[*idx]);
 339                         return (0);
 340                 }
 341         }
 342         debug2("proposals match");
 343         return (1);
 344 }
 345
 346 static void
 347 kex_choose_conf(Kex *kex)
 348 {
 349         Newkeys *newkeys;
 350         char **my, **peer;
 351         char **cprop, **sprop;
 352         int nenc, nmac, ncomp;
 353         int mode;
 354         int ctos;                               /* direction: if true client-to-server */
 355         int need;
 356         int first_kex_follows, type;
 357
 358         my   = kex_buf2prop(&kex->my, NULL);
 359         peer = kex_buf2prop(&kex->peer, &first_kex_follows);
 360
 361         if (kex->server) {
 362                 cprop=peer;
 363                 sprop=my;
 364         } else {
 365                 cprop=my;
 366                 sprop=peer;
 367         }
 368
 369         /* Algorithm Negotiation */
 370         for (mode = 0; mode < MODE_MAX; mode++) {
 371                 newkeys = xmalloc(sizeof(*newkeys));
 372                 memset(newkeys, 0, sizeof(*newkeys));
 373                 kex->newkeys[mode] = newkeys;
 374                 ctos = (!kex->server && mode == MODE_OUT) || (kex->server && mode == MODE_IN);
 375                 nenc  = ctos ? PROPOSAL_ENC_ALGS_CTOS  : PROPOSAL_ENC_ALGS_STOC;
 376                 nmac  = ctos ? PROPOSAL_MAC_ALGS_CTOS  : PROPOSAL_MAC_ALGS_STOC;
 377                 ncomp = ctos ? PROPOSAL_COMP_ALGS_CTOS : PROPOSAL_COMP_ALGS_STOC;
 378                 choose_enc (&newkeys->enc,  cprop[nenc],  sprop[nenc]);
 379                 choose_mac (&newkeys->mac,  cprop[nmac],  sprop[nmac]);
 380                 choose_comp(&newkeys->comp, cprop[ncomp], sprop[ncomp]);
 381                 debug("kex: %s %s %s %s",
 382                     ctos ? "client->server" : "server->client",
 383                     newkeys->enc.name,
 384                     newkeys->mac.name,
 385                     newkeys->comp.name);
 386         }
 387         choose_kex(kex, cprop[PROPOSAL_KEX_ALGS], sprop[PROPOSAL_KEX_ALGS]);
 388         choose_hostkeyalg(kex, cprop[PROPOSAL_SERVER_HOST_KEY_ALGS],
 389             sprop[PROPOSAL_SERVER_HOST_KEY_ALGS]);
 390         need = 0;
 391         for (mode = 0; mode < MODE_MAX; mode++) {
 392                 newkeys = kex->newkeys[mode];
 393                 if (need < newkeys->enc.key_len)
 394                         need = newkeys->enc.key_len;
 395                 if (need < newkeys->enc.block_size)
 396                         need = newkeys->enc.block_size;
 397                 if (need < newkeys->mac.key_len)
 398                         need = newkeys->mac.key_len;
 399         }
 400         /* XXX need runden? */
 401         kex->we_need = need;
 402
 403         /* ignore the next message if the proposals do not match */
 404         if (first_kex_follows && !proposals_match(my, peer) &&
 405            !(datafellows & SSH_BUG_FIRSTKEX)) {
 406                 type = packet_read();
 407                 debug2("skipping next packet (type %u)", type);
 408         }
 409
 410         kex_prop_free(my);
 411         kex_prop_free(peer);
 412 }
 413
 414 static u_char *
 415 derive_key(Kex *kex, int id, int need, u_char *hash, BIGNUM *shared_secret)
 416 {
 417         Buffer b;
 418         const EVP_MD *evp_md = EVP_sha1();
 419         EVP_MD_CTX md;
 420         char c = id;
 421         int have;
 422         int mdsz = EVP_MD_size(evp_md);
 423         u_char *digest = xmalloc(roundup(need, mdsz));
 424
 425         buffer_init(&b);
 426         buffer_put_bignum2(&b, shared_secret);
 427
 428         /* K1 = HASH(K || H || "A" || session_id) */
 429         EVP_DigestInit(&md, evp_md);
 430         if (!(datafellows & SSH_BUG_DERIVEKEY))
 431                 EVP_DigestUpdate(&md, buffer_ptr(&b), buffer_len(&b));
 432         EVP_DigestUpdate(&md, hash, mdsz);
 433         EVP_DigestUpdate(&md, &c, 1);
 434         EVP_DigestUpdate(&md, kex->session_id, kex->session_id_len);
 435         EVP_DigestFinal(&md, digest, NULL);
 436
 437         /*
 438          * expand key:
 439          * Kn = HASH(K || H || K1 || K2 || ... || Kn-1)
 440          * Key = K1 || K2 || ... || Kn
 441          */
 442         for (have = mdsz; need > have; have += mdsz) {
 443                 EVP_DigestInit(&md, evp_md);
 444                 if (!(datafellows & SSH_BUG_DERIVEKEY))
 445                         EVP_DigestUpdate(&md, buffer_ptr(&b), buffer_len(&b));
 446                 EVP_DigestUpdate(&md, hash, mdsz);
 447                 EVP_DigestUpdate(&md, digest, have);
 448                 EVP_DigestFinal(&md, digest + have, NULL);
 449         }
 450         buffer_free(&b);
 451 #ifdef DEBUG_KEX
 452         fprintf(stderr, "key '%c'== ", c);
 453         dump_digest("key", digest, need);
 454 #endif
 455         return digest;
 456 }
 457
 458 Newkeys *current_keys[MODE_MAX];
 459
 460 #define NKEYS   6
 461 void
 462 kex_derive_keys(Kex *kex, u_char *hash, BIGNUM *shared_secret)
 463 {
 464         u_char *keys[NKEYS];
 465         int i, mode, ctos;
 466
 467         for (i = 0; i < NKEYS; i++)
 468                 keys[i] = derive_key(kex, 'A'+i, kex->we_need, hash, shared_secret);
 469
 470         debug2("kex_derive_keys");
 471         for (mode = 0; mode < MODE_MAX; mode++) {
 472                 current_keys[mode] = kex->newkeys[mode];
 473                 kex->newkeys[mode] = NULL;
 474                 ctos = (!kex->server && mode == MODE_OUT) || (kex->server && mode == MODE_IN);
 475                 current_keys[mode]->enc.iv  = keys[ctos ? 0 : 1];
 476                 current_keys[mode]->enc.key = keys[ctos ? 2 : 3];
 477                 current_keys[mode]->mac.key = keys[ctos ? 4 : 5];
 478         }
 479 }
 480
 481 Newkeys *
 482 kex_get_newkeys(int mode)
 483 {
 484         Newkeys *ret;
 485
 486         ret = current_keys[mode];
 487         current_keys[mode] = NULL;
 488         return ret;
 489 }
 490
 491 #if defined(DEBUG_KEX) || defined(DEBUG_KEXDH)
 492 void
 493 dump_digest(char *msg, u_char *digest, int len)
 494 {
 495         int i;
 496
 497         fprintf(stderr, "%s\n", msg);
 498         for (i = 0; i< len; i++) {
 499                 fprintf(stderr, "%02x", digest[i]);
 500                 if (i%32 == 31)
 501                         fprintf(stderr, "\n");
 502                 else if (i%8 == 7)
 503                         fprintf(stderr, " ");
 504         }
 505         fprintf(stderr, "\n");
 506 }
 507 #endif