2 * winstore.c: Windows-specific implementation of the interface
3 * defined in storage.h.
14 #define CSIDL_APPDATA 0x001a
16 #ifndef CSIDL_LOCAL_APPDATA
17 #define CSIDL_LOCAL_APPDATA 0x001c
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";
24 static const char hex
[16] = "0123456789ABCDEF";
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
));
31 static void mungestr(const char *in
, char *out
)
36 if (*in
== ' ' || *in
== '\\' || *in
== '*' || *in
== '?' ||
37 *in
== '%' || *in
< ' ' || *in
> '~' || (*in
== '.'
40 *out
++ = hex
[((unsigned char) *in
) >> 4];
41 *out
++ = hex
[((unsigned char) *in
) & 15];
51 static void unmungestr(const char *in
, char *out
, int outlen
)
54 if (*in
== '%' && in
[1] && in
[2]) {
62 *out
++ = (i
<< 4) + j
;
76 void *open_settings_w(const char *sessionname
, char **errmsg
)
78 HKEY subkey1
, sesskey
;
84 if (!sessionname
|| !*sessionname
)
85 sessionname
= "Default Settings";
87 p
= snewn(3 * strlen(sessionname
) + 1, char);
88 mungestr(sessionname
, p
);
90 ret
= RegCreateKey(HKEY_CURRENT_USER
, puttystr
, &subkey1
);
91 if (ret
!= ERROR_SUCCESS
) {
93 *errmsg
= dupprintf("Unable to create registry key\n"
94 "HKEY_CURRENT_USER\\%s", puttystr
);
97 ret
= RegCreateKey(subkey1
, p
, &sesskey
);
99 if (ret
!= ERROR_SUCCESS
) {
100 *errmsg
= dupprintf("Unable to create registry key\n"
101 "HKEY_CURRENT_USER\\%s\\%s", puttystr
, p
);
106 return (void *) sesskey
;
109 void write_setting_s(void *handle
, const char *key
, const char *value
)
112 RegSetValueEx((HKEY
) handle
, key
, 0, REG_SZ
, value
,
116 void write_setting_i(void *handle
, const char *key
, int value
)
119 RegSetValueEx((HKEY
) handle
, key
, 0, REG_DWORD
,
120 (CONST BYTE
*) &value
, sizeof(value
));
123 void close_settings_w(void *handle
)
125 RegCloseKey((HKEY
) handle
);
128 void *open_settings_r(const char *sessionname
)
130 HKEY subkey1
, sesskey
;
133 if (!sessionname
|| !*sessionname
)
134 sessionname
= "Default Settings";
136 p
= snewn(3 * strlen(sessionname
) + 1, char);
137 mungestr(sessionname
, p
);
139 if (RegOpenKey(HKEY_CURRENT_USER
, puttystr
, &subkey1
) != ERROR_SUCCESS
) {
142 if (RegOpenKey(subkey1
, p
, &sesskey
) != ERROR_SUCCESS
) {
145 RegCloseKey(subkey1
);
150 return (void *) sesskey
;
153 char *read_setting_s(void *handle
, const char *key
)
161 /* Find out the type and size of the data. */
162 if (RegQueryValueEx((HKEY
) handle
, key
, 0,
163 &type
, NULL
, &size
) != ERROR_SUCCESS
||
167 ret
= snewn(size
+1, char);
168 if (RegQueryValueEx((HKEY
) handle
, key
, 0,
169 &type
, ret
, &size
) != ERROR_SUCCESS
||
178 int read_setting_i(void *handle
, const char *key
, int defvalue
)
180 DWORD type
, val
, size
;
184 RegQueryValueEx((HKEY
) handle
, key
, 0, &type
,
185 (BYTE
*) &val
, &size
) != ERROR_SUCCESS
||
186 size
!= sizeof(val
) || type
!= REG_DWORD
)
192 FontSpec
*read_setting_fontspec(void *handle
, const char *name
)
197 int isbold
, height
, charset
;
199 fontname
= read_setting_s(handle
, name
);
203 settingname
= dupcat(name
, "IsBold", NULL
);
204 isbold
= read_setting_i(handle
, settingname
, -1);
211 settingname
= dupcat(name
, "CharSet", NULL
);
212 charset
= read_setting_i(handle
, settingname
, -1);
219 settingname
= dupcat(name
, "Height", NULL
);
220 height
= read_setting_i(handle
, settingname
, INT_MIN
);
222 if (height
== INT_MIN
) {
227 ret
= fontspec_new(fontname
, isbold
, height
, charset
);
232 void write_setting_fontspec(void *handle
, const char *name
, FontSpec
*font
)
236 write_setting_s(handle
, name
, font
->name
);
237 settingname
= dupcat(name
, "IsBold", NULL
);
238 write_setting_i(handle
, settingname
, font
->isbold
);
240 settingname
= dupcat(name
, "CharSet", NULL
);
241 write_setting_i(handle
, settingname
, font
->charset
);
243 settingname
= dupcat(name
, "Height", NULL
);
244 write_setting_i(handle
, settingname
, font
->height
);
248 Filename
*read_setting_filename(void *handle
, const char *name
)
250 char *tmp
= read_setting_s(handle
, name
);
252 Filename
*ret
= filename_from_str(tmp
);
259 void write_setting_filename(void *handle
, const char *name
, Filename
*result
)
261 write_setting_s(handle
, name
, result
->path
);
264 void close_settings_r(void *handle
)
266 RegCloseKey((HKEY
) handle
);
269 void del_settings(const char *sessionname
)
274 if (RegOpenKey(HKEY_CURRENT_USER
, puttystr
, &subkey1
) != ERROR_SUCCESS
)
277 p
= snewn(3 * strlen(sessionname
) + 1, char);
278 mungestr(sessionname
, p
);
279 RegDeleteKey(subkey1
, p
);
282 RegCloseKey(subkey1
);
284 remove_session_from_jumplist(sessionname
);
287 struct enumsettings
{
292 void *enum_settings_start(void)
294 struct enumsettings
*ret
;
297 if (RegOpenKey(HKEY_CURRENT_USER
, puttystr
, &key
) != ERROR_SUCCESS
)
300 ret
= snew(struct enumsettings
);
309 char *enum_settings_next(void *handle
, char *buffer
, int buflen
)
311 struct enumsettings
*e
= (struct enumsettings
*) handle
;
313 otherbuf
= snewn(3 * buflen
, char);
314 if (RegEnumKey(e
->key
, e
->i
++, otherbuf
, 3 * buflen
) == ERROR_SUCCESS
) {
315 unmungestr(otherbuf
, buffer
, buflen
);
324 void enum_settings_finish(void *handle
)
326 struct enumsettings
*e
= (struct enumsettings
*) handle
;
331 static void hostkey_regname(char *buffer
, const char *hostname
,
332 int port
, const char *keytype
)
335 strcpy(buffer
, keytype
);
337 len
= strlen(buffer
);
338 len
+= sprintf(buffer
+ len
, "%d:", port
);
339 mungestr(hostname
, buffer
+ strlen(buffer
));
342 int verify_host_key(const char *hostname
, int port
,
343 const char *keytype
, const char *key
)
345 char *otherstr
, *regname
;
352 len
= 1 + strlen(key
);
355 * Now read a saved key in from the registry and see what it
358 regname
= snewn(3 * (strlen(hostname
) + strlen(keytype
)) + 15, char);
360 hostkey_regname(regname
, hostname
, port
, keytype
);
362 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_POS
"\\SshHostKeys",
363 &rkey
) != ERROR_SUCCESS
) {
365 return 1; /* key does not exist in registry */
369 otherstr
= snewn(len
, char);
370 ret
= RegQueryValueEx(rkey
, regname
, NULL
, &type
, otherstr
, &readlen
);
372 if (ret
!= ERROR_SUCCESS
&& ret
!= ERROR_MORE_DATA
&&
373 !strcmp(keytype
, "rsa")) {
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.
379 char *justhost
= regname
+ 1 + strcspn(regname
, ":");
380 char *oldstyle
= snewn(len
+ 10, char); /* safety margin */
382 ret
= RegQueryValueEx(rkey
, justhost
, NULL
, &type
,
385 if (ret
== ERROR_SUCCESS
&& type
== REG_SZ
) {
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.
402 for (i
= 0; i
< 2; i
++) {
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)
411 /* now move digits over to new string */
412 for (j
= 0; j
< ndigits
; j
++)
413 p
[ndigits
- 1 - j
] = q
[j
^ 3];
417 q
++; /* eat the slash */
418 *p
++ = ','; /* add a comma */
420 *p
= '\0'; /* terminate the string */
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.
428 if (!strcmp(otherstr
, key
))
429 RegSetValueEx(rkey
, regname
, 0, REG_SZ
, otherstr
,
430 strlen(otherstr
) + 1);
438 compare
= strcmp(otherstr
, key
);
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 */
449 return 0; /* key matched OK in registry */
452 void store_host_key(const char *hostname
, int port
,
453 const char *keytype
, const char *key
)
458 regname
= snewn(3 * (strlen(hostname
) + strlen(keytype
)) + 15, char);
460 hostkey_regname(regname
, hostname
, port
, keytype
);
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);
466 } /* else key does not exist in registry */
472 * Open (or delete) the random seed file.
474 enum { DEL
, OPEN_R
, OPEN_W
};
475 static int try_random_seed(char const *path
, int action
, HANDLE
*ret
)
478 if (!DeleteFile(path
) && GetLastError() != ERROR_FILE_NOT_FOUND
) {
479 nonfatal("Unable to delete '%s': %s", path
,
480 win_strerror(GetLastError()));
482 *ret
= INVALID_HANDLE_VALUE
;
483 return FALSE
; /* so we'll do the next ones too */
486 *ret
= CreateFile(path
,
487 action
== OPEN_W ? GENERIC_WRITE
: GENERIC_READ
,
488 action
== OPEN_W ?
0 : (FILE_SHARE_READ
|
491 action
== OPEN_W ? CREATE_ALWAYS
: OPEN_EXISTING
,
492 action
== OPEN_W ? FILE_ATTRIBUTE_NORMAL
: 0,
495 return (*ret
!= INVALID_HANDLE_VALUE
);
498 static HANDLE
access_random_seed(int action
)
503 char seedpath
[2 * MAX_PATH
+ 10] = "\0";
506 * Iterate over a selection of possible random seed paths until
507 * we find one that works.
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).
517 * First, try the location specified by the user in the
520 size
= sizeof(seedpath
);
521 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_POS
, &rkey
) ==
523 int ret
= RegQueryValueEx(rkey
, "RandSeedFile",
524 0, &type
, seedpath
, &size
);
525 if (ret
!= ERROR_SUCCESS
|| type
!= REG_SZ
)
529 if (*seedpath
&& try_random_seed(seedpath
, action
, &rethandle
))
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.
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,
546 shell32_module
= load_system32_dll("shell32.dll");
547 GET_WINDOWS_FUNCTION(shell32_module
, SHGetFolderPathA
);
548 tried_shgetfolderpath
= TRUE
;
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
))
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
))
567 * Failing that, try %HOMEDRIVE%%HOMEPATH% as a guess at the
568 * user's home directory.
574 GetEnvironmentVariable("HOMEDRIVE", seedpath
,
577 GetEnvironmentVariable("HOMEPATH", seedpath
+ len
,
578 sizeof(seedpath
) - len
);
580 strcat(seedpath
, "\\PUTTY.RND");
581 if (try_random_seed(seedpath
, action
, &rethandle
))
587 * And finally, fall back to C:\WINDOWS.
589 GetWindowsDirectory(seedpath
, sizeof(seedpath
));
590 strcat(seedpath
, "\\PUTTY.RND");
591 if (try_random_seed(seedpath
, action
, &rethandle
))
595 * If even that failed, give up.
597 return INVALID_HANDLE_VALUE
;
600 void read_random_seed(noise_consumer_t consumer
)
602 HANDLE seedf
= access_random_seed(OPEN_R
);
604 if (seedf
!= INVALID_HANDLE_VALUE
) {
609 if (ReadFile(seedf
, buf
, sizeof(buf
), &len
, NULL
) && len
)
618 void write_random_seed(void *data
, int len
)
620 HANDLE seedf
= access_random_seed(OPEN_W
);
622 if (seedf
!= INVALID_HANDLE_VALUE
) {
625 WriteFile(seedf
, data
, len
, &lenwritten
, NULL
);
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
639 static int transform_jumplist_registry
640 (const char *add
, const char *rem
, char **out
)
643 HKEY pjumplist_key
, psettings_tmp
;
646 char *old_value
, *new_value
;
647 char *piterator_old
, *piterator_new
, *piterator_tmp
;
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
;
656 /* Get current list of saved sessions in the registry. */
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
664 if (ret
== ERROR_MORE_DATA
) {
666 old_value
= snewn(value_length
, char);
667 ret
= RegQueryValueEx(pjumplist_key
, reg_jumplist_value
, NULL
, &type
,
668 old_value
, &value_length
);
671 if (ret
== ERROR_FILE_NOT_FOUND
) {
672 /* Value doesn't exist yet. Start from an empty value. */
674 *(old_value
+ 1) = '\0';
675 } else if (ret
!= ERROR_SUCCESS
) {
676 /* Some non-recoverable error occurred. */
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
) {
686 RegCloseKey(pjumplist_key
);
687 return JUMPLISTREG_ERROR_VALUEREAD_FAILURE
;
691 *(old_value
+ 1) = '\0';
694 /* Check validity of registry data: REG_MULTI_SZ value must end
696 piterator_tmp
= old_value
;
697 while (((piterator_tmp
- old_value
) < (value_length
- 1)) &&
698 !(*piterator_tmp
== '\0' && *(piterator_tmp
+1) == '\0')) {
702 if ((piterator_tmp
- old_value
) >= (value_length
-1)) {
703 /* Invalid value. Start from an empty value. */
705 *(old_value
+ 1) = '\0';
709 * Modify the list, if we're modifying.
712 /* Walk through the existing list and construct the new list of
714 new_value
= snewn(value_length
+ (add ?
strlen(add
) + 1 : 0), char);
715 piterator_new
= new_value
;
716 piterator_old
= old_value
;
718 /* First add the new item to the beginning of the list. */
720 strcpy(piterator_new
, add
);
721 piterator_new
+= strlen(piterator_new
) + 1;
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;
735 piterator_old
+= strlen(piterator_old
) + 1;
737 *piterator_new
= '\0';
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
);
745 old_value
= new_value
;
750 * Either return or free the result.
752 if (out
&& ret
== ERROR_SUCCESS
)
757 /* Clean up and return. */
758 RegCloseKey(pjumplist_key
);
760 if (ret
!= ERROR_SUCCESS
) {
761 return JUMPLISTREG_ERROR_VALUEWRITE_FAILURE
;
763 return JUMPLISTREG_OK
;
767 /* Adds a new entry to the jumplist entries in the registry. */
768 int add_to_jumplist_registry(const char *item
)
770 return transform_jumplist_registry(item
, item
, NULL
);
773 /* Removes an item from the jumplist entries in the registry. */
774 int remove_from_jumplist_registry(const char *item
)
776 return transform_jumplist_registry(NULL
, item
, NULL
);
779 /* Returns the jumplist entries from the registry. Caller must free
780 * the returned pointer. */
781 char *get_jumplist_registry_entries (void)
785 if (transform_jumplist_registry(NULL
,NULL
,&list_value
) != JUMPLISTREG_OK
) {
786 list_value
= snewn(2, char);
788 *(list_value
+ 1) = '\0';
794 * Recursively delete a registry key and everything under it.
796 static void registry_recursive_remove(HKEY key
)
799 char name
[MAX_PATH
+ 1];
803 while (RegEnumKey(key
, i
, name
, sizeof(name
)) == ERROR_SUCCESS
) {
804 if (RegOpenKey(key
, name
, &subkey
) == ERROR_SUCCESS
) {
805 registry_recursive_remove(subkey
);
808 RegDeleteKey(key
, name
);
812 void cleanup_all(void)
816 char name
[MAX_PATH
+ 1];
818 /* ------------------------------------------------------------
819 * Wipe out the random seed file, in all of its possible
822 access_random_seed(DEL
);
824 /* ------------------------------------------------------------
825 * Ask Windows to delete any jump list information associated
826 * with this installation of PuTTY.
830 /* ------------------------------------------------------------
831 * Destroy all registry information associated with PuTTY.
835 * Open the main PuTTY registry key and remove everything in it.
837 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_POS
, &key
) ==
839 registry_recursive_remove(key
);
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
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
));
853 * If the parent key had no other children, we must delete
854 * it in its turn. That means opening the _grandparent_
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
);