2 * Author: Tatu Ylonen <ylo@cs.hut.fi>
3 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 * This file contains functions for reading and writing identity files, and
6 * for reading the passphrase from the user.
8 * As far as I am concerned, the code I have written for this software
9 * can be used freely for any purpose. Any derived versions of this
10 * software must be clearly marked as such, and if the derived work is
11 * incompatible with the protocol description in the RFC file, it must be
12 * called by a name other than "ssh" or "Secure Shell".
15 * Copyright (c) 2000 Markus Friedl. All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
20 * 1. Redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution.
26 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 RCSID("$OpenBSD: authfile.c,v 1.60 2004/12/11 01:48:56 dtucker Exp $");
41 #include <openssl/err.h>
42 #include <openssl/evp.h>
43 #include <openssl/pem.h>
56 /* Version identification string for SSH v1 identity files. */
57 static const char authfile_id_string
[] =
58 "SSH PRIVATE KEY FILE FORMAT 1.1\n";
61 * Saves the authentication (private) key in a file, encrypting it with
62 * passphrase. The identification of the file (lowest 64 bits of n) will
63 * precede the key to provide identification of the key without needing a
68 key_save_private_rsa1(Key
*key
, const char *filename
, const char *passphrase
,
71 Buffer buffer
, encrypted
;
73 int fd
, i
, cipher_num
;
74 CipherContext ciphercontext
;
79 * If the passphrase is empty, use SSH_CIPHER_NONE to ease converting
80 * to another cipher; otherwise use SSH_AUTHFILE_CIPHER.
82 cipher_num
= (strcmp(passphrase
, "") == 0) ?
83 SSH_CIPHER_NONE
: SSH_AUTHFILE_CIPHER
;
84 if ((cipher
= cipher_by_number(cipher_num
)) == NULL
)
85 fatal("save_private_key_rsa: bad cipher");
87 /* This buffer is used to built the secret part of the private key. */
90 /* Put checkbytes for checking passphrase validity. */
93 buf
[1] = (rnd
>> 8) & 0xff;
96 buffer_append(&buffer
, buf
, 4);
99 * Store the private key (n and e will not be stored because they
100 * will be stored in plain text, and storing them also in encrypted
101 * format would just give known plaintext).
103 buffer_put_bignum(&buffer
, key
->rsa
->d
);
104 buffer_put_bignum(&buffer
, key
->rsa
->iqmp
);
105 buffer_put_bignum(&buffer
, key
->rsa
->q
); /* reverse from SSL p */
106 buffer_put_bignum(&buffer
, key
->rsa
->p
); /* reverse from SSL q */
108 /* Pad the part to be encrypted until its size is a multiple of 8. */
109 while (buffer_len(&buffer
) % 8 != 0)
110 buffer_put_char(&buffer
, 0);
112 /* This buffer will be used to contain the data in the file. */
113 buffer_init(&encrypted
);
115 /* First store keyfile id string. */
116 for (i
= 0; authfile_id_string
[i
]; i
++)
117 buffer_put_char(&encrypted
, authfile_id_string
[i
]);
118 buffer_put_char(&encrypted
, 0);
120 /* Store cipher type. */
121 buffer_put_char(&encrypted
, cipher_num
);
122 buffer_put_int(&encrypted
, 0); /* For future extension */
124 /* Store public key. This will be in plain text. */
125 buffer_put_int(&encrypted
, BN_num_bits(key
->rsa
->n
));
126 buffer_put_bignum(&encrypted
, key
->rsa
->n
);
127 buffer_put_bignum(&encrypted
, key
->rsa
->e
);
128 buffer_put_cstring(&encrypted
, comment
);
130 /* Allocate space for the private part of the key in the buffer. */
131 cp
= buffer_append_space(&encrypted
, buffer_len(&buffer
));
133 cipher_set_key_string(&ciphercontext
, cipher
, passphrase
,
135 cipher_crypt(&ciphercontext
, cp
,
136 buffer_ptr(&buffer
), buffer_len(&buffer
));
137 cipher_cleanup(&ciphercontext
);
138 memset(&ciphercontext
, 0, sizeof(ciphercontext
));
140 /* Destroy temporary data. */
141 memset(buf
, 0, sizeof(buf
));
142 buffer_free(&buffer
);
144 fd
= open(filename
, O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
146 error("open %s failed: %s.", filename
, strerror(errno
));
147 buffer_free(&encrypted
);
150 if (write(fd
, buffer_ptr(&encrypted
), buffer_len(&encrypted
)) !=
151 buffer_len(&encrypted
)) {
152 error("write to key file %s failed: %s", filename
,
154 buffer_free(&encrypted
);
160 buffer_free(&encrypted
);
164 /* save SSH v2 key in OpenSSL PEM format */
166 key_save_private_pem(Key
*key
, const char *filename
, const char *_passphrase
,
172 int len
= strlen(_passphrase
);
173 u_char
*passphrase
= (len
> 0) ? (u_char
*)_passphrase
: NULL
;
174 const EVP_CIPHER
*cipher
= (len
> 0) ? EVP_des_ede3_cbc() : NULL
;
176 if (len
> 0 && len
<= 4) {
177 error("passphrase too short: have %d bytes, need > 4", len
);
180 fd
= open(filename
, O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
182 error("open %s failed: %s.", filename
, strerror(errno
));
185 fp
= fdopen(fd
, "w");
187 error("fdopen %s failed: %s.", filename
, strerror(errno
));
193 success
= PEM_write_DSAPrivateKey(fp
, key
->dsa
,
194 cipher
, passphrase
, len
, NULL
, NULL
);
197 success
= PEM_write_RSAPrivateKey(fp
, key
->rsa
,
198 cipher
, passphrase
, len
, NULL
, NULL
);
206 key_save_private(Key
*key
, const char *filename
, const char *passphrase
,
211 return key_save_private_rsa1(key
, filename
, passphrase
,
216 return key_save_private_pem(key
, filename
, passphrase
,
222 error("key_save_private: cannot save key type %d", key
->type
);
227 * Loads the public part of the ssh v1 key file. Returns NULL if an error was
228 * encountered (the file does not exist or is not readable), and the key
233 key_load_public_rsa1(int fd
, const char *filename
, char **commentp
)
242 if (fstat(fd
, &st
) < 0) {
243 error("fstat for key file %.200s failed: %.100s",
244 filename
, strerror(errno
));
247 if (st
.st_size
> 1*1024*1024) {
248 error("key file %.200s too large", filename
);
251 len
= (size_t)st
.st_size
; /* truncated */
253 buffer_init(&buffer
);
254 cp
= buffer_append_space(&buffer
, len
);
256 if (read(fd
, cp
, (size_t) len
) != (size_t) len
) {
257 debug("Read from key file %.200s failed: %.100s", filename
,
259 buffer_free(&buffer
);
263 /* Check that it is at least big enough to contain the ID string. */
264 if (len
< sizeof(authfile_id_string
)) {
265 debug3("Not a RSA1 key file %.200s.", filename
);
266 buffer_free(&buffer
);
270 * Make sure it begins with the id string. Consume the id string
273 for (i
= 0; i
< sizeof(authfile_id_string
); i
++)
274 if (buffer_get_char(&buffer
) != authfile_id_string
[i
]) {
275 debug3("Not a RSA1 key file %.200s.", filename
);
276 buffer_free(&buffer
);
279 /* Skip cipher type and reserved data. */
280 (void) buffer_get_char(&buffer
); /* cipher type */
281 (void) buffer_get_int(&buffer
); /* reserved */
283 /* Read the public key from the buffer. */
284 (void) buffer_get_int(&buffer
);
285 pub
= key_new(KEY_RSA1
);
286 buffer_get_bignum(&buffer
, pub
->rsa
->n
);
287 buffer_get_bignum(&buffer
, pub
->rsa
->e
);
289 *commentp
= buffer_get_string(&buffer
, NULL
);
290 /* The encrypted private part is not parsed by this function. */
292 buffer_free(&buffer
);
296 /* load public key from private-key file, works only for SSH v1 */
298 key_load_public_type(int type
, const char *filename
, char **commentp
)
303 if (type
== KEY_RSA1
) {
304 fd
= open(filename
, O_RDONLY
);
307 pub
= key_load_public_rsa1(fd
, filename
, commentp
);
315 * Loads the private key from the file. Returns 0 if an error is encountered
316 * (file does not exist or is not readable, or passphrase is bad). This
317 * initializes the private key.
318 * Assumes we are called under uid of the owner of the file.
322 key_load_private_rsa1(int fd
, const char *filename
, const char *passphrase
,
325 int i
, check1
, check2
, cipher_type
;
327 Buffer buffer
, decrypted
;
329 CipherContext ciphercontext
;
334 if (fstat(fd
, &st
) < 0) {
335 error("fstat for key file %.200s failed: %.100s",
336 filename
, strerror(errno
));
340 if (st
.st_size
> 1*1024*1024) {
341 error("key file %.200s too large", filename
);
345 len
= (size_t)st
.st_size
; /* truncated */
347 buffer_init(&buffer
);
348 cp
= buffer_append_space(&buffer
, len
);
350 if (read(fd
, cp
, (size_t) len
) != (size_t) len
) {
351 debug("Read from key file %.200s failed: %.100s", filename
,
353 buffer_free(&buffer
);
358 /* Check that it is at least big enough to contain the ID string. */
359 if (len
< sizeof(authfile_id_string
)) {
360 debug3("Not a RSA1 key file %.200s.", filename
);
361 buffer_free(&buffer
);
366 * Make sure it begins with the id string. Consume the id string
369 for (i
= 0; i
< sizeof(authfile_id_string
); i
++)
370 if (buffer_get_char(&buffer
) != authfile_id_string
[i
]) {
371 debug3("Not a RSA1 key file %.200s.", filename
);
372 buffer_free(&buffer
);
377 /* Read cipher type. */
378 cipher_type
= buffer_get_char(&buffer
);
379 (void) buffer_get_int(&buffer
); /* Reserved data. */
381 /* Read the public key from the buffer. */
382 (void) buffer_get_int(&buffer
);
383 prv
= key_new_private(KEY_RSA1
);
385 buffer_get_bignum(&buffer
, prv
->rsa
->n
);
386 buffer_get_bignum(&buffer
, prv
->rsa
->e
);
388 *commentp
= buffer_get_string(&buffer
, NULL
);
390 xfree(buffer_get_string(&buffer
, NULL
));
392 /* Check that it is a supported cipher. */
393 cipher
= cipher_by_number(cipher_type
);
394 if (cipher
== NULL
) {
395 debug("Unsupported cipher %d used in key file %.200s.",
396 cipher_type
, filename
);
397 buffer_free(&buffer
);
400 /* Initialize space for decrypted data. */
401 buffer_init(&decrypted
);
402 cp
= buffer_append_space(&decrypted
, buffer_len(&buffer
));
404 /* Rest of the buffer is encrypted. Decrypt it using the passphrase. */
405 cipher_set_key_string(&ciphercontext
, cipher
, passphrase
,
407 cipher_crypt(&ciphercontext
, cp
,
408 buffer_ptr(&buffer
), buffer_len(&buffer
));
409 cipher_cleanup(&ciphercontext
);
410 memset(&ciphercontext
, 0, sizeof(ciphercontext
));
411 buffer_free(&buffer
);
413 check1
= buffer_get_char(&decrypted
);
414 check2
= buffer_get_char(&decrypted
);
415 if (check1
!= buffer_get_char(&decrypted
) ||
416 check2
!= buffer_get_char(&decrypted
)) {
417 if (strcmp(passphrase
, "") != 0)
418 debug("Bad passphrase supplied for key file %.200s.",
420 /* Bad passphrase. */
421 buffer_free(&decrypted
);
424 /* Read the rest of the private key. */
425 buffer_get_bignum(&decrypted
, prv
->rsa
->d
);
426 buffer_get_bignum(&decrypted
, prv
->rsa
->iqmp
); /* u */
427 /* in SSL and SSH v1 p and q are exchanged */
428 buffer_get_bignum(&decrypted
, prv
->rsa
->q
); /* p */
429 buffer_get_bignum(&decrypted
, prv
->rsa
->p
); /* q */
431 /* calculate p-1 and q-1 */
432 rsa_generate_additional_parameters(prv
->rsa
);
434 buffer_free(&decrypted
);
436 /* enable blinding */
437 if (RSA_blinding_on(prv
->rsa
, NULL
) != 1) {
438 error("key_load_private_rsa1: RSA_blinding_on failed");
453 key_load_private_pem(int fd
, int type
, const char *passphrase
,
459 char *name
= "<no key>";
461 fp
= fdopen(fd
, "r");
463 error("fdopen failed: %s", strerror(errno
));
467 pk
= PEM_read_PrivateKey(fp
, NULL
, NULL
, (char *)passphrase
);
469 debug("PEM_read_PrivateKey failed");
470 (void)ERR_get_error();
471 } else if (pk
->type
== EVP_PKEY_RSA
&&
472 (type
== KEY_UNSPEC
||type
==KEY_RSA
)) {
473 prv
= key_new(KEY_UNSPEC
);
474 prv
->rsa
= EVP_PKEY_get1_RSA(pk
);
476 name
= "rsa w/o comment";
478 RSA_print_fp(stderr
, prv
->rsa
, 8);
480 if (RSA_blinding_on(prv
->rsa
, NULL
) != 1) {
481 error("key_load_private_pem: RSA_blinding_on failed");
485 } else if (pk
->type
== EVP_PKEY_DSA
&&
486 (type
== KEY_UNSPEC
||type
==KEY_DSA
)) {
487 prv
= key_new(KEY_UNSPEC
);
488 prv
->dsa
= EVP_PKEY_get1_DSA(pk
);
490 name
= "dsa w/o comment";
492 DSA_print_fp(stderr
, prv
->dsa
, 8);
495 error("PEM_read_PrivateKey: mismatch or "
496 "unknown EVP_PKEY save_type %d", pk
->save_type
);
501 if (prv
!= NULL
&& commentp
)
502 *commentp
= xstrdup(name
);
503 debug("read PEM private key done: type %s",
504 prv
? key_type(prv
) : "<unknown>");
509 key_perm_ok(int fd
, const char *filename
)
513 if (fstat(fd
, &st
) < 0)
516 * if a key owned by the user is accessed, then we check the
517 * permissions of the file. if the key owned by a different user,
518 * then we don't care.
521 if (check_ntsec(filename
))
523 if ((st
.st_uid
== getuid()) && (st
.st_mode
& 077) != 0) {
524 error("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
525 error("@ WARNING: UNPROTECTED PRIVATE KEY FILE! @");
526 error("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
527 error("Permissions 0%3.3o for '%s' are too open.",
528 (u_int
)st
.st_mode
& 0777, filename
);
529 error("It is recommended that your private key files are NOT accessible by others.");
530 error("This private key will be ignored.");
537 key_load_private_type(int type
, const char *filename
, const char *passphrase
,
542 fd
= open(filename
, O_RDONLY
);
545 if (!key_perm_ok(fd
, filename
)) {
546 error("bad permissions: ignore key: %s", filename
);
552 return key_load_private_rsa1(fd
, filename
, passphrase
,
559 return key_load_private_pem(fd
, type
, passphrase
, commentp
);
570 key_load_private(const char *filename
, const char *passphrase
,
576 fd
= open(filename
, O_RDONLY
);
579 if (!key_perm_ok(fd
, filename
)) {
580 error("bad permissions: ignore key: %s", filename
);
584 pub
= key_load_public_rsa1(fd
, filename
, commentp
);
585 lseek(fd
, (off_t
) 0, SEEK_SET
); /* rewind */
588 prv
= key_load_private_pem(fd
, KEY_UNSPEC
, passphrase
, NULL
);
589 /* use the filename as a comment for PEM */
591 *commentp
= xstrdup(filename
);
593 /* it's a SSH v1 key if the public key part is readable */
596 prv
= key_load_private_rsa1(fd
, filename
, passphrase
, NULL
);
602 key_try_load_public(Key
*k
, const char *filename
, char **commentp
)
605 char line
[SSH_MAX_PUBKEY_BYTES
];
609 f
= fopen(filename
, "r");
611 while (read_keyfile_line(f
, filename
, line
, sizeof(line
),
620 /* Skip leading whitespace. */
621 for (; *cp
&& (*cp
== ' ' || *cp
== '\t'); cp
++)
624 if (key_read(k
, &cp
) == 1) {
626 *commentp
=xstrdup(filename
);
637 /* load public key from ssh v1 private or any pubkey file */
639 key_load_public(const char *filename
, char **commentp
)
642 char file
[MAXPATHLEN
];
644 /* try rsa1 private key */
645 pub
= key_load_public_type(KEY_RSA1
, filename
, commentp
);
649 /* try rsa1 public key */
650 pub
= key_new(KEY_RSA1
);
651 if (key_try_load_public(pub
, filename
, commentp
) == 1)
655 /* try ssh2 public key */
656 pub
= key_new(KEY_UNSPEC
);
657 if (key_try_load_public(pub
, filename
, commentp
) == 1)
659 if ((strlcpy(file
, filename
, sizeof file
) < sizeof(file
)) &&
660 (strlcat(file
, ".pub", sizeof file
) < sizeof(file
)) &&
661 (key_try_load_public(pub
, file
, commentp
) == 1))