openssh/cipher.c

   1 /*
   2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   4  *                    All rights reserved
   5  *
   6  * As far as I am concerned, the code I have written for this software
   7  * can be used freely for any purpose.  Any derived versions of this
   8  * software must be clearly marked as such, and if the derived work is
   9  * incompatible with the protocol description in the RFC file, it must be
  10  * called by a name other than "ssh" or "Secure Shell".
  11  *
  12  *
  13  * Copyright (c) 1999 Niels Provos.  All rights reserved.
  14  * Copyright (c) 1999, 2000 Markus Friedl.  All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  26  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  28  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  34  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #include "includes.h"
  38 RCSID("$OpenBSD: cipher.c,v 1.77 2005/07/16 01:35:24 djm Exp $");
  39
  40 #include "xmalloc.h"
  41 #include "log.h"
  42 #include "cipher.h"
  43
  44 #include <openssl/md5.h>
  45
  46 /* compatibility with old or broken OpenSSL versions */
  47 #include "openbsd-compat/openssl-compat.h"
  48
  49 extern const EVP_CIPHER *evp_ssh1_bf(void);
  50 extern const EVP_CIPHER *evp_ssh1_3des(void);
  51 extern void ssh1_3des_iv(EVP_CIPHER_CTX *, int, u_char *, int);
  52 extern const EVP_CIPHER *evp_aes_128_ctr(void);
  53 extern void ssh_aes_ctr_iv(EVP_CIPHER_CTX *, int, u_char *, u_int);
  54
  55 struct Cipher {
  56         char    *name;
  57         int     number;         /* for ssh1 only */
  58         u_int   block_size;
  59         u_int   key_len;
  60         u_int   discard_len;
  61         const EVP_CIPHER        *(*evptype)(void);
  62 } ciphers[] = {
  63         { "none",               SSH_CIPHER_NONE, 8, 0, 0, EVP_enc_null },
  64         { "des",                SSH_CIPHER_DES, 8, 8, 0, EVP_des_cbc },
  65         { "3des",               SSH_CIPHER_3DES, 8, 16, 0, evp_ssh1_3des },
  66         { "blowfish",           SSH_CIPHER_BLOWFISH, 8, 32, 0, evp_ssh1_bf },
  67
  68         { "3des-cbc",           SSH_CIPHER_SSH2, 8, 24, 0, EVP_des_ede3_cbc },
  69         { "blowfish-cbc",       SSH_CIPHER_SSH2, 8, 16, 0, EVP_bf_cbc },
  70         { "cast128-cbc",        SSH_CIPHER_SSH2, 8, 16, 0, EVP_cast5_cbc },
  71         { "arcfour",            SSH_CIPHER_SSH2, 8, 16, 0, EVP_rc4 },
  72         { "arcfour128",         SSH_CIPHER_SSH2, 8, 16, 1536, EVP_rc4 },
  73         { "arcfour256",         SSH_CIPHER_SSH2, 8, 32, 1536, EVP_rc4 },
  74         { "aes128-cbc",         SSH_CIPHER_SSH2, 16, 16, 0, EVP_aes_128_cbc },
  75         { "aes192-cbc",         SSH_CIPHER_SSH2, 16, 24, 0, EVP_aes_192_cbc },
  76         { "aes256-cbc",         SSH_CIPHER_SSH2, 16, 32, 0, EVP_aes_256_cbc },
  77         { "rijndael-cbc@lysator.liu.se",
  78                                 SSH_CIPHER_SSH2, 16, 32, 0, EVP_aes_256_cbc },
  79         { "aes128-ctr",         SSH_CIPHER_SSH2, 16, 16, 0, evp_aes_128_ctr },
  80         { "aes192-ctr",         SSH_CIPHER_SSH2, 16, 24, 0, evp_aes_128_ctr },
  81         { "aes256-ctr",         SSH_CIPHER_SSH2, 16, 32, 0, evp_aes_128_ctr },
  82 #ifdef USE_CIPHER_ACSS
  83         { "acss@openssh.org",   SSH_CIPHER_SSH2, 16, 5, 0, EVP_acss },
  84 #endif
  85         { NULL,                 SSH_CIPHER_INVALID, 0, 0, 0, NULL }
  86 };
  87
  88 /*--*/
  89
  90 u_int
  91 cipher_blocksize(const Cipher *c)
  92 {
  93         return (c->block_size);
  94 }
  95
  96 u_int
  97 cipher_keylen(const Cipher *c)
  98 {
  99         return (c->key_len);
 100 }
 101
 102 u_int
 103 cipher_get_number(const Cipher *c)
 104 {
 105         return (c->number);
 106 }
 107
 108 u_int
 109 cipher_mask_ssh1(int client)
 110 {
 111         u_int mask = 0;
 112         mask |= 1 << SSH_CIPHER_3DES;           /* Mandatory */
 113         mask |= 1 << SSH_CIPHER_BLOWFISH;
 114         if (client) {
 115                 mask |= 1 << SSH_CIPHER_DES;
 116         }
 117         return mask;
 118 }
 119
 120 Cipher *
 121 cipher_by_name(const char *name)
 122 {
 123         Cipher *c;
 124         for (c = ciphers; c->name != NULL; c++)
 125                 if (strcmp(c->name, name) == 0)
 126                         return c;
 127         return NULL;
 128 }
 129
 130 Cipher *
 131 cipher_by_number(int id)
 132 {
 133         Cipher *c;
 134         for (c = ciphers; c->name != NULL; c++)
 135                 if (c->number == id)
 136                         return c;
 137         return NULL;
 138 }
 139
 140 #define CIPHER_SEP      ","
 141 int
 142 ciphers_valid(const char *names)
 143 {
 144         Cipher *c;
 145         char *cipher_list, *cp;
 146         char *p;
 147
 148         if (names == NULL || strcmp(names, "") == 0)
 149                 return 0;
 150         cipher_list = cp = xstrdup(names);
 151         for ((p = strsep(&cp, CIPHER_SEP)); p && *p != '\0';
 152             (p = strsep(&cp, CIPHER_SEP))) {
 153                 c = cipher_by_name(p);
 154                 if (c == NULL || (c->number != SSH_CIPHER_SSH2 &&
 155                                   c->number != SSH_CIPHER_NONE)) {
 156                         debug("bad cipher %s [%s]", p, names);
 157                         xfree(cipher_list);
 158                         return 0;
 159                 } else {
 160                         debug3("cipher ok: %s [%s]", p, names);
 161                 }
 162         }
 163         debug3("ciphers ok: [%s]", names);
 164         xfree(cipher_list);
 165         return 1;
 166 }
 167
 168 /*
 169  * Parses the name of the cipher.  Returns the number of the corresponding
 170  * cipher, or -1 on error.
 171  */
 172
 173 int
 174 cipher_number(const char *name)
 175 {
 176         Cipher *c;
 177         if (name == NULL)
 178                 return -1;
 179         for (c = ciphers; c->name != NULL; c++)
 180                 if (strcasecmp(c->name, name) == 0)
 181                         return c->number;
 182         return -1;
 183 }
 184
 185 char *
 186 cipher_name(int id)
 187 {
 188         Cipher *c = cipher_by_number(id);
 189         return (c==NULL) ? "<unknown>" : c->name;
 190 }
 191
 192 void
 193 cipher_init(CipherContext *cc, Cipher *cipher,
 194     const u_char *key, u_int keylen, const u_char *iv, u_int ivlen,
 195     int do_encrypt)
 196 {
 197         static int dowarn = 1;
 198 #ifdef SSH_OLD_EVP
 199         EVP_CIPHER *type;
 200 #else
 201         const EVP_CIPHER *type;
 202         int klen;
 203 #endif
 204         u_char *junk, *discard;
 205
 206         if (cipher->number == SSH_CIPHER_DES) {
 207                 if (dowarn) {
 208                         error("Warning: use of DES is strongly discouraged "
 209                             "due to cryptographic weaknesses");
 210                         dowarn = 0;
 211                 }
 212                 if (keylen > 8)
 213                         keylen = 8;
 214         }
 215         cc->plaintext = (cipher->number == SSH_CIPHER_NONE);
 216
 217         if (keylen < cipher->key_len)
 218                 fatal("cipher_init: key length %d is insufficient for %s.",
 219                     keylen, cipher->name);
 220         if (iv != NULL && ivlen < cipher->block_size)
 221                 fatal("cipher_init: iv length %d is insufficient for %s.",
 222                     ivlen, cipher->name);
 223         cc->cipher = cipher;
 224
 225         type = (*cipher->evptype)();
 226
 227         EVP_CIPHER_CTX_init(&cc->evp);
 228 #ifdef SSH_OLD_EVP
 229         if (type->key_len > 0 && type->key_len != keylen) {
 230                 debug("cipher_init: set keylen (%d -> %d)",
 231                     type->key_len, keylen);
 232                 type->key_len = keylen;
 233         }
 234         EVP_CipherInit(&cc->evp, type, (u_char *)key, (u_char *)iv,
 235             (do_encrypt == CIPHER_ENCRYPT));
 236 #else
 237         if (EVP_CipherInit(&cc->evp, type, NULL, (u_char *)iv,
 238             (do_encrypt == CIPHER_ENCRYPT)) == 0)
 239                 fatal("cipher_init: EVP_CipherInit failed for %s",
 240                     cipher->name);
 241         klen = EVP_CIPHER_CTX_key_length(&cc->evp);
 242         if (klen > 0 && keylen != (u_int)klen) {
 243                 debug2("cipher_init: set keylen (%d -> %d)", klen, keylen);
 244                 if (EVP_CIPHER_CTX_set_key_length(&cc->evp, keylen) == 0)
 245                         fatal("cipher_init: set keylen failed (%d -> %d)",
 246                             klen, keylen);
 247         }
 248         if (EVP_CipherInit(&cc->evp, NULL, (u_char *)key, NULL, -1) == 0)
 249                 fatal("cipher_init: EVP_CipherInit: set key failed for %s",
 250                     cipher->name);
 251 #endif
 252
 253         if (cipher->discard_len > 0) {
 254                 junk = xmalloc(cipher->discard_len);
 255                 discard = xmalloc(cipher->discard_len);
 256                 if (EVP_Cipher(&cc->evp, discard, junk,
 257                     cipher->discard_len) == 0)
 258                         fatal("evp_crypt: EVP_Cipher failed during discard");
 259                 memset(discard, 0, cipher->discard_len);
 260                 xfree(junk);
 261                 xfree(discard);
 262         }
 263 }
 264
 265 void
 266 cipher_crypt(CipherContext *cc, u_char *dest, const u_char *src, u_int len)
 267 {
 268         if (len % cc->cipher->block_size)
 269                 fatal("cipher_encrypt: bad plaintext length %d", len);
 270         if (EVP_Cipher(&cc->evp, dest, (u_char *)src, len) == 0)
 271                 fatal("evp_crypt: EVP_Cipher failed");
 272 }
 273
 274 void
 275 cipher_cleanup(CipherContext *cc)
 276 {
 277         if (EVP_CIPHER_CTX_cleanup(&cc->evp) == 0)
 278                 error("cipher_cleanup: EVP_CIPHER_CTX_cleanup failed");
 279 }
 280
 281 /*
 282  * Selects the cipher, and keys if by computing the MD5 checksum of the
 283  * passphrase and using the resulting 16 bytes as the key.
 284  */
 285
 286 void
 287 cipher_set_key_string(CipherContext *cc, Cipher *cipher,
 288     const char *passphrase, int do_encrypt)
 289 {
 290         MD5_CTX md;
 291         u_char digest[16];
 292
 293         MD5_Init(&md);
 294         MD5_Update(&md, (const u_char *)passphrase, strlen(passphrase));
 295         MD5_Final(digest, &md);
 296
 297         cipher_init(cc, cipher, digest, 16, NULL, 0, do_encrypt);
 298
 299         memset(digest, 0, sizeof(digest));
 300         memset(&md, 0, sizeof(md));
 301 }
 302
 303 /*
 304  * Exports an IV from the CipherContext required to export the key
 305  * state back from the unprivileged child to the privileged parent
 306  * process.
 307  */
 308
 309 int
 310 cipher_get_keyiv_len(const CipherContext *cc)
 311 {
 312         Cipher *c = cc->cipher;
 313         int ivlen;
 314
 315         if (c->number == SSH_CIPHER_3DES)
 316                 ivlen = 24;
 317         else
 318                 ivlen = EVP_CIPHER_CTX_iv_length(&cc->evp);
 319         return (ivlen);
 320 }
 321
 322 void
 323 cipher_get_keyiv(CipherContext *cc, u_char *iv, u_int len)
 324 {
 325         Cipher *c = cc->cipher;
 326         int evplen;
 327
 328         switch (c->number) {
 329         case SSH_CIPHER_NONE:
 330         case SSH_CIPHER_SSH2:
 331         case SSH_CIPHER_DES:
 332         case SSH_CIPHER_BLOWFISH:
 333                 evplen = EVP_CIPHER_CTX_iv_length(&cc->evp);
 334                 if (evplen <= 0)
 335                         return;
 336                 if ((u_int)evplen != len)
 337                         fatal("%s: wrong iv length %d != %d", __func__,
 338                             evplen, len);
 339 #ifdef USE_BUILTIN_RIJNDAEL
 340                 if (c->evptype == evp_rijndael)
 341                         ssh_rijndael_iv(&cc->evp, 0, iv, len);
 342                 else
 343 #endif
 344                 if (c->evptype == evp_aes_128_ctr)
 345                         ssh_aes_ctr_iv(&cc->evp, 0, iv, len);
 346                 else
 347                         memcpy(iv, cc->evp.iv, len);
 348                 break;
 349         case SSH_CIPHER_3DES:
 350                 ssh1_3des_iv(&cc->evp, 0, iv, 24);
 351                 break;
 352         default:
 353                 fatal("%s: bad cipher %d", __func__, c->number);
 354         }
 355 }
 356
 357 void
 358 cipher_set_keyiv(CipherContext *cc, u_char *iv)
 359 {
 360         Cipher *c = cc->cipher;
 361         int evplen = 0;
 362
 363         switch (c->number) {
 364         case SSH_CIPHER_NONE:
 365         case SSH_CIPHER_SSH2:
 366         case SSH_CIPHER_DES:
 367         case SSH_CIPHER_BLOWFISH:
 368                 evplen = EVP_CIPHER_CTX_iv_length(&cc->evp);
 369                 if (evplen == 0)
 370                         return;
 371 #ifdef USE_BUILTIN_RIJNDAEL
 372                 if (c->evptype == evp_rijndael)
 373                         ssh_rijndael_iv(&cc->evp, 1, iv, evplen);
 374                 else
 375 #endif
 376                 if (c->evptype == evp_aes_128_ctr)
 377                         ssh_aes_ctr_iv(&cc->evp, 1, iv, evplen);
 378                 else
 379                         memcpy(cc->evp.iv, iv, evplen);
 380                 break;
 381         case SSH_CIPHER_3DES:
 382                 ssh1_3des_iv(&cc->evp, 1, iv, 24);
 383                 break;
 384         default:
 385                 fatal("%s: bad cipher %d", __func__, c->number);
 386         }
 387 }
 388
 389 #if OPENSSL_VERSION_NUMBER < 0x00907000L
 390 #define EVP_X_STATE(evp)        &(evp).c
 391 #define EVP_X_STATE_LEN(evp)    sizeof((evp).c)
 392 #else
 393 #define EVP_X_STATE(evp)        (evp).cipher_data
 394 #define EVP_X_STATE_LEN(evp)    (evp).cipher->ctx_size
 395 #endif
 396
 397 int
 398 cipher_get_keycontext(const CipherContext *cc, u_char *dat)
 399 {
 400         Cipher *c = cc->cipher;
 401         int plen = 0;
 402
 403         if (c->evptype == EVP_rc4 || c->evptype == EVP_acss) {
 404                 plen = EVP_X_STATE_LEN(cc->evp);
 405                 if (dat == NULL)
 406                         return (plen);
 407                 memcpy(dat, EVP_X_STATE(cc->evp), plen);
 408         }
 409         return (plen);
 410 }
 411
 412 void
 413 cipher_set_keycontext(CipherContext *cc, u_char *dat)
 414 {
 415         Cipher *c = cc->cipher;
 416         int plen;
 417
 418         if (c->evptype == EVP_rc4 || c->evptype == EVP_acss) {
 419                 plen = EVP_X_STATE_LEN(cc->evp);
 420                 memcpy(EVP_X_STATE(cc->evp), dat, plen);
 421         }
 422 }