2 * Author: Tatu Ylonen <ylo@cs.hut.fi>
3 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
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".
13 * Copyright (c) 1999 Niels Provos. All rights reserved.
14 * Copyright (c) 1999, 2000 Markus Friedl. All rights reserved.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
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.
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.
38 RCSID("$OpenBSD: cipher.c,v 1.63 2003/04/12 10:13:57 markus Exp $");
44 #include <openssl/md5.h>
46 #if OPENSSL_VERSION_NUMBER < 0x00906000L
48 #define EVP_CIPHER_CTX_get_app_data(e) ((e)->app_data)
51 #if OPENSSL_VERSION_NUMBER < 0x00907000L
53 static const EVP_CIPHER *evp_rijndael(void);
55 static const EVP_CIPHER *evp_ssh1_3des(void);
56 static const EVP_CIPHER *evp_ssh1_bf(void);
60 int number; /* for ssh1 only */
63 const EVP_CIPHER *(*evptype)(void);
65 { "none", SSH_CIPHER_NONE, 8, 0, EVP_enc_null },
66 { "des", SSH_CIPHER_DES, 8, 8, EVP_des_cbc },
67 { "3des", SSH_CIPHER_3DES, 8, 16, evp_ssh1_3des },
68 { "blowfish", SSH_CIPHER_BLOWFISH, 8, 32, evp_ssh1_bf },
70 { "3des-cbc", SSH_CIPHER_SSH2, 8, 24, EVP_des_ede3_cbc },
71 { "blowfish-cbc", SSH_CIPHER_SSH2, 8, 16, EVP_bf_cbc },
72 { "cast128-cbc", SSH_CIPHER_SSH2, 8, 16, EVP_cast5_cbc },
73 { "arcfour", SSH_CIPHER_SSH2, 8, 16, EVP_rc4 },
74 #if OPENSSL_VERSION_NUMBER < 0x00907000L
75 { "aes128-cbc", SSH_CIPHER_SSH2, 16, 16, evp_rijndael },
76 { "aes192-cbc", SSH_CIPHER_SSH2, 16, 24, evp_rijndael },
77 { "aes256-cbc", SSH_CIPHER_SSH2, 16, 32, evp_rijndael },
78 { "rijndael-cbc@lysator.liu.se",
79 SSH_CIPHER_SSH2, 16, 32, evp_rijndael },
81 { "aes128-cbc", SSH_CIPHER_SSH2, 16, 16, EVP_aes_128_cbc },
82 { "aes192-cbc", SSH_CIPHER_SSH2, 16, 24, EVP_aes_192_cbc },
83 { "aes256-cbc", SSH_CIPHER_SSH2, 16, 32, EVP_aes_256_cbc },
84 { "rijndael-cbc@lysator.liu.se",
85 SSH_CIPHER_SSH2, 16, 32, EVP_aes_256_cbc },
88 { NULL, SSH_CIPHER_ILLEGAL, 0, 0, NULL }
94 cipher_blocksize(Cipher *c)
96 return (c->block_size);
100 cipher_keylen(Cipher *c)
106 cipher_get_number(Cipher *c)
112 cipher_mask_ssh1(int client)
115 mask |= 1 << SSH_CIPHER_3DES; /* Mandatory */
116 mask |= 1 << SSH_CIPHER_BLOWFISH;
118 mask |= 1 << SSH_CIPHER_DES;
124 cipher_by_name(const char *name)
127 for (c = ciphers; c->name != NULL; c++)
128 if (strcasecmp(c->name, name) == 0)
134 cipher_by_number(int id)
137 for (c = ciphers; c->name != NULL; c++)
143 #define CIPHER_SEP ","
145 ciphers_valid(const char *names)
151 if (names == NULL || strcmp(names, "") == 0)
153 ciphers = cp = xstrdup(names);
154 for ((p = strsep(&cp, CIPHER_SEP)); p && *p != '\0';
155 (p = strsep(&cp, CIPHER_SEP))) {
156 c = cipher_by_name(p);
157 if (c == NULL || c->number != SSH_CIPHER_SSH2) {
158 debug("bad cipher %s [%s]", p, names);
162 debug3("cipher ok: %s [%s]", p, names);
165 debug3("ciphers ok: [%s]", names);
171 * Parses the name of the cipher. Returns the number of the corresponding
172 * cipher, or -1 on error.
176 cipher_number(const char *name)
181 c = cipher_by_name(name);
182 return (c==NULL) ? -1 : c->number;
188 Cipher *c = cipher_by_number(id);
189 return (c==NULL) ? "<unknown>" : c->name;
193 cipher_init(CipherContext *cc, Cipher *cipher,
194 const u_char *key, u_int keylen, const u_char *iv, u_int ivlen,
197 static int dowarn = 1;
201 const EVP_CIPHER *type;
205 if (cipher->number == SSH_CIPHER_DES) {
207 error("Warning: use of DES is strongly discouraged "
208 "due to cryptographic weaknesses");
214 cc->plaintext = (cipher->number == SSH_CIPHER_NONE);
216 if (keylen < cipher->key_len)
217 fatal("cipher_init: key length %d is insufficient for %s.",
218 keylen, cipher->name);
219 if (iv != NULL && ivlen < cipher->block_size)
220 fatal("cipher_init: iv length %d is insufficient for %s.",
221 ivlen, cipher->name);
224 type = (*cipher->evptype)();
226 EVP_CIPHER_CTX_init(&cc->evp);
228 if (type->key_len > 0 && type->key_len != keylen) {
229 debug("cipher_init: set keylen (%d -> %d)",
230 type->key_len, keylen);
231 type->key_len = keylen;
233 EVP_CipherInit(&cc->evp, type, (u_char *)key, (u_char *)iv,
234 (encrypt == CIPHER_ENCRYPT));
236 if (EVP_CipherInit(&cc->evp, type, NULL, (u_char *)iv,
237 (encrypt == CIPHER_ENCRYPT)) == 0)
238 fatal("cipher_init: EVP_CipherInit failed for %s",
240 klen = EVP_CIPHER_CTX_key_length(&cc->evp);
241 if (klen > 0 && keylen != klen) {
242 debug2("cipher_init: set keylen (%d -> %d)", klen, keylen);
243 if (EVP_CIPHER_CTX_set_key_length(&cc->evp, keylen) == 0)
244 fatal("cipher_init: set keylen failed (%d -> %d)",
247 if (EVP_CipherInit(&cc->evp, NULL, (u_char *)key, NULL, -1) == 0)
248 fatal("cipher_init: EVP_CipherInit: set key failed for %s",
254 cipher_crypt(CipherContext *cc, u_char *dest, const u_char *src, u_int len)
256 if (len % cc->cipher->block_size)
257 fatal("cipher_encrypt: bad plaintext length %d", len);
259 EVP_Cipher(&cc->evp, dest, (u_char *)src, len);
261 if (EVP_Cipher(&cc->evp, dest, (u_char *)src, len) == 0)
262 fatal("evp_crypt: EVP_Cipher failed");
267 cipher_cleanup(CipherContext *cc)
270 EVP_CIPHER_CTX_cleanup(&cc->evp);
272 if (EVP_CIPHER_CTX_cleanup(&cc->evp) == 0)
273 error("cipher_cleanup: EVP_CIPHER_CTX_cleanup failed");
278 * Selects the cipher, and keys if by computing the MD5 checksum of the
279 * passphrase and using the resulting 16 bytes as the key.
283 cipher_set_key_string(CipherContext *cc, Cipher *cipher,
284 const char *passphrase, int encrypt)
290 MD5_Update(&md, (const u_char *)passphrase, strlen(passphrase));
291 MD5_Final(digest, &md);
293 cipher_init(cc, cipher, digest, 16, NULL, 0, encrypt);
295 memset(digest, 0, sizeof(digest));
296 memset(&md, 0, sizeof(md));
299 /* Implementations for other non-EVP ciphers */
302 * This is used by SSH1:
304 * What kind of triple DES are these 2 routines?
306 * Why is there a redundant initialization vector?
308 * If only iv3 was used, then, this would till effect have been
309 * outer-cbc. However, there is also a private iv1 == iv2 which
310 * perhaps makes differential analysis easier. On the other hand, the
311 * private iv1 probably makes the CRC-32 attack ineffective. This is a
312 * result of that there is no longer any known iv1 to use when
313 * choosing the X block.
317 EVP_CIPHER_CTX k1, k2, k3;
321 ssh1_3des_init(EVP_CIPHER_CTX *ctx, const u_char *key, const u_char *iv,
324 struct ssh1_3des_ctx *c;
325 u_char *k1, *k2, *k3;
327 if ((c = EVP_CIPHER_CTX_get_app_data(ctx)) == NULL) {
328 c = xmalloc(sizeof(*c));
329 EVP_CIPHER_CTX_set_app_data(ctx, c);
335 k1 = k2 = k3 = (u_char *) key;
337 if (EVP_CIPHER_CTX_key_length(ctx) >= 16+8) {
343 EVP_CIPHER_CTX_init(&c->k1);
344 EVP_CIPHER_CTX_init(&c->k2);
345 EVP_CIPHER_CTX_init(&c->k3);
347 EVP_CipherInit(&c->k1, EVP_des_cbc(), k1, NULL, enc);
348 EVP_CipherInit(&c->k2, EVP_des_cbc(), k2, NULL, !enc);
349 EVP_CipherInit(&c->k3, EVP_des_cbc(), k3, NULL, enc);
351 if (EVP_CipherInit(&c->k1, EVP_des_cbc(), k1, NULL, enc) == 0 ||
352 EVP_CipherInit(&c->k2, EVP_des_cbc(), k2, NULL, !enc) == 0 ||
353 EVP_CipherInit(&c->k3, EVP_des_cbc(), k3, NULL, enc) == 0) {
354 memset(c, 0, sizeof(*c));
356 EVP_CIPHER_CTX_set_app_data(ctx, NULL);
364 ssh1_3des_cbc(EVP_CIPHER_CTX *ctx, u_char *dest, const u_char *src, u_int len)
366 struct ssh1_3des_ctx *c;
368 if ((c = EVP_CIPHER_CTX_get_app_data(ctx)) == NULL) {
369 error("ssh1_3des_cbc: no context");
373 EVP_Cipher(&c->k1, dest, (u_char *)src, len);
374 EVP_Cipher(&c->k2, dest, dest, len);
375 EVP_Cipher(&c->k3, dest, dest, len);
377 if (EVP_Cipher(&c->k1, dest, (u_char *)src, len) == 0 ||
378 EVP_Cipher(&c->k2, dest, dest, len) == 0 ||
379 EVP_Cipher(&c->k3, dest, dest, len) == 0)
386 ssh1_3des_cleanup(EVP_CIPHER_CTX *ctx)
388 struct ssh1_3des_ctx *c;
390 if ((c = EVP_CIPHER_CTX_get_app_data(ctx)) != NULL) {
391 memset(c, 0, sizeof(*c));
393 EVP_CIPHER_CTX_set_app_data(ctx, NULL);
399 ssh1_3des_iv(EVP_CIPHER_CTX *evp, int doset, u_char *iv, int len)
401 struct ssh1_3des_ctx *c;
404 fatal("%s: bad 3des iv length: %d", __func__, len);
405 if ((c = EVP_CIPHER_CTX_get_app_data(evp)) == NULL)
406 fatal("%s: no 3des context", __func__);
408 debug3("%s: Installed 3DES IV", __func__);
409 memcpy(c->k1.iv, iv, 8);
410 memcpy(c->k2.iv, iv + 8, 8);
411 memcpy(c->k3.iv, iv + 16, 8);
413 debug3("%s: Copying 3DES IV", __func__);
414 memcpy(iv, c->k1.iv, 8);
415 memcpy(iv + 8, c->k2.iv, 8);
416 memcpy(iv + 16, c->k3.iv, 8);
420 static const EVP_CIPHER *
423 static EVP_CIPHER ssh1_3des;
425 memset(&ssh1_3des, 0, sizeof(EVP_CIPHER));
426 ssh1_3des.nid = NID_undef;
427 ssh1_3des.block_size = 8;
428 ssh1_3des.iv_len = 0;
429 ssh1_3des.key_len = 16;
430 ssh1_3des.init = ssh1_3des_init;
431 ssh1_3des.cleanup = ssh1_3des_cleanup;
432 ssh1_3des.do_cipher = ssh1_3des_cbc;
434 ssh1_3des.flags = EVP_CIPH_CBC_MODE | EVP_CIPH_VARIABLE_LENGTH;
440 * SSH1 uses a variation on Blowfish, all bytes must be swapped before
441 * and after encryption/decryption. Thus the swap_bytes stuff (yuk).
444 swap_bytes(const u_char *src, u_char *dst, int n)
448 /* Process 4 bytes every lap. */
449 for (n = n / 4; n > 0; n--) {
463 static void bf_ssh1_init (EVP_CIPHER_CTX * ctx, const unsigned char *key,
464 const unsigned char *iv, int enc)
467 memcpy (&(ctx->oiv[0]), iv, 8);
468 memcpy (&(ctx->iv[0]), &(ctx->oiv[0]), 8);
470 BF_set_key (&(ctx->c.bf_ks), EVP_CIPHER_CTX_key_length (ctx),
474 static int (*orig_bf)(EVP_CIPHER_CTX *, u_char *, const u_char *, u_int) = NULL;
477 bf_ssh1_cipher(EVP_CIPHER_CTX *ctx, u_char *out, const u_char *in, u_int len)
481 swap_bytes(in, out, len);
482 ret = (*orig_bf)(ctx, out, out, len);
483 swap_bytes(out, out, len);
487 static const EVP_CIPHER *
490 static EVP_CIPHER ssh1_bf;
492 memcpy(&ssh1_bf, EVP_bf_cbc(), sizeof(EVP_CIPHER));
493 orig_bf = ssh1_bf.do_cipher;
494 ssh1_bf.nid = NID_undef;
496 ssh1_bf.init = bf_ssh1_init;
498 ssh1_bf.do_cipher = bf_ssh1_cipher;
499 ssh1_bf.key_len = 32;
503 #if OPENSSL_VERSION_NUMBER < 0x00907000L
505 #define RIJNDAEL_BLOCKSIZE 16
506 struct ssh_rijndael_ctx
509 u_char r_iv[RIJNDAEL_BLOCKSIZE];
513 ssh_rijndael_init(EVP_CIPHER_CTX *ctx, const u_char *key, const u_char *iv,
516 struct ssh_rijndael_ctx *c;
518 if ((c = EVP_CIPHER_CTX_get_app_data(ctx)) == NULL) {
519 c = xmalloc(sizeof(*c));
520 EVP_CIPHER_CTX_set_app_data(ctx, c);
525 rijndael_set_key(&c->r_ctx, (u_char *)key,
526 8*EVP_CIPHER_CTX_key_length(ctx), enc);
529 memcpy(c->r_iv, iv, RIJNDAEL_BLOCKSIZE);
534 ssh_rijndael_cbc(EVP_CIPHER_CTX *ctx, u_char *dest, const u_char *src,
537 struct ssh_rijndael_ctx *c;
538 u_char buf[RIJNDAEL_BLOCKSIZE];
539 u_char *cprev, *cnow, *plain, *ivp;
540 int i, j, blocks = len / RIJNDAEL_BLOCKSIZE;
544 if (len % RIJNDAEL_BLOCKSIZE)
545 fatal("ssh_rijndael_cbc: bad len %d", len);
546 if ((c = EVP_CIPHER_CTX_get_app_data(ctx)) == NULL) {
547 error("ssh_rijndael_cbc: no context");
552 plain = (u_char *)src;
554 for (i = 0; i < blocks; i++, plain+=RIJNDAEL_BLOCKSIZE,
555 cnow+=RIJNDAEL_BLOCKSIZE) {
556 for (j = 0; j < RIJNDAEL_BLOCKSIZE; j++)
557 buf[j] = plain[j] ^ cprev[j];
558 rijndael_encrypt(&c->r_ctx, buf, cnow);
561 memcpy(c->r_iv, cprev, RIJNDAEL_BLOCKSIZE);
563 cnow = (u_char *) (src+len-RIJNDAEL_BLOCKSIZE);
564 plain = dest+len-RIJNDAEL_BLOCKSIZE;
566 memcpy(buf, cnow, RIJNDAEL_BLOCKSIZE);
567 for (i = blocks; i > 0; i--, cnow-=RIJNDAEL_BLOCKSIZE,
568 plain-=RIJNDAEL_BLOCKSIZE) {
569 rijndael_decrypt(&c->r_ctx, cnow, plain);
570 ivp = (i == 1) ? c->r_iv : cnow-RIJNDAEL_BLOCKSIZE;
571 for (j = 0; j < RIJNDAEL_BLOCKSIZE; j++)
574 memcpy(c->r_iv, buf, RIJNDAEL_BLOCKSIZE);
580 ssh_rijndael_cleanup(EVP_CIPHER_CTX *ctx)
582 struct ssh_rijndael_ctx *c;
584 if ((c = EVP_CIPHER_CTX_get_app_data(ctx)) != NULL) {
585 memset(c, 0, sizeof(*c));
587 EVP_CIPHER_CTX_set_app_data(ctx, NULL);
593 ssh_rijndael_iv(EVP_CIPHER_CTX *evp, int doset, u_char * iv, u_int len)
595 struct ssh_rijndael_ctx *c;
597 if ((c = EVP_CIPHER_CTX_get_app_data(evp)) == NULL)
598 fatal("ssh_rijndael_iv: no context");
600 memcpy(c->r_iv, iv, len);
602 memcpy(iv, c->r_iv, len);
605 static const EVP_CIPHER *
608 static EVP_CIPHER rijndal_cbc;
610 memset(&rijndal_cbc, 0, sizeof(EVP_CIPHER));
611 rijndal_cbc.nid = NID_undef;
612 rijndal_cbc.block_size = RIJNDAEL_BLOCKSIZE;
613 rijndal_cbc.iv_len = RIJNDAEL_BLOCKSIZE;
614 rijndal_cbc.key_len = 16;
615 rijndal_cbc.init = ssh_rijndael_init;
616 rijndal_cbc.cleanup = ssh_rijndael_cleanup;
617 rijndal_cbc.do_cipher = ssh_rijndael_cbc;
619 rijndal_cbc.flags = EVP_CIPH_CBC_MODE | EVP_CIPH_VARIABLE_LENGTH |
620 EVP_CIPH_ALWAYS_CALL_INIT | EVP_CIPH_CUSTOM_IV;
622 return (&rijndal_cbc);
627 * Exports an IV from the CipherContext required to export the key
628 * state back from the unprivileged child to the privileged parent
633 cipher_get_keyiv_len(CipherContext *cc)
635 Cipher *c = cc->cipher;
638 if (c->number == SSH_CIPHER_3DES)
641 ivlen = EVP_CIPHER_CTX_iv_length(&cc->evp);
646 cipher_get_keyiv(CipherContext *cc, u_char *iv, u_int len)
648 Cipher *c = cc->cipher;
652 case SSH_CIPHER_SSH2:
654 case SSH_CIPHER_BLOWFISH:
655 evplen = EVP_CIPHER_CTX_iv_length(&cc->evp);
659 fatal("%s: wrong iv length %d != %d", __func__,
661 #if OPENSSL_VERSION_NUMBER < 0x00907000L
662 if (c->evptype == evp_rijndael)
663 ssh_rijndael_iv(&cc->evp, 0, iv, len);
666 memcpy(iv, cc->evp.iv, len);
668 case SSH_CIPHER_3DES:
669 ssh1_3des_iv(&cc->evp, 0, iv, 24);
672 fatal("%s: bad cipher %d", __func__, c->number);
677 cipher_set_keyiv(CipherContext *cc, u_char *iv)
679 Cipher *c = cc->cipher;
683 case SSH_CIPHER_SSH2:
685 case SSH_CIPHER_BLOWFISH:
686 evplen = EVP_CIPHER_CTX_iv_length(&cc->evp);
689 #if OPENSSL_VERSION_NUMBER < 0x00907000L
690 if (c->evptype == evp_rijndael)
691 ssh_rijndael_iv(&cc->evp, 1, iv, evplen);
694 memcpy(cc->evp.iv, iv, evplen);
696 case SSH_CIPHER_3DES:
697 ssh1_3des_iv(&cc->evp, 1, iv, 24);
700 fatal("%s: bad cipher %d", __func__, c->number);
704 #if OPENSSL_VERSION_NUMBER < 0x00907000L
705 #define EVP_X_STATE(evp) &(evp).c
706 #define EVP_X_STATE_LEN(evp) sizeof((evp).c)
708 #define EVP_X_STATE(evp) (evp).cipher_data
709 #define EVP_X_STATE_LEN(evp) (evp).cipher->ctx_size
713 cipher_get_keycontext(CipherContext *cc, u_char *dat)
715 Cipher *c = cc->cipher;
718 if (c->evptype == EVP_rc4) {
719 plen = EVP_X_STATE_LEN(cc->evp);
722 memcpy(dat, EVP_X_STATE(cc->evp), plen);
728 cipher_set_keycontext(CipherContext *cc, u_char *dat)
730 Cipher *c = cc->cipher;
733 if (c->evptype == EVP_rc4) {
734 plen = EVP_X_STATE_LEN(cc->evp);
735 memcpy(EVP_X_STATE(cc->evp), dat, plen);