unix/uxstore.c

   1 /*
   2  * uxstore.c: Unix-specific implementation of the interface defined
   3  * in storage.h.
   4  */
   5
   6 #include <stdio.h>
   7 #include <stdlib.h>
   8 #include <string.h>
   9 #include <assert.h>
  10 #include <errno.h>
  11 #include <ctype.h>
  12 #include <limits.h>
  13 #include <unistd.h>
  14 #include <fcntl.h>
  15 #include <dirent.h>
  16 #include <sys/stat.h>
  17 #include <sys/types.h>
  18 #include <pwd.h>
  19 #include "putty.h"
  20 #include "storage.h"
  21 #include "tree234.h"
  22
  23 #ifdef PATH_MAX
  24 #define FNLEN PATH_MAX
  25 #else
  26 #define FNLEN 1024 /* XXX */
  27 #endif
  28
  29 enum {
  30     INDEX_DIR, INDEX_HOSTKEYS, INDEX_HOSTKEYS_TMP, INDEX_RANDSEED,
  31     INDEX_SESSIONDIR, INDEX_SESSION,
  32 };
  33
  34 static const char hex[16] = "0123456789ABCDEF";
  35
  36 static char *mungestr(const char *in)
  37 {
  38     char *out, *ret;
  39
  40     if (!in || !*in)
  41         in = "Default Settings";
  42
  43     ret = out = snewn(3*strlen(in)+1, char);
  44
  45     while (*in) {
  46         /*
  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...
  52          */
  53         if (*in!='+' && *in!='-' && *in!='.' && *in!='@' && *in!='_' &&
  54             !(*in >= '0' && *in <= '9') &&
  55             !(*in >= 'A' && *in <= 'Z') &&
  56             !(*in >= 'a' && *in <= 'z')) {
  57             *out++ = '%';
  58             *out++ = hex[((unsigned char) *in) >> 4];
  59             *out++ = hex[((unsigned char) *in) & 15];
  60         } else
  61             *out++ = *in;
  62         in++;
  63     }
  64     *out = '\0';
  65     return ret;
  66 }
  67
  68 static char *unmungestr(const char *in)
  69 {
  70     char *out, *ret;
  71     out = ret = snewn(strlen(in)+1, char);
  72     while (*in) {
  73         if (*in == '%' && in[1] && in[2]) {
  74             int i, j;
  75
  76             i = in[1] - '0';
  77             i -= (i > 9 ? 7 : 0);
  78             j = in[2] - '0';
  79             j -= (j > 9 ? 7 : 0);
  80
  81             *out++ = (i << 4) + j;
  82             in += 3;
  83         } else {
  84             *out++ = *in++;
  85         }
  86     }
  87     *out = '\0';
  88     return ret;
  89 }
  90
  91 static char *make_filename(int index, const char *subname)
  92 {
  93     char *env, *tmp, *ret;
  94
  95     /*
  96      * Allow override of the PuTTY configuration location, and of
  97      * specific subparts of it, by means of environment variables.
  98      */
  99     if (index == INDEX_DIR) {
 100         struct passwd *pwd;
 101
 102         env = getenv("PUTTYDIR");
 103         if (env)
 104             return dupstr(env);
 105         env = getenv("HOME");
 106         if (env)
 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");
 112     }
 113     if (index == INDEX_SESSIONDIR) {
 114         env = getenv("PUTTYSESSIONS");
 115         if (env)
 116             return dupstr(env);
 117         tmp = make_filename(INDEX_DIR, NULL);
 118         ret = dupprintf("%s/sessions", tmp);
 119         sfree(tmp);
 120         return ret;
 121     }
 122     if (index == INDEX_SESSION) {
 123         char *munged = mungestr(subname);
 124         tmp = make_filename(INDEX_SESSIONDIR, NULL);
 125         ret = dupprintf("%s/%s", tmp, munged);
 126         sfree(tmp);
 127         sfree(munged);
 128         return ret;
 129     }
 130     if (index == INDEX_HOSTKEYS) {
 131         env = getenv("PUTTYSSHHOSTKEYS");
 132         if (env)
 133             return dupstr(env);
 134         tmp = make_filename(INDEX_DIR, NULL);
 135         ret = dupprintf("%s/sshhostkeys", tmp);
 136         sfree(tmp);
 137         return ret;
 138     }
 139     if (index == INDEX_HOSTKEYS_TMP) {
 140         tmp = make_filename(INDEX_HOSTKEYS, NULL);
 141         ret = dupprintf("%s.tmp", tmp);
 142         sfree(tmp);
 143         return ret;
 144     }
 145     if (index == INDEX_RANDSEED) {
 146         env = getenv("PUTTYRANDOMSEED");
 147         if (env)
 148             return dupstr(env);
 149         tmp = make_filename(INDEX_DIR, NULL);
 150         ret = dupprintf("%s/randomseed", tmp);
 151         sfree(tmp);
 152         return ret;
 153     }
 154     tmp = make_filename(INDEX_DIR, NULL);
 155     ret = dupprintf("%s/ERROR", tmp);
 156     sfree(tmp);
 157     return ret;
 158 }
 159
 160 void *open_settings_w(const char *sessionname, char **errmsg)
 161 {
 162     char *filename;
 163     FILE *fp;
 164
 165     *errmsg = NULL;
 166
 167     /*
 168      * Start by making sure the .putty directory and its sessions
 169      * subdir actually exist. Ignore error returns from mkdir since
 170      * they're perfectly likely to be `already exists', and any
 171      * other error will trip us up later on so there's no real need
 172      * to catch it now.
 173      */
 174     filename = make_filename(INDEX_SESSIONDIR, NULL);
 175     if (mkdir(filename, 0700) != 0) {
 176         char *filename2 = make_filename(INDEX_DIR, NULL);
 177         mkdir(filename2, 0700);
 178         sfree(filename2);
 179         mkdir(filename, 0700);
 180     }
 181     sfree(filename);
 182
 183     filename = make_filename(INDEX_SESSION, sessionname);
 184     fp = fopen(filename, "w");
 185     if (!fp) {
 186         *errmsg = dupprintf("Unable to create %s: %s",
 187                             filename, strerror(errno));
 188         sfree(filename);
 189         return NULL;                   /* can't open */
 190     }
 191     sfree(filename);
 192     return fp;
 193 }
 194
 195 void write_setting_s(void *handle, const char *key, const char *value)
 196 {
 197     FILE *fp = (FILE *)handle;
 198     fprintf(fp, "%s=%s\n", key, value);
 199 }
 200
 201 void write_setting_i(void *handle, const char *key, int value)
 202 {
 203     FILE *fp = (FILE *)handle;
 204     fprintf(fp, "%s=%d\n", key, value);
 205 }
 206
 207 void close_settings_w(void *handle)
 208 {
 209     FILE *fp = (FILE *)handle;
 210     fclose(fp);
 211 }
 212
 213 /*
 214  * Reading settings, for the moment, is done by retrieving X
 215  * resources from the X display. When we introduce disk files, I
 216  * think what will happen is that the X resources will override
 217  * PuTTY's inbuilt defaults, but that the disk files will then
 218  * override those. This isn't optimal, but it's the best I can
 219  * immediately work out.
 220  * FIXME: the above comment is a bit out of date. Did it happen?
 221  */
 222
 223 struct keyval {
 224     const char *key;
 225     const char *value;
 226 };
 227
 228 static tree234 *xrmtree = NULL;
 229
 230 int keycmp(void *av, void *bv)
 231 {
 232     struct keyval *a = (struct keyval *)av;
 233     struct keyval *b = (struct keyval *)bv;
 234     return strcmp(a->key, b->key);
 235 }
 236
 237 void provide_xrm_string(char *string)
 238 {
 239     char *p, *q, *key;
 240     struct keyval *xrms, *ret;
 241
 242     p = q = strchr(string, ':');
 243     if (!q) {
 244         fprintf(stderr, "pterm: expected a colon in resource string"
 245                 " \"%s\"\n", string);
 246         return;
 247     }
 248     q++;
 249     while (p > string && p[-1] != '.' && p[-1] != '*')
 250         p--;
 251     xrms = snew(struct keyval);
 252     key = snewn(q-p, char);
 253     memcpy(key, p, q-p);
 254     key[q-p-1] = '\0';
 255     xrms->key = key;
 256     while (*q && isspace((unsigned char)*q))
 257         q++;
 258     xrms->value = dupstr(q);
 259
 260     if (!xrmtree)
 261         xrmtree = newtree234(keycmp);
 262
 263     ret = add234(xrmtree, xrms);
 264     if (ret) {
 265         /* Override an existing string. */
 266         del234(xrmtree, ret);
 267         add234(xrmtree, xrms);
 268     }
 269 }
 270
 271 const char *get_setting(const char *key)
 272 {
 273     struct keyval tmp, *ret;
 274     tmp.key = key;
 275     if (xrmtree) {
 276         ret = find234(xrmtree, &tmp, NULL);
 277         if (ret)
 278             return ret->value;
 279     }
 280     return x_get_default(key);
 281 }
 282
 283 void *open_settings_r(const char *sessionname)
 284 {
 285     char *filename;
 286     FILE *fp;
 287     char *line;
 288     tree234 *ret;
 289
 290     filename = make_filename(INDEX_SESSION, sessionname);
 291     fp = fopen(filename, "r");
 292     sfree(filename);
 293     if (!fp)
 294         return NULL;                   /* can't open */
 295
 296     ret = newtree234(keycmp);
 297
 298     while ( (line = fgetline(fp)) ) {
 299         char *value = strchr(line, '=');
 300         struct keyval *kv;
 301
 302         if (!value)
 303             continue;
 304         *value++ = '\0';
 305         value[strcspn(value, "\r\n")] = '\0';   /* trim trailing NL */
 306
 307         kv = snew(struct keyval);
 308         kv->key = dupstr(line);
 309         kv->value = dupstr(value);
 310         add234(ret, kv);
 311
 312         sfree(line);
 313     }
 314
 315     fclose(fp);
 316
 317     return ret;
 318 }
 319
 320 char *read_setting_s(void *handle, const char *key, char *buffer, int buflen)
 321 {
 322     tree234 *tree = (tree234 *)handle;
 323     const char *val;
 324     struct keyval tmp, *kv;
 325
 326     tmp.key = key;
 327     if (tree != NULL &&
 328         (kv = find234(tree, &tmp, NULL)) != NULL) {
 329         val = kv->value;
 330         assert(val != NULL);
 331     } else
 332         val = get_setting(key);
 333
 334     if (!val)
 335         return NULL;
 336     else {
 337         strncpy(buffer, val, buflen);
 338         buffer[buflen-1] = '\0';
 339         return buffer;
 340     }
 341 }
 342
 343 int read_setting_i(void *handle, const char *key, int defvalue)
 344 {
 345     tree234 *tree = (tree234 *)handle;
 346     const char *val;
 347     struct keyval tmp, *kv;
 348
 349     tmp.key = key;
 350     if (tree != NULL &&
 351         (kv = find234(tree, &tmp, NULL)) != NULL) {
 352         val = kv->value;
 353         assert(val != NULL);
 354     } else
 355         val = get_setting(key);
 356
 357     if (!val)
 358         return defvalue;
 359     else
 360         return atoi(val);
 361 }
 362
 363 int read_setting_fontspec(void *handle, const char *name, FontSpec *result)
 364 {
 365     /*
 366      * In GTK1-only PuTTY, we used to store font names simply as a
 367      * valid X font description string (logical or alias), under a
 368      * bare key such as "Font".
 369      *
 370      * In GTK2 PuTTY, we have a prefix system where "client:"
 371      * indicates a Pango font and "server:" an X one; existing
 372      * configuration needs to be reinterpreted as having the
 373      * "server:" prefix, so we change the storage key from the
 374      * provided name string (e.g. "Font") to a suffixed one
 375      * ("FontName").
 376      */
 377     char *suffname = dupcat(name, "Name", NULL);
 378     if (read_setting_s(handle, suffname, result->name, sizeof(result->name))) {
 379         sfree(suffname);
 380         return TRUE;                   /* got new-style name */
 381     }
 382     sfree(suffname);
 383
 384     /* Fall back to old-style name. */
 385     memcpy(result->name, "server:", 7);
 386     if (!read_setting_s(handle, name,
 387                         result->name + 7, sizeof(result->name) - 7) ||
 388         !result->name[7]) {
 389         result->name[0] = '\0';
 390         return FALSE;
 391     } else {
 392         return TRUE;
 393     }
 394 }
 395 int read_setting_filename(void *handle, const char *name, Filename *result)
 396 {
 397     return !!read_setting_s(handle, name, result->path, sizeof(result->path));
 398 }
 399
 400 void write_setting_fontspec(void *handle, const char *name, FontSpec result)
 401 {
 402     /*
 403      * read_setting_fontspec had to handle two cases, but when
 404      * writing our settings back out we simply always generate the
 405      * new-style name.
 406      */
 407     char *suffname = dupcat(name, "Name", NULL);
 408     write_setting_s(handle, suffname, result.name);
 409     sfree(suffname);
 410 }
 411 void write_setting_filename(void *handle, const char *name, Filename result)
 412 {
 413     write_setting_s(handle, name, result.path);
 414 }
 415
 416 void close_settings_r(void *handle)
 417 {
 418     tree234 *tree = (tree234 *)handle;
 419     struct keyval *kv;
 420
 421     if (!tree)
 422         return;
 423
 424     while ( (kv = index234(tree, 0)) != NULL) {
 425         del234(tree, kv);
 426         sfree((char *)kv->key);
 427         sfree((char *)kv->value);
 428         sfree(kv);
 429     }
 430
 431     freetree234(tree);
 432 }
 433
 434 void del_settings(const char *sessionname)
 435 {
 436     char *filename;
 437     filename = make_filename(INDEX_SESSION, sessionname);
 438     unlink(filename);
 439     sfree(filename);
 440 }
 441
 442 void *enum_settings_start(void)
 443 {
 444     DIR *dp;
 445     char *filename;
 446
 447     filename = make_filename(INDEX_SESSIONDIR, NULL);
 448     dp = opendir(filename);
 449     sfree(filename);
 450
 451     return dp;
 452 }
 453
 454 char *enum_settings_next(void *handle, char *buffer, int buflen)
 455 {
 456     DIR *dp = (DIR *)handle;
 457     struct dirent *de;
 458     struct stat st;
 459     char *fullpath;
 460     int maxlen, thislen, len;
 461     char *unmunged;
 462
 463     fullpath = make_filename(INDEX_SESSIONDIR, NULL);
 464     maxlen = len = strlen(fullpath);
 465
 466     while ( (de = readdir(dp)) != NULL ) {
 467         thislen = len + 1 + strlen(de->d_name);
 468         if (maxlen < thislen) {
 469             maxlen = thislen;
 470             fullpath = sresize(fullpath, maxlen+1, char);
 471         }
 472         fullpath[len] = '/';
 473         strncpy(fullpath+len+1, de->d_name, thislen - (len+1));
 474         fullpath[thislen] = '\0';
 475
 476         if (stat(fullpath, &st) < 0 || !S_ISREG(st.st_mode))
 477             continue;                  /* try another one */
 478
 479         unmunged = unmungestr(de->d_name);
 480         strncpy(buffer, unmunged, buflen);
 481         buffer[buflen-1] = '\0';
 482         sfree(unmunged);
 483         sfree(fullpath);
 484         return buffer;
 485     }
 486
 487     sfree(fullpath);
 488     return NULL;
 489 }
 490
 491 void enum_settings_finish(void *handle)
 492 {
 493     DIR *dp = (DIR *)handle;
 494     closedir(dp);
 495 }
 496
 497 /*
 498  * Lines in the host keys file are of the form
 499  *
 500  *   type@port:hostname keydata
 501  *
 502  * e.g.
 503  *
 504  *   rsa@22:foovax.example.org 0x23,0x293487364395345345....2343
 505  */
 506 int verify_host_key(const char *hostname, int port,
 507                     const char *keytype, const char *key)
 508 {
 509     FILE *fp;
 510     char *filename;
 511     char *line;
 512     int ret;
 513
 514     filename = make_filename(INDEX_HOSTKEYS, NULL);
 515     fp = fopen(filename, "r");
 516     sfree(filename);
 517     if (!fp)
 518         return 1;                      /* key does not exist */
 519
 520     ret = 1;
 521     while ( (line = fgetline(fp)) ) {
 522         int i;
 523         char *p = line;
 524         char porttext[20];
 525
 526         line[strcspn(line, "\n")] = '\0';   /* strip trailing newline */
 527
 528         i = strlen(keytype);
 529         if (strncmp(p, keytype, i))
 530             goto done;
 531         p += i;
 532
 533         if (*p != '@')
 534             goto done;
 535         p++;
 536
 537         sprintf(porttext, "%d", port);
 538         i = strlen(porttext);
 539         if (strncmp(p, porttext, i))
 540             goto done;
 541         p += i;
 542
 543         if (*p != ':')
 544             goto done;
 545         p++;
 546
 547         i = strlen(hostname);
 548         if (strncmp(p, hostname, i))
 549             goto done;
 550         p += i;
 551
 552         if (*p != ' ')
 553             goto done;
 554         p++;
 555
 556         /*
 557          * Found the key. Now just work out whether it's the right
 558          * one or not.
 559          */
 560         if (!strcmp(p, key))
 561             ret = 0;                   /* key matched OK */
 562         else
 563             ret = 2;                   /* key mismatch */
 564
 565         done:
 566         sfree(line);
 567         if (ret != 1)
 568             break;
 569     }
 570
 571     fclose(fp);
 572     return ret;
 573 }
 574
 575 void store_host_key(const char *hostname, int port,
 576                     const char *keytype, const char *key)
 577 {
 578     FILE *rfp, *wfp;
 579     char *newtext, *line;
 580     int headerlen;
 581     char *filename, *tmpfilename;
 582
 583     newtext = dupprintf("%s@%d:%s %s\n", keytype, port, hostname, key);
 584     headerlen = 1 + strcspn(newtext, " ");   /* count the space too */
 585
 586     /*
 587      * Open both the old file and a new file.
 588      */
 589     tmpfilename = make_filename(INDEX_HOSTKEYS_TMP, NULL);
 590     wfp = fopen(tmpfilename, "w");
 591     if (!wfp) {
 592         char *dir;
 593
 594         dir = make_filename(INDEX_DIR, NULL);
 595         mkdir(dir, 0700);
 596         sfree(dir);
 597
 598         wfp = fopen(tmpfilename, "w");
 599     }
 600     if (!wfp) {
 601         sfree(tmpfilename);
 602         return;
 603     }
 604     filename = make_filename(INDEX_HOSTKEYS, NULL);
 605     rfp = fopen(filename, "r");
 606
 607     /*
 608      * Copy all lines from the old file to the new one that _don't_
 609      * involve the same host key identifier as the one we're adding.
 610      */
 611     if (rfp) {
 612         while ( (line = fgetline(rfp)) ) {
 613             if (strncmp(line, newtext, headerlen))
 614                 fputs(line, wfp);
 615         }
 616         fclose(rfp);
 617     }
 618
 619     /*
 620      * Now add the new line at the end.
 621      */
 622     fputs(newtext, wfp);
 623
 624     fclose(wfp);
 625
 626     rename(tmpfilename, filename);
 627
 628     sfree(tmpfilename);
 629     sfree(filename);
 630     sfree(newtext);
 631 }
 632
 633 void read_random_seed(noise_consumer_t consumer)
 634 {
 635     int fd;
 636     char *fname;
 637
 638     fname = make_filename(INDEX_RANDSEED, NULL);
 639     fd = open(fname, O_RDONLY);
 640     sfree(fname);
 641     if (fd >= 0) {
 642         char buf[512];
 643         int ret;
 644         while ( (ret = read(fd, buf, sizeof(buf))) > 0)
 645             consumer(buf, ret);
 646         close(fd);
 647     }
 648 }
 649
 650 void write_random_seed(void *data, int len)
 651 {
 652     int fd;
 653     char *fname;
 654
 655     fname = make_filename(INDEX_RANDSEED, NULL);
 656     /*
 657      * Don't truncate the random seed file if it already exists; if
 658      * something goes wrong half way through writing it, it would
 659      * be better to leave the old data there than to leave it empty.
 660      */
 661     fd = open(fname, O_CREAT | O_WRONLY, 0600);
 662     if (fd < 0) {
 663         char *dir;
 664
 665         dir = make_filename(INDEX_DIR, NULL);
 666         mkdir(dir, 0700);
 667         sfree(dir);
 668
 669         fd = open(fname, O_CREAT | O_WRONLY, 0600);
 670     }
 671
 672     while (len > 0) {
 673         int ret = write(fd, data, len);
 674         if (ret <= 0) break;
 675         len -= ret;
 676         data = (char *)data + len;
 677     }
 678
 679     close(fd);
 680     sfree(fname);
 681 }
 682
 683 void cleanup_all(void)
 684 {
 685 }