]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - cmdgen.c
Improvements to PuTTYgen error reporting:
[PuTTY.git] / cmdgen.c
1 /*
2  * cmdgen.c - command-line form of PuTTYgen
3  */
4
5 #define PUTTY_DO_GLOBALS
6
7 #include <stdio.h>
8 #include <stdlib.h>
9 #include <ctype.h>
10 #include <limits.h>
11 #include <assert.h>
12 #include <time.h>
13
14 #include "putty.h"
15 #include "ssh.h"
16
17 #ifdef TEST_CMDGEN
18 /*
19  * This section overrides some definitions below for test purposes.
20  * When compiled with -DTEST_CMDGEN:
21  * 
22  *  - Calls to get_random_data() are replaced with the diagnostic
23  *    function below (I #define the name so that I can still link
24  *    with the original set of modules without symbol clash), in
25  *    order to avoid depleting the test system's /dev/random
26  *    unnecessarily.
27  * 
28  *  - Calls to console_get_line() are replaced with the diagnostic
29  *    function below, so that I can run tests in an automated
30  *    manner and provide their interactive passphrase inputs.
31  * 
32  *  - main() is renamed to cmdgen_main(); at the bottom of the file
33  *    I define another main() which calls the former repeatedly to
34  *    run tests.
35  */
36 #define get_random_data get_random_data_diagnostic
37 char *get_random_data(int len)
38 {
39     char *buf = snewn(len, char);
40     memset(buf, 'x', len);
41     return buf;
42 }
43 #define console_get_line console_get_line_diagnostic
44 int nprompts, promptsgot;
45 const char *prompts[3];
46 int console_get_line(const char *prompt, char *str, int maxlen, int is_pw)
47 {
48     if (promptsgot < nprompts) {
49         assert(strlen(prompts[promptsgot]) < maxlen);
50         strcpy(str, prompts[promptsgot++]);
51         return TRUE;
52     } else {
53         promptsgot++;                  /* track number of requests anyway */
54         return FALSE;
55     }
56 }
57 #define main cmdgen_main
58 #endif
59
60 struct progress {
61     int phase, current;
62 };
63
64 static void progress_update(void *param, int action, int phase, int iprogress)
65 {
66     struct progress *p = (struct progress *)param;
67     if (action != PROGFN_PROGRESS)
68         return;
69     if (phase > p->phase) {
70         if (p->phase >= 0)
71             fputc('\n', stderr);
72         p->phase = phase;
73         if (iprogress >= 0)
74             p->current = iprogress - 1;
75         else
76             p->current = iprogress;
77     }
78     while (p->current < iprogress) {
79         fputc('+', stdout);
80         p->current++;
81     }
82     fflush(stdout);
83 }
84
85 static void no_progress(void *param, int action, int phase, int iprogress)
86 {
87 }
88
89 void modalfatalbox(char *p, ...)
90 {
91     va_list ap;
92     fprintf(stderr, "FATAL ERROR: ");
93     va_start(ap, p);
94     vfprintf(stderr, p, ap);
95     va_end(ap);
96     fputc('\n', stderr);
97     cleanup_exit(1);
98 }
99
100 /*
101  * Stubs to let everything else link sensibly.
102  */
103 void log_eventlog(void *handle, const char *event)
104 {
105 }
106 char *x_get_default(const char *key)
107 {
108     return NULL;
109 }
110 void sk_cleanup(void)
111 {
112 }
113
114 void showversion(void)
115 {
116     char *verstr = dupstr(ver);
117     verstr[0] = tolower(verstr[0]);
118     printf("PuTTYgen %s\n", verstr);
119     sfree(verstr);
120 }
121
122 void usage(void)
123 {
124     fprintf(stderr,
125             "Usage: puttygen ( keyfile | -t type [ -b bits ] )\n"
126             "                [ -C comment ] [ -P ]\n"
127             "                [ -o output-keyfile ] [ -O type | -l | -L"
128             " | -p ]\n");
129 }
130
131 void help(void)
132 {
133     /*
134      * Help message is an extended version of the usage message. So
135      * start with that, plus a version heading.
136      */
137     showversion();
138     usage();
139     fprintf(stderr,
140             "  -t    specify key type when generating (rsa, dsa, rsa1)\n"
141             "  -b    specify number of bits when generating key\n"
142             "  -C    change or specify key comment\n"
143             "  -P    change key passphrase\n"
144             "  -O    specify output type:\n"
145             "           private             output PuTTY private key format\n"
146             "           private-openssh     export OpenSSH private key\n"
147             "           private-sshcom      export ssh.com private key\n"
148             "           public              standard / ssh.com public key\n"
149             "           public-openssh      OpenSSH public key\n"
150             "           fingerprint         output the key fingerprint\n"
151             "  -o    specify output file\n"
152             "  -l    equivalent to `-O fingerprint'\n"
153             "  -L    equivalent to `-O public-openssh'\n"
154             "  -p    equivalent to `-O public'\n"
155             );
156 }
157
158 static int save_ssh2_pubkey(char *filename, char *comment,
159                             void *v_pub_blob, int pub_len)
160 {
161     unsigned char *pub_blob = (unsigned char *)v_pub_blob;
162     char *p;
163     int i, column;
164     FILE *fp;
165
166     if (filename) {
167         fp = fopen(filename, "wb");
168         if (!fp)
169             return 0;
170     } else
171         fp = stdout;
172
173     fprintf(fp, "---- BEGIN SSH2 PUBLIC KEY ----\n");
174
175     if (comment) {
176         fprintf(fp, "Comment: \"");
177         for (p = comment; *p; p++) {
178             if (*p == '\\' || *p == '\"')
179                 fputc('\\', fp);
180             fputc(*p, fp);
181         }
182         fprintf(fp, "\"\n");
183     }
184
185     i = 0;
186     column = 0;
187     while (i < pub_len) {
188         char buf[5];
189         int n = (pub_len - i < 3 ? pub_len - i : 3);
190         base64_encode_atom(pub_blob + i, n, buf);
191         i += n;
192         buf[4] = '\0';
193         fputs(buf, fp);
194         if (++column >= 16) {
195             fputc('\n', fp);
196             column = 0;
197         }
198     }
199     if (column > 0)
200         fputc('\n', fp);
201     
202     fprintf(fp, "---- END SSH2 PUBLIC KEY ----\n");
203     if (filename)
204         fclose(fp);
205     return 1;
206 }
207
208 static int move(char *from, char *to)
209 {
210     int ret;
211
212     ret = rename(from, to);
213     if (ret) {
214         /*
215          * This OS may require us to remove the original file first.
216          */
217         remove(to);
218         ret = rename(from, to);
219     }
220     if (ret) {
221         perror("puttygen: cannot move new file on to old one");
222         return FALSE;
223     }
224     return TRUE;
225 }
226
227 static char *blobfp(char *alg, int bits, char *blob, int bloblen)
228 {
229     char buffer[128];
230     unsigned char digest[16];
231     struct MD5Context md5c;
232     int i;
233
234     MD5Init(&md5c);
235     MD5Update(&md5c, blob, bloblen);
236     MD5Final(digest, &md5c);
237
238     sprintf(buffer, "%s ", alg);
239     if (bits > 0)
240         sprintf(buffer + strlen(buffer), "%d ", bits);
241     for (i = 0; i < 16; i++)
242         sprintf(buffer + strlen(buffer), "%s%02x", i ? ":" : "",
243                 digest[i]);
244
245     return dupstr(buffer);
246 }
247
248 int main(int argc, char **argv)
249 {
250     char *infile = NULL;
251     Filename infilename;
252     enum { NOKEYGEN, RSA1, RSA2, DSA } keytype = NOKEYGEN;    
253     char *outfile = NULL, *outfiletmp = NULL;
254     Filename outfilename;
255     enum { PRIVATE, PUBLIC, PUBLICO, FP, OPENSSH, SSHCOM } outtype = PRIVATE;
256     int bits = 1024;
257     char *comment = NULL, *origcomment = NULL;
258     int change_passphrase = FALSE;
259     int errs = FALSE, nogo = FALSE;
260     int intype = SSH_KEYTYPE_UNOPENABLE;
261     int sshver = 0;
262     struct ssh2_userkey *ssh2key = NULL;
263     struct RSAKey *ssh1key = NULL;
264     char *ssh2blob = NULL, *ssh2alg = NULL;
265     const struct ssh_signkey *ssh2algf = NULL;
266     int ssh2bloblen;
267     char *passphrase = NULL;
268     int load_encrypted;
269     progfn_t progressfn = is_interactive() ? progress_update : no_progress;
270
271     /* ------------------------------------------------------------------
272      * Parse the command line to figure out what we've been asked to do.
273      */
274
275     /*
276      * If run with no arguments at all, print the usage message and
277      * return success.
278      */
279     if (argc <= 1) {
280         usage();
281         return 0;
282     }
283
284     /*
285      * Parse command line arguments.
286      */
287     while (--argc) {
288         char *p = *++argv;
289         if (*p == '-') {
290             /*
291              * An option.
292              */
293             while (p && *++p) {
294                 char c = *p;
295                 switch (c) {
296                   case '-':
297                     /*
298                      * Long option.
299                      */
300                     {
301                         char *opt, *val;
302                         opt = p++;     /* opt will have _one_ leading - */
303                         while (*p && *p != '=')
304                             p++;               /* find end of option */
305                         if (*p == '=') {
306                             *p++ = '\0';
307                             val = p;
308                         } else
309                             val = NULL;
310                         if (!strcmp(opt, "-help")) {
311                             help();
312                             nogo = TRUE;
313                         } else if (!strcmp(opt, "-version")) {
314                             showversion();
315                             nogo = TRUE;
316                         }
317                         /*
318                          * A sample option requiring an argument:
319                          * 
320                          * else if (!strcmp(opt, "-output")) {
321                          *     if (!val)
322                          *         errs = TRUE, error(err_optnoarg, opt);
323                          *     else
324                          *         ofile = val;
325                          * }
326                          */
327                         else {
328                             errs = TRUE;
329                             fprintf(stderr,
330                                     "puttygen: no such option `--%s'\n", opt);
331                         }
332                     }
333                     p = NULL;
334                     break;
335                   case 'h':
336                   case 'V':
337                   case 'P':
338                   case 'l':
339                   case 'L':
340                   case 'p':
341                   case 'q':
342                     /*
343                      * Option requiring no parameter.
344                      */
345                     switch (c) {
346                       case 'h':
347                         help();
348                         nogo = TRUE;
349                         break;
350                       case 'V':
351                         showversion();
352                         nogo = TRUE;
353                         break;
354                       case 'P':
355                         change_passphrase = TRUE;
356                         break;
357                       case 'l':
358                         outtype = FP;
359                         break;
360                       case 'L':
361                         outtype = PUBLICO;
362                         break;
363                       case 'p':
364                         outtype = PUBLIC;
365                         break;
366                       case 'q':
367                         progressfn = no_progress;
368                         break;
369                     }
370                     break;
371                   case 't':
372                   case 'b':
373                   case 'C':
374                   case 'O':
375                   case 'o':
376                     /*
377                      * Option requiring parameter.
378                      */
379                     p++;
380                     if (!*p && argc > 1)
381                         --argc, p = *++argv;
382                     else if (!*p) {
383                         fprintf(stderr, "puttygen: option `-%c' expects a"
384                                 " parameter\n", c);
385                         errs = TRUE;
386                     }
387                     /*
388                      * Now c is the option and p is the parameter.
389                      */
390                     switch (c) {
391                       case 't':
392                         if (!strcmp(p, "rsa") || !strcmp(p, "rsa2"))
393                             keytype = RSA2, sshver = 2;
394                         else if (!strcmp(p, "rsa1"))
395                             keytype = RSA1, sshver = 1;
396                         else if (!strcmp(p, "dsa") || !strcmp(p, "dss"))
397                             keytype = DSA, sshver = 2;
398                         else {
399                             fprintf(stderr,
400                                     "puttygen: unknown key type `%s'\n", p);
401                             errs = TRUE;
402                         }
403                         break;
404                       case 'b':
405                         bits = atoi(p);
406                         break;
407                       case 'C':
408                         comment = p;
409                         break;
410                       case 'O':
411                         if (!strcmp(p, "public"))
412                             outtype = PUBLIC;
413                         else if (!strcmp(p, "public-openssh"))
414                             outtype = PUBLICO;
415                         else if (!strcmp(p, "private"))
416                             outtype = PRIVATE;
417                         else if (!strcmp(p, "fingerprint"))
418                             outtype = FP;
419                         else if (!strcmp(p, "private-openssh"))
420                             outtype = OPENSSH, sshver = 2;
421                         else if (!strcmp(p, "private-sshcom"))
422                             outtype = SSHCOM, sshver = 2;
423                         else {
424                             fprintf(stderr,
425                                     "puttygen: unknown output type `%s'\n", p);
426                             errs = TRUE;
427                         }
428                         break;
429                       case 'o':
430                         outfile = p;
431                         break;
432                     }
433                     p = NULL;          /* prevent continued processing */
434                     break;
435                   default:
436                     /*
437                      * Unrecognised option.
438                      */
439                     errs = TRUE;
440                     fprintf(stderr, "puttygen: no such option `-%c'\n", c);
441                     break;
442                 }
443             }
444         } else {
445             /*
446              * A non-option argument.
447              */
448             if (!infile)
449                 infile = p;
450             else {
451                 errs = TRUE;
452                 fprintf(stderr, "puttygen: cannot handle more than one"
453                         " input file\n");
454             }
455         }
456     }
457
458     if (errs)
459         return 1;
460
461     if (nogo)
462         return 0;
463
464     /*
465      * If run with at least one argument _but_ not the required
466      * ones, print the usage message and return failure.
467      */
468     if (!infile && keytype == NOKEYGEN) {
469         usage();
470         return 1;
471     }
472
473     /* ------------------------------------------------------------------
474      * Figure out further details of exactly what we're going to do.
475      */
476
477     /*
478      * Bomb out if we've been asked to both load and generate a
479      * key.
480      */
481     if (keytype != NOKEYGEN && intype) {
482         fprintf(stderr, "puttygen: cannot both load and generate a key\n");
483         return 1;
484     }
485
486     /*
487      * Analyse the type of the input file, in case this affects our
488      * course of action.
489      */
490     if (infile) {
491         infilename = filename_from_str(infile);
492
493         intype = key_type(&infilename);
494
495         switch (intype) {
496             /*
497              * It would be nice here to be able to load _public_
498              * key files, in any of a number of forms, and (a)
499              * convert them to other public key types, (b) print
500              * out their fingerprints. Or, I suppose, for real
501              * orthogonality, (c) change their comment!
502              * 
503              * In fact this opens some interesting possibilities.
504              * Suppose ssh2_userkey_loadpub() were able to load
505              * public key files as well as extracting the public
506              * key from private ones. And suppose I did the thing
507              * I've been wanting to do, where specifying a
508              * particular private key file for authentication
509              * causes any _other_ key in the agent to be discarded.
510              * Then, if you had an agent forwarded to the machine
511              * you were running Unix PuTTY or Plink on, and you
512              * needed to specify which of the keys in the agent it
513              * should use, you could do that by supplying a
514              * _public_ key file, thus not needing to trust even
515              * your encrypted private key file to the network. Ooh!
516              */
517
518           case SSH_KEYTYPE_UNOPENABLE:
519           case SSH_KEYTYPE_UNKNOWN:
520             fprintf(stderr, "puttygen: unable to load file `%s': %s\n",
521                     infile, key_type_to_str(intype));
522             return 1;
523
524           case SSH_KEYTYPE_SSH1:
525             if (sshver == 2) {
526                 fprintf(stderr, "puttygen: conversion from SSH1 to SSH2 keys"
527                         " not supported\n");
528                 return 1;
529             }
530             sshver = 1;
531             break;
532
533           case SSH_KEYTYPE_SSH2:
534           case SSH_KEYTYPE_OPENSSH:
535           case SSH_KEYTYPE_SSHCOM:
536             if (sshver == 1) {
537                 fprintf(stderr, "puttygen: conversion from SSH2 to SSH1 keys"
538                         " not supported\n");
539                 return 1;
540             }
541             sshver = 2;
542             break;
543         }
544     }
545
546     /*
547      * Determine the default output file, if none is provided.
548      * 
549      * This will usually be equal to stdout, except that if the
550      * input and output file formats are the same then the default
551      * output is to overwrite the input.
552      * 
553      * Also in this code, we bomb out if the input and output file
554      * formats are the same and no other action is performed.
555      */
556     if ((intype == SSH_KEYTYPE_SSH1 && outtype == PRIVATE) ||
557         (intype == SSH_KEYTYPE_SSH2 && outtype == PRIVATE) ||
558         (intype == SSH_KEYTYPE_OPENSSH && outtype == OPENSSH) ||
559         (intype == SSH_KEYTYPE_SSHCOM && outtype == SSHCOM)) {
560         if (!outfile) {
561             outfile = infile;
562             outfiletmp = dupcat(outfile, ".tmp", NULL);
563         }
564
565         if (!change_passphrase && !comment) {
566             fprintf(stderr, "puttygen: this command would perform no useful"
567                     " action\n");
568             return 1;
569         }
570     } else {
571         if (!outfile) {
572             /*
573              * Bomb out rather than automatically choosing to write
574              * a private key file to stdout.
575              */
576             if (outtype==PRIVATE || outtype==OPENSSH || outtype==SSHCOM) {
577                 fprintf(stderr, "puttygen: need to specify an output file\n");
578                 return 1;
579             }
580         }
581     }
582
583     /*
584      * Figure out whether we need to load the encrypted part of the
585      * key. This will be the case if either (a) we need to write
586      * out a private key format, or (b) the entire input key file
587      * is encrypted.
588      */
589     if (outtype == PRIVATE || outtype == OPENSSH || outtype == SSHCOM ||
590         intype == SSH_KEYTYPE_OPENSSH || intype == SSH_KEYTYPE_SSHCOM)
591         load_encrypted = TRUE;
592     else
593         load_encrypted = FALSE;
594
595     /* ------------------------------------------------------------------
596      * Now we're ready to actually do some stuff.
597      */
598
599     /*
600      * Either load or generate a key.
601      */
602     if (keytype != NOKEYGEN) {
603         char *entropy;
604         char default_comment[80];
605         struct tm tm;
606         struct progress prog;
607
608         prog.phase = -1;
609         prog.current = -1;
610
611         tm = ltime();
612         if (keytype == DSA)
613             strftime(default_comment, 30, "dsa-key-%Y%m%d", &tm);
614         else
615             strftime(default_comment, 30, "rsa-key-%Y%m%d", &tm);
616
617         random_ref();
618         entropy = get_random_data(bits / 8);
619         random_add_heavynoise(entropy, bits / 8);
620         memset(entropy, 0, bits/8);
621         sfree(entropy);
622
623         if (keytype == DSA) {
624             struct dss_key *dsskey = snew(struct dss_key);
625             dsa_generate(dsskey, bits, progressfn, &prog);
626             ssh2key = snew(struct ssh2_userkey);
627             ssh2key->data = dsskey;
628             ssh2key->alg = &ssh_dss;
629             ssh1key = NULL;
630         } else {
631             struct RSAKey *rsakey = snew(struct RSAKey);
632             rsa_generate(rsakey, bits, progressfn, &prog);
633             rsakey->comment = NULL;
634             if (keytype == RSA1) {
635                 ssh1key = rsakey;
636             } else {
637                 ssh2key = snew(struct ssh2_userkey);
638                 ssh2key->data = rsakey;
639                 ssh2key->alg = &ssh_rsa;
640             }
641         }
642         progressfn(&prog, PROGFN_PROGRESS, INT_MAX, -1);
643
644         if (ssh2key)
645             ssh2key->comment = dupstr(default_comment);
646         if (ssh1key)
647             ssh1key->comment = dupstr(default_comment);
648
649     } else {
650         const char *error = NULL;
651         int encrypted;
652
653         assert(infile != NULL);
654
655         /*
656          * Find out whether the input key is encrypted.
657          */
658         if (intype == SSH_KEYTYPE_SSH1)
659             encrypted = rsakey_encrypted(&infilename, &origcomment);
660         else if (intype == SSH_KEYTYPE_SSH2)
661             encrypted = ssh2_userkey_encrypted(&infilename, &origcomment);
662         else
663             encrypted = import_encrypted(&infilename, intype, &origcomment);
664
665         /*
666          * If so, ask for a passphrase.
667          */
668         if (encrypted && load_encrypted) {
669             passphrase = snewn(512, char);
670             if (!console_get_line("Enter passphrase to load key: ",
671                                   passphrase, 512, TRUE)) {
672                 perror("puttygen: unable to read passphrase");
673                 return 1;
674             }
675         } else {
676             passphrase = NULL;
677         }
678
679         switch (intype) {
680             int ret;
681
682           case SSH_KEYTYPE_SSH1:
683             ssh1key = snew(struct RSAKey);
684             if (!load_encrypted) {
685                 void *vblob;
686                 char *blob;
687                 int n, l, bloblen;
688
689                 ret = rsakey_pubblob(&infilename, &vblob, &bloblen, &error);
690                 blob = (char *)vblob;
691
692                 n = 4;                 /* skip modulus bits */
693                 
694                 l = ssh1_read_bignum(blob + n, bloblen - n,
695                                      &ssh1key->exponent);
696                 if (l < 0) {
697                     error = "SSH1 public key blob was too short";
698                 } else {
699                     n += l;
700                     l = ssh1_read_bignum(blob + n, bloblen - n,
701                                          &ssh1key->modulus);
702                     if (l < 0) {
703                         error = "SSH1 public key blob was too short";
704                     } else
705                         n += l;
706                 }
707                 ssh1key->comment = NULL;
708                 ssh1key->private_exponent = NULL;
709             } else {
710                 ret = loadrsakey(&infilename, ssh1key, passphrase, &error);
711             }
712             if (ret > 0)
713                 error = NULL;
714             else if (!error)
715                 error = "unknown error";
716             break;
717
718           case SSH_KEYTYPE_SSH2:
719             if (!load_encrypted) {
720                 ssh2blob = ssh2_userkey_loadpub(&infilename, &ssh2alg,
721                                                 &ssh2bloblen, &error);
722                 ssh2algf = find_pubkey_alg(ssh2alg);
723                 if (ssh2algf)
724                     bits = ssh2algf->pubkey_bits(ssh2blob, ssh2bloblen);
725                 else
726                     bits = -1;
727             } else {
728                 ssh2key = ssh2_load_userkey(&infilename, passphrase, &error);
729             }
730             if ((ssh2key && ssh2key != SSH2_WRONG_PASSPHRASE) || ssh2blob)
731                 error = NULL;
732             else if (!error) {
733                 if (ssh2key == SSH2_WRONG_PASSPHRASE)
734                     error = "wrong passphrase";
735                 else
736                     error = "unknown error";
737             }
738             break;
739
740           case SSH_KEYTYPE_OPENSSH:
741           case SSH_KEYTYPE_SSHCOM:
742             ssh2key = import_ssh2(&infilename, intype, passphrase, &error);
743             if (ssh2key) {
744                 if (ssh2key != SSH2_WRONG_PASSPHRASE)
745                     error = NULL;
746                 else
747                     error = "wrong passphrase";
748             } else if (!error)
749                 error = "unknown error";
750             break;
751
752           default:
753             assert(0);
754         }
755
756         if (error) {
757             fprintf(stderr, "puttygen: error loading `%s': %s\n",
758                     infile, error);
759             return 1;
760         }
761     }
762
763     /*
764      * Change the comment if asked to.
765      */
766     if (comment) {
767         if (sshver == 1) {
768             assert(ssh1key);
769             sfree(ssh1key->comment);
770             ssh1key->comment = dupstr(comment);
771         } else {
772             assert(ssh2key);
773             sfree(ssh2key->comment);
774             ssh2key->comment = dupstr(comment);
775         }
776     }
777
778     /*
779      * Prompt for a new passphrase if we have been asked to, or if
780      * we have just generated a key.
781      */
782     if (change_passphrase || keytype != NOKEYGEN) {
783         char *passphrase2;
784
785         if (passphrase) {
786             memset(passphrase, 0, strlen(passphrase));
787             sfree(passphrase);
788         }
789
790         passphrase = snewn(512, char);
791         passphrase2 = snewn(512, char);
792         if (!console_get_line("Enter passphrase to save key: ",
793                               passphrase, 512, TRUE) ||
794             !console_get_line("Re-enter passphrase to verify: ",
795                               passphrase2, 512, TRUE)) {
796             perror("puttygen: unable to read new passphrase");
797             return 1;
798         }
799         if (strcmp(passphrase, passphrase2)) {
800             fprintf(stderr, "puttygen: passphrases do not match\n");
801             return 1;
802         }
803         memset(passphrase2, 0, strlen(passphrase2));
804         sfree(passphrase2);
805         if (!*passphrase) {
806             sfree(passphrase);
807             passphrase = NULL;
808         }
809     }
810
811     /*
812      * Write output.
813      * 
814      * (In the case where outfile and outfiletmp are both NULL,
815      * there is no semantic reason to initialise outfilename at
816      * all; but we have to write _something_ to it or some compiler
817      * will probably complain that it might be used uninitialised.)
818      */
819     if (outfiletmp)
820         outfilename = filename_from_str(outfiletmp);
821     else
822         outfilename = filename_from_str(outfile ? outfile : "");
823
824     switch (outtype) {
825         int ret;
826
827       case PRIVATE:
828         if (sshver == 1) {
829             assert(ssh1key);
830             ret = saversakey(&outfilename, ssh1key, passphrase);
831             if (!ret) {
832                 fprintf(stderr, "puttygen: unable to save SSH1 private key\n");
833                 return 1;
834             }
835         } else {
836             assert(ssh2key);
837             ret = ssh2_save_userkey(&outfilename, ssh2key, passphrase);
838             if (!ret) {
839                 fprintf(stderr, "puttygen: unable to save SSH2 private key\n");
840                 return 1;
841             }
842         }
843         if (outfiletmp) {
844             if (!move(outfiletmp, outfile))
845                 return 1;              /* rename failed */
846         }
847         break;
848
849       case PUBLIC:
850       case PUBLICO:
851         if (sshver == 1) {
852             FILE *fp;
853             char *dec1, *dec2;
854
855             assert(ssh1key);
856
857             if (outfile)
858                 fp = f_open(outfilename, "w");
859             else
860                 fp = stdout;
861             dec1 = bignum_decimal(ssh1key->exponent);
862             dec2 = bignum_decimal(ssh1key->modulus);
863             fprintf(fp, "%d %s %s %s\n", bignum_bitcount(ssh1key->modulus),
864                     dec1, dec2, ssh1key->comment);
865             sfree(dec1);
866             sfree(dec2);
867             if (outfile)
868                 fclose(fp);
869         } else if (outtype == PUBLIC) {
870             if (!ssh2blob) {
871                 assert(ssh2key);
872                 ssh2blob = ssh2key->alg->public_blob(ssh2key->data,
873                                                      &ssh2bloblen);
874             }
875             save_ssh2_pubkey(outfile, ssh2key ? ssh2key->comment : origcomment,
876                              ssh2blob, ssh2bloblen);
877         } else if (outtype == PUBLICO) {
878             char *buffer, *p;
879             int i;
880             FILE *fp;
881
882             if (!ssh2blob) {
883                 assert(ssh2key);
884                 ssh2blob = ssh2key->alg->public_blob(ssh2key->data,
885                                                      &ssh2bloblen);
886             }
887             if (!ssh2alg) {
888                 assert(ssh2key);
889                 ssh2alg = ssh2key->alg->name;
890             }
891             if (ssh2key)
892                 comment = ssh2key->comment;
893             else
894                 comment = origcomment;
895
896             buffer = snewn(strlen(ssh2alg) +
897                            4 * ((ssh2bloblen+2) / 3) +
898                            strlen(comment) + 3, char);
899             strcpy(buffer, ssh2alg);
900             p = buffer + strlen(buffer);
901             *p++ = ' ';
902             i = 0;
903             while (i < ssh2bloblen) {
904                 int n = (ssh2bloblen - i < 3 ? ssh2bloblen - i : 3);
905                 base64_encode_atom(ssh2blob + i, n, p);
906                 i += n;
907                 p += 4;
908             }
909             if (*comment) {
910                 *p++ = ' ';
911                 strcpy(p, comment);
912             } else
913                 *p++ = '\0';
914
915             if (outfile)
916                 fp = f_open(outfilename, "w");
917             else
918                 fp = stdout;
919             fprintf(fp, "%s\n", buffer);
920             if (outfile)
921                 fclose(fp);
922
923             sfree(buffer);
924         }
925         break;
926
927       case FP:
928         {
929             FILE *fp;
930             char *fingerprint;
931
932             if (sshver == 1) {
933                 assert(ssh1key);
934                 fingerprint = snewn(128, char);
935                 rsa_fingerprint(fingerprint, 128, ssh1key);
936             } else {
937                 if (ssh2key) {
938                     fingerprint = ssh2key->alg->fingerprint(ssh2key->data);
939                 } else {
940                     assert(ssh2blob);
941                     fingerprint = blobfp(ssh2alg, bits, ssh2blob, ssh2bloblen);
942                 }
943             }
944
945             if (outfile)
946                 fp = f_open(outfilename, "w");
947             else
948                 fp = stdout;
949             fprintf(fp, "%s\n", fingerprint);
950             if (outfile)
951                 fclose(fp);
952
953             sfree(fingerprint);
954         }
955         break;
956         
957       case OPENSSH:
958       case SSHCOM:
959         assert(sshver == 2);
960         assert(ssh2key);
961         ret = export_ssh2(&outfilename, outtype, ssh2key, passphrase);
962         if (!ret) {
963             fprintf(stderr, "puttygen: unable to export key\n");
964             return 1;
965         }
966         if (outfiletmp) {
967             if (!move(outfiletmp, outfile))
968                 return 1;              /* rename failed */
969         }
970         break;
971     }
972
973     if (passphrase) {
974         memset(passphrase, 0, strlen(passphrase));
975         sfree(passphrase);
976     }
977
978     if (ssh1key)
979         freersakey(ssh1key);
980     if (ssh2key) {
981         ssh2key->alg->freekey(ssh2key->data);
982         sfree(ssh2key);
983     }
984
985     return 0;
986 }
987
988 #ifdef TEST_CMDGEN
989
990 #undef main
991
992 #include <stdarg.h>
993
994 int passes, fails;
995
996 void setup_passphrases(char *first, ...)
997 {
998     va_list ap;
999     char *next;
1000
1001     nprompts = 0;
1002     if (first) {
1003         prompts[nprompts++] = first;
1004         va_start(ap, first);
1005         while ((next = va_arg(ap, char *)) != NULL) {
1006             assert(nprompts < lenof(prompts));
1007             prompts[nprompts++] = next;
1008         }
1009         va_end(ap);
1010     }
1011 }
1012
1013 void test(int retval, ...)
1014 {
1015     va_list ap;
1016     int i, argc, ret;
1017     char **argv;
1018
1019     argc = 0;
1020     va_start(ap, retval);
1021     while (va_arg(ap, char *) != NULL)
1022         argc++;
1023     va_end(ap);
1024
1025     argv = snewn(argc+1, char *);
1026     va_start(ap, retval);
1027     for (i = 0; i <= argc; i++)
1028         argv[i] = va_arg(ap, char *);
1029     va_end(ap);
1030
1031     promptsgot = 0;
1032     ret = cmdgen_main(argc, argv);
1033
1034     if (ret != retval) {
1035         printf("FAILED retval (exp %d got %d):", retval, ret);
1036         for (i = 0; i < argc; i++)
1037             printf(" %s", argv[i]);
1038         printf("\n");
1039         fails++;
1040     } else if (promptsgot != nprompts) {
1041         printf("FAILED nprompts (exp %d got %d):", nprompts, promptsgot);
1042         for (i = 0; i < argc; i++)
1043             printf(" %s", argv[i]);
1044         printf("\n");
1045         fails++;
1046     } else {
1047         passes++;
1048     }
1049 }
1050
1051 void filecmp(char *file1, char *file2, char *fmt, ...)
1052 {
1053     /*
1054      * Ideally I should do file comparison myself, to maximise the
1055      * portability of this test suite once this application begins
1056      * running on non-Unix platforms. For the moment, though,
1057      * calling Unix diff is perfectly adequate.
1058      */
1059     char *buf;
1060     int ret;
1061
1062     buf = dupprintf("diff -q '%s' '%s'", file1, file2);
1063     ret = system(buf);
1064     sfree(buf);
1065
1066     if (ret) {
1067         va_list ap;
1068
1069         printf("FAILED diff (ret=%d): ", ret);
1070
1071         va_start(ap, fmt);
1072         vprintf(fmt, ap);
1073         va_end(ap);
1074
1075         printf("\n");
1076
1077         fails++;
1078     } else
1079         passes++;
1080 }
1081
1082 char *cleanup_fp(char *s)
1083 {
1084     char *p;
1085
1086     if (!strncmp(s, "ssh-", 4)) {
1087         s += strcspn(s, " \n\t");
1088         s += strspn(s, " \n\t");
1089     }
1090
1091     p = s;
1092     s += strcspn(s, " \n\t");
1093     s += strspn(s, " \n\t");
1094     s += strcspn(s, " \n\t");
1095
1096     return dupprintf("%.*s", s - p, p);
1097 }
1098
1099 char *get_fp(char *filename)
1100 {
1101     FILE *fp;
1102     char buf[256], *ret;
1103
1104     fp = fopen(filename, "r");
1105     if (!fp)
1106         return NULL;
1107     ret = fgets(buf, sizeof(buf), fp);
1108     fclose(fp);
1109     if (!ret)
1110         return NULL;
1111     return cleanup_fp(buf);
1112 }
1113
1114 void check_fp(char *filename, char *fp, char *fmt, ...)
1115 {
1116     char *newfp;
1117
1118     if (!fp)
1119         return;
1120
1121     newfp = get_fp(filename);
1122
1123     if (!strcmp(fp, newfp)) {
1124         passes++;
1125     } else {
1126         va_list ap;
1127
1128         printf("FAILED check_fp ['%s' != '%s']: ", newfp, fp);
1129
1130         va_start(ap, fmt);
1131         vprintf(fmt, ap);
1132         va_end(ap);
1133
1134         printf("\n");
1135
1136         fails++;
1137     }
1138
1139     sfree(newfp);
1140 }
1141
1142 int main(int argc, char **argv)
1143 {
1144     int i;
1145     static char *const keytypes[] = { "rsa1", "dsa", "rsa" };
1146
1147     /*
1148      * Even when this thing is compiled for automatic test mode,
1149      * it's helpful to be able to invoke it with command-line
1150      * options for _manual_ tests.
1151      */
1152     if (argc > 1)
1153         return cmdgen_main(argc, argv);
1154
1155     passes = fails = 0;
1156
1157     for (i = 0; i < lenof(keytypes); i++) {
1158         char filename[128], osfilename[128], scfilename[128];
1159         char pubfilename[128], tmpfilename1[128], tmpfilename2[128];
1160         char *fp;
1161
1162         sprintf(filename, "test-%s.ppk", keytypes[i]);
1163         sprintf(pubfilename, "test-%s.pub", keytypes[i]);
1164         sprintf(osfilename, "test-%s.os", keytypes[i]);
1165         sprintf(scfilename, "test-%s.sc", keytypes[i]);
1166         sprintf(tmpfilename1, "test-%s.tmp1", keytypes[i]);
1167         sprintf(tmpfilename2, "test-%s.tmp2", keytypes[i]);
1168
1169         /*
1170          * Create an encrypted key.
1171          */
1172         setup_passphrases("sponge", "sponge", NULL);
1173         test(0, "puttygen", "-t", keytypes[i], "-o", filename, NULL);
1174
1175         /*
1176          * List the public key in OpenSSH format.
1177          */
1178         setup_passphrases(NULL);
1179         test(0, "puttygen", "-L", filename, "-o", pubfilename, NULL);
1180         {
1181             char cmdbuf[256];
1182             fp = NULL;
1183             sprintf(cmdbuf, "ssh-keygen -l -f '%s' > '%s'",
1184                     pubfilename, tmpfilename1);
1185             if (system(cmdbuf) ||
1186                 (fp = get_fp(tmpfilename1)) == NULL) {
1187                 printf("UNABLE to test fingerprint matching against OpenSSH");
1188             }
1189         }
1190
1191         /*
1192          * List the public key in IETF/ssh.com format.
1193          */
1194         setup_passphrases(NULL);
1195         test(0, "puttygen", "-p", filename, NULL);
1196
1197         /*
1198          * List the fingerprint of the key.
1199          */
1200         setup_passphrases(NULL);
1201         test(0, "puttygen", "-l", filename, "-o", tmpfilename1, NULL);
1202         if (!fp) {
1203             /*
1204              * If we can't test fingerprints against OpenSSH, we
1205              * can at the very least test equality of all the
1206              * fingerprints we generate of this key throughout
1207              * testing.
1208              */
1209             fp = get_fp(tmpfilename1);
1210         } else {
1211             check_fp(tmpfilename1, fp, "%s initial fp", keytypes[i]);
1212         }
1213
1214         /*
1215          * Change the comment of the key; this _does_ require a
1216          * passphrase owing to the tamperproofing.
1217          * 
1218          * NOTE: In SSH1, this only requires a passphrase because
1219          * of inadequacies of the loading and saving mechanisms. In
1220          * _principle_, it should be perfectly possible to modify
1221          * the comment on an SSH1 key without requiring a
1222          * passphrase; the only reason I can't do it is because my
1223          * loading and saving mechanisms don't include a method of
1224          * loading all the key data without also trying to decrypt
1225          * the private section.
1226          * 
1227          * I don't consider this to be a problem worth solving,
1228          * because (a) to fix it would probably end up bloating
1229          * PuTTY proper, and (b) SSH1 is on the way out anyway so
1230          * it shouldn't be highly significant. If it seriously
1231          * bothers anyone then perhaps I _might_ be persuadable.
1232          */
1233         setup_passphrases("sponge", NULL);
1234         test(0, "puttygen", "-C", "new-comment", filename, NULL);
1235
1236         /*
1237          * Change the passphrase to nothing.
1238          */
1239         setup_passphrases("sponge", "", "", NULL);
1240         test(0, "puttygen", "-P", filename, NULL);
1241
1242         /*
1243          * Change the comment of the key again; this time we expect no
1244          * passphrase to be required.
1245          */
1246         setup_passphrases(NULL);
1247         test(0, "puttygen", "-C", "new-comment-2", filename, NULL);
1248
1249         /*
1250          * Export the private key into OpenSSH format; no passphrase
1251          * should be required since the key is currently unencrypted.
1252          * For RSA1 keys, this should give an error.
1253          */
1254         setup_passphrases(NULL);
1255         test((i==0), "puttygen", "-O", "private-openssh", "-o", osfilename,
1256              filename, NULL);
1257
1258         if (i) {
1259             /*
1260              * List the fingerprint of the OpenSSH-formatted key.
1261              */
1262             setup_passphrases(NULL);
1263             test(0, "puttygen", "-l", osfilename, "-o", tmpfilename1, NULL);
1264             check_fp(tmpfilename1, fp, "%s openssh clear fp", keytypes[i]);
1265
1266             /*
1267              * List the public half of the OpenSSH-formatted key in
1268              * OpenSSH format.
1269              */
1270             setup_passphrases(NULL);
1271             test(0, "puttygen", "-L", osfilename, NULL);
1272
1273             /*
1274              * List the public half of the OpenSSH-formatted key in
1275              * IETF/ssh.com format.
1276              */
1277             setup_passphrases(NULL);
1278             test(0, "puttygen", "-p", osfilename, NULL);
1279         }
1280
1281         /*
1282          * Export the private key into ssh.com format; no passphrase
1283          * should be required since the key is currently unencrypted.
1284          * For RSA1 keys, this should give an error.
1285          */
1286         setup_passphrases(NULL);
1287         test((i==0), "puttygen", "-O", "private-sshcom", "-o", scfilename,
1288              filename, NULL);
1289
1290         if (i) {
1291             /*
1292              * List the fingerprint of the ssh.com-formatted key.
1293              */
1294             setup_passphrases(NULL);
1295             test(0, "puttygen", "-l", scfilename, "-o", tmpfilename1, NULL);
1296             check_fp(tmpfilename1, fp, "%s ssh.com clear fp", keytypes[i]);
1297
1298             /*
1299              * List the public half of the ssh.com-formatted key in
1300              * OpenSSH format.
1301              */
1302             setup_passphrases(NULL);
1303             test(0, "puttygen", "-L", scfilename, NULL);
1304
1305             /*
1306              * List the public half of the ssh.com-formatted key in
1307              * IETF/ssh.com format.
1308              */
1309             setup_passphrases(NULL);
1310             test(0, "puttygen", "-p", scfilename, NULL);
1311         }
1312
1313         if (i) {
1314             /*
1315              * Convert from OpenSSH into ssh.com.
1316              */
1317             setup_passphrases(NULL);
1318             test(0, "puttygen", osfilename, "-o", tmpfilename1,
1319                  "-O", "private-sshcom", NULL);
1320
1321             /*
1322              * Convert from ssh.com back into a PuTTY key,
1323              * supplying the same comment as we had before we
1324              * started to ensure the comparison works.
1325              */
1326             setup_passphrases(NULL);
1327             test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
1328                  "-o", tmpfilename2, NULL);
1329
1330             /*
1331              * See if the PuTTY key thus generated is the same as
1332              * the original.
1333              */
1334             filecmp(filename, tmpfilename2,
1335                     "p->o->s->p clear %s", keytypes[i]);
1336
1337             /*
1338              * Convert from ssh.com to OpenSSH.
1339              */
1340             setup_passphrases(NULL);
1341             test(0, "puttygen", scfilename, "-o", tmpfilename1,
1342                  "-O", "private-openssh", NULL);
1343
1344             /*
1345              * Convert from OpenSSH back into a PuTTY key,
1346              * supplying the same comment as we had before we
1347              * started to ensure the comparison works.
1348              */
1349             setup_passphrases(NULL);
1350             test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
1351                  "-o", tmpfilename2, NULL);
1352
1353             /*
1354              * See if the PuTTY key thus generated is the same as
1355              * the original.
1356              */
1357             filecmp(filename, tmpfilename2,
1358                     "p->s->o->p clear %s", keytypes[i]);
1359
1360             /*
1361              * Finally, do a round-trip conversion between PuTTY
1362              * and ssh.com without involving OpenSSH, to test that
1363              * the key comment is preserved in that case.
1364              */
1365             setup_passphrases(NULL);
1366             test(0, "puttygen", "-O", "private-sshcom", "-o", tmpfilename1,
1367                  filename, NULL);
1368             setup_passphrases(NULL);
1369             test(0, "puttygen", tmpfilename1, "-o", tmpfilename2, NULL);
1370             filecmp(filename, tmpfilename2,
1371                     "p->s->p clear %s", keytypes[i]);
1372         }
1373
1374         /*
1375          * Check that mismatched passphrases cause an error.
1376          */
1377         setup_passphrases("sponge2", "sponge3", NULL);
1378         test(1, "puttygen", "-P", filename, NULL);
1379
1380         /*
1381          * Put a passphrase back on.
1382          */
1383         setup_passphrases("sponge2", "sponge2", NULL);
1384         test(0, "puttygen", "-P", filename, NULL);
1385
1386         /*
1387          * Export the private key into OpenSSH format, this time
1388          * while encrypted. For RSA1 keys, this should give an
1389          * error.
1390          */
1391         if (i == 0)
1392             setup_passphrases(NULL);   /* error, hence no passphrase read */
1393         else
1394             setup_passphrases("sponge2", NULL);
1395         test((i==0), "puttygen", "-O", "private-openssh", "-o", osfilename,
1396              filename, NULL);
1397
1398         if (i) {
1399             /*
1400              * List the fingerprint of the OpenSSH-formatted key.
1401              */
1402             setup_passphrases("sponge2", NULL);
1403             test(0, "puttygen", "-l", osfilename, "-o", tmpfilename1, NULL);
1404             check_fp(tmpfilename1, fp, "%s openssh encrypted fp", keytypes[i]);
1405
1406             /*
1407              * List the public half of the OpenSSH-formatted key in
1408              * OpenSSH format.
1409              */
1410             setup_passphrases("sponge2", NULL);
1411             test(0, "puttygen", "-L", osfilename, NULL);
1412
1413             /*
1414              * List the public half of the OpenSSH-formatted key in
1415              * IETF/ssh.com format.
1416              */
1417             setup_passphrases("sponge2", NULL);
1418             test(0, "puttygen", "-p", osfilename, NULL);
1419         }
1420
1421         /*
1422          * Export the private key into ssh.com format, this time
1423          * while encrypted. For RSA1 keys, this should give an
1424          * error.
1425          */
1426         if (i == 0)
1427             setup_passphrases(NULL);   /* error, hence no passphrase read */
1428         else
1429             setup_passphrases("sponge2", NULL);
1430         test((i==0), "puttygen", "-O", "private-sshcom", "-o", scfilename,
1431              filename, NULL);
1432
1433         if (i) {
1434             /*
1435              * List the fingerprint of the ssh.com-formatted key.
1436              */
1437             setup_passphrases("sponge2", NULL);
1438             test(0, "puttygen", "-l", scfilename, "-o", tmpfilename1, NULL);
1439             check_fp(tmpfilename1, fp, "%s ssh.com encrypted fp", keytypes[i]);
1440
1441             /*
1442              * List the public half of the ssh.com-formatted key in
1443              * OpenSSH format.
1444              */
1445             setup_passphrases("sponge2", NULL);
1446             test(0, "puttygen", "-L", scfilename, NULL);
1447
1448             /*
1449              * List the public half of the ssh.com-formatted key in
1450              * IETF/ssh.com format.
1451              */
1452             setup_passphrases("sponge2", NULL);
1453             test(0, "puttygen", "-p", scfilename, NULL);
1454         }
1455
1456         if (i) {
1457             /*
1458              * Convert from OpenSSH into ssh.com.
1459              */
1460             setup_passphrases("sponge2", NULL);
1461             test(0, "puttygen", osfilename, "-o", tmpfilename1,
1462                  "-O", "private-sshcom", NULL);
1463
1464             /*
1465              * Convert from ssh.com back into a PuTTY key,
1466              * supplying the same comment as we had before we
1467              * started to ensure the comparison works.
1468              */
1469             setup_passphrases("sponge2", NULL);
1470             test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
1471                  "-o", tmpfilename2, NULL);
1472
1473             /*
1474              * See if the PuTTY key thus generated is the same as
1475              * the original.
1476              */
1477             filecmp(filename, tmpfilename2,
1478                     "p->o->s->p encrypted %s", keytypes[i]);
1479
1480             /*
1481              * Convert from ssh.com to OpenSSH.
1482              */
1483             setup_passphrases("sponge2", NULL);
1484             test(0, "puttygen", scfilename, "-o", tmpfilename1,
1485                  "-O", "private-openssh", NULL);
1486
1487             /*
1488              * Convert from OpenSSH back into a PuTTY key,
1489              * supplying the same comment as we had before we
1490              * started to ensure the comparison works.
1491              */
1492             setup_passphrases("sponge2", NULL);
1493             test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
1494                  "-o", tmpfilename2, NULL);
1495
1496             /*
1497              * See if the PuTTY key thus generated is the same as
1498              * the original.
1499              */
1500             filecmp(filename, tmpfilename2,
1501                     "p->s->o->p encrypted %s", keytypes[i]);
1502
1503             /*
1504              * Finally, do a round-trip conversion between PuTTY
1505              * and ssh.com without involving OpenSSH, to test that
1506              * the key comment is preserved in that case.
1507              */
1508             setup_passphrases("sponge2", NULL);
1509             test(0, "puttygen", "-O", "private-sshcom", "-o", tmpfilename1,
1510                  filename, NULL);
1511             setup_passphrases("sponge2", NULL);
1512             test(0, "puttygen", tmpfilename1, "-o", tmpfilename2, NULL);
1513             filecmp(filename, tmpfilename2,
1514                     "p->s->p encrypted %s", keytypes[i]);
1515         }
1516
1517         /*
1518          * Load with the wrong passphrase.
1519          */
1520         setup_passphrases("sponge8", NULL);
1521         test(1, "puttygen", "-C", "spurious-new-comment", filename, NULL);
1522
1523         /*
1524          * Load a totally bogus file.
1525          */
1526         setup_passphrases(NULL);
1527         test(1, "puttygen", "-C", "spurious-new-comment", pubfilename, NULL);
1528     }
1529     printf("%d passes, %d fails\n", passes, fails);
1530     return 0;
1531 }
1532
1533 #endif