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