]> andersk Git - openssh.git/blob - authfile.c
- deraadt@cvs.openbsd.org 2006/03/19 18:59:09
[openssh.git] / authfile.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  * This file contains functions for reading and writing identity files, and
6  * for reading the passphrase from the user.
7  *
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".
13  *
14  *
15  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions
19  * are met:
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.
25  *
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.
36  */
37
38 #include "includes.h"
39
40 #include <sys/types.h>
41 #include <sys/stat.h>
42
43 #include <openssl/err.h>
44 #include <openssl/evp.h>
45 #include <openssl/pem.h>
46
47 #include "cipher.h"
48 #include "xmalloc.h"
49 #include "buffer.h"
50 #include "bufaux.h"
51 #include "key.h"
52 #include "ssh.h"
53 #include "log.h"
54 #include "authfile.h"
55 #include "rsa.h"
56 #include "misc.h"
57 #include "atomicio.h"
58
59 /* Version identification string for SSH v1 identity files. */
60 static const char authfile_id_string[] =
61     "SSH PRIVATE KEY FILE FORMAT 1.1\n";
62
63 /*
64  * Saves the authentication (private) key in a file, encrypting it with
65  * passphrase.  The identification of the file (lowest 64 bits of n) will
66  * precede the key to provide identification of the key without needing a
67  * passphrase.
68  */
69
70 static int
71 key_save_private_rsa1(Key *key, const char *filename, const char *passphrase,
72     const char *comment)
73 {
74         Buffer buffer, encrypted;
75         u_char buf[100], *cp;
76         int fd, i, cipher_num;
77         CipherContext ciphercontext;
78         Cipher *cipher;
79         u_int32_t rnd;
80
81         /*
82          * If the passphrase is empty, use SSH_CIPHER_NONE to ease converting
83          * to another cipher; otherwise use SSH_AUTHFILE_CIPHER.
84          */
85         cipher_num = (strcmp(passphrase, "") == 0) ?
86             SSH_CIPHER_NONE : SSH_AUTHFILE_CIPHER;
87         if ((cipher = cipher_by_number(cipher_num)) == NULL)
88                 fatal("save_private_key_rsa: bad cipher");
89
90         /* This buffer is used to built the secret part of the private key. */
91         buffer_init(&buffer);
92
93         /* Put checkbytes for checking passphrase validity. */
94         rnd = arc4random();
95         buf[0] = rnd & 0xff;
96         buf[1] = (rnd >> 8) & 0xff;
97         buf[2] = buf[0];
98         buf[3] = buf[1];
99         buffer_append(&buffer, buf, 4);
100
101         /*
102          * Store the private key (n and e will not be stored because they
103          * will be stored in plain text, and storing them also in encrypted
104          * format would just give known plaintext).
105          */
106         buffer_put_bignum(&buffer, key->rsa->d);
107         buffer_put_bignum(&buffer, key->rsa->iqmp);
108         buffer_put_bignum(&buffer, key->rsa->q);        /* reverse from SSL p */
109         buffer_put_bignum(&buffer, key->rsa->p);        /* reverse from SSL q */
110
111         /* Pad the part to be encrypted until its size is a multiple of 8. */
112         while (buffer_len(&buffer) % 8 != 0)
113                 buffer_put_char(&buffer, 0);
114
115         /* This buffer will be used to contain the data in the file. */
116         buffer_init(&encrypted);
117
118         /* First store keyfile id string. */
119         for (i = 0; authfile_id_string[i]; i++)
120                 buffer_put_char(&encrypted, authfile_id_string[i]);
121         buffer_put_char(&encrypted, 0);
122
123         /* Store cipher type. */
124         buffer_put_char(&encrypted, cipher_num);
125         buffer_put_int(&encrypted, 0);  /* For future extension */
126
127         /* Store public key.  This will be in plain text. */
128         buffer_put_int(&encrypted, BN_num_bits(key->rsa->n));
129         buffer_put_bignum(&encrypted, key->rsa->n);
130         buffer_put_bignum(&encrypted, key->rsa->e);
131         buffer_put_cstring(&encrypted, comment);
132
133         /* Allocate space for the private part of the key in the buffer. */
134         cp = buffer_append_space(&encrypted, buffer_len(&buffer));
135
136         cipher_set_key_string(&ciphercontext, cipher, passphrase,
137             CIPHER_ENCRYPT);
138         cipher_crypt(&ciphercontext, cp,
139             buffer_ptr(&buffer), buffer_len(&buffer));
140         cipher_cleanup(&ciphercontext);
141         memset(&ciphercontext, 0, sizeof(ciphercontext));
142
143         /* Destroy temporary data. */
144         memset(buf, 0, sizeof(buf));
145         buffer_free(&buffer);
146
147         fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, 0600);
148         if (fd < 0) {
149                 error("open %s failed: %s.", filename, strerror(errno));
150                 buffer_free(&encrypted);
151                 return 0;
152         }
153         if (atomicio(vwrite, fd, buffer_ptr(&encrypted),
154             buffer_len(&encrypted)) != buffer_len(&encrypted)) {
155                 error("write to key file %s failed: %s", filename,
156                     strerror(errno));
157                 buffer_free(&encrypted);
158                 close(fd);
159                 unlink(filename);
160                 return 0;
161         }
162         close(fd);
163         buffer_free(&encrypted);
164         return 1;
165 }
166
167 /* save SSH v2 key in OpenSSL PEM format */
168 static int
169 key_save_private_pem(Key *key, const char *filename, const char *_passphrase,
170     const char *comment)
171 {
172         FILE *fp;
173         int fd;
174         int success = 0;
175         int len = strlen(_passphrase);
176         u_char *passphrase = (len > 0) ? (u_char *)_passphrase : NULL;
177         const EVP_CIPHER *cipher = (len > 0) ? EVP_des_ede3_cbc() : NULL;
178
179         if (len > 0 && len <= 4) {
180                 error("passphrase too short: have %d bytes, need > 4", len);
181                 return 0;
182         }
183         fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, 0600);
184         if (fd < 0) {
185                 error("open %s failed: %s.", filename, strerror(errno));
186                 return 0;
187         }
188         fp = fdopen(fd, "w");
189         if (fp == NULL ) {
190                 error("fdopen %s failed: %s.", filename, strerror(errno));
191                 close(fd);
192                 return 0;
193         }
194         switch (key->type) {
195         case KEY_DSA:
196                 success = PEM_write_DSAPrivateKey(fp, key->dsa,
197                     cipher, passphrase, len, NULL, NULL);
198                 break;
199         case KEY_RSA:
200                 success = PEM_write_RSAPrivateKey(fp, key->rsa,
201                     cipher, passphrase, len, NULL, NULL);
202                 break;
203         }
204         fclose(fp);
205         return success;
206 }
207
208 int
209 key_save_private(Key *key, const char *filename, const char *passphrase,
210     const char *comment)
211 {
212         switch (key->type) {
213         case KEY_RSA1:
214                 return key_save_private_rsa1(key, filename, passphrase,
215                     comment);
216         case KEY_DSA:
217         case KEY_RSA:
218                 return key_save_private_pem(key, filename, passphrase,
219                     comment);
220         default:
221                 break;
222         }
223         error("key_save_private: cannot save key type %d", key->type);
224         return 0;
225 }
226
227 /*
228  * Loads the public part of the ssh v1 key file.  Returns NULL if an error was
229  * encountered (the file does not exist or is not readable), and the key
230  * otherwise.
231  */
232
233 static Key *
234 key_load_public_rsa1(int fd, const char *filename, char **commentp)
235 {
236         Buffer buffer;
237         Key *pub;
238         struct stat st;
239         char *cp;
240         u_int i;
241         size_t len;
242
243         if (fstat(fd, &st) < 0) {
244                 error("fstat for key file %.200s failed: %.100s",
245                     filename, strerror(errno));
246                 return NULL;
247         }
248         if (st.st_size > 1*1024*1024) {
249                 error("key file %.200s too large", filename);
250                 return NULL;
251         }
252         len = (size_t)st.st_size;               /* truncated */
253
254         buffer_init(&buffer);
255         cp = buffer_append_space(&buffer, len);
256
257         if (atomicio(read, fd, cp, len) != len) {
258                 debug("Read from key file %.200s failed: %.100s", filename,
259                     strerror(errno));
260                 buffer_free(&buffer);
261                 return NULL;
262         }
263
264         /* Check that it is at least big enough to contain the ID string. */
265         if (len < sizeof(authfile_id_string)) {
266                 debug3("Not a RSA1 key file %.200s.", filename);
267                 buffer_free(&buffer);
268                 return NULL;
269         }
270         /*
271          * Make sure it begins with the id string.  Consume the id string
272          * from the buffer.
273          */
274         for (i = 0; i < sizeof(authfile_id_string); i++)
275                 if (buffer_get_char(&buffer) != authfile_id_string[i]) {
276                         debug3("Not a RSA1 key file %.200s.", filename);
277                         buffer_free(&buffer);
278                         return NULL;
279                 }
280         /* Skip cipher type and reserved data. */
281         (void) buffer_get_char(&buffer);        /* cipher type */
282         (void) buffer_get_int(&buffer);         /* reserved */
283
284         /* Read the public key from the buffer. */
285         (void) buffer_get_int(&buffer);
286         pub = key_new(KEY_RSA1);
287         buffer_get_bignum(&buffer, pub->rsa->n);
288         buffer_get_bignum(&buffer, pub->rsa->e);
289         if (commentp)
290                 *commentp = buffer_get_string(&buffer, NULL);
291         /* The encrypted private part is not parsed by this function. */
292
293         buffer_free(&buffer);
294         return pub;
295 }
296
297 /* load public key from private-key file, works only for SSH v1 */
298 Key *
299 key_load_public_type(int type, const char *filename, char **commentp)
300 {
301         Key *pub;
302         int fd;
303
304         if (type == KEY_RSA1) {
305                 fd = open(filename, O_RDONLY);
306                 if (fd < 0)
307                         return NULL;
308                 pub = key_load_public_rsa1(fd, filename, commentp);
309                 close(fd);
310                 return pub;
311         }
312         return NULL;
313 }
314
315 /*
316  * Loads the private key from the file.  Returns 0 if an error is encountered
317  * (file does not exist or is not readable, or passphrase is bad). This
318  * initializes the private key.
319  * Assumes we are called under uid of the owner of the file.
320  */
321
322 static Key *
323 key_load_private_rsa1(int fd, const char *filename, const char *passphrase,
324     char **commentp)
325 {
326         u_int i;
327         int check1, check2, cipher_type;
328         size_t len;
329         Buffer buffer, decrypted;
330         u_char *cp;
331         CipherContext ciphercontext;
332         Cipher *cipher;
333         Key *prv = NULL;
334         struct stat st;
335
336         if (fstat(fd, &st) < 0) {
337                 error("fstat for key file %.200s failed: %.100s",
338                     filename, strerror(errno));
339                 close(fd);
340                 return NULL;
341         }
342         if (st.st_size > 1*1024*1024) {
343                 error("key file %.200s too large", filename);
344                 close(fd);
345                 return (NULL);
346         }
347         len = (size_t)st.st_size;               /* truncated */
348
349         buffer_init(&buffer);
350         cp = buffer_append_space(&buffer, len);
351
352         if (atomicio(read, fd, cp, len) != len) {
353                 debug("Read from key file %.200s failed: %.100s", filename,
354                     strerror(errno));
355                 buffer_free(&buffer);
356                 close(fd);
357                 return NULL;
358         }
359
360         /* Check that it is at least big enough to contain the ID string. */
361         if (len < sizeof(authfile_id_string)) {
362                 debug3("Not a RSA1 key file %.200s.", filename);
363                 buffer_free(&buffer);
364                 close(fd);
365                 return NULL;
366         }
367         /*
368          * Make sure it begins with the id string.  Consume the id string
369          * from the buffer.
370          */
371         for (i = 0; i < sizeof(authfile_id_string); i++)
372                 if (buffer_get_char(&buffer) != authfile_id_string[i]) {
373                         debug3("Not a RSA1 key file %.200s.", filename);
374                         buffer_free(&buffer);
375                         close(fd);
376                         return NULL;
377                 }
378
379         /* Read cipher type. */
380         cipher_type = buffer_get_char(&buffer);
381         (void) buffer_get_int(&buffer); /* Reserved data. */
382
383         /* Read the public key from the buffer. */
384         (void) buffer_get_int(&buffer);
385         prv = key_new_private(KEY_RSA1);
386
387         buffer_get_bignum(&buffer, prv->rsa->n);
388         buffer_get_bignum(&buffer, prv->rsa->e);
389         if (commentp)
390                 *commentp = buffer_get_string(&buffer, NULL);
391         else
392                 xfree(buffer_get_string(&buffer, NULL));
393
394         /* Check that it is a supported cipher. */
395         cipher = cipher_by_number(cipher_type);
396         if (cipher == NULL) {
397                 debug("Unsupported cipher %d used in key file %.200s.",
398                     cipher_type, filename);
399                 buffer_free(&buffer);
400                 goto fail;
401         }
402         /* Initialize space for decrypted data. */
403         buffer_init(&decrypted);
404         cp = buffer_append_space(&decrypted, buffer_len(&buffer));
405
406         /* Rest of the buffer is encrypted.  Decrypt it using the passphrase. */
407         cipher_set_key_string(&ciphercontext, cipher, passphrase,
408             CIPHER_DECRYPT);
409         cipher_crypt(&ciphercontext, cp,
410             buffer_ptr(&buffer), buffer_len(&buffer));
411         cipher_cleanup(&ciphercontext);
412         memset(&ciphercontext, 0, sizeof(ciphercontext));
413         buffer_free(&buffer);
414
415         check1 = buffer_get_char(&decrypted);
416         check2 = buffer_get_char(&decrypted);
417         if (check1 != buffer_get_char(&decrypted) ||
418             check2 != buffer_get_char(&decrypted)) {
419                 if (strcmp(passphrase, "") != 0)
420                         debug("Bad passphrase supplied for key file %.200s.",
421                             filename);
422                 /* Bad passphrase. */
423                 buffer_free(&decrypted);
424                 goto fail;
425         }
426         /* Read the rest of the private key. */
427         buffer_get_bignum(&decrypted, prv->rsa->d);
428         buffer_get_bignum(&decrypted, prv->rsa->iqmp);          /* u */
429         /* in SSL and SSH v1 p and q are exchanged */
430         buffer_get_bignum(&decrypted, prv->rsa->q);             /* p */
431         buffer_get_bignum(&decrypted, prv->rsa->p);             /* q */
432
433         /* calculate p-1 and q-1 */
434         rsa_generate_additional_parameters(prv->rsa);
435
436         buffer_free(&decrypted);
437
438         /* enable blinding */
439         if (RSA_blinding_on(prv->rsa, NULL) != 1) {
440                 error("key_load_private_rsa1: RSA_blinding_on failed");
441                 goto fail;
442         }
443         close(fd);
444         return prv;
445
446 fail:
447         if (commentp)
448                 xfree(*commentp);
449         close(fd);
450         key_free(prv);
451         return NULL;
452 }
453
454 Key *
455 key_load_private_pem(int fd, int type, const char *passphrase,
456     char **commentp)
457 {
458         FILE *fp;
459         EVP_PKEY *pk = NULL;
460         Key *prv = NULL;
461         char *name = "<no key>";
462
463         fp = fdopen(fd, "r");
464         if (fp == NULL) {
465                 error("fdopen failed: %s", strerror(errno));
466                 close(fd);
467                 return NULL;
468         }
469         pk = PEM_read_PrivateKey(fp, NULL, NULL, (char *)passphrase);
470         if (pk == NULL) {
471                 debug("PEM_read_PrivateKey failed");
472                 (void)ERR_get_error();
473         } else if (pk->type == EVP_PKEY_RSA &&
474             (type == KEY_UNSPEC||type==KEY_RSA)) {
475                 prv = key_new(KEY_UNSPEC);
476                 prv->rsa = EVP_PKEY_get1_RSA(pk);
477                 prv->type = KEY_RSA;
478                 name = "rsa w/o comment";
479 #ifdef DEBUG_PK
480                 RSA_print_fp(stderr, prv->rsa, 8);
481 #endif
482                 if (RSA_blinding_on(prv->rsa, NULL) != 1) {
483                         error("key_load_private_pem: RSA_blinding_on failed");
484                         key_free(prv);
485                         prv = NULL;
486                 }
487         } else if (pk->type == EVP_PKEY_DSA &&
488             (type == KEY_UNSPEC||type==KEY_DSA)) {
489                 prv = key_new(KEY_UNSPEC);
490                 prv->dsa = EVP_PKEY_get1_DSA(pk);
491                 prv->type = KEY_DSA;
492                 name = "dsa w/o comment";
493 #ifdef DEBUG_PK
494                 DSA_print_fp(stderr, prv->dsa, 8);
495 #endif
496         } else {
497                 error("PEM_read_PrivateKey: mismatch or "
498                     "unknown EVP_PKEY save_type %d", pk->save_type);
499         }
500         fclose(fp);
501         if (pk != NULL)
502                 EVP_PKEY_free(pk);
503         if (prv != NULL && commentp)
504                 *commentp = xstrdup(name);
505         debug("read PEM private key done: type %s",
506             prv ? key_type(prv) : "<unknown>");
507         return prv;
508 }
509
510 int
511 key_perm_ok(int fd, const char *filename)
512 {
513         struct stat st;
514
515         if (fstat(fd, &st) < 0)
516                 return 0;
517         /*
518          * if a key owned by the user is accessed, then we check the
519          * permissions of the file. if the key owned by a different user,
520          * then we don't care.
521          */
522 #ifdef HAVE_CYGWIN
523         if (check_ntsec(filename))
524 #endif
525         if ((st.st_uid == getuid()) && (st.st_mode & 077) != 0) {
526                 error("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
527                 error("@         WARNING: UNPROTECTED PRIVATE KEY FILE!          @");
528                 error("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@");
529                 error("Permissions 0%3.3o for '%s' are too open.",
530                     (u_int)st.st_mode & 0777, filename);
531                 error("It is recommended that your private key files are NOT accessible by others.");
532                 error("This private key will be ignored.");
533                 return 0;
534         }
535         return 1;
536 }
537
538 Key *
539 key_load_private_type(int type, const char *filename, const char *passphrase,
540     char **commentp)
541 {
542         int fd;
543
544         fd = open(filename, O_RDONLY);
545         if (fd < 0)
546                 return NULL;
547         if (!key_perm_ok(fd, filename)) {
548                 error("bad permissions: ignore key: %s", filename);
549                 close(fd);
550                 return NULL;
551         }
552         switch (type) {
553         case KEY_RSA1:
554                 return key_load_private_rsa1(fd, filename, passphrase,
555                     commentp);
556                 /* closes fd */
557         case KEY_DSA:
558         case KEY_RSA:
559         case KEY_UNSPEC:
560                 return key_load_private_pem(fd, type, passphrase, commentp);
561                 /* closes fd */
562         default:
563                 close(fd);
564                 break;
565         }
566         return NULL;
567 }
568
569 Key *
570 key_load_private(const char *filename, const char *passphrase,
571     char **commentp)
572 {
573         Key *pub, *prv;
574         int fd;
575
576         fd = open(filename, O_RDONLY);
577         if (fd < 0)
578                 return NULL;
579         if (!key_perm_ok(fd, filename)) {
580                 error("bad permissions: ignore key: %s", filename);
581                 close(fd);
582                 return NULL;
583         }
584         pub = key_load_public_rsa1(fd, filename, commentp);
585         lseek(fd, (off_t) 0, SEEK_SET);         /* rewind */
586         if (pub == NULL) {
587                 /* closes fd */
588                 prv = key_load_private_pem(fd, KEY_UNSPEC, passphrase, NULL);
589                 /* use the filename as a comment for PEM */
590                 if (commentp && prv)
591                         *commentp = xstrdup(filename);
592         } else {
593                 /* it's a SSH v1 key if the public key part is readable */
594                 key_free(pub);
595                 /* closes fd */
596                 prv = key_load_private_rsa1(fd, filename, passphrase, NULL);
597         }
598         return prv;
599 }
600
601 static int
602 key_try_load_public(Key *k, const char *filename, char **commentp)
603 {
604         FILE *f;
605         char line[SSH_MAX_PUBKEY_BYTES];
606         char *cp;
607         u_long linenum = 0;
608
609         f = fopen(filename, "r");
610         if (f != NULL) {
611                 while (read_keyfile_line(f, filename, line, sizeof(line),
612                             &linenum) != -1) {
613                         cp = line;
614                         switch (*cp) {
615                         case '#':
616                         case '\n':
617                         case '\0':
618                                 continue;
619                         }
620                         /* Skip leading whitespace. */
621                         for (; *cp && (*cp == ' ' || *cp == '\t'); cp++)
622                                 ;
623                         if (*cp) {
624                                 if (key_read(k, &cp) == 1) {
625                                         if (commentp)
626                                                 *commentp=xstrdup(filename);
627                                         fclose(f);
628                                         return 1;
629                                 }
630                         }
631                 }
632                 fclose(f);
633         }
634         return 0;
635 }
636
637 /* load public key from ssh v1 private or any pubkey file */
638 Key *
639 key_load_public(const char *filename, char **commentp)
640 {
641         Key *pub;
642         char file[MAXPATHLEN];
643
644         /* try rsa1 private key */
645         pub = key_load_public_type(KEY_RSA1, filename, commentp);
646         if (pub != NULL)
647                 return pub;
648
649         /* try rsa1 public key */
650         pub = key_new(KEY_RSA1);
651         if (key_try_load_public(pub, filename, commentp) == 1)
652                 return pub;
653         key_free(pub);
654
655         /* try ssh2 public key */
656         pub = key_new(KEY_UNSPEC);
657         if (key_try_load_public(pub, filename, commentp) == 1)
658                 return pub;
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))
662                 return pub;
663         key_free(pub);
664         return NULL;
665 }
This page took 0.393579 seconds and 5 git commands to generate.