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.65 2003/05/17 04:27:52 markus Exp $");
  39
  40 #include "xmalloc.h"
  41 #include "log.h"
  42 #include "cipher.h"
  43
  44 #include <openssl/md5.h>
  45
  46 #if OPENSSL_VERSION_NUMBER < 0x00906000L
  47 #define SSH_OLD_EVP
  48 #define EVP_CIPHER_CTX_get_app_data(e)          ((e)->app_data)
  49 #endif
  50
  51 #if OPENSSL_VERSION_NUMBER < 0x00907000L
  52 extern const EVP_CIPHER *evp_rijndael(void);
  53 extern void ssh_rijndael_iv(EVP_CIPHER_CTX *, int, u_char *, u_int);
  54 #endif
  55 extern const EVP_CIPHER *evp_ssh1_bf(void);
  56 extern const EVP_CIPHER *evp_ssh1_3des(void);
  57 extern void ssh1_3des_iv(EVP_CIPHER_CTX *, int, u_char *, int);
  58 extern const EVP_CIPHER *evp_aes_128_ctr(void);
  59 extern void ssh_aes_ctr_iv(EVP_CIPHER_CTX *, int, u_char *, u_int);
  60
  61 struct Cipher {
  62         char    *name;
  63         int     number;         /* for ssh1 only */
  64         u_int   block_size;
  65         u_int   key_len;
  66         const EVP_CIPHER        *(*evptype)(void);
  67 } ciphers[] = {
  68         { "none",               SSH_CIPHER_NONE, 8, 0, EVP_enc_null },
  69         { "des",                SSH_CIPHER_DES, 8, 8, EVP_des_cbc },
  70         { "3des",               SSH_CIPHER_3DES, 8, 16, evp_ssh1_3des },
  71         { "blowfish",           SSH_CIPHER_BLOWFISH, 8, 32, evp_ssh1_bf },
  72
  73         { "3des-cbc",           SSH_CIPHER_SSH2, 8, 24, EVP_des_ede3_cbc },
  74         { "blowfish-cbc",       SSH_CIPHER_SSH2, 8, 16, EVP_bf_cbc },
  75         { "cast128-cbc",        SSH_CIPHER_SSH2, 8, 16, EVP_cast5_cbc },
  76         { "arcfour",            SSH_CIPHER_SSH2, 8, 16, EVP_rc4 },
  77 #if OPENSSL_VERSION_NUMBER < 0x00907000L
  78         { "aes128-cbc",         SSH_CIPHER_SSH2, 16, 16, evp_rijndael },
  79         { "aes192-cbc",         SSH_CIPHER_SSH2, 16, 24, evp_rijndael },
  80         { "aes256-cbc",         SSH_CIPHER_SSH2, 16, 32, evp_rijndael },
  81         { "rijndael-cbc@lysator.liu.se",
  82                                 SSH_CIPHER_SSH2, 16, 32, evp_rijndael },
  83 #else
  84         { "aes128-cbc",         SSH_CIPHER_SSH2, 16, 16, EVP_aes_128_cbc },
  85         { "aes192-cbc",         SSH_CIPHER_SSH2, 16, 24, EVP_aes_192_cbc },
  86         { "aes256-cbc",         SSH_CIPHER_SSH2, 16, 32, EVP_aes_256_cbc },
  87         { "rijndael-cbc@lysator.liu.se",
  88                                 SSH_CIPHER_SSH2, 16, 32, EVP_aes_256_cbc },
  89 #endif
  90 #if OPENSSL_VERSION_NUMBER >= 0x00906000L
  91         { "aes128-ctr",         SSH_CIPHER_SSH2, 16, 16, evp_aes_128_ctr },
  92         { "aes192-ctr",         SSH_CIPHER_SSH2, 16, 24, evp_aes_128_ctr },
  93         { "aes256-ctr",         SSH_CIPHER_SSH2, 16, 32, evp_aes_128_ctr },
  94 #endif
  95
  96         { NULL,                 SSH_CIPHER_ILLEGAL, 0, 0, NULL }
  97 };
  98
  99 /*--*/
 100
 101 u_int
 102 cipher_blocksize(Cipher *c)
 103 {
 104         return (c->block_size);
 105 }
 106
 107 u_int
 108 cipher_keylen(Cipher *c)
 109 {
 110         return (c->key_len);
 111 }
 112
 113 u_int
 114 cipher_get_number(Cipher *c)
 115 {
 116         return (c->number);
 117 }
 118
 119 u_int
 120 cipher_mask_ssh1(int client)
 121 {
 122         u_int mask = 0;
 123         mask |= 1 << SSH_CIPHER_3DES;           /* Mandatory */
 124         mask |= 1 << SSH_CIPHER_BLOWFISH;
 125         if (client) {
 126                 mask |= 1 << SSH_CIPHER_DES;
 127         }
 128         return mask;
 129 }
 130
 131 Cipher *
 132 cipher_by_name(const char *name)
 133 {
 134         Cipher *c;
 135         for (c = ciphers; c->name != NULL; c++)
 136                 if (strcasecmp(c->name, name) == 0)
 137                         return c;
 138         return NULL;
 139 }
 140
 141 Cipher *
 142 cipher_by_number(int id)
 143 {
 144         Cipher *c;
 145         for (c = ciphers; c->name != NULL; c++)
 146                 if (c->number == id)
 147                         return c;
 148         return NULL;
 149 }
 150
 151 #define CIPHER_SEP      ","
 152 int
 153 ciphers_valid(const char *names)
 154 {
 155         Cipher *c;
 156         char *ciphers, *cp;
 157         char *p;
 158
 159         if (names == NULL || strcmp(names, "") == 0)
 160                 return 0;
 161         ciphers = cp = xstrdup(names);
 162         for ((p = strsep(&cp, CIPHER_SEP)); p && *p != '\0';
 163             (p = strsep(&cp, CIPHER_SEP))) {
 164                 c = cipher_by_name(p);
 165                 if (c == NULL || c->number != SSH_CIPHER_SSH2) {
 166                         debug("bad cipher %s [%s]", p, names);
 167                         xfree(ciphers);
 168                         return 0;
 169                 } else {
 170                         debug3("cipher ok: %s [%s]", p, names);
 171                 }
 172         }
 173         debug3("ciphers ok: [%s]", names);
 174         xfree(ciphers);
 175         return 1;
 176 }
 177
 178 /*
 179  * Parses the name of the cipher.  Returns the number of the corresponding
 180  * cipher, or -1 on error.
 181  */
 182
 183 int
 184 cipher_number(const char *name)
 185 {
 186         Cipher *c;
 187         if (name == NULL)
 188                 return -1;
 189         c = cipher_by_name(name);
 190         return (c==NULL) ? -1 : c->number;
 191 }
 192
 193 char *
 194 cipher_name(int id)
 195 {
 196         Cipher *c = cipher_by_number(id);
 197         return (c==NULL) ? "<unknown>" : c->name;
 198 }
 199
 200 void
 201 cipher_init(CipherContext *cc, Cipher *cipher,
 202     const u_char *key, u_int keylen, const u_char *iv, u_int ivlen,
 203     int encrypt)
 204 {
 205         static int dowarn = 1;
 206 #ifdef SSH_OLD_EVP
 207         EVP_CIPHER *type;
 208 #else
 209         const EVP_CIPHER *type;
 210 #endif
 211         int klen;
 212
 213         if (cipher->number == SSH_CIPHER_DES) {
 214                 if (dowarn) {
 215                         error("Warning: use of DES is strongly discouraged "
 216                             "due to cryptographic weaknesses");
 217                         dowarn = 0;
 218                 }
 219                 if (keylen > 8)
 220                         keylen = 8;
 221         }
 222         cc->plaintext = (cipher->number == SSH_CIPHER_NONE);
 223
 224         if (keylen < cipher->key_len)
 225                 fatal("cipher_init: key length %d is insufficient for %s.",
 226                     keylen, cipher->name);
 227         if (iv != NULL && ivlen < cipher->block_size)
 228                 fatal("cipher_init: iv length %d is insufficient for %s.",
 229                     ivlen, cipher->name);
 230         cc->cipher = cipher;
 231
 232         type = (*cipher->evptype)();
 233
 234         EVP_CIPHER_CTX_init(&cc->evp);
 235 #ifdef SSH_OLD_EVP
 236         if (type->key_len > 0 && type->key_len != keylen) {
 237                 debug("cipher_init: set keylen (%d -> %d)",
 238                     type->key_len, keylen);
 239                 type->key_len = keylen;
 240         }
 241         EVP_CipherInit(&cc->evp, type, (u_char *)key, (u_char *)iv,
 242             (encrypt == CIPHER_ENCRYPT));
 243 #else
 244         if (EVP_CipherInit(&cc->evp, type, NULL, (u_char *)iv,
 245             (encrypt == CIPHER_ENCRYPT)) == 0)
 246                 fatal("cipher_init: EVP_CipherInit failed for %s",
 247                     cipher->name);
 248         klen = EVP_CIPHER_CTX_key_length(&cc->evp);
 249         if (klen > 0 && keylen != klen) {
 250                 debug2("cipher_init: set keylen (%d -> %d)", klen, keylen);
 251                 if (EVP_CIPHER_CTX_set_key_length(&cc->evp, keylen) == 0)
 252                         fatal("cipher_init: set keylen failed (%d -> %d)",
 253                             klen, keylen);
 254         }
 255         if (EVP_CipherInit(&cc->evp, NULL, (u_char *)key, NULL, -1) == 0)
 256                 fatal("cipher_init: EVP_CipherInit: set key failed for %s",
 257                     cipher->name);
 258 #endif
 259 }
 260
 261 void
 262 cipher_crypt(CipherContext *cc, u_char *dest, const u_char *src, u_int len)
 263 {
 264         if (len % cc->cipher->block_size)
 265                 fatal("cipher_encrypt: bad plaintext length %d", len);
 266 #ifdef SSH_OLD_EVP
 267         EVP_Cipher(&cc->evp, dest, (u_char *)src, len);
 268 #else
 269         if (EVP_Cipher(&cc->evp, dest, (u_char *)src, len) == 0)
 270                 fatal("evp_crypt: EVP_Cipher failed");
 271 #endif
 272 }
 273
 274 void
 275 cipher_cleanup(CipherContext *cc)
 276 {
 277 #ifdef SSH_OLD_EVP
 278         EVP_CIPHER_CTX_cleanup(&cc->evp);
 279 #else
 280         if (EVP_CIPHER_CTX_cleanup(&cc->evp) == 0)
 281                 error("cipher_cleanup: EVP_CIPHER_CTX_cleanup failed");
 282 #endif
 283 }
 284
 285 /*
 286  * Selects the cipher, and keys if by computing the MD5 checksum of the
 287  * passphrase and using the resulting 16 bytes as the key.
 288  */
 289
 290 void
 291 cipher_set_key_string(CipherContext *cc, Cipher *cipher,
 292     const char *passphrase, int encrypt)
 293 {
 294         MD5_CTX md;
 295         u_char digest[16];
 296
 297         MD5_Init(&md);
 298         MD5_Update(&md, (const u_char *)passphrase, strlen(passphrase));
 299         MD5_Final(digest, &md);
 300
 301         cipher_init(cc, cipher, digest, 16, NULL, 0, encrypt);
 302
 303         memset(digest, 0, sizeof(digest));
 304         memset(&md, 0, sizeof(md));
 305 }
 306
 307 /*
 308  * Exports an IV from the CipherContext required to export the key
 309  * state back from the unprivileged child to the privileged parent
 310  * process.
 311  */
 312
 313 int
 314 cipher_get_keyiv_len(CipherContext *cc)
 315 {
 316         Cipher *c = cc->cipher;
 317         int ivlen;
 318
 319         if (c->number == SSH_CIPHER_3DES)
 320                 ivlen = 24;
 321         else
 322                 ivlen = EVP_CIPHER_CTX_iv_length(&cc->evp);
 323         return (ivlen);
 324 }
 325
 326 void
 327 cipher_get_keyiv(CipherContext *cc, u_char *iv, u_int len)
 328 {
 329         Cipher *c = cc->cipher;
 330         int evplen;
 331
 332         switch (c->number) {
 333         case SSH_CIPHER_SSH2:
 334         case SSH_CIPHER_DES:
 335         case SSH_CIPHER_BLOWFISH:
 336                 evplen = EVP_CIPHER_CTX_iv_length(&cc->evp);
 337                 if (evplen == 0)
 338                         return;
 339                 if (evplen != len)
 340                         fatal("%s: wrong iv length %d != %d", __func__,
 341                             evplen, len);
 342 #if OPENSSL_VERSION_NUMBER < 0x00907000L
 343                 if (c->evptype == evp_rijndael)
 344                         ssh_rijndael_iv(&cc->evp, 0, iv, len);
 345                 else
 346 #endif
 347                 if (c->evptype == evp_aes_128_ctr)
 348                         ssh_aes_ctr_iv(&cc->evp, 0, iv, len);
 349                 else
 350                         memcpy(iv, cc->evp.iv, len);
 351                 break;
 352         case SSH_CIPHER_3DES:
 353                 ssh1_3des_iv(&cc->evp, 0, iv, 24);
 354                 break;
 355         default:
 356                 fatal("%s: bad cipher %d", __func__, c->number);
 357         }
 358 }
 359
 360 void
 361 cipher_set_keyiv(CipherContext *cc, u_char *iv)
 362 {
 363         Cipher *c = cc->cipher;
 364         int evplen = 0;
 365
 366         switch (c->number) {
 367         case SSH_CIPHER_SSH2:
 368         case SSH_CIPHER_DES:
 369         case SSH_CIPHER_BLOWFISH:
 370                 evplen = EVP_CIPHER_CTX_iv_length(&cc->evp);
 371                 if (evplen == 0)
 372                         return;
 373 #if OPENSSL_VERSION_NUMBER < 0x00907000L
 374                 if (c->evptype == evp_rijndael)
 375                         ssh_rijndael_iv(&cc->evp, 1, iv, evplen);
 376                 else
 377 #endif
 378                 if (c->evptype == evp_aes_128_ctr)
 379                         ssh_aes_ctr_iv(&cc->evp, 1, iv, evplen);
 380                 else
 381                         memcpy(cc->evp.iv, iv, evplen);
 382                 break;
 383         case SSH_CIPHER_3DES:
 384                 ssh1_3des_iv(&cc->evp, 1, iv, 24);
 385                 break;
 386         default:
 387                 fatal("%s: bad cipher %d", __func__, c->number);
 388         }
 389 }
 390
 391 #if OPENSSL_VERSION_NUMBER < 0x00907000L
 392 #define EVP_X_STATE(evp)        &(evp).c
 393 #define EVP_X_STATE_LEN(evp)    sizeof((evp).c)
 394 #else
 395 #define EVP_X_STATE(evp)        (evp).cipher_data
 396 #define EVP_X_STATE_LEN(evp)    (evp).cipher->ctx_size
 397 #endif
 398
 399 int
 400 cipher_get_keycontext(CipherContext *cc, u_char *dat)
 401 {
 402         Cipher *c = cc->cipher;
 403         int plen = 0;
 404
 405         if (c->evptype == EVP_rc4) {
 406                 plen = EVP_X_STATE_LEN(cc->evp);
 407                 if (dat == NULL)
 408                         return (plen);
 409                 memcpy(dat, EVP_X_STATE(cc->evp), plen);
 410         }
 411         return (plen);
 412 }
 413
 414 void
 415 cipher_set_keycontext(CipherContext *cc, u_char *dat)
 416 {
 417         Cipher *c = cc->cipher;
 418         int plen;
 419
 420         if (c->evptype == EVP_rc4) {
 421                 plen = EVP_X_STATE_LEN(cc->evp);
 422                 memcpy(EVP_X_STATE(cc->evp), dat, plen);
 423         }
 424 }