winstore.c

   1 /*
   2  * winstore.c: Windows-specific implementation of the interface
   3  * defined in storage.h.
   4  */
   5
   6 #include <stdio.h>
   7 #include <stdlib.h>
   8 #include <limits.h>
   9 #include "putty.h"
  10 #include "storage.h"
  11
  12 static const char *const puttystr = PUTTY_REG_POS "\\Sessions";
  13
  14 static char seedpath[2 * MAX_PATH + 10] = "\0";
  15
  16 static const char hex[16] = "0123456789ABCDEF";
  17
  18 static void mungestr(const char *in, char *out)
  19 {
  20     int candot = 0;
  21
  22     while (*in) {
  23         if (*in == ' ' || *in == '\\' || *in == '*' || *in == '?' ||
  24             *in == '%' || *in < ' ' || *in > '~' || (*in == '.'
  25                                                      && !candot)) {
  26             *out++ = '%';
  27             *out++ = hex[((unsigned char) *in) >> 4];
  28             *out++ = hex[((unsigned char) *in) & 15];
  29         } else
  30             *out++ = *in;
  31         in++;
  32         candot = 1;
  33     }
  34     *out = '\0';
  35     return;
  36 }
  37
  38 static void unmungestr(const char *in, char *out, int outlen)
  39 {
  40     while (*in) {
  41         if (*in == '%' && in[1] && in[2]) {
  42             int i, j;
  43
  44             i = in[1] - '0';
  45             i -= (i > 9 ? 7 : 0);
  46             j = in[2] - '0';
  47             j -= (j > 9 ? 7 : 0);
  48
  49             *out++ = (i << 4) + j;
  50             if (!--outlen)
  51                 return;
  52             in += 3;
  53         } else {
  54             *out++ = *in++;
  55             if (!--outlen)
  56                 return;
  57         }
  58     }
  59     *out = '\0';
  60     return;
  61 }
  62
  63 void *open_settings_w(const char *sessionname, char **errmsg)
  64 {
  65     HKEY subkey1, sesskey;
  66     int ret;
  67     char *p;
  68
  69     *errmsg = NULL;
  70
  71     if (!sessionname || !*sessionname)
  72         sessionname = "Default Settings";
  73
  74     p = snewn(3 * strlen(sessionname) + 1, char);
  75     mungestr(sessionname, p);
  76
  77     ret = RegCreateKey(HKEY_CURRENT_USER, puttystr, &subkey1);
  78     if (ret != ERROR_SUCCESS) {
  79         sfree(p);
  80         *errmsg = dupprintf("Unable to create registry key\n"
  81                             "HKEY_CURRENT_USER%s", puttystr);
  82         return NULL;
  83     }
  84     ret = RegCreateKey(subkey1, p, &sesskey);
  85     sfree(p);
  86     RegCloseKey(subkey1);
  87     if (ret != ERROR_SUCCESS) {
  88         *errmsg = dupprintf("Unable to create registry key\n"
  89                             "HKEY_CURRENT_USER%s\\%s", puttystr, p);
  90         return NULL;
  91     }
  92     return (void *) sesskey;
  93 }
  94
  95 void write_setting_s(void *handle, const char *key, const char *value)
  96 {
  97     if (handle)
  98         RegSetValueEx((HKEY) handle, key, 0, REG_SZ, value,
  99                       1 + strlen(value));
 100 }
 101
 102 void write_setting_i(void *handle, const char *key, int value)
 103 {
 104     if (handle)
 105         RegSetValueEx((HKEY) handle, key, 0, REG_DWORD,
 106                       (CONST BYTE *) & value, sizeof(value));
 107 }
 108
 109 void close_settings_w(void *handle)
 110 {
 111     RegCloseKey((HKEY) handle);
 112 }
 113
 114 void *open_settings_r(const char *sessionname)
 115 {
 116     HKEY subkey1, sesskey;
 117     char *p;
 118
 119     if (!sessionname || !*sessionname)
 120         sessionname = "Default Settings";
 121
 122     p = snewn(3 * strlen(sessionname) + 1, char);
 123     mungestr(sessionname, p);
 124
 125     if (RegOpenKey(HKEY_CURRENT_USER, puttystr, &subkey1) != ERROR_SUCCESS) {
 126         sesskey = NULL;
 127     } else {
 128         if (RegOpenKey(subkey1, p, &sesskey) != ERROR_SUCCESS) {
 129             sesskey = NULL;
 130         }
 131         RegCloseKey(subkey1);
 132     }
 133
 134     sfree(p);
 135
 136     return (void *) sesskey;
 137 }
 138
 139 char *read_setting_s(void *handle, const char *key, char *buffer, int buflen)
 140 {
 141     DWORD type, size;
 142     size = buflen;
 143
 144     if (!handle ||
 145         RegQueryValueEx((HKEY) handle, key, 0,
 146                         &type, buffer, &size) != ERROR_SUCCESS ||
 147         type != REG_SZ) return NULL;
 148     else
 149         return buffer;
 150 }
 151
 152 int read_setting_i(void *handle, const char *key, int defvalue)
 153 {
 154     DWORD type, val, size;
 155     size = sizeof(val);
 156
 157     if (!handle ||
 158         RegQueryValueEx((HKEY) handle, key, 0, &type,
 159                         (BYTE *) & val, &size) != ERROR_SUCCESS ||
 160         size != sizeof(val) || type != REG_DWORD)
 161         return defvalue;
 162     else
 163         return val;
 164 }
 165
 166 int read_setting_fontspec(void *handle, const char *name, FontSpec *result)
 167 {
 168     char *settingname;
 169     FontSpec ret;
 170
 171     if (!read_setting_s(handle, name, ret.name, sizeof(ret.name)))
 172         return 0;
 173     settingname = dupcat(name, "IsBold", NULL);
 174     ret.isbold = read_setting_i(handle, settingname, -1);
 175     sfree(settingname);
 176     if (ret.isbold == -1) return 0;
 177     settingname = dupcat(name, "CharSet", NULL);
 178     ret.charset = read_setting_i(handle, settingname, -1);
 179     sfree(settingname);
 180     if (ret.charset == -1) return 0;
 181     settingname = dupcat(name, "Height", NULL);
 182     ret.height = read_setting_i(handle, settingname, INT_MIN);
 183     sfree(settingname);
 184     if (ret.height == INT_MIN) return 0;
 185     *result = ret;
 186     return 1;
 187 }
 188
 189 void write_setting_fontspec(void *handle, const char *name, FontSpec font)
 190 {
 191     char *settingname;
 192
 193     write_setting_s(handle, name, font.name);
 194     settingname = dupcat(name, "IsBold", NULL);
 195     write_setting_i(handle, settingname, font.isbold);
 196     sfree(settingname);
 197     settingname = dupcat(name, "CharSet", NULL);
 198     write_setting_i(handle, settingname, font.charset);
 199     sfree(settingname);
 200     settingname = dupcat(name, "Height", NULL);
 201     write_setting_i(handle, settingname, font.height);
 202     sfree(settingname);
 203 }
 204
 205 int read_setting_filename(void *handle, const char *name, Filename *result)
 206 {
 207     return !!read_setting_s(handle, name, result->path, sizeof(result->path));
 208 }
 209
 210 void write_setting_filename(void *handle, const char *name, Filename result)
 211 {
 212     write_setting_s(handle, name, result.path);
 213 }
 214
 215 void close_settings_r(void *handle)
 216 {
 217     RegCloseKey((HKEY) handle);
 218 }
 219
 220 void del_settings(const char *sessionname)
 221 {
 222     HKEY subkey1;
 223     char *p;
 224
 225     if (RegOpenKey(HKEY_CURRENT_USER, puttystr, &subkey1) != ERROR_SUCCESS)
 226         return;
 227
 228     p = snewn(3 * strlen(sessionname) + 1, char);
 229     mungestr(sessionname, p);
 230     RegDeleteKey(subkey1, p);
 231     sfree(p);
 232
 233     RegCloseKey(subkey1);
 234 }
 235
 236 struct enumsettings {
 237     HKEY key;
 238     int i;
 239 };
 240
 241 void *enum_settings_start(void)
 242 {
 243     struct enumsettings *ret;
 244     HKEY key;
 245
 246     if (RegOpenKey(HKEY_CURRENT_USER, puttystr, &key) != ERROR_SUCCESS)
 247         return NULL;
 248
 249     ret = snew(struct enumsettings);
 250     if (ret) {
 251         ret->key = key;
 252         ret->i = 0;
 253     }
 254
 255     return ret;
 256 }
 257
 258 char *enum_settings_next(void *handle, char *buffer, int buflen)
 259 {
 260     struct enumsettings *e = (struct enumsettings *) handle;
 261     char *otherbuf;
 262     otherbuf = snewn(3 * buflen, char);
 263     if (RegEnumKey(e->key, e->i++, otherbuf, 3 * buflen) == ERROR_SUCCESS) {
 264         unmungestr(otherbuf, buffer, buflen);
 265         sfree(otherbuf);
 266         return buffer;
 267     } else {
 268         sfree(otherbuf);
 269         return NULL;
 270     }
 271 }
 272
 273 void enum_settings_finish(void *handle)
 274 {
 275     struct enumsettings *e = (struct enumsettings *) handle;
 276     RegCloseKey(e->key);
 277     sfree(e);
 278 }
 279
 280 static void hostkey_regname(char *buffer, const char *hostname,
 281                             int port, const char *keytype)
 282 {
 283     int len;
 284     strcpy(buffer, keytype);
 285     strcat(buffer, "@");
 286     len = strlen(buffer);
 287     len += sprintf(buffer + len, "%d:", port);
 288     mungestr(hostname, buffer + strlen(buffer));
 289 }
 290
 291 int verify_host_key(const char *hostname, int port,
 292                     const char *keytype, const char *key)
 293 {
 294     char *otherstr, *regname;
 295     int len;
 296     HKEY rkey;
 297     DWORD readlen;
 298     DWORD type;
 299     int ret, compare;
 300
 301     len = 1 + strlen(key);
 302
 303     /*
 304      * Now read a saved key in from the registry and see what it
 305      * says.
 306      */
 307     otherstr = snewn(len, char);
 308     regname = snewn(3 * (strlen(hostname) + strlen(keytype)) + 15, char);
 309
 310     hostkey_regname(regname, hostname, port, keytype);
 311
 312     if (RegOpenKey(HKEY_CURRENT_USER, PUTTY_REG_POS "\\SshHostKeys",
 313                    &rkey) != ERROR_SUCCESS)
 314         return 1;                      /* key does not exist in registry */
 315
 316     readlen = len;
 317     ret = RegQueryValueEx(rkey, regname, NULL, &type, otherstr, &readlen);
 318
 319     if (ret != ERROR_SUCCESS && ret != ERROR_MORE_DATA &&
 320         !strcmp(keytype, "rsa")) {
 321         /*
 322          * Key didn't exist. If the key type is RSA, we'll try
 323          * another trick, which is to look up the _old_ key format
 324          * under just the hostname and translate that.
 325          */
 326         char *justhost = regname + 1 + strcspn(regname, ":");
 327         char *oldstyle = snewn(len + 10, char); /* safety margin */
 328         readlen = len;
 329         ret = RegQueryValueEx(rkey, justhost, NULL, &type,
 330                               oldstyle, &readlen);
 331
 332         if (ret == ERROR_SUCCESS && type == REG_SZ) {
 333             /*
 334              * The old format is two old-style bignums separated by
 335              * a slash. An old-style bignum is made of groups of
 336              * four hex digits: digits are ordered in sensible
 337              * (most to least significant) order within each group,
 338              * but groups are ordered in silly (least to most)
 339              * order within the bignum. The new format is two
 340              * ordinary C-format hex numbers (0xABCDEFG...XYZ, with
 341              * A nonzero except in the special case 0x0, which
 342              * doesn't appear anyway in RSA keys) separated by a
 343              * comma. All hex digits are lowercase in both formats.
 344              */
 345             char *p = otherstr;
 346             char *q = oldstyle;
 347             int i, j;
 348
 349             for (i = 0; i < 2; i++) {
 350                 int ndigits, nwords;
 351                 *p++ = '0';
 352                 *p++ = 'x';
 353                 ndigits = strcspn(q, "/");      /* find / or end of string */
 354                 nwords = ndigits / 4;
 355                 /* now trim ndigits to remove leading zeros */
 356                 while (q[(ndigits - 1) ^ 3] == '0' && ndigits > 1)
 357                     ndigits--;
 358                 /* now move digits over to new string */
 359                 for (j = 0; j < ndigits; j++)
 360                     p[ndigits - 1 - j] = q[j ^ 3];
 361                 p += ndigits;
 362                 q += nwords * 4;
 363                 if (*q) {
 364                     q++;               /* eat the slash */
 365                     *p++ = ',';        /* add a comma */
 366                 }
 367                 *p = '\0';             /* terminate the string */
 368             }
 369
 370             /*
 371              * Now _if_ this key matches, we'll enter it in the new
 372              * format. If not, we'll assume something odd went
 373              * wrong, and hyper-cautiously do nothing.
 374              */
 375             if (!strcmp(otherstr, key))
 376                 RegSetValueEx(rkey, regname, 0, REG_SZ, otherstr,
 377                               strlen(otherstr) + 1);
 378         }
 379     }
 380
 381     RegCloseKey(rkey);
 382
 383     compare = strcmp(otherstr, key);
 384
 385     sfree(otherstr);
 386     sfree(regname);
 387
 388     if (ret == ERROR_MORE_DATA ||
 389         (ret == ERROR_SUCCESS && type == REG_SZ && compare))
 390         return 2;                      /* key is different in registry */
 391     else if (ret != ERROR_SUCCESS || type != REG_SZ)
 392         return 1;                      /* key does not exist in registry */
 393     else
 394         return 0;                      /* key matched OK in registry */
 395 }
 396
 397 void store_host_key(const char *hostname, int port,
 398                     const char *keytype, const char *key)
 399 {
 400     char *regname;
 401     HKEY rkey;
 402
 403     regname = snewn(3 * (strlen(hostname) + strlen(keytype)) + 15, char);
 404
 405     hostkey_regname(regname, hostname, port, keytype);
 406
 407     if (RegCreateKey(HKEY_CURRENT_USER, PUTTY_REG_POS "\\SshHostKeys",
 408                      &rkey) != ERROR_SUCCESS)
 409         return;                        /* key does not exist in registry */
 410     RegSetValueEx(rkey, regname, 0, REG_SZ, key, strlen(key) + 1);
 411     RegCloseKey(rkey);
 412 }
 413
 414 /*
 415  * Find the random seed file path and store it in `seedpath'.
 416  */
 417 static void get_seedpath(void)
 418 {
 419     HKEY rkey;
 420     DWORD type, size;
 421
 422     size = sizeof(seedpath);
 423
 424     if (RegOpenKey(HKEY_CURRENT_USER, PUTTY_REG_POS, &rkey) ==
 425         ERROR_SUCCESS) {
 426         int ret = RegQueryValueEx(rkey, "RandSeedFile",
 427                                   0, &type, seedpath, &size);
 428         if (ret != ERROR_SUCCESS || type != REG_SZ)
 429             seedpath[0] = '\0';
 430         RegCloseKey(rkey);
 431     } else
 432         seedpath[0] = '\0';
 433
 434     if (!seedpath[0]) {
 435         int len, ret;
 436
 437         len =
 438             GetEnvironmentVariable("HOMEDRIVE", seedpath,
 439                                    sizeof(seedpath));
 440         ret =
 441             GetEnvironmentVariable("HOMEPATH", seedpath + len,
 442                                    sizeof(seedpath) - len);
 443         if (ret == 0) {                /* probably win95; store in \WINDOWS */
 444             GetWindowsDirectory(seedpath, sizeof(seedpath));
 445             len = strlen(seedpath);
 446         } else
 447             len += ret;
 448         strcpy(seedpath + len, "\\PUTTY.RND");
 449     }
 450 }
 451
 452 void read_random_seed(noise_consumer_t consumer)
 453 {
 454     HANDLE seedf;
 455
 456     if (!seedpath[0])
 457         get_seedpath();
 458
 459     seedf = CreateFile(seedpath, GENERIC_READ,
 460                        FILE_SHARE_READ | FILE_SHARE_WRITE,
 461                        NULL, OPEN_EXISTING, 0, NULL);
 462
 463     if (seedf != INVALID_HANDLE_VALUE) {
 464         while (1) {
 465             char buf[1024];
 466             DWORD len;
 467
 468             if (ReadFile(seedf, buf, sizeof(buf), &len, NULL) && len)
 469                 consumer(buf, len);
 470             else
 471                 break;
 472         }
 473         CloseHandle(seedf);
 474     }
 475 }
 476
 477 void write_random_seed(void *data, int len)
 478 {
 479     HANDLE seedf;
 480
 481     if (!seedpath[0])
 482         get_seedpath();
 483
 484     seedf = CreateFile(seedpath, GENERIC_WRITE, 0,
 485                        NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
 486
 487     if (seedf != INVALID_HANDLE_VALUE) {
 488         DWORD lenwritten;
 489
 490         WriteFile(seedf, data, len, &lenwritten, NULL);
 491         CloseHandle(seedf);
 492     }
 493 }
 494
 495 /*
 496  * Recursively delete a registry key and everything under it.
 497  */
 498 static void registry_recursive_remove(HKEY key)
 499 {
 500     DWORD i;
 501     char name[MAX_PATH + 1];
 502     HKEY subkey;
 503
 504     i = 0;
 505     while (RegEnumKey(key, i, name, sizeof(name)) == ERROR_SUCCESS) {
 506         if (RegOpenKey(key, name, &subkey) == ERROR_SUCCESS) {
 507             registry_recursive_remove(subkey);
 508             RegCloseKey(subkey);
 509         }
 510         RegDeleteKey(key, name);
 511     }
 512 }
 513
 514 void cleanup_all(void)
 515 {
 516     HKEY key;
 517     int ret;
 518     char name[MAX_PATH + 1];
 519
 520     /* ------------------------------------------------------------
 521      * Wipe out the random seed file.
 522      */
 523     if (!seedpath[0])
 524         get_seedpath();
 525     remove(seedpath);
 526
 527     /* ------------------------------------------------------------
 528      * Destroy all registry information associated with PuTTY.
 529      */
 530
 531     /*
 532      * Open the main PuTTY registry key and remove everything in it.
 533      */
 534     if (RegOpenKey(HKEY_CURRENT_USER, PUTTY_REG_POS, &key) ==
 535         ERROR_SUCCESS) {
 536         registry_recursive_remove(key);
 537         RegCloseKey(key);
 538     }
 539     /*
 540      * Now open the parent key and remove the PuTTY main key. Once
 541      * we've done that, see if the parent key has any other
 542      * children.
 543      */
 544     if (RegOpenKey(HKEY_CURRENT_USER, PUTTY_REG_PARENT,
 545                    &key) == ERROR_SUCCESS) {
 546         RegDeleteKey(key, PUTTY_REG_PARENT_CHILD);
 547         ret = RegEnumKey(key, 0, name, sizeof(name));
 548         RegCloseKey(key);
 549         /*
 550          * If the parent key had no other children, we must delete
 551          * it in its turn. That means opening the _grandparent_
 552          * key.
 553          */
 554         if (ret != ERROR_SUCCESS) {
 555             if (RegOpenKey(HKEY_CURRENT_USER, PUTTY_REG_GPARENT,
 556                            &key) == ERROR_SUCCESS) {
 557                 RegDeleteKey(key, PUTTY_REG_GPARENT_CHILD);
 558                 RegCloseKey(key);
 559             }
 560         }
 561     }
 562     /*
 563      * Now we're done.
 564      */
 565 }