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 puttystr
= PUTTY_REG_POS
"\\Sessions";
22 static const char hex
[16] = "0123456789ABCDEF";
24 static int tried_shgetfolderpath
= FALSE
;
25 static HMODULE shell32_module
= NULL
;
26 DECL_WINDOWS_FUNCTION(static, HRESULT
, SHGetFolderPathA
,
27 (HWND
, int, HANDLE
, DWORD
, LPSTR
));
29 static void mungestr(const char *in
, char *out
)
34 if (*in
== ' ' || *in
== '\\' || *in
== '*' || *in
== '?' ||
35 *in
== '%' || *in
< ' ' || *in
> '~' || (*in
== '.'
38 *out
++ = hex
[((unsigned char) *in
) >> 4];
39 *out
++ = hex
[((unsigned char) *in
) & 15];
49 static void unmungestr(const char *in
, char *out
, int outlen
)
52 if (*in
== '%' && in
[1] && in
[2]) {
60 *out
++ = (i
<< 4) + j
;
74 void *open_settings_w(const char *sessionname
, char **errmsg
)
76 HKEY subkey1
, sesskey
;
82 if (!sessionname
|| !*sessionname
)
83 sessionname
= "Default Settings";
85 p
= snewn(3 * strlen(sessionname
) + 1, char);
86 mungestr(sessionname
, p
);
88 ret
= RegCreateKey(HKEY_CURRENT_USER
, puttystr
, &subkey1
);
89 if (ret
!= ERROR_SUCCESS
) {
91 *errmsg
= dupprintf("Unable to create registry key\n"
92 "HKEY_CURRENT_USER\\%s", puttystr
);
95 ret
= RegCreateKey(subkey1
, p
, &sesskey
);
97 if (ret
!= ERROR_SUCCESS
) {
98 *errmsg
= dupprintf("Unable to create registry key\n"
99 "HKEY_CURRENT_USER\\%s\\%s", puttystr
, p
);
104 return (void *) sesskey
;
107 void write_setting_s(void *handle
, const char *key
, const char *value
)
110 RegSetValueEx((HKEY
) handle
, key
, 0, REG_SZ
, value
,
114 void write_setting_i(void *handle
, const char *key
, int value
)
117 RegSetValueEx((HKEY
) handle
, key
, 0, REG_DWORD
,
118 (CONST BYTE
*) &value
, sizeof(value
));
121 void close_settings_w(void *handle
)
123 RegCloseKey((HKEY
) handle
);
126 void *open_settings_r(const char *sessionname
)
128 HKEY subkey1
, sesskey
;
131 if (!sessionname
|| !*sessionname
)
132 sessionname
= "Default Settings";
134 p
= snewn(3 * strlen(sessionname
) + 1, char);
135 mungestr(sessionname
, p
);
137 if (RegOpenKey(HKEY_CURRENT_USER
, puttystr
, &subkey1
) != ERROR_SUCCESS
) {
140 if (RegOpenKey(subkey1
, p
, &sesskey
) != ERROR_SUCCESS
) {
143 RegCloseKey(subkey1
);
148 return (void *) sesskey
;
151 char *read_setting_s(void *handle
, const char *key
, char *buffer
, int buflen
)
157 RegQueryValueEx((HKEY
) handle
, key
, 0,
158 &type
, buffer
, &size
) != ERROR_SUCCESS
||
159 type
!= REG_SZ
) return NULL
;
164 int read_setting_i(void *handle
, const char *key
, int defvalue
)
166 DWORD type
, val
, size
;
170 RegQueryValueEx((HKEY
) handle
, key
, 0, &type
,
171 (BYTE
*) &val
, &size
) != ERROR_SUCCESS
||
172 size
!= sizeof(val
) || type
!= REG_DWORD
)
178 int read_setting_fontspec(void *handle
, const char *name
, FontSpec
*result
)
183 if (!read_setting_s(handle
, name
, ret
.name
, sizeof(ret
.name
)))
185 settingname
= dupcat(name
, "IsBold", NULL
);
186 ret
.isbold
= read_setting_i(handle
, settingname
, -1);
188 if (ret
.isbold
== -1) return 0;
189 settingname
= dupcat(name
, "CharSet", NULL
);
190 ret
.charset
= read_setting_i(handle
, settingname
, -1);
192 if (ret
.charset
== -1) return 0;
193 settingname
= dupcat(name
, "Height", NULL
);
194 ret
.height
= read_setting_i(handle
, settingname
, INT_MIN
);
196 if (ret
.height
== INT_MIN
) return 0;
201 void write_setting_fontspec(void *handle
, const char *name
, FontSpec font
)
205 write_setting_s(handle
, name
, font
.name
);
206 settingname
= dupcat(name
, "IsBold", NULL
);
207 write_setting_i(handle
, settingname
, font
.isbold
);
209 settingname
= dupcat(name
, "CharSet", NULL
);
210 write_setting_i(handle
, settingname
, font
.charset
);
212 settingname
= dupcat(name
, "Height", NULL
);
213 write_setting_i(handle
, settingname
, font
.height
);
217 int read_setting_filename(void *handle
, const char *name
, Filename
*result
)
219 return !!read_setting_s(handle
, name
, result
->path
, sizeof(result
->path
));
222 void write_setting_filename(void *handle
, const char *name
, Filename result
)
224 write_setting_s(handle
, name
, result
.path
);
227 void close_settings_r(void *handle
)
229 RegCloseKey((HKEY
) handle
);
232 void del_settings(const char *sessionname
)
237 if (RegOpenKey(HKEY_CURRENT_USER
, puttystr
, &subkey1
) != ERROR_SUCCESS
)
240 p
= snewn(3 * strlen(sessionname
) + 1, char);
241 mungestr(sessionname
, p
);
242 RegDeleteKey(subkey1
, p
);
245 RegCloseKey(subkey1
);
248 struct enumsettings
{
253 void *enum_settings_start(void)
255 struct enumsettings
*ret
;
258 if (RegOpenKey(HKEY_CURRENT_USER
, puttystr
, &key
) != ERROR_SUCCESS
)
261 ret
= snew(struct enumsettings
);
270 char *enum_settings_next(void *handle
, char *buffer
, int buflen
)
272 struct enumsettings
*e
= (struct enumsettings
*) handle
;
274 otherbuf
= snewn(3 * buflen
, char);
275 if (RegEnumKey(e
->key
, e
->i
++, otherbuf
, 3 * buflen
) == ERROR_SUCCESS
) {
276 unmungestr(otherbuf
, buffer
, buflen
);
285 void enum_settings_finish(void *handle
)
287 struct enumsettings
*e
= (struct enumsettings
*) handle
;
292 static void hostkey_regname(char *buffer
, const char *hostname
,
293 int port
, const char *keytype
)
296 strcpy(buffer
, keytype
);
298 len
= strlen(buffer
);
299 len
+= sprintf(buffer
+ len
, "%d:", port
);
300 mungestr(hostname
, buffer
+ strlen(buffer
));
303 int verify_host_key(const char *hostname
, int port
,
304 const char *keytype
, const char *key
)
306 char *otherstr
, *regname
;
313 len
= 1 + strlen(key
);
316 * Now read a saved key in from the registry and see what it
319 otherstr
= snewn(len
, char);
320 regname
= snewn(3 * (strlen(hostname
) + strlen(keytype
)) + 15, char);
322 hostkey_regname(regname
, hostname
, port
, keytype
);
324 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_POS
"\\SshHostKeys",
325 &rkey
) != ERROR_SUCCESS
)
326 return 1; /* key does not exist in registry */
329 ret
= RegQueryValueEx(rkey
, regname
, NULL
, &type
, otherstr
, &readlen
);
331 if (ret
!= ERROR_SUCCESS
&& ret
!= ERROR_MORE_DATA
&&
332 !strcmp(keytype
, "rsa")) {
334 * Key didn't exist. If the key type is RSA, we'll try
335 * another trick, which is to look up the _old_ key format
336 * under just the hostname and translate that.
338 char *justhost
= regname
+ 1 + strcspn(regname
, ":");
339 char *oldstyle
= snewn(len
+ 10, char); /* safety margin */
341 ret
= RegQueryValueEx(rkey
, justhost
, NULL
, &type
,
344 if (ret
== ERROR_SUCCESS
&& type
== REG_SZ
) {
346 * The old format is two old-style bignums separated by
347 * a slash. An old-style bignum is made of groups of
348 * four hex digits: digits are ordered in sensible
349 * (most to least significant) order within each group,
350 * but groups are ordered in silly (least to most)
351 * order within the bignum. The new format is two
352 * ordinary C-format hex numbers (0xABCDEFG...XYZ, with
353 * A nonzero except in the special case 0x0, which
354 * doesn't appear anyway in RSA keys) separated by a
355 * comma. All hex digits are lowercase in both formats.
361 for (i
= 0; i
< 2; i
++) {
365 ndigits
= strcspn(q
, "/"); /* find / or end of string */
366 nwords
= ndigits
/ 4;
367 /* now trim ndigits to remove leading zeros */
368 while (q
[(ndigits
- 1) ^ 3] == '0' && ndigits
> 1)
370 /* now move digits over to new string */
371 for (j
= 0; j
< ndigits
; j
++)
372 p
[ndigits
- 1 - j
] = q
[j
^ 3];
376 q
++; /* eat the slash */
377 *p
++ = ','; /* add a comma */
379 *p
= '\0'; /* terminate the string */
383 * Now _if_ this key matches, we'll enter it in the new
384 * format. If not, we'll assume something odd went
385 * wrong, and hyper-cautiously do nothing.
387 if (!strcmp(otherstr
, key
))
388 RegSetValueEx(rkey
, regname
, 0, REG_SZ
, otherstr
,
389 strlen(otherstr
) + 1);
395 compare
= strcmp(otherstr
, key
);
400 if (ret
== ERROR_MORE_DATA
||
401 (ret
== ERROR_SUCCESS
&& type
== REG_SZ
&& compare
))
402 return 2; /* key is different in registry */
403 else if (ret
!= ERROR_SUCCESS
|| type
!= REG_SZ
)
404 return 1; /* key does not exist in registry */
406 return 0; /* key matched OK in registry */
409 void store_host_key(const char *hostname
, int port
,
410 const char *keytype
, const char *key
)
415 regname
= snewn(3 * (strlen(hostname
) + strlen(keytype
)) + 15, char);
417 hostkey_regname(regname
, hostname
, port
, keytype
);
419 if (RegCreateKey(HKEY_CURRENT_USER
, PUTTY_REG_POS
"\\SshHostKeys",
420 &rkey
) == ERROR_SUCCESS
) {
421 RegSetValueEx(rkey
, regname
, 0, REG_SZ
, key
, strlen(key
) + 1);
423 } /* else key does not exist in registry */
429 * Open (or delete) the random seed file.
431 enum { DEL
, OPEN_R
, OPEN_W
};
432 static int try_random_seed(char const *path
, int action
, HANDLE
*ret
)
436 *ret
= INVALID_HANDLE_VALUE
;
437 return FALSE
; /* so we'll do the next ones too */
440 *ret
= CreateFile(path
,
441 action
== OPEN_W ? GENERIC_WRITE
: GENERIC_READ
,
442 action
== OPEN_W ?
0 : (FILE_SHARE_READ
|
445 action
== OPEN_W ? CREATE_ALWAYS
: OPEN_EXISTING
,
446 action
== OPEN_W ? FILE_ATTRIBUTE_NORMAL
: 0,
449 return (*ret
!= INVALID_HANDLE_VALUE
);
452 static HANDLE
access_random_seed(int action
)
457 char seedpath
[2 * MAX_PATH
+ 10] = "\0";
460 * Iterate over a selection of possible random seed paths until
461 * we find one that works.
463 * We do this iteration separately for reading and writing,
464 * meaning that we will automatically migrate random seed files
465 * if a better location becomes available (by reading from the
466 * best location in which we actually find one, and then
467 * writing to the best location in which we can _create_ one).
471 * First, try the location specified by the user in the
474 size
= sizeof(seedpath
);
475 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_POS
, &rkey
) ==
477 int ret
= RegQueryValueEx(rkey
, "RandSeedFile",
478 0, &type
, seedpath
, &size
);
479 if (ret
!= ERROR_SUCCESS
|| type
!= REG_SZ
)
483 if (*seedpath
&& try_random_seed(seedpath
, action
, &rethandle
))
488 * Next, try the user's local Application Data directory,
489 * followed by their non-local one. This is found using the
490 * SHGetFolderPath function, which won't be present on all
491 * versions of Windows.
493 if (!tried_shgetfolderpath
) {
494 /* This is likely only to bear fruit on systems with IE5+
495 * installed, or WinMe/2K+. There is some faffing with
496 * SHFOLDER.DLL we could do to try to find an equivalent
497 * on older versions of Windows if we cared enough.
498 * However, the invocation below requires IE5+ anyway,
500 shell32_module
= LoadLibrary("SHELL32.DLL");
501 GET_WINDOWS_FUNCTION(shell32_module
, SHGetFolderPathA
);
502 tried_shgetfolderpath
= TRUE
;
504 if (p_SHGetFolderPathA
) {
505 if (SUCCEEDED(p_SHGetFolderPathA(NULL
, CSIDL_LOCAL_APPDATA
,
506 NULL
, SHGFP_TYPE_CURRENT
, seedpath
))) {
507 strcat(seedpath
, "\\PUTTY.RND");
508 if (try_random_seed(seedpath
, action
, &rethandle
))
512 if (SUCCEEDED(p_SHGetFolderPathA(NULL
, CSIDL_APPDATA
,
513 NULL
, SHGFP_TYPE_CURRENT
, seedpath
))) {
514 strcat(seedpath
, "\\PUTTY.RND");
515 if (try_random_seed(seedpath
, action
, &rethandle
))
521 * Failing that, try %HOMEDRIVE%%HOMEPATH% as a guess at the
522 * user's home directory.
528 GetEnvironmentVariable("HOMEDRIVE", seedpath
,
531 GetEnvironmentVariable("HOMEPATH", seedpath
+ len
,
532 sizeof(seedpath
) - len
);
534 strcat(seedpath
, "\\PUTTY.RND");
535 if (try_random_seed(seedpath
, action
, &rethandle
))
541 * And finally, fall back to C:\WINDOWS.
543 GetWindowsDirectory(seedpath
, sizeof(seedpath
));
544 strcat(seedpath
, "\\PUTTY.RND");
545 if (try_random_seed(seedpath
, action
, &rethandle
))
549 * If even that failed, give up.
551 return INVALID_HANDLE_VALUE
;
554 void read_random_seed(noise_consumer_t consumer
)
556 HANDLE seedf
= access_random_seed(OPEN_R
);
558 if (seedf
!= INVALID_HANDLE_VALUE
) {
563 if (ReadFile(seedf
, buf
, sizeof(buf
), &len
, NULL
) && len
)
572 void write_random_seed(void *data
, int len
)
574 HANDLE seedf
= access_random_seed(OPEN_W
);
576 if (seedf
!= INVALID_HANDLE_VALUE
) {
579 WriteFile(seedf
, data
, len
, &lenwritten
, NULL
);
585 * Recursively delete a registry key and everything under it.
587 static void registry_recursive_remove(HKEY key
)
590 char name
[MAX_PATH
+ 1];
594 while (RegEnumKey(key
, i
, name
, sizeof(name
)) == ERROR_SUCCESS
) {
595 if (RegOpenKey(key
, name
, &subkey
) == ERROR_SUCCESS
) {
596 registry_recursive_remove(subkey
);
599 RegDeleteKey(key
, name
);
603 void cleanup_all(void)
607 char name
[MAX_PATH
+ 1];
609 /* ------------------------------------------------------------
610 * Wipe out the random seed file, in all of its possible
613 access_random_seed(DEL
);
615 /* ------------------------------------------------------------
616 * Destroy all registry information associated with PuTTY.
620 * Open the main PuTTY registry key and remove everything in it.
622 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_POS
, &key
) ==
624 registry_recursive_remove(key
);
628 * Now open the parent key and remove the PuTTY main key. Once
629 * we've done that, see if the parent key has any other
632 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_PARENT
,
633 &key
) == ERROR_SUCCESS
) {
634 RegDeleteKey(key
, PUTTY_REG_PARENT_CHILD
);
635 ret
= RegEnumKey(key
, 0, name
, sizeof(name
));
638 * If the parent key had no other children, we must delete
639 * it in its turn. That means opening the _grandparent_
642 if (ret
!= ERROR_SUCCESS
) {
643 if (RegOpenKey(HKEY_CURRENT_USER
, PUTTY_REG_GPARENT
,
644 &key
) == ERROR_SUCCESS
) {
645 RegDeleteKey(key
, PUTTY_REG_GPARENT_CHILD
);