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
||
170 type
!= REG_SZ
) return NULL
;
175 int read_setting_i(void *handle
, const char *key
, int defvalue
)
177 DWORD type
, val
, size
;
181 RegQueryValueEx((HKEY
) handle
, key
, 0, &type
,
182 (BYTE
*) &val
, &size
) != ERROR_SUCCESS
||
183 size
!= sizeof(val
) || type
!= REG_DWORD
)
189 FontSpec
*read_setting_fontspec(void *handle
, const char *name
)
193 int isbold
, height
, charset
;
195 fontname
= read_setting_s(handle
, name
);
199 settingname
= dupcat(name
, "IsBold", NULL
);
200 isbold
= read_setting_i(handle
, settingname
, -1);
202 if (isbold
== -1) return NULL
;
204 settingname
= dupcat(name
, "CharSet", NULL
);
205 charset
= read_setting_i(handle
, settingname
, -1);
207 if (charset
== -1) return NULL
;
209 settingname
= dupcat(name
, "Height", NULL
);
210 height
= read_setting_i(handle
, settingname
, INT_MIN
);
212 if (height
== INT_MIN
) return NULL
;
214 return fontspec_new(fontname
, isbold
, height
, charset
);
217 void write_setting_fontspec(void *handle
, const char *name
, FontSpec
*font
)
221 write_setting_s(handle
, name
, font
->name
);
222 settingname
= dupcat(name
, "IsBold", NULL
);
223 write_setting_i(handle
, settingname
, font
->isbold
);
225 settingname
= dupcat(name
, "CharSet", NULL
);
226 write_setting_i(handle
, settingname
, font
->charset
);
228 settingname
= dupcat(name
, "Height", NULL
);
229 write_setting_i(handle
, settingname
, font
->height
);
233 int read_setting_filename(void *handle
, const char *name
, Filename
*result
)
235 char *tmp
= read_setting_s(handle
, name
);
237 strncpy(result
->path
, tmp
, sizeof(result
->path
)-1);
238 result
->path
[sizeof(result
->path
)-1] = '\0';
245 void write_setting_filename(void *handle
, const char *name
, Filename result
)
247 write_setting_s(handle
, name
, result
.path
);
250 void close_settings_r(void *handle
)
252 RegCloseKey((HKEY
) handle
);
255 void del_settings(const char *sessionname
)
260 if (RegOpenKey(HKEY_CURRENT_USER
, puttystr
, &subkey1
) != ERROR_SUCCESS
)
263 p
= snewn(3 * strlen(sessionname
) + 1, char);
264 mungestr(sessionname
, p
);
265 RegDeleteKey(subkey1
, p
);
268 RegCloseKey(subkey1
);
270 remove_session_from_jumplist(sessionname
);
273 struct enumsettings
{
278 void *enum_settings_start(void)
280 struct enumsettings
*ret
;
283 if (RegOpenKey(HKEY_CURRENT_USER
, puttystr
, &key
) != ERROR_SUCCESS
)
286 ret
= snew(struct enumsettings
);
295 char *enum_settings_next(void *handle
, char *buffer
, int buflen
)
297 struct enumsettings
*e
= (struct enumsettings
*) handle
;
299 otherbuf
= snewn(3 * buflen
, char);
300 if (RegEnumKey(e
->key
, e
->i
++, otherbuf
, 3 * buflen
) == ERROR_SUCCESS
) {
301 unmungestr(otherbuf
, buffer
, buflen
);
310 void enum_settings_finish(void *handle
)
312 struct enumsettings
*e
= (struct enumsettings
*) handle
;
317 static void hostkey_regname(char *buffer
, const char *hostname
,
318 int port
, const char *keytype
)
321 strcpy(buffer
, keytype
);
323 len
= strlen(buffer
);
324 len
+= sprintf(buffer
+ len
, "%d:", port
);
325 mungestr(hostname
, buffer
+ strlen(buffer
));
328 int verify_host_key(const char *hostname
, int port
,
329 const char *keytype
, const char *key
)
331 char *otherstr
, *regname
;
338 len
= 1 + strlen(key
);
341 * Now read a saved key in from the registry and see what it
344 otherstr
= snewn(len
, char);
345 regname
= snewn(3 * (strlen(hostname
) + strlen(keytype
)) + 15, char);
347 hostkey_regname(regname
, hostname
, port
, keytype
);
349 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_POS
"\\SshHostKeys",
350 &rkey
) != ERROR_SUCCESS
)
351 return 1; /* key does not exist in registry */
354 ret
= RegQueryValueEx(rkey
, regname
, NULL
, &type
, otherstr
, &readlen
);
356 if (ret
!= ERROR_SUCCESS
&& ret
!= ERROR_MORE_DATA
&&
357 !strcmp(keytype
, "rsa")) {
359 * Key didn't exist. If the key type is RSA, we'll try
360 * another trick, which is to look up the _old_ key format
361 * under just the hostname and translate that.
363 char *justhost
= regname
+ 1 + strcspn(regname
, ":");
364 char *oldstyle
= snewn(len
+ 10, char); /* safety margin */
366 ret
= RegQueryValueEx(rkey
, justhost
, NULL
, &type
,
369 if (ret
== ERROR_SUCCESS
&& type
== REG_SZ
) {
371 * The old format is two old-style bignums separated by
372 * a slash. An old-style bignum is made of groups of
373 * four hex digits: digits are ordered in sensible
374 * (most to least significant) order within each group,
375 * but groups are ordered in silly (least to most)
376 * order within the bignum. The new format is two
377 * ordinary C-format hex numbers (0xABCDEFG...XYZ, with
378 * A nonzero except in the special case 0x0, which
379 * doesn't appear anyway in RSA keys) separated by a
380 * comma. All hex digits are lowercase in both formats.
386 for (i
= 0; i
< 2; i
++) {
390 ndigits
= strcspn(q
, "/"); /* find / or end of string */
391 nwords
= ndigits
/ 4;
392 /* now trim ndigits to remove leading zeros */
393 while (q
[(ndigits
- 1) ^ 3] == '0' && ndigits
> 1)
395 /* now move digits over to new string */
396 for (j
= 0; j
< ndigits
; j
++)
397 p
[ndigits
- 1 - j
] = q
[j
^ 3];
401 q
++; /* eat the slash */
402 *p
++ = ','; /* add a comma */
404 *p
= '\0'; /* terminate the string */
408 * Now _if_ this key matches, we'll enter it in the new
409 * format. If not, we'll assume something odd went
410 * wrong, and hyper-cautiously do nothing.
412 if (!strcmp(otherstr
, key
))
413 RegSetValueEx(rkey
, regname
, 0, REG_SZ
, otherstr
,
414 strlen(otherstr
) + 1);
420 compare
= strcmp(otherstr
, key
);
425 if (ret
== ERROR_MORE_DATA
||
426 (ret
== ERROR_SUCCESS
&& type
== REG_SZ
&& compare
))
427 return 2; /* key is different in registry */
428 else if (ret
!= ERROR_SUCCESS
|| type
!= REG_SZ
)
429 return 1; /* key does not exist in registry */
431 return 0; /* key matched OK in registry */
434 void store_host_key(const char *hostname
, int port
,
435 const char *keytype
, const char *key
)
440 regname
= snewn(3 * (strlen(hostname
) + strlen(keytype
)) + 15, char);
442 hostkey_regname(regname
, hostname
, port
, keytype
);
444 if (RegCreateKey(HKEY_CURRENT_USER
, PUTTY_REG_POS
"\\SshHostKeys",
445 &rkey
) == ERROR_SUCCESS
) {
446 RegSetValueEx(rkey
, regname
, 0, REG_SZ
, key
, strlen(key
) + 1);
448 } /* else key does not exist in registry */
454 * Open (or delete) the random seed file.
456 enum { DEL
, OPEN_R
, OPEN_W
};
457 static int try_random_seed(char const *path
, int action
, HANDLE
*ret
)
461 *ret
= INVALID_HANDLE_VALUE
;
462 return FALSE
; /* so we'll do the next ones too */
465 *ret
= CreateFile(path
,
466 action
== OPEN_W ? GENERIC_WRITE
: GENERIC_READ
,
467 action
== OPEN_W ?
0 : (FILE_SHARE_READ
|
470 action
== OPEN_W ? CREATE_ALWAYS
: OPEN_EXISTING
,
471 action
== OPEN_W ? FILE_ATTRIBUTE_NORMAL
: 0,
474 return (*ret
!= INVALID_HANDLE_VALUE
);
477 static HANDLE
access_random_seed(int action
)
482 char seedpath
[2 * MAX_PATH
+ 10] = "\0";
485 * Iterate over a selection of possible random seed paths until
486 * we find one that works.
488 * We do this iteration separately for reading and writing,
489 * meaning that we will automatically migrate random seed files
490 * if a better location becomes available (by reading from the
491 * best location in which we actually find one, and then
492 * writing to the best location in which we can _create_ one).
496 * First, try the location specified by the user in the
499 size
= sizeof(seedpath
);
500 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_POS
, &rkey
) ==
502 int ret
= RegQueryValueEx(rkey
, "RandSeedFile",
503 0, &type
, seedpath
, &size
);
504 if (ret
!= ERROR_SUCCESS
|| type
!= REG_SZ
)
508 if (*seedpath
&& try_random_seed(seedpath
, action
, &rethandle
))
513 * Next, try the user's local Application Data directory,
514 * followed by their non-local one. This is found using the
515 * SHGetFolderPath function, which won't be present on all
516 * versions of Windows.
518 if (!tried_shgetfolderpath
) {
519 /* This is likely only to bear fruit on systems with IE5+
520 * installed, or WinMe/2K+. There is some faffing with
521 * SHFOLDER.DLL we could do to try to find an equivalent
522 * on older versions of Windows if we cared enough.
523 * However, the invocation below requires IE5+ anyway,
525 shell32_module
= load_system32_dll("shell32.dll");
526 GET_WINDOWS_FUNCTION(shell32_module
, SHGetFolderPathA
);
527 tried_shgetfolderpath
= TRUE
;
529 if (p_SHGetFolderPathA
) {
530 if (SUCCEEDED(p_SHGetFolderPathA(NULL
, CSIDL_LOCAL_APPDATA
,
531 NULL
, SHGFP_TYPE_CURRENT
, seedpath
))) {
532 strcat(seedpath
, "\\PUTTY.RND");
533 if (try_random_seed(seedpath
, action
, &rethandle
))
537 if (SUCCEEDED(p_SHGetFolderPathA(NULL
, CSIDL_APPDATA
,
538 NULL
, SHGFP_TYPE_CURRENT
, seedpath
))) {
539 strcat(seedpath
, "\\PUTTY.RND");
540 if (try_random_seed(seedpath
, action
, &rethandle
))
546 * Failing that, try %HOMEDRIVE%%HOMEPATH% as a guess at the
547 * user's home directory.
553 GetEnvironmentVariable("HOMEDRIVE", seedpath
,
556 GetEnvironmentVariable("HOMEPATH", seedpath
+ len
,
557 sizeof(seedpath
) - len
);
559 strcat(seedpath
, "\\PUTTY.RND");
560 if (try_random_seed(seedpath
, action
, &rethandle
))
566 * And finally, fall back to C:\WINDOWS.
568 GetWindowsDirectory(seedpath
, sizeof(seedpath
));
569 strcat(seedpath
, "\\PUTTY.RND");
570 if (try_random_seed(seedpath
, action
, &rethandle
))
574 * If even that failed, give up.
576 return INVALID_HANDLE_VALUE
;
579 void read_random_seed(noise_consumer_t consumer
)
581 HANDLE seedf
= access_random_seed(OPEN_R
);
583 if (seedf
!= INVALID_HANDLE_VALUE
) {
588 if (ReadFile(seedf
, buf
, sizeof(buf
), &len
, NULL
) && len
)
597 void write_random_seed(void *data
, int len
)
599 HANDLE seedf
= access_random_seed(OPEN_W
);
601 if (seedf
!= INVALID_HANDLE_VALUE
) {
604 WriteFile(seedf
, data
, len
, &lenwritten
, NULL
);
610 * Internal function supporting the jump list registry code. All the
611 * functions to add, remove and read the list have substantially
612 * similar content, so this is a generalisation of all of them which
613 * transforms the list in the registry by prepending 'add' (if
614 * non-null), removing 'rem' from what's left (if non-null), and
615 * returning the resulting concatenated list of strings in 'out' (if
618 static int transform_jumplist_registry
619 (const char *add
, const char *rem
, char **out
)
622 HKEY pjumplist_key
, psettings_tmp
;
625 char *old_value
, *new_value
;
626 char *piterator_old
, *piterator_new
, *piterator_tmp
;
628 ret
= RegCreateKeyEx(HKEY_CURRENT_USER
, reg_jumplist_key
, 0, NULL
,
629 REG_OPTION_NON_VOLATILE
, (KEY_READ
| KEY_WRITE
), NULL
,
630 &pjumplist_key
, NULL
);
631 if (ret
!= ERROR_SUCCESS
) {
632 return JUMPLISTREG_ERROR_KEYOPENCREATE_FAILURE
;
635 /* Get current list of saved sessions in the registry. */
637 old_value
= snewn(value_length
, char);
638 ret
= RegQueryValueEx(pjumplist_key
, reg_jumplist_value
, NULL
, &type
,
639 old_value
, &value_length
);
640 /* When the passed buffer is too small, ERROR_MORE_DATA is
641 * returned and the required size is returned in the length
643 if (ret
== ERROR_MORE_DATA
) {
645 old_value
= snewn(value_length
, char);
646 ret
= RegQueryValueEx(pjumplist_key
, reg_jumplist_value
, NULL
, &type
,
647 old_value
, &value_length
);
650 if (ret
== ERROR_FILE_NOT_FOUND
) {
651 /* Value doesn't exist yet. Start from an empty value. */
653 *(old_value
+ 1) = '\0';
654 } else if (ret
!= ERROR_SUCCESS
) {
655 /* Some non-recoverable error occurred. */
657 RegCloseKey(pjumplist_key
);
658 return JUMPLISTREG_ERROR_VALUEREAD_FAILURE
;
659 } else if (type
!= REG_MULTI_SZ
) {
660 /* The value present in the registry has the wrong type: we
661 * try to delete it and start from an empty value. */
662 ret
= RegDeleteValue(pjumplist_key
, reg_jumplist_value
);
663 if (ret
!= ERROR_SUCCESS
) {
665 RegCloseKey(pjumplist_key
);
666 return JUMPLISTREG_ERROR_VALUEREAD_FAILURE
;
670 *(old_value
+ 1) = '\0';
673 /* Check validity of registry data: REG_MULTI_SZ value must end
675 piterator_tmp
= old_value
;
676 while (((piterator_tmp
- old_value
) < (value_length
- 1)) &&
677 !(*piterator_tmp
== '\0' && *(piterator_tmp
+1) == '\0')) {
681 if ((piterator_tmp
- old_value
) >= (value_length
-1)) {
682 /* Invalid value. Start from an empty value. */
684 *(old_value
+ 1) = '\0';
688 * Modify the list, if we're modifying.
691 /* Walk through the existing list and construct the new list of
693 new_value
= snewn(value_length
+ (add ?
strlen(add
) + 1 : 0), char);
694 piterator_new
= new_value
;
695 piterator_old
= old_value
;
697 /* First add the new item to the beginning of the list. */
699 strcpy(piterator_new
, add
);
700 piterator_new
+= strlen(piterator_new
) + 1;
702 /* Now add the existing list, taking care to leave out the removed
703 * item, if it was already in the existing list. */
704 while (*piterator_old
!= '\0') {
705 if (!rem
|| strcmp(piterator_old
, rem
) != 0) {
706 /* Check if this is a valid session, otherwise don't add. */
707 psettings_tmp
= open_settings_r(piterator_old
);
708 if (psettings_tmp
!= NULL
) {
709 close_settings_r(psettings_tmp
);
710 strcpy(piterator_new
, piterator_old
);
711 piterator_new
+= strlen(piterator_new
) + 1;
714 piterator_old
+= strlen(piterator_old
) + 1;
716 *piterator_new
= '\0';
719 /* Save the new list to the registry. */
720 ret
= RegSetValueEx(pjumplist_key
, reg_jumplist_value
, 0, REG_MULTI_SZ
,
721 new_value
, piterator_new
- new_value
);
724 old_value
= new_value
;
729 * Either return or free the result.
736 /* Clean up and return. */
737 RegCloseKey(pjumplist_key
);
739 if (ret
!= ERROR_SUCCESS
) {
740 return JUMPLISTREG_ERROR_VALUEWRITE_FAILURE
;
742 return JUMPLISTREG_OK
;
746 /* Adds a new entry to the jumplist entries in the registry. */
747 int add_to_jumplist_registry(const char *item
)
749 return transform_jumplist_registry(item
, item
, NULL
);
752 /* Removes an item from the jumplist entries in the registry. */
753 int remove_from_jumplist_registry(const char *item
)
755 return transform_jumplist_registry(NULL
, item
, NULL
);
758 /* Returns the jumplist entries from the registry. Caller must free
759 * the returned pointer. */
760 char *get_jumplist_registry_entries (void)
764 if (transform_jumplist_registry(NULL
,NULL
,&list_value
) != ERROR_SUCCESS
) {
765 list_value
= snewn(2, char);
767 *(list_value
+ 1) = '\0';
773 * Recursively delete a registry key and everything under it.
775 static void registry_recursive_remove(HKEY key
)
778 char name
[MAX_PATH
+ 1];
782 while (RegEnumKey(key
, i
, name
, sizeof(name
)) == ERROR_SUCCESS
) {
783 if (RegOpenKey(key
, name
, &subkey
) == ERROR_SUCCESS
) {
784 registry_recursive_remove(subkey
);
787 RegDeleteKey(key
, name
);
791 void cleanup_all(void)
795 char name
[MAX_PATH
+ 1];
797 /* ------------------------------------------------------------
798 * Wipe out the random seed file, in all of its possible
801 access_random_seed(DEL
);
803 /* ------------------------------------------------------------
804 * Ask Windows to delete any jump list information associated
805 * with this installation of PuTTY.
809 /* ------------------------------------------------------------
810 * Destroy all registry information associated with PuTTY.
814 * Open the main PuTTY registry key and remove everything in it.
816 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_POS
, &key
) ==
818 registry_recursive_remove(key
);
822 * Now open the parent key and remove the PuTTY main key. Once
823 * we've done that, see if the parent key has any other
826 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_PARENT
,
827 &key
) == ERROR_SUCCESS
) {
828 RegDeleteKey(key
, PUTTY_REG_PARENT_CHILD
);
829 ret
= RegEnumKey(key
, 0, name
, sizeof(name
));
832 * If the parent key had no other children, we must delete
833 * it in its turn. That means opening the _grandparent_
836 if (ret
!= ERROR_SUCCESS
) {
837 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_GPARENT
,
838 &key
) == ERROR_SUCCESS
) {
839 RegDeleteKey(key
, PUTTY_REG_GPARENT_CHILD
);