2 * uxstore.c: Unix-specific implementation of the interface defined
17 #include <sys/types.h>
24 #define FNLEN PATH_MAX
26 #define FNLEN 1024 /* XXX */
30 INDEX_DIR, INDEX_HOSTKEYS, INDEX_HOSTKEYS_TMP, INDEX_RANDSEED,
31 INDEX_SESSIONDIR, INDEX_SESSION,
34 static const char hex[16] = "0123456789ABCDEF";
36 static char *mungestr(const char *in)
41 in = "Default Settings";
43 ret = out = snewn(3*strlen(in)+1, char);
47 * There are remarkably few punctuation characters that
48 * aren't shell-special in some way or likely to be used as
49 * separators in some file format or another! Hence we use
50 * opt-in for safe characters rather than opt-out for
51 * specific unsafe ones...
53 if (*in!='+' && *in!='-' && *in!='.' && *in!='@' && *in!='_' &&
54 !(*in >= '0' && *in <= '9') &&
55 !(*in >= 'A' && *in <= 'Z') &&
56 !(*in >= 'a' && *in <= 'z')) {
58 *out++ = hex[((unsigned char) *in) >> 4];
59 *out++ = hex[((unsigned char) *in) & 15];
68 static char *unmungestr(const char *in)
71 out = ret = snewn(strlen(in)+1, char);
73 if (*in == '%' && in[1] && in[2]) {
81 *out++ = (i << 4) + j;
91 static char *make_filename(int index, const char *subname)
93 char *env, *tmp, *ret;
96 * Allow override of the PuTTY configuration location, and of
97 * specific subparts of it, by means of environment variables.
99 if (index == INDEX_DIR) {
101 char *xdg_dir, *old_dir, *old_dir2, *old_dir3, *home, *pwd_home;
103 env = getenv("PUTTYDIR");
107 home = getenv("HOME");
108 pwd = getpwuid(getuid());
109 if (pwd && pwd->pw_dir) {
110 pwd_home = pwd->pw_dir;
116 env = getenv("XDG_CONFIG_HOME");
118 xdg_dir = dupprintf("%s/putty", env);
123 } else if (pwd_home) {
128 xdg_dir = dupprintf("%s/.config/putty", tmp);
130 if (xdg_dir && access(xdg_dir, F_OK) == 0) {
134 old_dir = old_dir2 = old_dir3 = NULL;
136 old_dir = dupprintf("%s/.putty", home);
139 old_dir2 = dupprintf("%s/.putty", pwd_home);
141 old_dir3 = dupstr("/.putty");
143 if (access(old_dir, F_OK) == 0) {
147 if (access(old_dir2, F_OK) == 0) {
151 if (access(old_dir3, F_OK) == 0) {
161 ret = old_dir ? old_dir : (old_dir2 ? old_dir2 : old_dir3);
174 if (index == INDEX_SESSIONDIR) {
175 env = getenv("PUTTYSESSIONS");
178 tmp = make_filename(INDEX_DIR, NULL);
179 ret = dupprintf("%s/sessions", tmp);
183 if (index == INDEX_SESSION) {
184 char *munged = mungestr(subname);
185 tmp = make_filename(INDEX_SESSIONDIR, NULL);
186 ret = dupprintf("%s/%s", tmp, munged);
191 if (index == INDEX_HOSTKEYS) {
192 env = getenv("PUTTYSSHHOSTKEYS");
195 tmp = make_filename(INDEX_DIR, NULL);
196 ret = dupprintf("%s/sshhostkeys", tmp);
200 if (index == INDEX_HOSTKEYS_TMP) {
201 tmp = make_filename(INDEX_HOSTKEYS, NULL);
202 ret = dupprintf("%s.tmp", tmp);
206 if (index == INDEX_RANDSEED) {
207 env = getenv("PUTTYRANDOMSEED");
210 tmp = make_filename(INDEX_DIR, NULL);
211 ret = dupprintf("%s/randomseed", tmp);
215 tmp = make_filename(INDEX_DIR, NULL);
216 ret = dupprintf("%s/ERROR", tmp);
221 void *open_settings_w(const char *sessionname, char **errmsg)
223 char *filename, *err;
229 * Start by making sure the .putty directory and its sessions
230 * subdir actually exist.
232 filename = make_filename(INDEX_DIR, NULL);
233 if ((err = make_dir_path(filename, 0700)) != NULL) {
234 *errmsg = dupprintf("Unable to save session: %s", err);
241 filename = make_filename(INDEX_SESSIONDIR, NULL);
242 if ((err = make_dir_path(filename, 0700)) != NULL) {
243 *errmsg = dupprintf("Unable to save session: %s", err);
250 filename = make_filename(INDEX_SESSION, sessionname);
251 fp = fopen(filename, "w");
253 *errmsg = dupprintf("Unable to save session: open(\"%s\") "
254 "returned '%s'", filename, strerror(errno));
256 return NULL; /* can't open */
262 void write_setting_s(void *handle, const char *key, const char *value)
264 FILE *fp = (FILE *)handle;
265 fprintf(fp, "%s=%s\n", key, value);
268 void write_setting_i(void *handle, const char *key, int value)
270 FILE *fp = (FILE *)handle;
271 fprintf(fp, "%s=%d\n", key, value);
274 void close_settings_w(void *handle)
276 FILE *fp = (FILE *)handle;
281 * Reading settings, for the moment, is done by retrieving X
282 * resources from the X display. When we introduce disk files, I
283 * think what will happen is that the X resources will override
284 * PuTTY's inbuilt defaults, but that the disk files will then
285 * override those. This isn't optimal, but it's the best I can
286 * immediately work out.
287 * FIXME: the above comment is a bit out of date. Did it happen?
295 static tree234 *xrmtree = NULL;
297 int keycmp(void *av, void *bv)
299 struct skeyval *a = (struct skeyval *)av;
300 struct skeyval *b = (struct skeyval *)bv;
301 return strcmp(a->key, b->key);
304 void provide_xrm_string(char *string)
307 struct skeyval *xrms, *ret;
309 p = q = strchr(string, ':');
311 fprintf(stderr, "pterm: expected a colon in resource string"
312 " \"%s\"\n", string);
316 while (p > string && p[-1] != '.' && p[-1] != '*')
318 xrms = snew(struct skeyval);
319 key = snewn(q-p, char);
323 while (*q && isspace((unsigned char)*q))
325 xrms->value = dupstr(q);
328 xrmtree = newtree234(keycmp);
330 ret = add234(xrmtree, xrms);
332 /* Override an existing string. */
333 del234(xrmtree, ret);
334 add234(xrmtree, xrms);
338 const char *get_setting(const char *key)
340 struct skeyval tmp, *ret;
343 ret = find234(xrmtree, &tmp, NULL);
347 return x_get_default(key);
350 void *open_settings_r(const char *sessionname)
357 filename = make_filename(INDEX_SESSION, sessionname);
358 fp = fopen(filename, "r");
361 return NULL; /* can't open */
363 ret = newtree234(keycmp);
365 while ( (line = fgetline(fp)) ) {
366 char *value = strchr(line, '=');
374 value[strcspn(value, "\r\n")] = '\0'; /* trim trailing NL */
376 kv = snew(struct skeyval);
377 kv->key = dupstr(line);
378 kv->value = dupstr(value);
389 char *read_setting_s(void *handle, const char *key)
391 tree234 *tree = (tree234 *)handle;
393 struct skeyval tmp, *kv;
397 (kv = find234(tree, &tmp, NULL)) != NULL) {
401 val = get_setting(key);
409 int read_setting_i(void *handle, const char *key, int defvalue)
411 tree234 *tree = (tree234 *)handle;
413 struct skeyval tmp, *kv;
417 (kv = find234(tree, &tmp, NULL)) != NULL) {
421 val = get_setting(key);
429 FontSpec *read_setting_fontspec(void *handle, const char *name)
432 * In GTK1-only PuTTY, we used to store font names simply as a
433 * valid X font description string (logical or alias), under a
434 * bare key such as "Font".
436 * In GTK2 PuTTY, we have a prefix system where "client:"
437 * indicates a Pango font and "server:" an X one; existing
438 * configuration needs to be reinterpreted as having the
439 * "server:" prefix, so we change the storage key from the
440 * provided name string (e.g. "Font") to a suffixed one
443 char *suffname = dupcat(name, "Name", NULL);
446 if ((tmp = read_setting_s(handle, suffname)) != NULL) {
447 FontSpec *fs = fontspec_new(tmp);
450 return fs; /* got new-style name */
454 /* Fall back to old-style name. */
455 tmp = read_setting_s(handle, name);
457 char *tmp2 = dupcat("server:", tmp, NULL);
458 FontSpec *fs = fontspec_new(tmp2);
467 Filename *read_setting_filename(void *handle, const char *name)
469 char *tmp = read_setting_s(handle, name);
471 Filename *ret = filename_from_str(tmp);
478 void write_setting_fontspec(void *handle, const char *name, FontSpec *fs)
481 * read_setting_fontspec had to handle two cases, but when
482 * writing our settings back out we simply always generate the
485 char *suffname = dupcat(name, "Name", NULL);
486 write_setting_s(handle, suffname, fs->name);
489 void write_setting_filename(void *handle, const char *name, Filename *result)
491 write_setting_s(handle, name, result->path);
494 void close_settings_r(void *handle)
496 tree234 *tree = (tree234 *)handle;
502 while ( (kv = index234(tree, 0)) != NULL) {
504 sfree((char *)kv->key);
505 sfree((char *)kv->value);
512 void del_settings(const char *sessionname)
515 filename = make_filename(INDEX_SESSION, sessionname);
520 void *enum_settings_start(void)
525 filename = make_filename(INDEX_SESSIONDIR, NULL);
526 dp = opendir(filename);
532 char *enum_settings_next(void *handle, char *buffer, int buflen)
534 DIR *dp = (DIR *)handle;
538 int maxlen, thislen, len;
541 fullpath = make_filename(INDEX_SESSIONDIR, NULL);
542 maxlen = len = strlen(fullpath);
544 while ( (de = readdir(dp)) != NULL ) {
545 thislen = len + 1 + strlen(de->d_name);
546 if (maxlen < thislen) {
548 fullpath = sresize(fullpath, maxlen+1, char);
551 strncpy(fullpath+len+1, de->d_name, thislen - (len+1));
552 fullpath[thislen] = '\0';
554 if (stat(fullpath, &st) < 0 || !S_ISREG(st.st_mode))
555 continue; /* try another one */
557 unmunged = unmungestr(de->d_name);
558 strncpy(buffer, unmunged, buflen);
559 buffer[buflen-1] = '\0';
569 void enum_settings_finish(void *handle)
571 DIR *dp = (DIR *)handle;
576 * Lines in the host keys file are of the form
578 * type@port:hostname keydata
582 * rsa@22:foovax.example.org 0x23,0x293487364395345345....2343
584 int verify_host_key(const char *hostname, int port,
585 const char *keytype, const char *key)
592 filename = make_filename(INDEX_HOSTKEYS, NULL);
593 fp = fopen(filename, "r");
596 return 1; /* key does not exist */
599 while ( (line = fgetline(fp)) ) {
604 line[strcspn(line, "\n")] = '\0'; /* strip trailing newline */
607 if (strncmp(p, keytype, i))
615 sprintf(porttext, "%d", port);
616 i = strlen(porttext);
617 if (strncmp(p, porttext, i))
625 i = strlen(hostname);
626 if (strncmp(p, hostname, i))
635 * Found the key. Now just work out whether it's the right
639 ret = 0; /* key matched OK */
641 ret = 2; /* key mismatch */
653 int have_ssh_host_key(const char *hostname, int port,
657 * If we have a host key, verify_host_key will return 0 or 2.
658 * If we don't have one, it'll return 1.
660 return verify_host_key(hostname, port, keytype, "") != 1;
663 void store_host_key(const char *hostname, int port,
664 const char *keytype, const char *key)
667 char *newtext, *line;
669 char *filename, *tmpfilename;
672 * Open both the old file and a new file.
674 tmpfilename = make_filename(INDEX_HOSTKEYS_TMP, NULL);
675 wfp = fopen(tmpfilename, "w");
676 if (!wfp && errno == ENOENT) {
679 dir = make_filename(INDEX_DIR, NULL);
680 if ((errmsg = make_dir_path(dir, 0700)) != NULL) {
681 nonfatal("Unable to store host key: %s", errmsg);
689 wfp = fopen(tmpfilename, "w");
692 nonfatal("Unable to store host key: open(\"%s\") "
693 "returned '%s'", tmpfilename, strerror(errno));
697 filename = make_filename(INDEX_HOSTKEYS, NULL);
698 rfp = fopen(filename, "r");
700 newtext = dupprintf("%s@%d:%s %s\n", keytype, port, hostname, key);
701 headerlen = 1 + strcspn(newtext, " "); /* count the space too */
704 * Copy all lines from the old file to the new one that _don't_
705 * involve the same host key identifier as the one we're adding.
708 while ( (line = fgetline(rfp)) ) {
709 if (strncmp(line, newtext, headerlen))
717 * Now add the new line at the end.
723 if (rename(tmpfilename, filename) < 0) {
724 nonfatal("Unable to store host key: rename(\"%s\",\"%s\")"
725 " returned '%s'", tmpfilename, filename,
734 void read_random_seed(noise_consumer_t consumer)
739 fname = make_filename(INDEX_RANDSEED, NULL);
740 fd = open(fname, O_RDONLY);
745 while ( (ret = read(fd, buf, sizeof(buf))) > 0)
751 void write_random_seed(void *data, int len)
756 fname = make_filename(INDEX_RANDSEED, NULL);
758 * Don't truncate the random seed file if it already exists; if
759 * something goes wrong half way through writing it, it would
760 * be better to leave the old data there than to leave it empty.
762 fd = open(fname, O_CREAT | O_WRONLY, 0600);
764 if (errno != ENOENT) {
765 nonfatal("Unable to write random seed: open(\"%s\") "
766 "returned '%s'", fname, strerror(errno));
772 dir = make_filename(INDEX_DIR, NULL);
773 if ((errmsg = make_dir_path(dir, 0700)) != NULL) {
774 nonfatal("Unable to write random seed: %s", errmsg);
782 fd = open(fname, O_CREAT | O_WRONLY, 0600);
784 nonfatal("Unable to write random seed: open(\"%s\") "
785 "returned '%s'", fname, strerror(errno));
792 int ret = write(fd, data, len);
794 nonfatal("Unable to write random seed: write "
795 "returned '%s'", strerror(errno));
799 data = (char *)data + len;
806 void cleanup_all(void)