windows/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 #include <shlobj.h>
  13 #ifndef CSIDL_APPDATA
  14 #define CSIDL_APPDATA 0x001a
  15 #endif
  16 #ifndef CSIDL_LOCAL_APPDATA
  17 #define CSIDL_LOCAL_APPDATA 0x001c
  18 #endif
  19
  20 static const char *const reg_jumplist_key = PUTTY_REG_POS "\\Jumplist";
  21 static const char *const reg_jumplist_value = "Recent sessions";
  22 static const char *const puttystr = PUTTY_REG_POS "\\Sessions";
  23
  24 static const char hex[16] = "0123456789ABCDEF";
  25
  26 static int tried_shgetfolderpath = FALSE;
  27 static HMODULE shell32_module = NULL;
  28 DECL_WINDOWS_FUNCTION(static, HRESULT, SHGetFolderPathA,
  29                       (HWND, int, HANDLE, DWORD, LPSTR));
  30
  31 static void mungestr(const char *in, char *out)
  32 {
  33     int candot = 0;
  34
  35     while (*in) {
  36         if (*in == ' ' || *in == '\\' || *in == '*' || *in == '?' ||
  37             *in == '%' || *in < ' ' || *in > '~' || (*in == '.'
  38                                                      && !candot)) {
  39             *out++ = '%';
  40             *out++ = hex[((unsigned char) *in) >> 4];
  41             *out++ = hex[((unsigned char) *in) & 15];
  42         } else
  43             *out++ = *in;
  44         in++;
  45         candot = 1;
  46     }
  47     *out = '\0';
  48     return;
  49 }
  50
  51 static void unmungestr(const char *in, char *out, int outlen)
  52 {
  53     while (*in) {
  54         if (*in == '%' && in[1] && in[2]) {
  55             int i, j;
  56
  57             i = in[1] - '0';
  58             i -= (i > 9 ? 7 : 0);
  59             j = in[2] - '0';
  60             j -= (j > 9 ? 7 : 0);
  61
  62             *out++ = (i << 4) + j;
  63             if (!--outlen)
  64                 return;
  65             in += 3;
  66         } else {
  67             *out++ = *in++;
  68             if (!--outlen)
  69                 return;
  70         }
  71     }
  72     *out = '\0';
  73     return;
  74 }
  75
  76 void *open_settings_w(const char *sessionname, char **errmsg)
  77 {
  78     HKEY subkey1, sesskey;
  79     int ret;
  80     char *p;
  81
  82     *errmsg = NULL;
  83
  84     if (!sessionname || !*sessionname)
  85         sessionname = "Default Settings";
  86
  87     p = snewn(3 * strlen(sessionname) + 1, char);
  88     mungestr(sessionname, p);
  89
  90     ret = RegCreateKey(HKEY_CURRENT_USER, puttystr, &subkey1);
  91     if (ret != ERROR_SUCCESS) {
  92         sfree(p);
  93         *errmsg = dupprintf("Unable to create registry key\n"
  94                             "HKEY_CURRENT_USER\\%s", puttystr);
  95         return NULL;
  96     }
  97     ret = RegCreateKey(subkey1, p, &sesskey);
  98     RegCloseKey(subkey1);
  99     if (ret != ERROR_SUCCESS) {
 100         *errmsg = dupprintf("Unable to create registry key\n"
 101                             "HKEY_CURRENT_USER\\%s\\%s", puttystr, p);
 102         sfree(p);
 103         return NULL;
 104     }
 105     sfree(p);
 106     return (void *) sesskey;
 107 }
 108
 109 void write_setting_s(void *handle, const char *key, const char *value)
 110 {
 111     if (handle)
 112         RegSetValueEx((HKEY) handle, key, 0, REG_SZ, value,
 113                       1 + strlen(value));
 114 }
 115
 116 void write_setting_i(void *handle, const char *key, int value)
 117 {
 118     if (handle)
 119         RegSetValueEx((HKEY) handle, key, 0, REG_DWORD,
 120                       (CONST BYTE *) &value, sizeof(value));
 121 }
 122
 123 void close_settings_w(void *handle)
 124 {
 125     RegCloseKey((HKEY) handle);
 126 }
 127
 128 void *open_settings_r(const char *sessionname)
 129 {
 130     HKEY subkey1, sesskey;
 131     char *p;
 132
 133     if (!sessionname || !*sessionname)
 134         sessionname = "Default Settings";
 135
 136     p = snewn(3 * strlen(sessionname) + 1, char);
 137     mungestr(sessionname, p);
 138
 139     if (RegOpenKey(HKEY_CURRENT_USER, puttystr, &subkey1) != ERROR_SUCCESS) {
 140         sesskey = NULL;
 141     } else {
 142         if (RegOpenKey(subkey1, p, &sesskey) != ERROR_SUCCESS) {
 143             sesskey = NULL;
 144         }
 145         RegCloseKey(subkey1);
 146     }
 147
 148     sfree(p);
 149
 150     return (void *) sesskey;
 151 }
 152
 153 char *read_setting_s(void *handle, const char *key)
 154 {
 155     DWORD type, size;
 156     char *ret;
 157
 158     if (!handle)
 159         return NULL;
 160
 161     /* Find out the type and size of the data. */
 162     if (RegQueryValueEx((HKEY) handle, key, 0,
 163                         &type, NULL, &size) != ERROR_SUCCESS ||
 164         type != REG_SZ)
 165         return NULL;
 166
 167     ret = snewn(size+1, char);
 168     if (RegQueryValueEx((HKEY) handle, key, 0,
 169                         &type, ret, &size) != ERROR_SUCCESS ||
 170         type != REG_SZ) {
 171         sfree(ret);
 172         return NULL;
 173     }
 174
 175     return ret;
 176 }
 177
 178 int read_setting_i(void *handle, const char *key, int defvalue)
 179 {
 180     DWORD type, val, size;
 181     size = sizeof(val);
 182
 183     if (!handle ||
 184         RegQueryValueEx((HKEY) handle, key, 0, &type,
 185                         (BYTE *) &val, &size) != ERROR_SUCCESS ||
 186         size != sizeof(val) || type != REG_DWORD)
 187         return defvalue;
 188     else
 189         return val;
 190 }
 191
 192 FontSpec *read_setting_fontspec(void *handle, const char *name)
 193 {
 194     char *settingname;
 195     char *fontname;
 196     FontSpec *ret;
 197     int isbold, height, charset;
 198
 199     fontname = read_setting_s(handle, name);
 200     if (!fontname)
 201         return NULL;
 202
 203     settingname = dupcat(name, "IsBold", NULL);
 204     isbold = read_setting_i(handle, settingname, -1);
 205     sfree(settingname);
 206     if (isbold == -1) {
 207         sfree(fontname);
 208         return NULL;
 209     }
 210
 211     settingname = dupcat(name, "CharSet", NULL);
 212     charset = read_setting_i(handle, settingname, -1);
 213     sfree(settingname);
 214     if (charset == -1) {
 215         sfree(fontname);
 216         return NULL;
 217     }
 218
 219     settingname = dupcat(name, "Height", NULL);
 220     height = read_setting_i(handle, settingname, INT_MIN);
 221     sfree(settingname);
 222     if (height == INT_MIN) {
 223         sfree(fontname);
 224         return NULL;
 225     }
 226
 227     ret = fontspec_new(fontname, isbold, height, charset);
 228     sfree(fontname);
 229     return ret;
 230 }
 231
 232 void write_setting_fontspec(void *handle, const char *name, FontSpec *font)
 233 {
 234     char *settingname;
 235
 236     write_setting_s(handle, name, font->name);
 237     settingname = dupcat(name, "IsBold", NULL);
 238     write_setting_i(handle, settingname, font->isbold);
 239     sfree(settingname);
 240     settingname = dupcat(name, "CharSet", NULL);
 241     write_setting_i(handle, settingname, font->charset);
 242     sfree(settingname);
 243     settingname = dupcat(name, "Height", NULL);
 244     write_setting_i(handle, settingname, font->height);
 245     sfree(settingname);
 246 }
 247
 248 Filename *read_setting_filename(void *handle, const char *name)
 249 {
 250     char *tmp = read_setting_s(handle, name);
 251     if (tmp) {
 252         Filename *ret = filename_from_str(tmp);
 253         sfree(tmp);
 254         return ret;
 255     } else
 256         return NULL;
 257 }
 258
 259 void write_setting_filename(void *handle, const char *name, Filename *result)
 260 {
 261     write_setting_s(handle, name, result->path);
 262 }
 263
 264 void close_settings_r(void *handle)
 265 {
 266     RegCloseKey((HKEY) handle);
 267 }
 268
 269 void del_settings(const char *sessionname)
 270 {
 271     HKEY subkey1;
 272     char *p;
 273
 274     if (RegOpenKey(HKEY_CURRENT_USER, puttystr, &subkey1) != ERROR_SUCCESS)
 275         return;
 276
 277     p = snewn(3 * strlen(sessionname) + 1, char);
 278     mungestr(sessionname, p);
 279     RegDeleteKey(subkey1, p);
 280     sfree(p);
 281
 282     RegCloseKey(subkey1);
 283
 284     remove_session_from_jumplist(sessionname);
 285 }
 286
 287 struct enumsettings {
 288     HKEY key;
 289     int i;
 290 };
 291
 292 void *enum_settings_start(void)
 293 {
 294     struct enumsettings *ret;
 295     HKEY key;
 296
 297     if (RegOpenKey(HKEY_CURRENT_USER, puttystr, &key) != ERROR_SUCCESS)
 298         return NULL;
 299
 300     ret = snew(struct enumsettings);
 301     if (ret) {
 302         ret->key = key;
 303         ret->i = 0;
 304     }
 305
 306     return ret;
 307 }
 308
 309 char *enum_settings_next(void *handle, char *buffer, int buflen)
 310 {
 311     struct enumsettings *e = (struct enumsettings *) handle;
 312     char *otherbuf;
 313     otherbuf = snewn(3 * buflen, char);
 314     if (RegEnumKey(e->key, e->i++, otherbuf, 3 * buflen) == ERROR_SUCCESS) {
 315         unmungestr(otherbuf, buffer, buflen);
 316         sfree(otherbuf);
 317         return buffer;
 318     } else {
 319         sfree(otherbuf);
 320         return NULL;
 321     }
 322 }
 323
 324 void enum_settings_finish(void *handle)
 325 {
 326     struct enumsettings *e = (struct enumsettings *) handle;
 327     RegCloseKey(e->key);
 328     sfree(e);
 329 }
 330
 331 static void hostkey_regname(char *buffer, const char *hostname,
 332                             int port, const char *keytype)
 333 {
 334     int len;
 335     strcpy(buffer, keytype);
 336     strcat(buffer, "@");
 337     len = strlen(buffer);
 338     len += sprintf(buffer + len, "%d:", port);
 339     mungestr(hostname, buffer + strlen(buffer));
 340 }
 341
 342 int verify_host_key(const char *hostname, int port,
 343                     const char *keytype, const char *key)
 344 {
 345     char *otherstr, *regname;
 346     int len;
 347     HKEY rkey;
 348     DWORD readlen;
 349     DWORD type;
 350     int ret, compare;
 351
 352     len = 1 + strlen(key);
 353
 354     /*
 355      * Now read a saved key in from the registry and see what it
 356      * says.
 357      */
 358     regname = snewn(3 * (strlen(hostname) + strlen(keytype)) + 15, char);
 359
 360     hostkey_regname(regname, hostname, port, keytype);
 361
 362     if (RegOpenKey(HKEY_CURRENT_USER, PUTTY_REG_POS "\\SshHostKeys",
 363                    &rkey) != ERROR_SUCCESS) {
 364         sfree(regname);
 365         return 1;                      /* key does not exist in registry */
 366     }
 367
 368     readlen = len;
 369     otherstr = snewn(len, char);
 370     ret = RegQueryValueEx(rkey, regname, NULL, &type, otherstr, &readlen);
 371
 372     if (ret != ERROR_SUCCESS && ret != ERROR_MORE_DATA &&
 373         !strcmp(keytype, "rsa")) {
 374         /*
 375          * Key didn't exist. If the key type is RSA, we'll try
 376          * another trick, which is to look up the _old_ key format
 377          * under just the hostname and translate that.
 378          */
 379         char *justhost = regname + 1 + strcspn(regname, ":");
 380         char *oldstyle = snewn(len + 10, char); /* safety margin */
 381         readlen = len;
 382         ret = RegQueryValueEx(rkey, justhost, NULL, &type,
 383                               oldstyle, &readlen);
 384
 385         if (ret == ERROR_SUCCESS && type == REG_SZ) {
 386             /*
 387              * The old format is two old-style bignums separated by
 388              * a slash. An old-style bignum is made of groups of
 389              * four hex digits: digits are ordered in sensible
 390              * (most to least significant) order within each group,
 391              * but groups are ordered in silly (least to most)
 392              * order within the bignum. The new format is two
 393              * ordinary C-format hex numbers (0xABCDEFG...XYZ, with
 394              * A nonzero except in the special case 0x0, which
 395              * doesn't appear anyway in RSA keys) separated by a
 396              * comma. All hex digits are lowercase in both formats.
 397              */
 398             char *p = otherstr;
 399             char *q = oldstyle;
 400             int i, j;
 401
 402             for (i = 0; i < 2; i++) {
 403                 int ndigits, nwords;
 404                 *p++ = '0';
 405                 *p++ = 'x';
 406                 ndigits = strcspn(q, "/");      /* find / or end of string */
 407                 nwords = ndigits / 4;
 408                 /* now trim ndigits to remove leading zeros */
 409                 while (q[(ndigits - 1) ^ 3] == '0' && ndigits > 1)
 410                     ndigits--;
 411                 /* now move digits over to new string */
 412                 for (j = 0; j < ndigits; j++)
 413                     p[ndigits - 1 - j] = q[j ^ 3];
 414                 p += ndigits;
 415                 q += nwords * 4;
 416                 if (*q) {
 417                     q++;               /* eat the slash */
 418                     *p++ = ',';        /* add a comma */
 419                 }
 420                 *p = '\0';             /* terminate the string */
 421             }
 422
 423             /*
 424              * Now _if_ this key matches, we'll enter it in the new
 425              * format. If not, we'll assume something odd went
 426              * wrong, and hyper-cautiously do nothing.
 427              */
 428             if (!strcmp(otherstr, key))
 429                 RegSetValueEx(rkey, regname, 0, REG_SZ, otherstr,
 430                               strlen(otherstr) + 1);
 431         }
 432
 433         sfree(oldstyle);
 434     }
 435
 436     RegCloseKey(rkey);
 437
 438     compare = strcmp(otherstr, key);
 439
 440     sfree(otherstr);
 441     sfree(regname);
 442
 443     if (ret == ERROR_MORE_DATA ||
 444         (ret == ERROR_SUCCESS && type == REG_SZ && compare))
 445         return 2;                      /* key is different in registry */
 446     else if (ret != ERROR_SUCCESS || type != REG_SZ)
 447         return 1;                      /* key does not exist in registry */
 448     else
 449         return 0;                      /* key matched OK in registry */
 450 }
 451
 452 void store_host_key(const char *hostname, int port,
 453                     const char *keytype, const char *key)
 454 {
 455     char *regname;
 456     HKEY rkey;
 457
 458     regname = snewn(3 * (strlen(hostname) + strlen(keytype)) + 15, char);
 459
 460     hostkey_regname(regname, hostname, port, keytype);
 461
 462     if (RegCreateKey(HKEY_CURRENT_USER, PUTTY_REG_POS "\\SshHostKeys",
 463                      &rkey) == ERROR_SUCCESS) {
 464         RegSetValueEx(rkey, regname, 0, REG_SZ, key, strlen(key) + 1);
 465         RegCloseKey(rkey);
 466     } /* else key does not exist in registry */
 467
 468     sfree(regname);
 469 }
 470
 471 /*
 472  * Open (or delete) the random seed file.
 473  */
 474 enum { DEL, OPEN_R, OPEN_W };
 475 static int try_random_seed(char const *path, int action, HANDLE *ret)
 476 {
 477     if (action == DEL) {
 478         if (!DeleteFile(path) && GetLastError() != ERROR_FILE_NOT_FOUND) {
 479             nonfatal("Unable to delete '%s': %s", path,
 480                      win_strerror(GetLastError()));
 481         }
 482         *ret = INVALID_HANDLE_VALUE;
 483         return FALSE;                  /* so we'll do the next ones too */
 484     }
 485
 486     *ret = CreateFile(path,
 487                       action == OPEN_W ? GENERIC_WRITE : GENERIC_READ,
 488                       action == OPEN_W ? 0 : (FILE_SHARE_READ |
 489                                               FILE_SHARE_WRITE),
 490                       NULL,
 491                       action == OPEN_W ? CREATE_ALWAYS : OPEN_EXISTING,
 492                       action == OPEN_W ? FILE_ATTRIBUTE_NORMAL : 0,
 493                       NULL);
 494
 495     return (*ret != INVALID_HANDLE_VALUE);
 496 }
 497
 498 static HANDLE access_random_seed(int action)
 499 {
 500     HKEY rkey;
 501     DWORD type, size;
 502     HANDLE rethandle;
 503     char seedpath[2 * MAX_PATH + 10] = "\0";
 504
 505     /*
 506      * Iterate over a selection of possible random seed paths until
 507      * we find one that works.
 508      *
 509      * We do this iteration separately for reading and writing,
 510      * meaning that we will automatically migrate random seed files
 511      * if a better location becomes available (by reading from the
 512      * best location in which we actually find one, and then
 513      * writing to the best location in which we can _create_ one).
 514      */
 515
 516     /*
 517      * First, try the location specified by the user in the
 518      * Registry, if any.
 519      */
 520     size = sizeof(seedpath);
 521     if (RegOpenKey(HKEY_CURRENT_USER, PUTTY_REG_POS, &rkey) ==
 522         ERROR_SUCCESS) {
 523         int ret = RegQueryValueEx(rkey, "RandSeedFile",
 524                                   0, &type, seedpath, &size);
 525         if (ret != ERROR_SUCCESS || type != REG_SZ)
 526             seedpath[0] = '\0';
 527         RegCloseKey(rkey);
 528
 529         if (*seedpath && try_random_seed(seedpath, action, &rethandle))
 530             return rethandle;
 531     }
 532
 533     /*
 534      * Next, try the user's local Application Data directory,
 535      * followed by their non-local one. This is found using the
 536      * SHGetFolderPath function, which won't be present on all
 537      * versions of Windows.
 538      */
 539     if (!tried_shgetfolderpath) {
 540         /* This is likely only to bear fruit on systems with IE5+
 541          * installed, or WinMe/2K+. There is some faffing with
 542          * SHFOLDER.DLL we could do to try to find an equivalent
 543          * on older versions of Windows if we cared enough.
 544          * However, the invocation below requires IE5+ anyway,
 545          * so stuff that. */
 546         shell32_module = load_system32_dll("shell32.dll");
 547         GET_WINDOWS_FUNCTION(shell32_module, SHGetFolderPathA);
 548         tried_shgetfolderpath = TRUE;
 549     }
 550     if (p_SHGetFolderPathA) {
 551         if (SUCCEEDED(p_SHGetFolderPathA(NULL, CSIDL_LOCAL_APPDATA,
 552                                          NULL, SHGFP_TYPE_CURRENT, seedpath))) {
 553             strcat(seedpath, "\\PUTTY.RND");
 554             if (try_random_seed(seedpath, action, &rethandle))
 555                 return rethandle;
 556         }
 557
 558         if (SUCCEEDED(p_SHGetFolderPathA(NULL, CSIDL_APPDATA,
 559                                          NULL, SHGFP_TYPE_CURRENT, seedpath))) {
 560             strcat(seedpath, "\\PUTTY.RND");
 561             if (try_random_seed(seedpath, action, &rethandle))
 562                 return rethandle;
 563         }
 564     }
 565
 566     /*
 567      * Failing that, try %HOMEDRIVE%%HOMEPATH% as a guess at the
 568      * user's home directory.
 569      */
 570     {
 571         int len, ret;
 572
 573         len =
 574             GetEnvironmentVariable("HOMEDRIVE", seedpath,
 575                                    sizeof(seedpath));
 576         ret =
 577             GetEnvironmentVariable("HOMEPATH", seedpath + len,
 578                                    sizeof(seedpath) - len);
 579         if (ret != 0) {
 580             strcat(seedpath, "\\PUTTY.RND");
 581             if (try_random_seed(seedpath, action, &rethandle))
 582                 return rethandle;
 583         }
 584     }
 585
 586     /*
 587      * And finally, fall back to C:\WINDOWS.
 588      */
 589     GetWindowsDirectory(seedpath, sizeof(seedpath));
 590     strcat(seedpath, "\\PUTTY.RND");
 591     if (try_random_seed(seedpath, action, &rethandle))
 592         return rethandle;
 593
 594     /*
 595      * If even that failed, give up.
 596      */
 597     return INVALID_HANDLE_VALUE;
 598 }
 599
 600 void read_random_seed(noise_consumer_t consumer)
 601 {
 602     HANDLE seedf = access_random_seed(OPEN_R);
 603
 604     if (seedf != INVALID_HANDLE_VALUE) {
 605         while (1) {
 606             char buf[1024];
 607             DWORD len;
 608
 609             if (ReadFile(seedf, buf, sizeof(buf), &len, NULL) && len)
 610                 consumer(buf, len);
 611             else
 612                 break;
 613         }
 614         CloseHandle(seedf);
 615     }
 616 }
 617
 618 void write_random_seed(void *data, int len)
 619 {
 620     HANDLE seedf = access_random_seed(OPEN_W);
 621
 622     if (seedf != INVALID_HANDLE_VALUE) {
 623         DWORD lenwritten;
 624
 625         WriteFile(seedf, data, len, &lenwritten, NULL);
 626         CloseHandle(seedf);
 627     }
 628 }
 629
 630 /*
 631  * Internal function supporting the jump list registry code. All the
 632  * functions to add, remove and read the list have substantially
 633  * similar content, so this is a generalisation of all of them which
 634  * transforms the list in the registry by prepending 'add' (if
 635  * non-null), removing 'rem' from what's left (if non-null), and
 636  * returning the resulting concatenated list of strings in 'out' (if
 637  * non-null).
 638  */
 639 static int transform_jumplist_registry
 640     (const char *add, const char *rem, char **out)
 641 {
 642     int ret;
 643     HKEY pjumplist_key, psettings_tmp;
 644     DWORD type;
 645     int value_length;
 646     char *old_value, *new_value;
 647     char *piterator_old, *piterator_new, *piterator_tmp;
 648
 649     ret = RegCreateKeyEx(HKEY_CURRENT_USER, reg_jumplist_key, 0, NULL,
 650                          REG_OPTION_NON_VOLATILE, (KEY_READ | KEY_WRITE), NULL,
 651                          &pjumplist_key, NULL);
 652     if (ret != ERROR_SUCCESS) {
 653         return JUMPLISTREG_ERROR_KEYOPENCREATE_FAILURE;
 654     }
 655
 656     /* Get current list of saved sessions in the registry. */
 657     value_length = 200;
 658     old_value = snewn(value_length, char);
 659     ret = RegQueryValueEx(pjumplist_key, reg_jumplist_value, NULL, &type,
 660                           old_value, &value_length);
 661     /* When the passed buffer is too small, ERROR_MORE_DATA is
 662      * returned and the required size is returned in the length
 663      * argument. */
 664     if (ret == ERROR_MORE_DATA) {
 665         sfree(old_value);
 666         old_value = snewn(value_length, char);
 667         ret = RegQueryValueEx(pjumplist_key, reg_jumplist_value, NULL, &type,
 668                               old_value, &value_length);
 669     }
 670
 671     if (ret == ERROR_FILE_NOT_FOUND) {
 672         /* Value doesn't exist yet. Start from an empty value. */
 673         *old_value = '\0';
 674         *(old_value + 1) = '\0';
 675     } else if (ret != ERROR_SUCCESS) {
 676         /* Some non-recoverable error occurred. */
 677         sfree(old_value);
 678         RegCloseKey(pjumplist_key);
 679         return JUMPLISTREG_ERROR_VALUEREAD_FAILURE;
 680     } else if (type != REG_MULTI_SZ) {
 681         /* The value present in the registry has the wrong type: we
 682          * try to delete it and start from an empty value. */
 683         ret = RegDeleteValue(pjumplist_key, reg_jumplist_value);
 684         if (ret != ERROR_SUCCESS) {
 685             sfree(old_value);
 686             RegCloseKey(pjumplist_key);
 687             return JUMPLISTREG_ERROR_VALUEREAD_FAILURE;
 688         }
 689
 690         *old_value = '\0';
 691         *(old_value + 1) = '\0';
 692     }
 693
 694     /* Check validity of registry data: REG_MULTI_SZ value must end
 695      * with \0\0. */
 696     piterator_tmp = old_value;
 697     while (((piterator_tmp - old_value) < (value_length - 1)) &&
 698            !(*piterator_tmp == '\0' && *(piterator_tmp+1) == '\0')) {
 699         ++piterator_tmp;
 700     }
 701
 702     if ((piterator_tmp - old_value) >= (value_length-1)) {
 703         /* Invalid value. Start from an empty value. */
 704         *old_value = '\0';
 705         *(old_value + 1) = '\0';
 706     }
 707
 708     /*
 709      * Modify the list, if we're modifying.
 710      */
 711     if (add || rem) {
 712         /* Walk through the existing list and construct the new list of
 713          * saved sessions. */
 714         new_value = snewn(value_length + (add ? strlen(add) + 1 : 0), char);
 715         piterator_new = new_value;
 716         piterator_old = old_value;
 717
 718         /* First add the new item to the beginning of the list. */
 719         if (add) {
 720             strcpy(piterator_new, add);
 721             piterator_new += strlen(piterator_new) + 1;
 722         }
 723         /* Now add the existing list, taking care to leave out the removed
 724          * item, if it was already in the existing list. */
 725         while (*piterator_old != '\0') {
 726             if (!rem || strcmp(piterator_old, rem) != 0) {
 727                 /* Check if this is a valid session, otherwise don't add. */
 728                 psettings_tmp = open_settings_r(piterator_old);
 729                 if (psettings_tmp != NULL) {
 730                     close_settings_r(psettings_tmp);
 731                     strcpy(piterator_new, piterator_old);
 732                     piterator_new += strlen(piterator_new) + 1;
 733                 }
 734             }
 735             piterator_old += strlen(piterator_old) + 1;
 736         }
 737         *piterator_new = '\0';
 738         ++piterator_new;
 739
 740         /* Save the new list to the registry. */
 741         ret = RegSetValueEx(pjumplist_key, reg_jumplist_value, 0, REG_MULTI_SZ,
 742                             new_value, piterator_new - new_value);
 743
 744         sfree(old_value);
 745         old_value = new_value;
 746     } else
 747         ret = ERROR_SUCCESS;
 748
 749     /*
 750      * Either return or free the result.
 751      */
 752     if (out && ret == ERROR_SUCCESS)
 753         *out = old_value;
 754     else
 755         sfree(old_value);
 756
 757     /* Clean up and return. */
 758     RegCloseKey(pjumplist_key);
 759
 760     if (ret != ERROR_SUCCESS) {
 761         return JUMPLISTREG_ERROR_VALUEWRITE_FAILURE;
 762     } else {
 763         return JUMPLISTREG_OK;
 764     }
 765 }
 766
 767 /* Adds a new entry to the jumplist entries in the registry. */
 768 int add_to_jumplist_registry(const char *item)
 769 {
 770     return transform_jumplist_registry(item, item, NULL);
 771 }
 772
 773 /* Removes an item from the jumplist entries in the registry. */
 774 int remove_from_jumplist_registry(const char *item)
 775 {
 776     return transform_jumplist_registry(NULL, item, NULL);
 777 }
 778
 779 /* Returns the jumplist entries from the registry. Caller must free
 780  * the returned pointer. */
 781 char *get_jumplist_registry_entries (void)
 782 {
 783     char *list_value;
 784
 785     if (transform_jumplist_registry(NULL,NULL,&list_value) != JUMPLISTREG_OK) {
 786         list_value = snewn(2, char);
 787         *list_value = '\0';
 788         *(list_value + 1) = '\0';
 789     }
 790     return list_value;
 791 }
 792
 793 /*
 794  * Recursively delete a registry key and everything under it.
 795  */
 796 static void registry_recursive_remove(HKEY key)
 797 {
 798     DWORD i;
 799     char name[MAX_PATH + 1];
 800     HKEY subkey;
 801
 802     i = 0;
 803     while (RegEnumKey(key, i, name, sizeof(name)) == ERROR_SUCCESS) {
 804         if (RegOpenKey(key, name, &subkey) == ERROR_SUCCESS) {
 805             registry_recursive_remove(subkey);
 806             RegCloseKey(subkey);
 807         }
 808         RegDeleteKey(key, name);
 809     }
 810 }
 811
 812 void cleanup_all(void)
 813 {
 814     HKEY key;
 815     int ret;
 816     char name[MAX_PATH + 1];
 817
 818     /* ------------------------------------------------------------
 819      * Wipe out the random seed file, in all of its possible
 820      * locations.
 821      */
 822     access_random_seed(DEL);
 823
 824     /* ------------------------------------------------------------
 825      * Ask Windows to delete any jump list information associated
 826      * with this installation of PuTTY.
 827      */
 828     clear_jumplist();
 829
 830     /* ------------------------------------------------------------
 831      * Destroy all registry information associated with PuTTY.
 832      */
 833
 834     /*
 835      * Open the main PuTTY registry key and remove everything in it.
 836      */
 837     if (RegOpenKey(HKEY_CURRENT_USER, PUTTY_REG_POS, &key) ==
 838         ERROR_SUCCESS) {
 839         registry_recursive_remove(key);
 840         RegCloseKey(key);
 841     }
 842     /*
 843      * Now open the parent key and remove the PuTTY main key. Once
 844      * we've done that, see if the parent key has any other
 845      * children.
 846      */
 847     if (RegOpenKey(HKEY_CURRENT_USER, PUTTY_REG_PARENT,
 848                    &key) == ERROR_SUCCESS) {
 849         RegDeleteKey(key, PUTTY_REG_PARENT_CHILD);
 850         ret = RegEnumKey(key, 0, name, sizeof(name));
 851         RegCloseKey(key);
 852         /*
 853          * If the parent key had no other children, we must delete
 854          * it in its turn. That means opening the _grandparent_
 855          * key.
 856          */
 857         if (ret != ERROR_SUCCESS) {
 858             if (RegOpenKey(HKEY_CURRENT_USER, PUTTY_REG_GPARENT,
 859                            &key) == ERROR_SUCCESS) {
 860                 RegDeleteKey(key, PUTTY_REG_GPARENT_CHILD);
 861                 RegCloseKey(key);
 862             }
 863         }
 864     }
 865     /*
 866      * Now we're done.
 867      */
 868 }