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