1 /* $OpenBSD: authfile.c,v 1.77 2009/10/22 22:26:13 djm Exp $ */
3 * Author: Tatu Ylonen <ylo@cs.hut.fi>
4 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * This file contains functions for reading and writing identity files, and
7 * for reading the passphrase from the user.
9 * As far as I am concerned, the code I have written for this software
10 * can be used freely for any purpose. Any derived versions of this
11 * software must be clearly marked as such, and if the derived work is
12 * incompatible with the protocol description in the RFC file, it must be
13 * called by a name other than "ssh" or "Secure Shell".
16 * Copyright (c) 2000 Markus Friedl. All rights reserved.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in the
25 * documentation and/or other materials provided with the distribution.
27 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
28 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
29 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
31 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
32 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
36 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 #include <sys/types.h>
43 #include <sys/param.h>
46 #include <openssl/err.h>
47 #include <openssl/evp.h>
48 #include <openssl/pem.h>
50 /* compatibility with old or broken OpenSSL versions */
51 #include "openbsd-compat/openssl-compat.h"
72 /* Version identification string for SSH v1 identity files. */
73 static const char authfile_id_string
[] =
74 "SSH PRIVATE KEY FILE FORMAT 1.1\n";
77 * Saves the authentication (private) key in a file, encrypting it with
78 * passphrase. The identification of the file (lowest 64 bits of n) will
79 * precede the key to provide identification of the key without needing a
84 key_save_private_rsa1(Key
*key
, const char *filename
, const char *passphrase
,
87 Buffer buffer
, encrypted
;
89 int fd
, i
, cipher_num
;
90 CipherContext ciphercontext
;
95 * If the passphrase is empty, use SSH_CIPHER_NONE to ease converting
96 * to another cipher; otherwise use SSH_AUTHFILE_CIPHER.
98 cipher_num
= (strcmp(passphrase
, "") == 0) ?
99 SSH_CIPHER_NONE
: SSH_AUTHFILE_CIPHER
;
100 if ((cipher
= cipher_by_number(cipher_num
)) == NULL
)
101 fatal("save_private_key_rsa: bad cipher");
103 /* This buffer is used to built the secret part of the private key. */
104 buffer_init(&buffer
);
106 /* Put checkbytes for checking passphrase validity. */
109 buf
[1] = (rnd
>> 8) & 0xff;
112 buffer_append(&buffer
, buf
, 4);
115 * Store the private key (n and e will not be stored because they
116 * will be stored in plain text, and storing them also in encrypted
117 * format would just give known plaintext).
119 buffer_put_bignum(&buffer
, key
->rsa
->d
);
120 buffer_put_bignum(&buffer
, key
->rsa
->iqmp
);
121 buffer_put_bignum(&buffer
, key
->rsa
->q
); /* reverse from SSL p */
122 buffer_put_bignum(&buffer
, key
->rsa
->p
); /* reverse from SSL q */
124 /* Pad the part to be encrypted until its size is a multiple of 8. */
125 while (buffer_len(&buffer
) % 8 != 0)
126 buffer_put_char(&buffer
, 0);
128 /* This buffer will be used to contain the data in the file. */
129 buffer_init(&encrypted
);
131 /* First store keyfile id string. */
132 for (i
= 0; authfile_id_string
[i
]; i
++)
133 buffer_put_char(&encrypted
, authfile_id_string
[i
]);
134 buffer_put_char(&encrypted
, 0);
136 /* Store cipher type. */
137 buffer_put_char(&encrypted
, cipher_num
);
138 buffer_put_int(&encrypted
, 0); /* For future extension */
140 /* Store public key. This will be in plain text. */
141 buffer_put_int(&encrypted
, BN_num_bits(key
->rsa
->n
));
142 buffer_put_bignum(&encrypted
, key
->rsa
->n
);
143 buffer_put_bignum(&encrypted
, key
->rsa
->e
);
144 buffer_put_cstring(&encrypted
, comment
);
146 /* Allocate space for the private part of the key in the buffer. */
147 cp
= buffer_append_space(&encrypted
, buffer_len(&buffer
));
149 cipher_set_key_string(&ciphercontext
, cipher
, passphrase
,
151 cipher_crypt(&ciphercontext
, cp
,
152 buffer_ptr(&buffer
), buffer_len(&buffer
));
153 cipher_cleanup(&ciphercontext
);
154 memset(&ciphercontext
, 0, sizeof(ciphercontext
));
156 /* Destroy temporary data. */
157 memset(buf
, 0, sizeof(buf
));
158 buffer_free(&buffer
);
160 fd
= open(filename
, O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
162 error("open %s failed: %s.", filename
, strerror(errno
));
163 buffer_free(&encrypted
);
166 if (atomicio(vwrite
, fd
, buffer_ptr(&encrypted
),
167 buffer_len(&encrypted
)) != buffer_len(&encrypted
)) {
168 error("write to key file %s failed: %s", filename
,
170 buffer_free(&encrypted
);
176 buffer_free(&encrypted
);
180 /* save SSH v2 key in OpenSSL PEM format */
182 key_save_private_pem(Key
*key
, const char *filename
, const char *_passphrase
,
188 int len
= strlen(_passphrase
);
189 u_char
*passphrase
= (len
> 0) ? (u_char
*)_passphrase
: NULL
;
190 const EVP_CIPHER
*cipher
= (len
> 0) ? EVP_aes_128_cbc() : NULL
;
192 if (len
> 0 && len
<= 4) {
193 error("passphrase too short: have %d bytes, need > 4", len
);
196 fd
= open(filename
, O_WRONLY
| O_CREAT
| O_TRUNC
, 0600);
198 error("open %s failed: %s.", filename
, strerror(errno
));
201 fp
= fdopen(fd
, "w");
203 error("fdopen %s failed: %s.", filename
, strerror(errno
));
209 success
= PEM_write_DSAPrivateKey(fp
, key
->dsa
,
210 cipher
, passphrase
, len
, NULL
, NULL
);
213 success
= PEM_write_RSAPrivateKey(fp
, key
->rsa
,
214 cipher
, passphrase
, len
, NULL
, NULL
);
222 key_save_private(Key
*key
, const char *filename
, const char *passphrase
,
227 return key_save_private_rsa1(key
, filename
, passphrase
,
231 return key_save_private_pem(key
, filename
, passphrase
,
236 error("key_save_private: cannot save key type %d", key
->type
);
241 * Loads the public part of the ssh v1 key file. Returns NULL if an error was
242 * encountered (the file does not exist or is not readable), and the key
247 key_load_public_rsa1(int fd
, const char *filename
, char **commentp
)
256 if (fstat(fd
, &st
) < 0) {
257 error("fstat for key file %.200s failed: %.100s",
258 filename
, strerror(errno
));
261 if (st
.st_size
> 1*1024*1024) {
262 error("key file %.200s too large", filename
);
265 len
= (size_t)st
.st_size
; /* truncated */
267 buffer_init(&buffer
);
268 cp
= buffer_append_space(&buffer
, len
);
270 if (atomicio(read
, fd
, cp
, len
) != len
) {
271 debug("Read from key file %.200s failed: %.100s", filename
,
273 buffer_free(&buffer
);
277 /* Check that it is at least big enough to contain the ID string. */
278 if (len
< sizeof(authfile_id_string
)) {
279 debug3("Not a RSA1 key file %.200s.", filename
);
280 buffer_free(&buffer
);
284 * Make sure it begins with the id string. Consume the id string
287 for (i
= 0; i
< sizeof(authfile_id_string
); i
++)
288 if (buffer_get_char(&buffer
) != authfile_id_string
[i
]) {
289 debug3("Not a RSA1 key file %.200s.", filename
);
290 buffer_free(&buffer
);
293 /* Skip cipher type and reserved data. */
294 (void) buffer_get_char(&buffer
); /* cipher type */
295 (void) buffer_get_int(&buffer
); /* reserved */
297 /* Read the public key from the buffer. */
298 (void) buffer_get_int(&buffer
);
299 pub
= key_new(KEY_RSA1
);
300 buffer_get_bignum(&buffer
, pub
->rsa
->n
);
301 buffer_get_bignum(&buffer
, pub
->rsa
->e
);
303 *commentp
= buffer_get_string(&buffer
, NULL
);
304 /* The encrypted private part is not parsed by this function. */
306 buffer_free(&buffer
);
310 /* load public key from private-key file, works only for SSH v1 */
312 key_load_public_type(int type
, const char *filename
, char **commentp
)
317 if (type
== KEY_RSA1
) {
318 fd
= open(filename
, O_RDONLY
);
321 pub
= key_load_public_rsa1(fd
, filename
, commentp
);
329 * Loads the private key from the file. Returns 0 if an error is encountered
330 * (file does not exist or is not readable, or passphrase is bad). This
331 * initializes the private key.
332 * Assumes we are called under uid of the owner of the file.
336 key_load_private_rsa1(int fd
, const char *filename
, const char *passphrase
,
340 int check1
, check2
, cipher_type
;
342 Buffer buffer
, decrypted
;
344 CipherContext ciphercontext
;
349 if (fstat(fd
, &st
) < 0) {
350 error("fstat for key file %.200s failed: %.100s",
351 filename
, strerror(errno
));
355 if (st
.st_size
> 1*1024*1024) {
356 error("key file %.200s too large", filename
);
360 len
= (size_t)st
.st_size
; /* truncated */
362 buffer_init(&buffer
);
363 cp
= buffer_append_space(&buffer
, len
);
365 if (atomicio(read
, fd
, cp
, len
) != len
) {
366 debug("Read from key file %.200s failed: %.100s", filename
,
368 buffer_free(&buffer
);
373 /* Check that it is at least big enough to contain the ID string. */
374 if (len
< sizeof(authfile_id_string
)) {
375 debug3("Not a RSA1 key file %.200s.", filename
);
376 buffer_free(&buffer
);
381 * Make sure it begins with the id string. Consume the id string
384 for (i
= 0; i
< sizeof(authfile_id_string
); i
++)
385 if (buffer_get_char(&buffer
) != authfile_id_string
[i
]) {
386 debug3("Not a RSA1 key file %.200s.", filename
);
387 buffer_free(&buffer
);
392 /* Read cipher type. */
393 cipher_type
= buffer_get_char(&buffer
);
394 (void) buffer_get_int(&buffer
); /* Reserved data. */
396 /* Read the public key from the buffer. */
397 (void) buffer_get_int(&buffer
);
398 prv
= key_new_private(KEY_RSA1
);
400 buffer_get_bignum(&buffer
, prv
->rsa
->n
);
401 buffer_get_bignum(&buffer
, prv
->rsa
->e
);
403 *commentp
= buffer_get_string(&buffer
, NULL
);
405 xfree(buffer_get_string(&buffer
, NULL
));
407 /* Check that it is a supported cipher. */
408 cipher
= cipher_by_number(cipher_type
);
409 if (cipher
== NULL
) {
410 debug("Unsupported cipher %d used in key file %.200s.",
411 cipher_type
, filename
);
412 buffer_free(&buffer
);
415 /* Initialize space for decrypted data. */
416 buffer_init(&decrypted
);
417 cp
= buffer_append_space(&decrypted
, buffer_len(&buffer
));
419 /* Rest of the buffer is encrypted. Decrypt it using the passphrase. */
420 cipher_set_key_string(&ciphercontext
, cipher
, passphrase
,
422 cipher_crypt(&ciphercontext
, cp
,
423 buffer_ptr(&buffer
), buffer_len(&buffer
));
424 cipher_cleanup(&ciphercontext
);
425 memset(&ciphercontext
, 0, sizeof(ciphercontext
));
426 buffer_free(&buffer
);
428 check1
= buffer_get_char(&decrypted
);
429 check2
= buffer_get_char(&decrypted
);
430 if (check1
!= buffer_get_char(&decrypted
) ||
431 check2
!= buffer_get_char(&decrypted
)) {
432 if (strcmp(passphrase
, "") != 0)
433 debug("Bad passphrase supplied for key file %.200s.",
435 /* Bad passphrase. */
436 buffer_free(&decrypted
);
439 /* Read the rest of the private key. */
440 buffer_get_bignum(&decrypted
, prv
->rsa
->d
);
441 buffer_get_bignum(&decrypted
, prv
->rsa
->iqmp
); /* u */
442 /* in SSL and SSH v1 p and q are exchanged */
443 buffer_get_bignum(&decrypted
, prv
->rsa
->q
); /* p */
444 buffer_get_bignum(&decrypted
, prv
->rsa
->p
); /* q */
446 /* calculate p-1 and q-1 */
447 rsa_generate_additional_parameters(prv
->rsa
);
449 buffer_free(&decrypted
);
451 /* enable blinding */
452 if (RSA_blinding_on(prv
->rsa
, NULL
) != 1) {
453 error("key_load_private_rsa1: RSA_blinding_on failed");
468 key_load_private_pem(int fd
, int type
, const char *passphrase
,
474 char *name
= "<no key>";
476 fp
= fdopen(fd
, "r");
478 error("fdopen failed: %s", strerror(errno
));
482 pk
= PEM_read_PrivateKey(fp
, NULL
, NULL
, (char *)passphrase
);
484 debug("PEM_read_PrivateKey failed");
485 (void)ERR_get_error();
486 } else if (pk
->type
== EVP_PKEY_RSA
&&
487 (type
== KEY_UNSPEC
||type
==KEY_RSA
)) {
488 prv
= key_new(KEY_UNSPEC
);
489 prv
->rsa
= EVP_PKEY_get1_RSA(pk
);
491 name
= "rsa w/o comment";
493 RSA_print_fp(stderr
, prv
->rsa
, 8);
495 if (RSA_blinding_on(prv
->rsa
, NULL
) != 1) {
496 error("key_load_private_pem: RSA_blinding_on failed");
500 } else if (pk
->type
== EVP_PKEY_DSA
&&
501 (type
== KEY_UNSPEC
||type
==KEY_DSA
)) {
502 prv
= key_new(KEY_UNSPEC
);
503 prv
->dsa
= EVP_PKEY_get1_DSA(pk
);
505 name
= "dsa w/o comment";
507 DSA_print_fp(stderr
, prv
->dsa
, 8);
510 error("PEM_read_PrivateKey: mismatch or "
511 "unknown EVP_PKEY save_type %d", pk
->save_type
);
516 if (prv
!= NULL
&& commentp
)
517 *commentp
= xstrdup(name
);
518 debug("read PEM private key done: type %s",
519 prv
? key_type(prv
) : "<unknown>");
524 key_perm_ok(int fd
, const char *filename
)
528 if (fstat(fd
, &st
) < 0)
531 * if a key owned by the user is accessed, then we check the
532 * permissions of the file. if the key owned by a different user,
533 * then we don't care.
536 if (check_ntsec(filename
))
538 if ((st
.st_uid
== getuid()) && (st
.st_mode
& 077) != 0) {
539 error("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
540 error("@ WARNING: UNPROTECTED PRIVATE KEY FILE! @");
541 error("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
542 error("Permissions 0%3.3o for '%s' are too open.",
543 (u_int
)st
.st_mode
& 0777, filename
);
544 error("It is recommended that your private key files are NOT accessible by others.");
545 error("This private key will be ignored.");
552 key_load_private_type(int type
, const char *filename
, const char *passphrase
,
553 char **commentp
, int *perm_ok
)
557 fd
= open(filename
, O_RDONLY
);
560 if (!key_perm_ok(fd
, filename
)) {
563 error("bad permissions: ignore key: %s", filename
);
571 return key_load_private_rsa1(fd
, filename
, passphrase
,
577 return key_load_private_pem(fd
, type
, passphrase
, commentp
);
587 key_load_private(const char *filename
, const char *passphrase
,
593 fd
= open(filename
, O_RDONLY
);
596 if (!key_perm_ok(fd
, filename
)) {
597 error("bad permissions: ignore key: %s", filename
);
601 pub
= key_load_public_rsa1(fd
, filename
, commentp
);
602 lseek(fd
, (off_t
) 0, SEEK_SET
); /* rewind */
605 prv
= key_load_private_pem(fd
, KEY_UNSPEC
, passphrase
, NULL
);
606 /* use the filename as a comment for PEM */
608 *commentp
= xstrdup(filename
);
610 /* it's a SSH v1 key if the public key part is readable */
613 prv
= key_load_private_rsa1(fd
, filename
, passphrase
, NULL
);
619 key_try_load_public(Key
*k
, const char *filename
, char **commentp
)
622 char line
[SSH_MAX_PUBKEY_BYTES
];
626 f
= fopen(filename
, "r");
628 while (read_keyfile_line(f
, filename
, line
, sizeof(line
),
637 /* Skip leading whitespace. */
638 for (; *cp
&& (*cp
== ' ' || *cp
== '\t'); cp
++)
641 if (key_read(k
, &cp
) == 1) {
643 *commentp
=xstrdup(filename
);
654 /* load public key from ssh v1 private or any pubkey file */
656 key_load_public(const char *filename
, char **commentp
)
659 char file
[MAXPATHLEN
];
661 /* try rsa1 private key */
662 pub
= key_load_public_type(KEY_RSA1
, filename
, commentp
);
666 /* try rsa1 public key */
667 pub
= key_new(KEY_RSA1
);
668 if (key_try_load_public(pub
, filename
, commentp
) == 1)
672 /* try ssh2 public key */
673 pub
= key_new(KEY_UNSPEC
);
674 if (key_try_load_public(pub
, filename
, commentp
) == 1)
676 if ((strlcpy(file
, filename
, sizeof file
) < sizeof(file
)) &&
677 (strlcat(file
, ".pub", sizeof file
) < sizeof(file
)) &&
678 (key_try_load_public(pub
, file
, commentp
) == 1))