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) {
102 env = getenv("PUTTYDIR");
105 env = getenv("HOME");
107 return dupprintf("%s/.putty", env);
108 pwd = getpwuid(getuid());
109 if (pwd && pwd->pw_dir)
110 return dupprintf("%s/.putty", pwd->pw_dir);
111 return dupstr("/.putty");
113 if (index == INDEX_SESSIONDIR) {
114 env = getenv("PUTTYSESSIONS");
117 tmp = make_filename(INDEX_DIR, NULL);
118 ret = dupprintf("%s/sessions", tmp);
122 if (index == INDEX_SESSION) {
123 char *munged = mungestr(subname);
124 tmp = make_filename(INDEX_SESSIONDIR, NULL);
125 ret = dupprintf("%s/%s", tmp, munged);
130 if (index == INDEX_HOSTKEYS) {
131 env = getenv("PUTTYSSHHOSTKEYS");
134 tmp = make_filename(INDEX_DIR, NULL);
135 ret = dupprintf("%s/sshhostkeys", tmp);
139 if (index == INDEX_HOSTKEYS_TMP) {
140 tmp = make_filename(INDEX_HOSTKEYS, NULL);
141 ret = dupprintf("%s.tmp", tmp);
145 if (index == INDEX_RANDSEED) {
146 env = getenv("PUTTYRANDOMSEED");
149 tmp = make_filename(INDEX_DIR, NULL);
150 ret = dupprintf("%s/randomseed", tmp);
154 tmp = make_filename(INDEX_DIR, NULL);
155 ret = dupprintf("%s/ERROR", tmp);
160 void *open_settings_w(const char *sessionname, char **errmsg)
168 * Start by making sure the .putty directory and its sessions
169 * subdir actually exist.
171 filename = make_filename(INDEX_DIR, NULL);
172 if (mkdir(filename, 0700) < 0 && errno != EEXIST) {
173 *errmsg = dupprintf("Unable to save session: mkdir(\"%s\") "
174 "returned '%s'", filename, strerror(errno));
180 filename = make_filename(INDEX_SESSIONDIR, NULL);
181 if (mkdir(filename, 0700) < 0 && errno != EEXIST) {
182 *errmsg = dupprintf("Unable to save session: mkdir(\"%s\") "
183 "returned '%s'", filename, strerror(errno));
189 filename = make_filename(INDEX_SESSION, sessionname);
190 fp = fopen(filename, "w");
192 *errmsg = dupprintf("Unable to save session: open(\"%s\") "
193 "returned '%s'", filename, strerror(errno));
195 return NULL; /* can't open */
201 void write_setting_s(void *handle, const char *key, const char *value)
203 FILE *fp = (FILE *)handle;
204 fprintf(fp, "%s=%s\n", key, value);
207 void write_setting_i(void *handle, const char *key, int value)
209 FILE *fp = (FILE *)handle;
210 fprintf(fp, "%s=%d\n", key, value);
213 void close_settings_w(void *handle)
215 FILE *fp = (FILE *)handle;
220 * Reading settings, for the moment, is done by retrieving X
221 * resources from the X display. When we introduce disk files, I
222 * think what will happen is that the X resources will override
223 * PuTTY's inbuilt defaults, but that the disk files will then
224 * override those. This isn't optimal, but it's the best I can
225 * immediately work out.
226 * FIXME: the above comment is a bit out of date. Did it happen?
234 static tree234 *xrmtree = NULL;
236 int keycmp(void *av, void *bv)
238 struct skeyval *a = (struct skeyval *)av;
239 struct skeyval *b = (struct skeyval *)bv;
240 return strcmp(a->key, b->key);
243 void provide_xrm_string(char *string)
246 struct skeyval *xrms, *ret;
248 p = q = strchr(string, ':');
250 fprintf(stderr, "pterm: expected a colon in resource string"
251 " \"%s\"\n", string);
255 while (p > string && p[-1] != '.' && p[-1] != '*')
257 xrms = snew(struct skeyval);
258 key = snewn(q-p, char);
262 while (*q && isspace((unsigned char)*q))
264 xrms->value = dupstr(q);
267 xrmtree = newtree234(keycmp);
269 ret = add234(xrmtree, xrms);
271 /* Override an existing string. */
272 del234(xrmtree, ret);
273 add234(xrmtree, xrms);
277 const char *get_setting(const char *key)
279 struct skeyval tmp, *ret;
282 ret = find234(xrmtree, &tmp, NULL);
286 return x_get_default(key);
289 void *open_settings_r(const char *sessionname)
296 filename = make_filename(INDEX_SESSION, sessionname);
297 fp = fopen(filename, "r");
300 return NULL; /* can't open */
302 ret = newtree234(keycmp);
304 while ( (line = fgetline(fp)) ) {
305 char *value = strchr(line, '=');
313 value[strcspn(value, "\r\n")] = '\0'; /* trim trailing NL */
315 kv = snew(struct skeyval);
316 kv->key = dupstr(line);
317 kv->value = dupstr(value);
328 char *read_setting_s(void *handle, const char *key)
330 tree234 *tree = (tree234 *)handle;
332 struct skeyval tmp, *kv;
336 (kv = find234(tree, &tmp, NULL)) != NULL) {
340 val = get_setting(key);
348 int read_setting_i(void *handle, const char *key, int defvalue)
350 tree234 *tree = (tree234 *)handle;
352 struct skeyval tmp, *kv;
356 (kv = find234(tree, &tmp, NULL)) != NULL) {
360 val = get_setting(key);
368 FontSpec *read_setting_fontspec(void *handle, const char *name)
371 * In GTK1-only PuTTY, we used to store font names simply as a
372 * valid X font description string (logical or alias), under a
373 * bare key such as "Font".
375 * In GTK2 PuTTY, we have a prefix system where "client:"
376 * indicates a Pango font and "server:" an X one; existing
377 * configuration needs to be reinterpreted as having the
378 * "server:" prefix, so we change the storage key from the
379 * provided name string (e.g. "Font") to a suffixed one
382 char *suffname = dupcat(name, "Name", NULL);
385 if ((tmp = read_setting_s(handle, suffname)) != NULL) {
386 FontSpec *fs = fontspec_new(tmp);
389 return fs; /* got new-style name */
393 /* Fall back to old-style name. */
394 tmp = read_setting_s(handle, name);
396 char *tmp2 = dupcat("server:", tmp, NULL);
397 FontSpec *fs = fontspec_new(tmp2);
406 Filename *read_setting_filename(void *handle, const char *name)
408 char *tmp = read_setting_s(handle, name);
410 Filename *ret = filename_from_str(tmp);
417 void write_setting_fontspec(void *handle, const char *name, FontSpec *fs)
420 * read_setting_fontspec had to handle two cases, but when
421 * writing our settings back out we simply always generate the
424 char *suffname = dupcat(name, "Name", NULL);
425 write_setting_s(handle, suffname, fs->name);
428 void write_setting_filename(void *handle, const char *name, Filename *result)
430 write_setting_s(handle, name, result->path);
433 void close_settings_r(void *handle)
435 tree234 *tree = (tree234 *)handle;
441 while ( (kv = index234(tree, 0)) != NULL) {
443 sfree((char *)kv->key);
444 sfree((char *)kv->value);
451 void del_settings(const char *sessionname)
454 filename = make_filename(INDEX_SESSION, sessionname);
459 void *enum_settings_start(void)
464 filename = make_filename(INDEX_SESSIONDIR, NULL);
465 dp = opendir(filename);
471 char *enum_settings_next(void *handle, char *buffer, int buflen)
473 DIR *dp = (DIR *)handle;
477 int maxlen, thislen, len;
480 fullpath = make_filename(INDEX_SESSIONDIR, NULL);
481 maxlen = len = strlen(fullpath);
483 while ( (de = readdir(dp)) != NULL ) {
484 thislen = len + 1 + strlen(de->d_name);
485 if (maxlen < thislen) {
487 fullpath = sresize(fullpath, maxlen+1, char);
490 strncpy(fullpath+len+1, de->d_name, thislen - (len+1));
491 fullpath[thislen] = '\0';
493 if (stat(fullpath, &st) < 0 || !S_ISREG(st.st_mode))
494 continue; /* try another one */
496 unmunged = unmungestr(de->d_name);
497 strncpy(buffer, unmunged, buflen);
498 buffer[buflen-1] = '\0';
508 void enum_settings_finish(void *handle)
510 DIR *dp = (DIR *)handle;
515 * Lines in the host keys file are of the form
517 * type@port:hostname keydata
521 * rsa@22:foovax.example.org 0x23,0x293487364395345345....2343
523 int verify_host_key(const char *hostname, int port,
524 const char *keytype, const char *key)
531 filename = make_filename(INDEX_HOSTKEYS, NULL);
532 fp = fopen(filename, "r");
535 return 1; /* key does not exist */
538 while ( (line = fgetline(fp)) ) {
543 line[strcspn(line, "\n")] = '\0'; /* strip trailing newline */
546 if (strncmp(p, keytype, i))
554 sprintf(porttext, "%d", port);
555 i = strlen(porttext);
556 if (strncmp(p, porttext, i))
564 i = strlen(hostname);
565 if (strncmp(p, hostname, i))
574 * Found the key. Now just work out whether it's the right
578 ret = 0; /* key matched OK */
580 ret = 2; /* key mismatch */
592 void store_host_key(const char *hostname, int port,
593 const char *keytype, const char *key)
596 char *newtext, *line;
598 char *filename, *tmpfilename;
601 * Open both the old file and a new file.
603 tmpfilename = make_filename(INDEX_HOSTKEYS_TMP, NULL);
604 wfp = fopen(tmpfilename, "w");
605 if (!wfp && errno == ENOENT) {
608 dir = make_filename(INDEX_DIR, NULL);
609 if (mkdir(dir, 0700) < 0) {
610 char *msg = dupprintf("Unable to store host key: mkdir(\"%s\") "
611 "returned '%s'", dir, strerror(errno));
619 wfp = fopen(tmpfilename, "w");
622 char *msg = dupprintf("Unable to store host key: open(\"%s\") "
623 "returned '%s'", tmpfilename, strerror(errno));
628 filename = make_filename(INDEX_HOSTKEYS, NULL);
629 rfp = fopen(filename, "r");
631 newtext = dupprintf("%s@%d:%s %s\n", keytype, port, hostname, key);
632 headerlen = 1 + strcspn(newtext, " "); /* count the space too */
635 * Copy all lines from the old file to the new one that _don't_
636 * involve the same host key identifier as the one we're adding.
639 while ( (line = fgetline(rfp)) ) {
640 if (strncmp(line, newtext, headerlen))
648 * Now add the new line at the end.
654 if (rename(tmpfilename, filename) < 0) {
655 char *msg = dupprintf("Unable to store host key: rename(\"%s\",\"%s\")"
656 " returned '%s'", tmpfilename, filename,
666 void read_random_seed(noise_consumer_t consumer)
671 fname = make_filename(INDEX_RANDSEED, NULL);
672 fd = open(fname, O_RDONLY);
677 while ( (ret = read(fd, buf, sizeof(buf))) > 0)
683 void write_random_seed(void *data, int len)
688 fname = make_filename(INDEX_RANDSEED, NULL);
690 * Don't truncate the random seed file if it already exists; if
691 * something goes wrong half way through writing it, it would
692 * be better to leave the old data there than to leave it empty.
694 fd = open(fname, O_CREAT | O_WRONLY, 0600);
696 if (errno != ENOENT) {
697 char *msg = dupprintf("Unable to write random seed: open(\"%s\") "
698 "returned '%s'", fname, strerror(errno));
706 dir = make_filename(INDEX_DIR, NULL);
707 if (mkdir(dir, 0700) < 0) {
708 char *msg = dupprintf("Unable to write random seed: mkdir(\"%s\") "
709 "returned '%s'", dir, strerror(errno));
718 fd = open(fname, O_CREAT | O_WRONLY, 0600);
720 char *msg = dupprintf("Unable to write random seed: open(\"%s\") "
721 "returned '%s'", fname, strerror(errno));
730 int ret = write(fd, data, len);
732 char *msg = dupprintf("Unable to write random seed: write "
733 "returned '%s'", strerror(errno));
739 data = (char *)data + len;
746 void cleanup_all(void)