]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - cmdgen.c
Briefly document the "special commands" menu.
[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         time_t t;
606         struct tm *tm;
607         struct progress prog;
608
609         prog.phase = -1;
610         prog.current = -1;
611
612         time(&t);
613         tm = localtime(&t);
614         if (keytype == DSA)
615             strftime(default_comment, 30, "dsa-key-%Y%m%d", tm);
616         else
617             strftime(default_comment, 30, "rsa-key-%Y%m%d", tm);
618
619         random_init();
620         entropy = get_random_data(bits / 8);
621         random_add_heavynoise(entropy, bits / 8);
622         memset(entropy, 0, bits/8);
623         sfree(entropy);
624
625         if (keytype == DSA) {
626             struct dss_key *dsskey = snew(struct dss_key);
627             dsa_generate(dsskey, bits, progressfn, &prog);
628             ssh2key = snew(struct ssh2_userkey);
629             ssh2key->data = dsskey;
630             ssh2key->alg = &ssh_dss;
631             ssh1key = NULL;
632         } else {
633             struct RSAKey *rsakey = snew(struct RSAKey);
634             rsa_generate(rsakey, bits, progressfn, &prog);
635             rsakey->comment = NULL;
636             if (keytype == RSA1) {
637                 ssh1key = rsakey;
638             } else {
639                 ssh2key = snew(struct ssh2_userkey);
640                 ssh2key->data = rsakey;
641                 ssh2key->alg = &ssh_rsa;
642             }
643         }
644         progressfn(&prog, PROGFN_PROGRESS, INT_MAX, -1);
645
646         if (ssh2key)
647             ssh2key->comment = dupstr(default_comment);
648         if (ssh1key)
649             ssh1key->comment = dupstr(default_comment);
650
651     } else {
652         const char *error = NULL;
653         int encrypted;
654
655         assert(infile != NULL);
656
657         /*
658          * Find out whether the input key is encrypted.
659          */
660         if (intype == SSH_KEYTYPE_SSH1)
661             encrypted = rsakey_encrypted(&infilename, &origcomment);
662         else if (intype == SSH_KEYTYPE_SSH2)
663             encrypted = ssh2_userkey_encrypted(&infilename, &origcomment);
664         else
665             encrypted = import_encrypted(&infilename, intype, &origcomment);
666
667         /*
668          * If so, ask for a passphrase.
669          */
670         if (encrypted && load_encrypted) {
671             passphrase = snewn(512, char);
672             if (!console_get_line("Enter passphrase to load key: ",
673                                   passphrase, 512, TRUE)) {
674                 perror("puttygen: unable to read passphrase");
675                 return 1;
676             }
677         } else {
678             passphrase = NULL;
679         }
680
681         switch (intype) {
682             int ret;
683
684           case SSH_KEYTYPE_SSH1:
685             ssh1key = snew(struct RSAKey);
686             if (!load_encrypted) {
687                 void *vblob;
688                 char *blob;
689                 int n, bloblen;
690
691                 ret = rsakey_pubblob(&infilename, &vblob, &bloblen, &error);
692                 blob = (char *)vblob;
693
694                 n = 4;                 /* skip modulus bits */
695                 n += ssh1_read_bignum(blob + n, &ssh1key->exponent);
696                 n += ssh1_read_bignum(blob + n, &ssh1key->modulus);
697                 ssh1key->comment = NULL;
698                 ssh1key->private_exponent = NULL;
699             } else {
700                 ret = loadrsakey(&infilename, ssh1key, passphrase, &error);
701             }
702             if (ret > 0)
703                 error = NULL;
704             else if (!error)
705                 error = "unknown error";
706             break;
707
708           case SSH_KEYTYPE_SSH2:
709             if (!load_encrypted) {
710                 ssh2blob = ssh2_userkey_loadpub(&infilename, &ssh2alg,
711                                                 &ssh2bloblen, &error);
712                 ssh2algf = find_pubkey_alg(ssh2alg);
713                 if (ssh2algf)
714                     bits = ssh2algf->pubkey_bits(ssh2blob, ssh2bloblen);
715                 else
716                     bits = -1;
717             } else {
718                 ssh2key = ssh2_load_userkey(&infilename, passphrase, &error);
719             }
720             if ((ssh2key && ssh2key != SSH2_WRONG_PASSPHRASE) || ssh2blob)
721                 error = NULL;
722             else if (!error) {
723                 if (ssh2key == SSH2_WRONG_PASSPHRASE)
724                     error = "wrong passphrase";
725                 else
726                     error = "unknown error";
727             }
728             break;
729
730           case SSH_KEYTYPE_OPENSSH:
731           case SSH_KEYTYPE_SSHCOM:
732             ssh2key = import_ssh2(&infilename, intype, passphrase);
733             if (ssh2key)
734                 error = NULL;
735             else if (!error) {
736                 if (ssh2key == SSH2_WRONG_PASSPHRASE)
737                     error = "wrong passphrase";
738                 else
739                     error = "unknown error";
740             }
741             break;
742
743           default:
744             assert(0);
745         }
746
747         if (error) {
748             fprintf(stderr, "puttygen: error loading `%s': %s\n",
749                     infile, error);
750             return 1;
751         }
752     }
753
754     /*
755      * Change the comment if asked to.
756      */
757     if (comment) {
758         if (sshver == 1) {
759             assert(ssh1key);
760             sfree(ssh1key->comment);
761             ssh1key->comment = dupstr(comment);
762         } else {
763             assert(ssh2key);
764             sfree(ssh2key->comment);
765             ssh2key->comment = dupstr(comment);
766         }
767     }
768
769     /*
770      * Prompt for a new passphrase if we have been asked to, or if
771      * we have just generated a key.
772      */
773     if (change_passphrase || keytype != NOKEYGEN) {
774         char *passphrase2;
775
776         if (passphrase) {
777             memset(passphrase, 0, strlen(passphrase));
778             sfree(passphrase);
779         }
780
781         passphrase = snewn(512, char);
782         passphrase2 = snewn(512, char);
783         if (!console_get_line("Enter passphrase to save key: ",
784                               passphrase, 512, TRUE) ||
785             !console_get_line("Re-enter passphrase to verify: ",
786                               passphrase2, 512, TRUE)) {
787             perror("puttygen: unable to read new passphrase");
788             return 1;
789         }
790         if (strcmp(passphrase, passphrase2)) {
791             fprintf(stderr, "puttygen: passphrases do not match\n");
792             return 1;
793         }
794         memset(passphrase2, 0, strlen(passphrase2));
795         sfree(passphrase2);
796         if (!*passphrase) {
797             sfree(passphrase);
798             passphrase = NULL;
799         }
800     }
801
802     /*
803      * Write output.
804      * 
805      * (In the case where outfile and outfiletmp are both NULL,
806      * there is no semantic reason to initialise outfilename at
807      * all; but we have to write _something_ to it or some compiler
808      * will probably complain that it might be used uninitialised.)
809      */
810     if (outfiletmp)
811         outfilename = filename_from_str(outfiletmp);
812     else
813         outfilename = filename_from_str(outfile ? outfile : "");
814
815     switch (outtype) {
816         int ret;
817
818       case PRIVATE:
819         if (sshver == 1) {
820             assert(ssh1key);
821             ret = saversakey(&outfilename, ssh1key, passphrase);
822             if (!ret) {
823                 fprintf(stderr, "puttygen: unable to save SSH1 private key\n");
824                 return 1;
825             }
826         } else {
827             assert(ssh2key);
828             ret = ssh2_save_userkey(&outfilename, ssh2key, passphrase);
829             if (!ret) {
830                 fprintf(stderr, "puttygen: unable to save SSH2 private key\n");
831                 return 1;
832             }
833         }
834         if (outfiletmp) {
835             if (!move(outfiletmp, outfile))
836                 return 1;              /* rename failed */
837         }
838         break;
839
840       case PUBLIC:
841       case PUBLICO:
842         if (sshver == 1) {
843             FILE *fp;
844             char *dec1, *dec2;
845
846             assert(ssh1key);
847
848             if (outfile)
849                 fp = f_open(outfilename, "w");
850             else
851                 fp = stdout;
852             dec1 = bignum_decimal(ssh1key->exponent);
853             dec2 = bignum_decimal(ssh1key->modulus);
854             fprintf(fp, "%d %s %s %s\n", bignum_bitcount(ssh1key->modulus),
855                     dec1, dec2, ssh1key->comment);
856             sfree(dec1);
857             sfree(dec2);
858             if (outfile)
859                 fclose(fp);
860         } else if (outtype == PUBLIC) {
861             if (!ssh2blob) {
862                 assert(ssh2key);
863                 ssh2blob = ssh2key->alg->public_blob(ssh2key->data,
864                                                      &ssh2bloblen);
865             }
866             save_ssh2_pubkey(outfile, ssh2key ? ssh2key->comment : origcomment,
867                              ssh2blob, ssh2bloblen);
868         } else if (outtype == PUBLICO) {
869             char *buffer, *p;
870             int i;
871             FILE *fp;
872
873             if (!ssh2blob) {
874                 assert(ssh2key);
875                 ssh2blob = ssh2key->alg->public_blob(ssh2key->data,
876                                                      &ssh2bloblen);
877             }
878             if (!ssh2alg) {
879                 assert(ssh2key);
880                 ssh2alg = ssh2key->alg->name;
881             }
882             if (ssh2key)
883                 comment = ssh2key->comment;
884             else
885                 comment = origcomment;
886
887             buffer = snewn(strlen(ssh2alg) +
888                            4 * ((ssh2bloblen+2) / 3) +
889                            strlen(comment) + 3, char);
890             strcpy(buffer, ssh2alg);
891             p = buffer + strlen(buffer);
892             *p++ = ' ';
893             i = 0;
894             while (i < ssh2bloblen) {
895                 int n = (ssh2bloblen - i < 3 ? ssh2bloblen - i : 3);
896                 base64_encode_atom(ssh2blob + i, n, p);
897                 i += n;
898                 p += 4;
899             }
900             if (*comment) {
901                 *p++ = ' ';
902                 strcpy(p, comment);
903             } else
904                 *p++ = '\0';
905
906             if (outfile)
907                 fp = f_open(outfilename, "w");
908             else
909                 fp = stdout;
910             fprintf(fp, "%s\n", buffer);
911             if (outfile)
912                 fclose(fp);
913
914             sfree(buffer);
915         }
916         break;
917
918       case FP:
919         {
920             FILE *fp;
921             char *fingerprint;
922
923             if (sshver == 1) {
924                 assert(ssh1key);
925                 fingerprint = snewn(128, char);
926                 rsa_fingerprint(fingerprint, 128, ssh1key);
927             } else {
928                 if (ssh2key) {
929                     fingerprint = ssh2key->alg->fingerprint(ssh2key->data);
930                 } else {
931                     assert(ssh2blob);
932                     fingerprint = blobfp(ssh2alg, bits, ssh2blob, ssh2bloblen);
933                 }
934             }
935
936             if (outfile)
937                 fp = f_open(outfilename, "w");
938             else
939                 fp = stdout;
940             fprintf(fp, "%s\n", fingerprint);
941             if (outfile)
942                 fclose(fp);
943
944             sfree(fingerprint);
945         }
946         break;
947         
948       case OPENSSH:
949       case SSHCOM:
950         assert(sshver == 2);
951         assert(ssh2key);
952         ret = export_ssh2(&outfilename, outtype, ssh2key, passphrase);
953         if (!ret) {
954             fprintf(stderr, "puttygen: unable to export key\n");
955             return 1;
956         }
957         if (outfiletmp) {
958             if (!move(outfiletmp, outfile))
959                 return 1;              /* rename failed */
960         }
961         break;
962     }
963
964     if (passphrase) {
965         memset(passphrase, 0, strlen(passphrase));
966         sfree(passphrase);
967     }
968
969     if (ssh1key)
970         freersakey(ssh1key);
971     if (ssh2key) {
972         ssh2key->alg->freekey(ssh2key->data);
973         sfree(ssh2key);
974     }
975
976     return 0;
977 }
978
979 #ifdef TEST_CMDGEN
980
981 #undef main
982
983 #include <stdarg.h>
984
985 int passes, fails;
986
987 void setup_passphrases(char *first, ...)
988 {
989     va_list ap;
990     char *next;
991
992     nprompts = 0;
993     if (first) {
994         prompts[nprompts++] = first;
995         va_start(ap, first);
996         while ((next = va_arg(ap, char *)) != NULL) {
997             assert(nprompts < lenof(prompts));
998             prompts[nprompts++] = next;
999         }
1000         va_end(ap);
1001     }
1002 }
1003
1004 void test(int retval, ...)
1005 {
1006     va_list ap;
1007     int i, argc, ret;
1008     char **argv;
1009
1010     argc = 0;
1011     va_start(ap, retval);
1012     while (va_arg(ap, char *) != NULL)
1013         argc++;
1014     va_end(ap);
1015
1016     argv = snewn(argc+1, char *);
1017     va_start(ap, retval);
1018     for (i = 0; i <= argc; i++)
1019         argv[i] = va_arg(ap, char *);
1020     va_end(ap);
1021
1022     promptsgot = 0;
1023     ret = cmdgen_main(argc, argv);
1024
1025     if (ret != retval) {
1026         printf("FAILED retval (exp %d got %d):", retval, ret);
1027         for (i = 0; i < argc; i++)
1028             printf(" %s", argv[i]);
1029         printf("\n");
1030         fails++;
1031     } else if (promptsgot != nprompts) {
1032         printf("FAILED nprompts (exp %d got %d):", nprompts, promptsgot);
1033         for (i = 0; i < argc; i++)
1034             printf(" %s", argv[i]);
1035         printf("\n");
1036         fails++;
1037     } else {
1038         passes++;
1039     }
1040 }
1041
1042 void filecmp(char *file1, char *file2, char *fmt, ...)
1043 {
1044     /*
1045      * Ideally I should do file comparison myself, to maximise the
1046      * portability of this test suite once this application begins
1047      * running on non-Unix platforms. For the moment, though,
1048      * calling Unix diff is perfectly adequate.
1049      */
1050     char *buf;
1051     int ret;
1052
1053     buf = dupprintf("diff -q '%s' '%s'", file1, file2);
1054     ret = system(buf);
1055     sfree(buf);
1056
1057     if (ret) {
1058         va_list ap;
1059
1060         printf("FAILED diff (ret=%d): ", ret);
1061
1062         va_start(ap, fmt);
1063         vprintf(fmt, ap);
1064         va_end(ap);
1065
1066         printf("\n");
1067
1068         fails++;
1069     } else
1070         passes++;
1071 }
1072
1073 char *cleanup_fp(char *s)
1074 {
1075     char *p;
1076
1077     if (!strncmp(s, "ssh-", 4)) {
1078         s += strcspn(s, " \n\t");
1079         s += strspn(s, " \n\t");
1080     }
1081
1082     p = s;
1083     s += strcspn(s, " \n\t");
1084     s += strspn(s, " \n\t");
1085     s += strcspn(s, " \n\t");
1086
1087     return dupprintf("%.*s", s - p, p);
1088 }
1089
1090 char *get_fp(char *filename)
1091 {
1092     FILE *fp;
1093     char buf[256], *ret;
1094
1095     fp = fopen(filename, "r");
1096     if (!fp)
1097         return NULL;
1098     ret = fgets(buf, sizeof(buf), fp);
1099     fclose(fp);
1100     if (!ret)
1101         return NULL;
1102     return cleanup_fp(buf);
1103 }
1104
1105 void check_fp(char *filename, char *fp, char *fmt, ...)
1106 {
1107     char *newfp;
1108
1109     if (!fp)
1110         return;
1111
1112     newfp = get_fp(filename);
1113
1114     if (!strcmp(fp, newfp)) {
1115         passes++;
1116     } else {
1117         va_list ap;
1118
1119         printf("FAILED check_fp ['%s' != '%s']: ", newfp, fp);
1120
1121         va_start(ap, fmt);
1122         vprintf(fmt, ap);
1123         va_end(ap);
1124
1125         printf("\n");
1126
1127         fails++;
1128     }
1129
1130     sfree(newfp);
1131 }
1132
1133 int main(int argc, char **argv)
1134 {
1135     int i;
1136     static char *const keytypes[] = { "rsa1", "dsa", "rsa" };
1137
1138     /*
1139      * Even when this thing is compiled for automatic test mode,
1140      * it's helpful to be able to invoke it with command-line
1141      * options for _manual_ tests.
1142      */
1143     if (argc > 1)
1144         return cmdgen_main(argc, argv);
1145
1146     passes = fails = 0;
1147
1148     for (i = 0; i < lenof(keytypes); i++) {
1149         char filename[128], osfilename[128], scfilename[128];
1150         char pubfilename[128], tmpfilename1[128], tmpfilename2[128];
1151         char *fp;
1152
1153         sprintf(filename, "test-%s.ppk", keytypes[i]);
1154         sprintf(pubfilename, "test-%s.pub", keytypes[i]);
1155         sprintf(osfilename, "test-%s.os", keytypes[i]);
1156         sprintf(scfilename, "test-%s.sc", keytypes[i]);
1157         sprintf(tmpfilename1, "test-%s.tmp1", keytypes[i]);
1158         sprintf(tmpfilename2, "test-%s.tmp2", keytypes[i]);
1159
1160         /*
1161          * Create an encrypted key.
1162          */
1163         setup_passphrases("sponge", "sponge", NULL);
1164         test(0, "puttygen", "-t", keytypes[i], "-o", filename, NULL);
1165
1166         /*
1167          * List the public key in OpenSSH format.
1168          */
1169         setup_passphrases(NULL);
1170         test(0, "puttygen", "-L", filename, "-o", pubfilename, NULL);
1171         {
1172             char cmdbuf[256];
1173             fp = NULL;
1174             sprintf(cmdbuf, "ssh-keygen -l -f '%s' > '%s'",
1175                     pubfilename, tmpfilename1);
1176             if (system(cmdbuf) ||
1177                 (fp = get_fp(tmpfilename1)) == NULL) {
1178                 printf("UNABLE to test fingerprint matching against OpenSSH");
1179             }
1180         }
1181
1182         /*
1183          * List the public key in IETF/ssh.com format.
1184          */
1185         setup_passphrases(NULL);
1186         test(0, "puttygen", "-p", filename, NULL);
1187
1188         /*
1189          * List the fingerprint of the key.
1190          */
1191         setup_passphrases(NULL);
1192         test(0, "puttygen", "-l", filename, "-o", tmpfilename1, NULL);
1193         if (!fp) {
1194             /*
1195              * If we can't test fingerprints against OpenSSH, we
1196              * can at the very least test equality of all the
1197              * fingerprints we generate of this key throughout
1198              * testing.
1199              */
1200             fp = get_fp(tmpfilename1);
1201         } else {
1202             check_fp(tmpfilename1, fp, "%s initial fp", keytypes[i]);
1203         }
1204
1205         /*
1206          * Change the comment of the key; this _does_ require a
1207          * passphrase owing to the tamperproofing.
1208          * 
1209          * NOTE: In SSH1, this only requires a passphrase because
1210          * of inadequacies of the loading and saving mechanisms. In
1211          * _principle_, it should be perfectly possible to modify
1212          * the comment on an SSH1 key without requiring a
1213          * passphrase; the only reason I can't do it is because my
1214          * loading and saving mechanisms don't include a method of
1215          * loading all the key data without also trying to decrypt
1216          * the private section.
1217          * 
1218          * I don't consider this to be a problem worth solving,
1219          * because (a) to fix it would probably end up bloating
1220          * PuTTY proper, and (b) SSH1 is on the way out anyway so
1221          * it shouldn't be highly significant. If it seriously
1222          * bothers anyone then perhaps I _might_ be persuadable.
1223          */
1224         setup_passphrases("sponge", NULL);
1225         test(0, "puttygen", "-C", "new-comment", filename, NULL);
1226
1227         /*
1228          * Change the passphrase to nothing.
1229          */
1230         setup_passphrases("sponge", "", "", NULL);
1231         test(0, "puttygen", "-P", filename, NULL);
1232
1233         /*
1234          * Change the comment of the key again; this time we expect no
1235          * passphrase to be required.
1236          */
1237         setup_passphrases(NULL);
1238         test(0, "puttygen", "-C", "new-comment-2", filename, NULL);
1239
1240         /*
1241          * Export the private key into OpenSSH format; no passphrase
1242          * should be required since the key is currently unencrypted.
1243          * For RSA1 keys, this should give an error.
1244          */
1245         setup_passphrases(NULL);
1246         test((i==0), "puttygen", "-O", "private-openssh", "-o", osfilename,
1247              filename, NULL);
1248
1249         if (i) {
1250             /*
1251              * List the fingerprint of the OpenSSH-formatted key.
1252              */
1253             setup_passphrases(NULL);
1254             test(0, "puttygen", "-l", osfilename, "-o", tmpfilename1, NULL);
1255             check_fp(tmpfilename1, fp, "%s openssh clear fp", keytypes[i]);
1256
1257             /*
1258              * List the public half of the OpenSSH-formatted key in
1259              * OpenSSH format.
1260              */
1261             setup_passphrases(NULL);
1262             test(0, "puttygen", "-L", osfilename, NULL);
1263
1264             /*
1265              * List the public half of the OpenSSH-formatted key in
1266              * IETF/ssh.com format.
1267              */
1268             setup_passphrases(NULL);
1269             test(0, "puttygen", "-p", osfilename, NULL);
1270         }
1271
1272         /*
1273          * Export the private key into ssh.com format; no passphrase
1274          * should be required since the key is currently unencrypted.
1275          * For RSA1 keys, this should give an error.
1276          */
1277         setup_passphrases(NULL);
1278         test((i==0), "puttygen", "-O", "private-sshcom", "-o", scfilename,
1279              filename, NULL);
1280
1281         if (i) {
1282             /*
1283              * List the fingerprint of the ssh.com-formatted key.
1284              */
1285             setup_passphrases(NULL);
1286             test(0, "puttygen", "-l", scfilename, "-o", tmpfilename1, NULL);
1287             check_fp(tmpfilename1, fp, "%s ssh.com clear fp", keytypes[i]);
1288
1289             /*
1290              * List the public half of the ssh.com-formatted key in
1291              * OpenSSH format.
1292              */
1293             setup_passphrases(NULL);
1294             test(0, "puttygen", "-L", scfilename, NULL);
1295
1296             /*
1297              * List the public half of the ssh.com-formatted key in
1298              * IETF/ssh.com format.
1299              */
1300             setup_passphrases(NULL);
1301             test(0, "puttygen", "-p", scfilename, NULL);
1302         }
1303
1304         if (i) {
1305             /*
1306              * Convert from OpenSSH into ssh.com.
1307              */
1308             setup_passphrases(NULL);
1309             test(0, "puttygen", osfilename, "-o", tmpfilename1,
1310                  "-O", "private-sshcom", NULL);
1311
1312             /*
1313              * Convert from ssh.com back into a PuTTY key,
1314              * supplying the same comment as we had before we
1315              * started to ensure the comparison works.
1316              */
1317             setup_passphrases(NULL);
1318             test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
1319                  "-o", tmpfilename2, NULL);
1320
1321             /*
1322              * See if the PuTTY key thus generated is the same as
1323              * the original.
1324              */
1325             filecmp(filename, tmpfilename2,
1326                     "p->o->s->p clear %s", keytypes[i]);
1327
1328             /*
1329              * Convert from ssh.com to OpenSSH.
1330              */
1331             setup_passphrases(NULL);
1332             test(0, "puttygen", scfilename, "-o", tmpfilename1,
1333                  "-O", "private-openssh", NULL);
1334
1335             /*
1336              * Convert from OpenSSH back into a PuTTY key,
1337              * supplying the same comment as we had before we
1338              * started to ensure the comparison works.
1339              */
1340             setup_passphrases(NULL);
1341             test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
1342                  "-o", tmpfilename2, NULL);
1343
1344             /*
1345              * See if the PuTTY key thus generated is the same as
1346              * the original.
1347              */
1348             filecmp(filename, tmpfilename2,
1349                     "p->s->o->p clear %s", keytypes[i]);
1350
1351             /*
1352              * Finally, do a round-trip conversion between PuTTY
1353              * and ssh.com without involving OpenSSH, to test that
1354              * the key comment is preserved in that case.
1355              */
1356             setup_passphrases(NULL);
1357             test(0, "puttygen", "-O", "private-sshcom", "-o", tmpfilename1,
1358                  filename, NULL);
1359             setup_passphrases(NULL);
1360             test(0, "puttygen", tmpfilename1, "-o", tmpfilename2, NULL);
1361             filecmp(filename, tmpfilename2,
1362                     "p->s->p clear %s", keytypes[i]);
1363         }
1364
1365         /*
1366          * Check that mismatched passphrases cause an error.
1367          */
1368         setup_passphrases("sponge2", "sponge3", NULL);
1369         test(1, "puttygen", "-P", filename, NULL);
1370
1371         /*
1372          * Put a passphrase back on.
1373          */
1374         setup_passphrases("sponge2", "sponge2", NULL);
1375         test(0, "puttygen", "-P", filename, NULL);
1376
1377         /*
1378          * Export the private key into OpenSSH format, this time
1379          * while encrypted. For RSA1 keys, this should give an
1380          * error.
1381          */
1382         if (i == 0)
1383             setup_passphrases(NULL);   /* error, hence no passphrase read */
1384         else
1385             setup_passphrases("sponge2", NULL);
1386         test((i==0), "puttygen", "-O", "private-openssh", "-o", osfilename,
1387              filename, NULL);
1388
1389         if (i) {
1390             /*
1391              * List the fingerprint of the OpenSSH-formatted key.
1392              */
1393             setup_passphrases("sponge2", NULL);
1394             test(0, "puttygen", "-l", osfilename, "-o", tmpfilename1, NULL);
1395             check_fp(tmpfilename1, fp, "%s openssh encrypted fp", keytypes[i]);
1396
1397             /*
1398              * List the public half of the OpenSSH-formatted key in
1399              * OpenSSH format.
1400              */
1401             setup_passphrases("sponge2", NULL);
1402             test(0, "puttygen", "-L", osfilename, NULL);
1403
1404             /*
1405              * List the public half of the OpenSSH-formatted key in
1406              * IETF/ssh.com format.
1407              */
1408             setup_passphrases("sponge2", NULL);
1409             test(0, "puttygen", "-p", osfilename, NULL);
1410         }
1411
1412         /*
1413          * Export the private key into ssh.com format, this time
1414          * while encrypted. For RSA1 keys, this should give an
1415          * error.
1416          */
1417         if (i == 0)
1418             setup_passphrases(NULL);   /* error, hence no passphrase read */
1419         else
1420             setup_passphrases("sponge2", NULL);
1421         test((i==0), "puttygen", "-O", "private-sshcom", "-o", scfilename,
1422              filename, NULL);
1423
1424         if (i) {
1425             /*
1426              * List the fingerprint of the ssh.com-formatted key.
1427              */
1428             setup_passphrases("sponge2", NULL);
1429             test(0, "puttygen", "-l", scfilename, "-o", tmpfilename1, NULL);
1430             check_fp(tmpfilename1, fp, "%s ssh.com encrypted fp", keytypes[i]);
1431
1432             /*
1433              * List the public half of the ssh.com-formatted key in
1434              * OpenSSH format.
1435              */
1436             setup_passphrases("sponge2", NULL);
1437             test(0, "puttygen", "-L", scfilename, NULL);
1438
1439             /*
1440              * List the public half of the ssh.com-formatted key in
1441              * IETF/ssh.com format.
1442              */
1443             setup_passphrases("sponge2", NULL);
1444             test(0, "puttygen", "-p", scfilename, NULL);
1445         }
1446
1447         if (i) {
1448             /*
1449              * Convert from OpenSSH into ssh.com.
1450              */
1451             setup_passphrases("sponge2", NULL);
1452             test(0, "puttygen", osfilename, "-o", tmpfilename1,
1453                  "-O", "private-sshcom", NULL);
1454
1455             /*
1456              * Convert from ssh.com back into a PuTTY key,
1457              * supplying the same comment as we had before we
1458              * started to ensure the comparison works.
1459              */
1460             setup_passphrases("sponge2", NULL);
1461             test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
1462                  "-o", tmpfilename2, NULL);
1463
1464             /*
1465              * See if the PuTTY key thus generated is the same as
1466              * the original.
1467              */
1468             filecmp(filename, tmpfilename2,
1469                     "p->o->s->p encrypted %s", keytypes[i]);
1470
1471             /*
1472              * Convert from ssh.com to OpenSSH.
1473              */
1474             setup_passphrases("sponge2", NULL);
1475             test(0, "puttygen", scfilename, "-o", tmpfilename1,
1476                  "-O", "private-openssh", NULL);
1477
1478             /*
1479              * Convert from OpenSSH back into a PuTTY key,
1480              * supplying the same comment as we had before we
1481              * started to ensure the comparison works.
1482              */
1483             setup_passphrases("sponge2", NULL);
1484             test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
1485                  "-o", tmpfilename2, NULL);
1486
1487             /*
1488              * See if the PuTTY key thus generated is the same as
1489              * the original.
1490              */
1491             filecmp(filename, tmpfilename2,
1492                     "p->s->o->p encrypted %s", keytypes[i]);
1493
1494             /*
1495              * Finally, do a round-trip conversion between PuTTY
1496              * and ssh.com without involving OpenSSH, to test that
1497              * the key comment is preserved in that case.
1498              */
1499             setup_passphrases("sponge2", NULL);
1500             test(0, "puttygen", "-O", "private-sshcom", "-o", tmpfilename1,
1501                  filename, NULL);
1502             setup_passphrases("sponge2", NULL);
1503             test(0, "puttygen", tmpfilename1, "-o", tmpfilename2, NULL);
1504             filecmp(filename, tmpfilename2,
1505                     "p->s->p encrypted %s", keytypes[i]);
1506         }
1507
1508         /*
1509          * Load with the wrong passphrase.
1510          */
1511         setup_passphrases("sponge8", NULL);
1512         test(1, "puttygen", "-C", "spurious-new-comment", filename, NULL);
1513
1514         /*
1515          * Load a totally bogus file.
1516          */
1517         setup_passphrases(NULL);
1518         test(1, "puttygen", "-C", "spurious-new-comment", pubfilename, NULL);
1519     }
1520     printf("%d passes, %d fails\n", passes, fails);
1521     return 0;
1522 }
1523
1524 #endif