Sebastian Kuschel reports that pfd_closing can be called for a socket
[u/mdw/putty] / cmdgen.c
index f845c62..69c0177 100644 (file)
--- a/cmdgen.c
+++ b/cmdgen.c
@@ -2,18 +2,6 @@
  * cmdgen.c - command-line form of PuTTYgen
  */
 
-/*
- * TODO:
- * 
- *  - Test thoroughly.
- *     + a neat way to do this might be to have a -DTESTMODE for
- *      this file, which #defines console_get_line and
- *      get_random_noise to different names in order to be able to
- *      link them to test stubs rather than the real ones. That
- *      way I can have a test rig which checks whether passphrases
- *      are being prompted for.
- */
-
 #define PUTTY_DO_GLOBALS
 
 #include <stdio.h>
 #include "putty.h"
 #include "ssh.h"
 
-#ifdef TESTMODE
+#ifdef TEST_CMDGEN
+/*
+ * This section overrides some definitions below for test purposes.
+ * When compiled with -DTEST_CMDGEN:
+ * 
+ *  - Calls to get_random_data() are replaced with the diagnostic
+ *    function below (I #define the name so that I can still link
+ *    with the original set of modules without symbol clash), in
+ *    order to avoid depleting the test system's /dev/random
+ *    unnecessarily.
+ * 
+ *  - Calls to console_get_userpass_input() are replaced with the
+ *    diagnostic function below, so that I can run tests in an
+ *    automated manner and provide their interactive passphrase
+ *    inputs.
+ * 
+ *  - main() is renamed to cmdgen_main(); at the bottom of the file
+ *    I define another main() which calls the former repeatedly to
+ *    run tests.
+ */
 #define get_random_data get_random_data_diagnostic
 char *get_random_data(int len)
 {
@@ -34,6 +41,25 @@ char *get_random_data(int len)
     memset(buf, 'x', len);
     return buf;
 }
+#define console_get_userpass_input console_get_userpass_input_diagnostic
+int nprompts, promptsgot;
+const char *prompts[3];
+int console_get_userpass_input(prompts_t *p, unsigned char *in, int inlen)
+{
+    size_t i;
+    int ret = 1;
+    for (i = 0; i < p->n_prompts; i++) {
+       if (promptsgot < nprompts) {
+           assert(strlen(prompts[promptsgot]) < p->prompts[i]->result_len);
+           strcpy(p->prompts[i]->result, prompts[promptsgot++]);
+       } else {
+           promptsgot++;           /* track number of requests anyway */
+           ret = 0;
+       }
+    }
+    return ret;
+}
+#define main cmdgen_main
 #endif
 
 struct progress {
@@ -76,6 +102,16 @@ void modalfatalbox(char *p, ...)
     cleanup_exit(1);
 }
 
+void nonfatal(char *p, ...)
+{
+    va_list ap;
+    fprintf(stderr, "ERROR: ");
+    va_start(ap, p);
+    vfprintf(stderr, p, ap);
+    va_end(ap);
+    fputc('\n', stderr);
+}
+
 /*
  * Stubs to let everything else link sensibly.
  */
@@ -92,18 +128,19 @@ void sk_cleanup(void)
 
 void showversion(void)
 {
-    char *verstr = dupstr(ver);
-    verstr[0] = tolower(verstr[0]);
-    printf("PuTTYgen %s\n", verstr);
-    sfree(verstr);
+    printf("puttygen: %s\n", ver);
 }
 
-void usage(void)
+void usage(int standalone)
 {
     fprintf(stderr,
            "Usage: puttygen ( keyfile | -t type [ -b bits ] )\n"
-           "                [ -C comment ] [ -P ]\n"
-           "                [ -o output-keyfile ] [ -O type ]\n");
+           "                [ -C comment ] [ -P ] [ -q ]\n"
+           "                [ -o output-keyfile ] [ -O type | -l | -L"
+           " | -p ]\n");
+    if (standalone)
+       fprintf(stderr,
+               "Use \"puttygen --help\" for more detail.\n");
 }
 
 void help(void)
@@ -113,11 +150,13 @@ void help(void)
      * start with that, plus a version heading.
      */
     showversion();
-    usage();
+    usage(FALSE);
     fprintf(stderr,
            "  -t    specify key type when generating (rsa, dsa, rsa1)\n"
+           "  -b    specify number of bits when generating key\n"
            "  -C    change or specify key comment\n"
            "  -P    change key passphrase\n"
+           "  -q    quiet: do not display progress bar\n"
            "  -O    specify output type:\n"
            "           private             output PuTTY private key format\n"
            "           private-openssh     export OpenSSH private key\n"
@@ -125,6 +164,7 @@ void help(void)
            "           public              standard / ssh.com public key\n"
            "           public-openssh      OpenSSH public key\n"
            "           fingerprint         output the key fingerprint\n"
+           "  -o    specify output file\n"
            "  -l    equivalent to `-O fingerprint'\n"
            "  -L    equivalent to `-O public-openssh'\n"
            "  -p    equivalent to `-O public'\n"
@@ -181,7 +221,7 @@ static int save_ssh2_pubkey(char *filename, char *comment,
     return 1;
 }
 
-static void move(char *from, char *to)
+static int move(char *from, char *to)
 {
     int ret;
 
@@ -195,11 +235,12 @@ static void move(char *from, char *to)
     }
     if (ret) {
        perror("puttygen: cannot move new file on to old one");
-       exit(1);
+       return FALSE;
     }
+    return TRUE;
 }
 
-static char *blobfp(char *alg, int bits, char *blob, int bloblen)
+static char *blobfp(char *alg, int bits, unsigned char *blob, int bloblen)
 {
     char buffer[128];
     unsigned char digest[16];
@@ -223,12 +264,11 @@ static char *blobfp(char *alg, int bits, char *blob, int bloblen)
 int main(int argc, char **argv)
 {
     char *infile = NULL;
-    Filename infilename;
+    Filename *infilename = NULL, *outfilename = NULL;
     enum { NOKEYGEN, RSA1, RSA2, DSA } keytype = NOKEYGEN;    
     char *outfile = NULL, *outfiletmp = NULL;
-    Filename outfilename;
     enum { PRIVATE, PUBLIC, PUBLICO, FP, OPENSSH, SSHCOM } outtype = PRIVATE;
-    int bits = 1024;
+    int bits = 2048;
     char *comment = NULL, *origcomment = NULL;
     int change_passphrase = FALSE;
     int errs = FALSE, nogo = FALSE;
@@ -236,7 +276,8 @@ int main(int argc, char **argv)
     int sshver = 0;
     struct ssh2_userkey *ssh2key = NULL;
     struct RSAKey *ssh1key = NULL;
-    char *ssh2blob = NULL, *ssh2alg = NULL;
+    unsigned char *ssh2blob = NULL;
+    char *ssh2alg = NULL;
     const struct ssh_signkey *ssh2algf = NULL;
     int ssh2bloblen;
     char *passphrase = NULL;
@@ -252,7 +293,7 @@ int main(int argc, char **argv)
      * return success.
      */
     if (argc <= 1) {
-       usage();
+       usage(TRUE);
        return 0;
     }
 
@@ -281,28 +322,54 @@ int main(int argc, char **argv)
                            *p++ = '\0';
                            val = p;
                        } else
-                           val = NULL;
+                            val = NULL;
+
                        if (!strcmp(opt, "-help")) {
-                           help();
-                           nogo = TRUE;
+                            if (val) {
+                                errs = TRUE;
+                                fprintf(stderr, "puttygen: option `-%s'"
+                                        " expects no argument\n", opt);
+                            } else {
+                                help();
+                                nogo = TRUE;
+                            }
                        } else if (!strcmp(opt, "-version")) {
-                           showversion();
-                           nogo = TRUE;
-                       }
+                            if (val) {
+                                errs = TRUE;
+                                fprintf(stderr, "puttygen: option `-%s'"
+                                        " expects no argument\n", opt);
+                            } else {
+                                showversion();
+                                nogo = TRUE;
+                            }
+                       } else if (!strcmp(opt, "-pgpfp")) {
+                            if (val) {
+                                errs = TRUE;
+                                fprintf(stderr, "puttygen: option `-%s'"
+                                        " expects no argument\n", opt);
+                            } else {
+                                /* support --pgpfp for consistency */
+                                pgp_fingerprints();
+                                nogo = TRUE;
+                            }
+                        }
                        /*
-                        * A sample option requiring an argument:
+                        * For long options requiring an argument, add
+                        * code along the lines of
                         * 
                         * else if (!strcmp(opt, "-output")) {
-                        *     if (!val)
-                        *         errs = TRUE, error(err_optnoarg, opt);
-                        *     else
+                        *     if (!val) {
+                        *         errs = TRUE;
+                         *         fprintf(stderr, "puttygen: option `-%s'"
+                         *                 " expects an argument\n", opt);
+                        *     } else
                         *         ofile = val;
                         * }
                         */
                        else {
                            errs = TRUE;
                            fprintf(stderr,
-                                   "puttygen: no such option `--%s'\n", opt);
+                                   "puttygen: no such option `-%s'\n", opt);
                        }
                    }
                    p = NULL;
@@ -441,7 +508,7 @@ int main(int argc, char **argv)
      * ones, print the usage message and return failure.
      */
     if (!infile && keytype == NOKEYGEN) {
-       usage();
+       usage(TRUE);
        return 1;
     }
 
@@ -453,11 +520,21 @@ int main(int argc, char **argv)
      * Bomb out if we've been asked to both load and generate a
      * key.
      */
-    if (keytype != NOKEYGEN && intype) {
+    if (keytype != NOKEYGEN && infile) {
        fprintf(stderr, "puttygen: cannot both load and generate a key\n");
        return 1;
     }
 
+    /* 
+     * We must save the private part when generating a new key.
+     */
+    if (keytype != NOKEYGEN &&
+       (outtype != PRIVATE && outtype != OPENSSH && outtype != SSHCOM)) {
+       fprintf(stderr, "puttygen: this would generate a new key but "
+               "discard the private part\n");
+       return 1;
+    }
+
     /*
      * Analyse the type of the input file, in case this affects our
      * course of action.
@@ -465,7 +542,7 @@ int main(int argc, char **argv)
     if (infile) {
        infilename = filename_from_str(infile);
 
-       intype = key_type(&infilename);
+       intype = key_type(infilename);
 
        switch (intype) {
            /*
@@ -498,7 +575,7 @@ int main(int argc, char **argv)
 
          case SSH_KEYTYPE_SSH1:
            if (sshver == 2) {
-               fprintf(stderr, "puttygen: conversion from SSH1 to SSH2 keys"
+               fprintf(stderr, "puttygen: conversion from SSH-1 to SSH-2 keys"
                        " not supported\n");
                return 1;
            }
@@ -509,7 +586,7 @@ int main(int argc, char **argv)
          case SSH_KEYTYPE_OPENSSH:
          case SSH_KEYTYPE_SSHCOM:
            if (sshver == 1) {
-               fprintf(stderr, "puttygen: conversion from SSH2 to SSH1 keys"
+               fprintf(stderr, "puttygen: conversion from SSH-2 to SSH-1 keys"
                        " not supported\n");
                return 1;
            }
@@ -534,7 +611,7 @@ int main(int argc, char **argv)
        (intype == SSH_KEYTYPE_SSHCOM && outtype == SSHCOM)) {
        if (!outfile) {
            outfile = infile;
-           outfiletmp = dupcat(outfile, ".tmp");
+           outfiletmp = dupcat(outfile, ".tmp", NULL);
        }
 
        if (!change_passphrase && !comment) {
@@ -577,24 +654,27 @@ int main(int argc, char **argv)
     if (keytype != NOKEYGEN) {
        char *entropy;
        char default_comment[80];
-       time_t t;
-       struct tm *tm;
+       struct tm tm;
        struct progress prog;
 
        prog.phase = -1;
        prog.current = -1;
 
-       time(&t);
-       tm = localtime(&t);
+       tm = ltime();
        if (keytype == DSA)
-           strftime(default_comment, 30, "dsa-key-%Y%m%d", tm);
+           strftime(default_comment, 30, "dsa-key-%Y%m%d", &tm);
        else
-           strftime(default_comment, 30, "rsa-key-%Y%m%d", tm);
+           strftime(default_comment, 30, "rsa-key-%Y%m%d", &tm);
 
-       random_init();
+       random_ref();
        entropy = get_random_data(bits / 8);
+       if (!entropy) {
+           fprintf(stderr, "puttygen: failed to collect entropy, "
+                   "could not generate key\n");
+           return 1;
+       }
        random_add_heavynoise(entropy, bits / 8);
-       memset(entropy, 0, bits/8);
+       smemclr(entropy, bits/8);
        sfree(entropy);
 
        if (keytype == DSA) {
@@ -607,6 +687,7 @@ int main(int argc, char **argv)
        } else {
            struct RSAKey *rsakey = snew(struct RSAKey);
            rsa_generate(rsakey, bits, progressfn, &prog);
+           rsakey->comment = NULL;
            if (keytype == RSA1) {
                ssh1key = rsakey;
            } else {
@@ -632,21 +713,30 @@ int main(int argc, char **argv)
         * Find out whether the input key is encrypted.
         */
        if (intype == SSH_KEYTYPE_SSH1)
-           encrypted = rsakey_encrypted(&infilename, &origcomment);
+           encrypted = rsakey_encrypted(infilename, &origcomment);
        else if (intype == SSH_KEYTYPE_SSH2)
-           encrypted = ssh2_userkey_encrypted(&infilename, &origcomment);
+           encrypted = ssh2_userkey_encrypted(infilename, &origcomment);
        else
-           encrypted = import_encrypted(&infilename, intype, &origcomment);
+           encrypted = import_encrypted(infilename, intype, &origcomment);
 
        /*
         * If so, ask for a passphrase.
         */
        if (encrypted && load_encrypted) {
-           passphrase = snewn(512, char);
-           if (!console_get_line("Enter passphrase to load key: ",
-                                 passphrase, 512, TRUE)) {
+           prompts_t *p = new_prompts(NULL);
+           int ret;
+           p->to_server = FALSE;
+           p->name = dupstr("SSH key passphrase");
+           add_prompt(p, dupstr("Enter passphrase to load key: "), FALSE);
+           ret = console_get_userpass_input(p, NULL, 0);
+           assert(ret >= 0);
+           if (!ret) {
+               free_prompts(p);
                perror("puttygen: unable to read passphrase");
                return 1;
+           } else {
+               passphrase = dupstr(p->prompts[0]->result);
+               free_prompts(p);
            }
        } else {
            passphrase = NULL;
@@ -659,20 +749,37 @@ int main(int argc, char **argv)
            ssh1key = snew(struct RSAKey);
            if (!load_encrypted) {
                void *vblob;
-               char *blob;
-               int n, bloblen;
+               unsigned char *blob;
+               int n, l, bloblen;
 
-               ret = rsakey_pubblob(&infilename, &vblob, &bloblen, &error);
-               blob = (char *)vblob;
+               ret = rsakey_pubblob(infilename, &vblob, &bloblen,
+                                    &origcomment, &error);
+               blob = (unsigned char *)vblob;
 
                n = 4;                 /* skip modulus bits */
-               n += ssh1_read_bignum(blob + n, &ssh1key->exponent);
-               n += ssh1_read_bignum(blob + n, &ssh1key->modulus);
-               ssh1key->comment = NULL;
+               
+               l = ssh1_read_bignum(blob + n, bloblen - n,
+                                    &ssh1key->exponent);
+               if (l < 0) {
+                   error = "SSH-1 public key blob was too short";
+               } else {
+                   n += l;
+                   l = ssh1_read_bignum(blob + n, bloblen - n,
+                                        &ssh1key->modulus);
+                   if (l < 0) {
+                       error = "SSH-1 public key blob was too short";
+                   } else
+                       n += l;
+               }
+               ssh1key->comment = dupstr(origcomment);
+               ssh1key->private_exponent = NULL;
+               ssh1key->p = NULL;
+               ssh1key->q = NULL;
+               ssh1key->iqmp = NULL;
            } else {
-               ret = loadrsakey(&infilename, ssh1key, passphrase, &error);
+               ret = loadrsakey(infilename, ssh1key, passphrase, &error);
            }
-           if (ret)
+           if (ret > 0)
                error = NULL;
            else if (!error)
                error = "unknown error";
@@ -680,17 +787,19 @@ int main(int argc, char **argv)
 
          case SSH_KEYTYPE_SSH2:
            if (!load_encrypted) {
-               ssh2blob = ssh2_userkey_loadpub(&infilename, &ssh2alg,
-                                               &ssh2bloblen, &error);
-               ssh2algf = find_pubkey_alg(ssh2alg);
-               if (ssh2algf)
-                   bits = ssh2algf->pubkey_bits(ssh2blob, ssh2bloblen);
-               else
-                   bits = -1;
+               ssh2blob = ssh2_userkey_loadpub(infilename, &ssh2alg,
+                                               &ssh2bloblen, NULL, &error);
+                if (ssh2blob) {
+                    ssh2algf = find_pubkey_alg(ssh2alg);
+                    if (ssh2algf)
+                        bits = ssh2algf->pubkey_bits(ssh2blob, ssh2bloblen);
+                    else
+                        bits = -1;
+                }
            } else {
-               ssh2key = ssh2_load_userkey(&infilename, passphrase, &error);
+               ssh2key = ssh2_load_userkey(infilename, passphrase, &error);
            }
-           if (ssh2key || ssh2blob)
+           if ((ssh2key && ssh2key != SSH2_WRONG_PASSPHRASE) || ssh2blob)
                error = NULL;
            else if (!error) {
                if (ssh2key == SSH2_WRONG_PASSPHRASE)
@@ -702,15 +811,14 @@ int main(int argc, char **argv)
 
          case SSH_KEYTYPE_OPENSSH:
          case SSH_KEYTYPE_SSHCOM:
-           ssh2key = import_ssh2(&infilename, intype, passphrase);
-           if (ssh2key)
-               error = NULL;
-           else if (!error) {
-               if (ssh2key == SSH2_WRONG_PASSPHRASE)
-                   error = "wrong passphrase";
+           ssh2key = import_ssh2(infilename, intype, passphrase, &error);
+           if (ssh2key) {
+               if (ssh2key != SSH2_WRONG_PASSPHRASE)
+                   error = NULL;
                else
-                   error = "unknown error";
-           }
+                   error = "wrong passphrase";
+           } else if (!error)
+               error = "unknown error";
            break;
 
          default:
@@ -744,31 +852,35 @@ int main(int argc, char **argv)
      * we have just generated a key.
      */
     if (change_passphrase || keytype != NOKEYGEN) {
-       char *passphrase2;
-
-       if (passphrase) {
-           memset(passphrase, 0, strlen(passphrase));
-           sfree(passphrase);
-       }
+       prompts_t *p = new_prompts(NULL);
+       int ret;
 
-       passphrase = snewn(512, char);
-       passphrase2 = snewn(512, char);
-       if (!console_get_line("Enter passphrase to save key: ",
-                             passphrase, 512, TRUE) ||
-           !console_get_line("Re-enter passphrase to verify: ",
-                             passphrase2, 512, TRUE)) {
+       p->to_server = FALSE;
+       p->name = dupstr("New SSH key passphrase");
+       add_prompt(p, dupstr("Enter passphrase to save key: "), FALSE);
+       add_prompt(p, dupstr("Re-enter passphrase to verify: "), FALSE);
+       ret = console_get_userpass_input(p, NULL, 0);
+       assert(ret >= 0);
+       if (!ret) {
+           free_prompts(p);
            perror("puttygen: unable to read new passphrase");
            return 1;
-       }
-       if (strcmp(passphrase, passphrase2)) {
-           fprintf(stderr, "puttygen: passphrases do not match\n");
-           return 1;
-       }
-       memset(passphrase2, 0, strlen(passphrase2));
-       sfree(passphrase2);
-       if (!*passphrase) {
-           sfree(passphrase);
-           passphrase = NULL;
+       } else {
+           if (strcmp(p->prompts[0]->result, p->prompts[1]->result)) {
+               free_prompts(p);
+               fprintf(stderr, "puttygen: passphrases do not match\n");
+               return 1;
+           }
+           if (passphrase) {
+               smemclr(passphrase, strlen(passphrase));
+               sfree(passphrase);
+           }
+           passphrase = dupstr(p->prompts[0]->result);
+           free_prompts(p);
+           if (!*passphrase) {
+               sfree(passphrase);
+               passphrase = NULL;
+           }
        }
     }
 
@@ -791,21 +903,23 @@ int main(int argc, char **argv)
       case PRIVATE:
        if (sshver == 1) {
            assert(ssh1key);
-           ret = saversakey(&outfilename, ssh1key, passphrase);
+           ret = saversakey(outfilename, ssh1key, passphrase);
            if (!ret) {
-               fprintf(stderr, "puttygen: unable to save SSH1 private key\n");
+               fprintf(stderr, "puttygen: unable to save SSH-1 private key\n");
                return 1;
            }
        } else {
            assert(ssh2key);
-           ret = ssh2_save_userkey(&outfilename, ssh2key, passphrase);
+           ret = ssh2_save_userkey(outfilename, ssh2key, passphrase);
            if (!ret) {
-               fprintf(stderr, "puttygen: unable to save SSH2 private key\n");
+               fprintf(stderr, "puttygen: unable to save SSH-2 private key\n");
                return 1;
            }
        }
-       if (outfiletmp)
-           move(outfiletmp, outfile);
+       if (outfiletmp) {
+           if (!move(outfiletmp, outfile))
+               return 1;              /* rename failed */
+       }
        break;
 
       case PUBLIC:
@@ -817,7 +931,7 @@ int main(int argc, char **argv)
            assert(ssh1key);
 
            if (outfile)
-               fp = f_open(outfilename, "w");
+               fp = f_open(outfilename, "w", FALSE);
            else
                fp = stdout;
            dec1 = bignum_decimal(ssh1key->exponent);
@@ -875,7 +989,7 @@ int main(int argc, char **argv)
                *p++ = '\0';
 
            if (outfile)
-               fp = f_open(outfilename, "w");
+               fp = f_open(outfilename, "w", FALSE);
            else
                fp = stdout;
            fprintf(fp, "%s\n", buffer);
@@ -905,7 +1019,7 @@ int main(int argc, char **argv)
            }
 
            if (outfile)
-               fp = f_open(outfilename, "w");
+               fp = f_open(outfilename, "w", FALSE);
            else
                fp = stdout;
            fprintf(fp, "%s\n", fingerprint);
@@ -920,18 +1034,20 @@ int main(int argc, char **argv)
       case SSHCOM:
        assert(sshver == 2);
        assert(ssh2key);
-       ret = export_ssh2(&outfilename, outtype, ssh2key, passphrase);
+       ret = export_ssh2(outfilename, outtype, ssh2key, passphrase);
        if (!ret) {
            fprintf(stderr, "puttygen: unable to export key\n");
            return 1;
        }
-       if (outfiletmp)
-           move(outfiletmp, outfile);
+       if (outfiletmp) {
+           if (!move(outfiletmp, outfile))
+               return 1;              /* rename failed */
+       }
        break;
     }
 
     if (passphrase) {
-       memset(passphrase, 0, strlen(passphrase));
+       smemclr(passphrase, strlen(passphrase));
        sfree(passphrase);
     }
 
@@ -944,3 +1060,550 @@ int main(int argc, char **argv)
 
     return 0;
 }
+
+#ifdef TEST_CMDGEN
+
+#undef main
+
+#include <stdarg.h>
+
+int passes, fails;
+
+void setup_passphrases(char *first, ...)
+{
+    va_list ap;
+    char *next;
+
+    nprompts = 0;
+    if (first) {
+       prompts[nprompts++] = first;
+       va_start(ap, first);
+       while ((next = va_arg(ap, char *)) != NULL) {
+           assert(nprompts < lenof(prompts));
+           prompts[nprompts++] = next;
+       }
+       va_end(ap);
+    }
+}
+
+void test(int retval, ...)
+{
+    va_list ap;
+    int i, argc, ret;
+    char **argv;
+
+    argc = 0;
+    va_start(ap, retval);
+    while (va_arg(ap, char *) != NULL)
+       argc++;
+    va_end(ap);
+
+    argv = snewn(argc+1, char *);
+    va_start(ap, retval);
+    for (i = 0; i <= argc; i++)
+       argv[i] = va_arg(ap, char *);
+    va_end(ap);
+
+    promptsgot = 0;
+    ret = cmdgen_main(argc, argv);
+
+    if (ret != retval) {
+       printf("FAILED retval (exp %d got %d):", retval, ret);
+       for (i = 0; i < argc; i++)
+           printf(" %s", argv[i]);
+       printf("\n");
+       fails++;
+    } else if (promptsgot != nprompts) {
+       printf("FAILED nprompts (exp %d got %d):", nprompts, promptsgot);
+       for (i = 0; i < argc; i++)
+           printf(" %s", argv[i]);
+       printf("\n");
+       fails++;
+    } else {
+       passes++;
+    }
+}
+
+void filecmp(char *file1, char *file2, char *fmt, ...)
+{
+    /*
+     * Ideally I should do file comparison myself, to maximise the
+     * portability of this test suite once this application begins
+     * running on non-Unix platforms. For the moment, though,
+     * calling Unix diff is perfectly adequate.
+     */
+    char *buf;
+    int ret;
+
+    buf = dupprintf("diff -q '%s' '%s'", file1, file2);
+    ret = system(buf);
+    sfree(buf);
+
+    if (ret) {
+       va_list ap;
+
+       printf("FAILED diff (ret=%d): ", ret);
+
+       va_start(ap, fmt);
+       vprintf(fmt, ap);
+       va_end(ap);
+
+       printf("\n");
+
+       fails++;
+    } else
+       passes++;
+}
+
+char *cleanup_fp(char *s)
+{
+    char *p;
+
+    if (!strncmp(s, "ssh-", 4)) {
+       s += strcspn(s, " \n\t");
+       s += strspn(s, " \n\t");
+    }
+
+    p = s;
+    s += strcspn(s, " \n\t");
+    s += strspn(s, " \n\t");
+    s += strcspn(s, " \n\t");
+
+    return dupprintf("%.*s", s - p, p);
+}
+
+char *get_fp(char *filename)
+{
+    FILE *fp;
+    char buf[256], *ret;
+
+    fp = fopen(filename, "r");
+    if (!fp)
+       return NULL;
+    ret = fgets(buf, sizeof(buf), fp);
+    fclose(fp);
+    if (!ret)
+       return NULL;
+    return cleanup_fp(buf);
+}
+
+void check_fp(char *filename, char *fp, char *fmt, ...)
+{
+    char *newfp;
+
+    if (!fp)
+       return;
+
+    newfp = get_fp(filename);
+
+    if (!strcmp(fp, newfp)) {
+       passes++;
+    } else {
+       va_list ap;
+
+       printf("FAILED check_fp ['%s' != '%s']: ", newfp, fp);
+
+       va_start(ap, fmt);
+       vprintf(fmt, ap);
+       va_end(ap);
+
+       printf("\n");
+
+       fails++;
+    }
+
+    sfree(newfp);
+}
+
+int main(int argc, char **argv)
+{
+    int i;
+    static char *const keytypes[] = { "rsa1", "dsa", "rsa" };
+
+    /*
+     * Even when this thing is compiled for automatic test mode,
+     * it's helpful to be able to invoke it with command-line
+     * options for _manual_ tests.
+     */
+    if (argc > 1)
+       return cmdgen_main(argc, argv);
+
+    passes = fails = 0;
+
+    for (i = 0; i < lenof(keytypes); i++) {
+       char filename[128], osfilename[128], scfilename[128];
+       char pubfilename[128], tmpfilename1[128], tmpfilename2[128];
+       char *fp;
+
+       sprintf(filename, "test-%s.ppk", keytypes[i]);
+       sprintf(pubfilename, "test-%s.pub", keytypes[i]);
+       sprintf(osfilename, "test-%s.os", keytypes[i]);
+       sprintf(scfilename, "test-%s.sc", keytypes[i]);
+       sprintf(tmpfilename1, "test-%s.tmp1", keytypes[i]);
+       sprintf(tmpfilename2, "test-%s.tmp2", keytypes[i]);
+
+       /*
+        * Create an encrypted key.
+        */
+       setup_passphrases("sponge", "sponge", NULL);
+       test(0, "puttygen", "-t", keytypes[i], "-o", filename, NULL);
+
+       /*
+        * List the public key in OpenSSH format.
+        */
+       setup_passphrases(NULL);
+       test(0, "puttygen", "-L", filename, "-o", pubfilename, NULL);
+       {
+           char cmdbuf[256];
+           fp = NULL;
+           sprintf(cmdbuf, "ssh-keygen -l -f '%s' > '%s'",
+                   pubfilename, tmpfilename1);
+           if (system(cmdbuf) ||
+               (fp = get_fp(tmpfilename1)) == NULL) {
+               printf("UNABLE to test fingerprint matching against OpenSSH");
+           }
+       }
+
+       /*
+        * List the public key in IETF/ssh.com format.
+        */
+       setup_passphrases(NULL);
+       test(0, "puttygen", "-p", filename, NULL);
+
+       /*
+        * List the fingerprint of the key.
+        */
+       setup_passphrases(NULL);
+       test(0, "puttygen", "-l", filename, "-o", tmpfilename1, NULL);
+       if (!fp) {
+           /*
+            * If we can't test fingerprints against OpenSSH, we
+            * can at the very least test equality of all the
+            * fingerprints we generate of this key throughout
+            * testing.
+            */
+           fp = get_fp(tmpfilename1);
+       } else {
+           check_fp(tmpfilename1, fp, "%s initial fp", keytypes[i]);
+       }
+
+       /*
+        * Change the comment of the key; this _does_ require a
+        * passphrase owing to the tamperproofing.
+        * 
+        * NOTE: In SSH-1, this only requires a passphrase because
+        * of inadequacies of the loading and saving mechanisms. In
+        * _principle_, it should be perfectly possible to modify
+        * the comment on an SSH-1 key without requiring a
+        * passphrase; the only reason I can't do it is because my
+        * loading and saving mechanisms don't include a method of
+        * loading all the key data without also trying to decrypt
+        * the private section.
+        * 
+        * I don't consider this to be a problem worth solving,
+        * because (a) to fix it would probably end up bloating
+        * PuTTY proper, and (b) SSH-1 is on the way out anyway so
+        * it shouldn't be highly significant. If it seriously
+        * bothers anyone then perhaps I _might_ be persuadable.
+        */
+       setup_passphrases("sponge", NULL);
+       test(0, "puttygen", "-C", "new-comment", filename, NULL);
+
+       /*
+        * Change the passphrase to nothing.
+        */
+       setup_passphrases("sponge", "", "", NULL);
+       test(0, "puttygen", "-P", filename, NULL);
+
+       /*
+        * Change the comment of the key again; this time we expect no
+        * passphrase to be required.
+        */
+       setup_passphrases(NULL);
+       test(0, "puttygen", "-C", "new-comment-2", filename, NULL);
+
+       /*
+        * Export the private key into OpenSSH format; no passphrase
+        * should be required since the key is currently unencrypted.
+        * For RSA1 keys, this should give an error.
+        */
+       setup_passphrases(NULL);
+       test((i==0), "puttygen", "-O", "private-openssh", "-o", osfilename,
+            filename, NULL);
+
+       if (i) {
+           /*
+            * List the fingerprint of the OpenSSH-formatted key.
+            */
+           setup_passphrases(NULL);
+           test(0, "puttygen", "-l", osfilename, "-o", tmpfilename1, NULL);
+           check_fp(tmpfilename1, fp, "%s openssh clear fp", keytypes[i]);
+
+           /*
+            * List the public half of the OpenSSH-formatted key in
+            * OpenSSH format.
+            */
+           setup_passphrases(NULL);
+           test(0, "puttygen", "-L", osfilename, NULL);
+
+           /*
+            * List the public half of the OpenSSH-formatted key in
+            * IETF/ssh.com format.
+            */
+           setup_passphrases(NULL);
+           test(0, "puttygen", "-p", osfilename, NULL);
+       }
+
+       /*
+        * Export the private key into ssh.com format; no passphrase
+        * should be required since the key is currently unencrypted.
+        * For RSA1 keys, this should give an error.
+        */
+       setup_passphrases(NULL);
+       test((i==0), "puttygen", "-O", "private-sshcom", "-o", scfilename,
+            filename, NULL);
+
+       if (i) {
+           /*
+            * List the fingerprint of the ssh.com-formatted key.
+            */
+           setup_passphrases(NULL);
+           test(0, "puttygen", "-l", scfilename, "-o", tmpfilename1, NULL);
+           check_fp(tmpfilename1, fp, "%s ssh.com clear fp", keytypes[i]);
+
+           /*
+            * List the public half of the ssh.com-formatted key in
+            * OpenSSH format.
+            */
+           setup_passphrases(NULL);
+           test(0, "puttygen", "-L", scfilename, NULL);
+
+           /*
+            * List the public half of the ssh.com-formatted key in
+            * IETF/ssh.com format.
+            */
+           setup_passphrases(NULL);
+           test(0, "puttygen", "-p", scfilename, NULL);
+       }
+
+       if (i) {
+           /*
+            * Convert from OpenSSH into ssh.com.
+            */
+           setup_passphrases(NULL);
+           test(0, "puttygen", osfilename, "-o", tmpfilename1,
+                "-O", "private-sshcom", NULL);
+
+           /*
+            * Convert from ssh.com back into a PuTTY key,
+            * supplying the same comment as we had before we
+            * started to ensure the comparison works.
+            */
+           setup_passphrases(NULL);
+           test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
+                "-o", tmpfilename2, NULL);
+
+           /*
+            * See if the PuTTY key thus generated is the same as
+            * the original.
+            */
+           filecmp(filename, tmpfilename2,
+                   "p->o->s->p clear %s", keytypes[i]);
+
+           /*
+            * Convert from ssh.com to OpenSSH.
+            */
+           setup_passphrases(NULL);
+           test(0, "puttygen", scfilename, "-o", tmpfilename1,
+                "-O", "private-openssh", NULL);
+
+           /*
+            * Convert from OpenSSH back into a PuTTY key,
+            * supplying the same comment as we had before we
+            * started to ensure the comparison works.
+            */
+           setup_passphrases(NULL);
+           test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
+                "-o", tmpfilename2, NULL);
+
+           /*
+            * See if the PuTTY key thus generated is the same as
+            * the original.
+            */
+           filecmp(filename, tmpfilename2,
+                   "p->s->o->p clear %s", keytypes[i]);
+
+           /*
+            * Finally, do a round-trip conversion between PuTTY
+            * and ssh.com without involving OpenSSH, to test that
+            * the key comment is preserved in that case.
+            */
+           setup_passphrases(NULL);
+           test(0, "puttygen", "-O", "private-sshcom", "-o", tmpfilename1,
+                filename, NULL);
+           setup_passphrases(NULL);
+           test(0, "puttygen", tmpfilename1, "-o", tmpfilename2, NULL);
+           filecmp(filename, tmpfilename2,
+                   "p->s->p clear %s", keytypes[i]);
+       }
+
+       /*
+        * Check that mismatched passphrases cause an error.
+        */
+       setup_passphrases("sponge2", "sponge3", NULL);
+       test(1, "puttygen", "-P", filename, NULL);
+
+       /*
+        * Put a passphrase back on.
+        */
+       setup_passphrases("sponge2", "sponge2", NULL);
+       test(0, "puttygen", "-P", filename, NULL);
+
+       /*
+        * Export the private key into OpenSSH format, this time
+        * while encrypted. For RSA1 keys, this should give an
+        * error.
+        */
+       if (i == 0)
+           setup_passphrases(NULL);   /* error, hence no passphrase read */
+       else
+           setup_passphrases("sponge2", NULL);
+       test((i==0), "puttygen", "-O", "private-openssh", "-o", osfilename,
+            filename, NULL);
+
+       if (i) {
+           /*
+            * List the fingerprint of the OpenSSH-formatted key.
+            */
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", "-l", osfilename, "-o", tmpfilename1, NULL);
+           check_fp(tmpfilename1, fp, "%s openssh encrypted fp", keytypes[i]);
+
+           /*
+            * List the public half of the OpenSSH-formatted key in
+            * OpenSSH format.
+            */
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", "-L", osfilename, NULL);
+
+           /*
+            * List the public half of the OpenSSH-formatted key in
+            * IETF/ssh.com format.
+            */
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", "-p", osfilename, NULL);
+       }
+
+       /*
+        * Export the private key into ssh.com format, this time
+        * while encrypted. For RSA1 keys, this should give an
+        * error.
+        */
+       if (i == 0)
+           setup_passphrases(NULL);   /* error, hence no passphrase read */
+       else
+           setup_passphrases("sponge2", NULL);
+       test((i==0), "puttygen", "-O", "private-sshcom", "-o", scfilename,
+            filename, NULL);
+
+       if (i) {
+           /*
+            * List the fingerprint of the ssh.com-formatted key.
+            */
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", "-l", scfilename, "-o", tmpfilename1, NULL);
+           check_fp(tmpfilename1, fp, "%s ssh.com encrypted fp", keytypes[i]);
+
+           /*
+            * List the public half of the ssh.com-formatted key in
+            * OpenSSH format.
+            */
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", "-L", scfilename, NULL);
+
+           /*
+            * List the public half of the ssh.com-formatted key in
+            * IETF/ssh.com format.
+            */
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", "-p", scfilename, NULL);
+       }
+
+       if (i) {
+           /*
+            * Convert from OpenSSH into ssh.com.
+            */
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", osfilename, "-o", tmpfilename1,
+                "-O", "private-sshcom", NULL);
+
+           /*
+            * Convert from ssh.com back into a PuTTY key,
+            * supplying the same comment as we had before we
+            * started to ensure the comparison works.
+            */
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
+                "-o", tmpfilename2, NULL);
+
+           /*
+            * See if the PuTTY key thus generated is the same as
+            * the original.
+            */
+           filecmp(filename, tmpfilename2,
+                   "p->o->s->p encrypted %s", keytypes[i]);
+
+           /*
+            * Convert from ssh.com to OpenSSH.
+            */
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", scfilename, "-o", tmpfilename1,
+                "-O", "private-openssh", NULL);
+
+           /*
+            * Convert from OpenSSH back into a PuTTY key,
+            * supplying the same comment as we had before we
+            * started to ensure the comparison works.
+            */
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", tmpfilename1, "-C", "new-comment-2",
+                "-o", tmpfilename2, NULL);
+
+           /*
+            * See if the PuTTY key thus generated is the same as
+            * the original.
+            */
+           filecmp(filename, tmpfilename2,
+                   "p->s->o->p encrypted %s", keytypes[i]);
+
+           /*
+            * Finally, do a round-trip conversion between PuTTY
+            * and ssh.com without involving OpenSSH, to test that
+            * the key comment is preserved in that case.
+            */
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", "-O", "private-sshcom", "-o", tmpfilename1,
+                filename, NULL);
+           setup_passphrases("sponge2", NULL);
+           test(0, "puttygen", tmpfilename1, "-o", tmpfilename2, NULL);
+           filecmp(filename, tmpfilename2,
+                   "p->s->p encrypted %s", keytypes[i]);
+       }
+
+       /*
+        * Load with the wrong passphrase.
+        */
+       setup_passphrases("sponge8", NULL);
+       test(1, "puttygen", "-C", "spurious-new-comment", filename, NULL);
+
+       /*
+        * Load a totally bogus file.
+        */
+       setup_passphrases(NULL);
+       test(1, "puttygen", "-C", "spurious-new-comment", pubfilename, NULL);
+    }
+    printf("%d passes, %d fails\n", passes, fails);
+    return 0;
+}
+
+#endif