windows/winmisc.c

   1 /*
   2  * winmisc.c: miscellaneous Windows-specific things
   3  */
   4
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include "putty.h"
   8 #include <security.h>
   9
  10 OSVERSIONINFO osVersion;
  11
  12 char *platform_get_x_display(void) {
  13     /* We may as well check for DISPLAY in case it's useful. */
  14     return dupstr(getenv("DISPLAY"));
  15 }
  16
  17 Filename *filename_from_str(const char *str)
  18 {
  19     Filename *ret = snew(Filename);
  20     ret->path = dupstr(str);
  21     return ret;
  22 }
  23
  24 Filename *filename_copy(const Filename *fn)
  25 {
  26     return filename_from_str(fn->path);
  27 }
  28
  29 const char *filename_to_str(const Filename *fn)
  30 {
  31     return fn->path;
  32 }
  33
  34 int filename_equal(const Filename *f1, const Filename *f2)
  35 {
  36     return !strcmp(f1->path, f2->path);
  37 }
  38
  39 int filename_is_null(const Filename *fn)
  40 {
  41     return !*fn->path;
  42 }
  43
  44 void filename_free(Filename *fn)
  45 {
  46     sfree(fn->path);
  47     sfree(fn);
  48 }
  49
  50 int filename_serialise(const Filename *f, void *vdata)
  51 {
  52     char *data = (char *)vdata;
  53     int len = strlen(f->path) + 1;     /* include trailing NUL */
  54     if (data) {
  55         strcpy(data, f->path);
  56     }
  57     return len;
  58 }
  59 Filename *filename_deserialise(void *vdata, int maxsize, int *used)
  60 {
  61     char *data = (char *)vdata;
  62     char *end;
  63     end = memchr(data, '\0', maxsize);
  64     if (!end)
  65         return NULL;
  66     end++;
  67     *used = end - data;
  68     return filename_from_str(data);
  69 }
  70
  71 #ifndef NO_SECUREZEROMEMORY
  72 /*
  73  * Windows implementation of smemclr (see misc.c) using SecureZeroMemory.
  74  */
  75 void smemclr(void *b, size_t n) {
  76     if (b && n > 0)
  77         SecureZeroMemory(b, n);
  78 }
  79 #endif
  80
  81 char *get_username(void)
  82 {
  83     DWORD namelen;
  84     char *user;
  85     int got_username = FALSE;
  86     DECL_WINDOWS_FUNCTION(static, BOOLEAN, GetUserNameExA,
  87                           (EXTENDED_NAME_FORMAT, LPSTR, PULONG));
  88
  89     {
  90         static int tried_usernameex = FALSE;
  91         if (!tried_usernameex) {
  92             /* Not available on Win9x, so load dynamically */
  93             HMODULE secur32 = load_system32_dll("secur32.dll");
  94             GET_WINDOWS_FUNCTION(secur32, GetUserNameExA);
  95             tried_usernameex = TRUE;
  96         }
  97     }
  98
  99     if (p_GetUserNameExA) {
 100         /*
 101          * If available, use the principal -- this avoids the problem
 102          * that the local username is case-insensitive but Kerberos
 103          * usernames are case-sensitive.
 104          */
 105
 106         /* Get the length */
 107         namelen = 0;
 108         (void) p_GetUserNameExA(NameUserPrincipal, NULL, &namelen);
 109
 110         user = snewn(namelen, char);
 111         got_username = p_GetUserNameExA(NameUserPrincipal, user, &namelen);
 112         if (got_username) {
 113             char *p = strchr(user, '@');
 114             if (p) *p = 0;
 115         } else {
 116             sfree(user);
 117         }
 118     }
 119
 120     if (!got_username) {
 121         /* Fall back to local user name */
 122         namelen = 0;
 123         if (GetUserName(NULL, &namelen) == FALSE) {
 124             /*
 125              * Apparently this doesn't work at least on Windows XP SP2.
 126              * Thus assume a maximum of 256. It will fail again if it
 127              * doesn't fit.
 128              */
 129             namelen = 256;
 130         }
 131
 132         user = snewn(namelen, char);
 133         got_username = GetUserName(user, &namelen);
 134         if (!got_username) {
 135             sfree(user);
 136         }
 137     }
 138
 139     return got_username ? user : NULL;
 140 }
 141
 142 BOOL init_winver(void)
 143 {
 144     ZeroMemory(&osVersion, sizeof(osVersion));
 145     osVersion.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
 146     return GetVersionEx ( (OSVERSIONINFO *) &osVersion);
 147 }
 148
 149 HMODULE load_system32_dll(const char *libname)
 150 {
 151     /*
 152      * Wrapper function to load a DLL out of c:\windows\system32
 153      * without going through the full DLL search path. (Hence no
 154      * attack is possible by placing a substitute DLL earlier on that
 155      * path.)
 156      */
 157     static char *sysdir = NULL;
 158     char *fullpath;
 159     HMODULE ret;
 160
 161     if (!sysdir) {
 162         int size = 0, len;
 163         do {
 164             size = 3*size/2 + 512;
 165             sysdir = sresize(sysdir, size, char);
 166             len = GetSystemDirectory(sysdir, size);
 167         } while (len >= size);
 168     }
 169
 170     fullpath = dupcat(sysdir, "\\", libname, NULL);
 171     ret = LoadLibrary(fullpath);
 172     sfree(fullpath);
 173     return ret;
 174 }
 175
 176 /*
 177  * A tree234 containing mappings from system error codes to strings.
 178  */
 179
 180 struct errstring {
 181     int error;
 182     char *text;
 183 };
 184
 185 static int errstring_find(void *av, void *bv)
 186 {
 187     int *a = (int *)av;
 188     struct errstring *b = (struct errstring *)bv;
 189     if (*a < b->error)
 190         return -1;
 191     if (*a > b->error)
 192         return +1;
 193     return 0;
 194 }
 195 static int errstring_compare(void *av, void *bv)
 196 {
 197     struct errstring *a = (struct errstring *)av;
 198     return errstring_find(&a->error, bv);
 199 }
 200
 201 static tree234 *errstrings = NULL;
 202
 203 const char *win_strerror(int error)
 204 {
 205     struct errstring *es;
 206
 207     if (!errstrings)
 208         errstrings = newtree234(errstring_compare);
 209
 210     es = find234(errstrings, &error, errstring_find);
 211
 212     if (!es) {
 213         char msgtext[65536]; /* maximum size for FormatMessage is 64K */
 214
 215         es = snew(struct errstring);
 216         es->error = error;
 217         if (!FormatMessage((FORMAT_MESSAGE_FROM_SYSTEM |
 218                             FORMAT_MESSAGE_IGNORE_INSERTS), NULL, error,
 219                            MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
 220                            msgtext, lenof(msgtext)-1, NULL)) {
 221             sprintf(msgtext,
 222                     "(unable to format: FormatMessage returned %d)",
 223                     error, GetLastError());
 224         } else {
 225             int len = strlen(msgtext);
 226             if (len > 0 && msgtext[len-1] == '\n')
 227                 msgtext[len-1] = '\0';
 228         }
 229         es->text = dupprintf("Error %d: %s", error, msgtext);
 230         add234(errstrings, es);
 231     }
 232
 233     return es->text;
 234 }
 235
 236 #ifdef DEBUG
 237 static FILE *debug_fp = NULL;
 238 static HANDLE debug_hdl = INVALID_HANDLE_VALUE;
 239 static int debug_got_console = 0;
 240
 241 void dputs(char *buf)
 242 {
 243     DWORD dw;
 244
 245     if (!debug_got_console) {
 246         if (AllocConsole()) {
 247             debug_got_console = 1;
 248             debug_hdl = GetStdHandle(STD_OUTPUT_HANDLE);
 249         }
 250     }
 251     if (!debug_fp) {
 252         debug_fp = fopen("debug.log", "w");
 253     }
 254
 255     if (debug_hdl != INVALID_HANDLE_VALUE) {
 256         WriteFile(debug_hdl, buf, strlen(buf), &dw, NULL);
 257     }
 258     fputs(buf, debug_fp);
 259     fflush(debug_fp);
 260 }
 261 #endif
 262
 263 #ifdef MINEFIELD
 264 /*
 265  * Minefield - a Windows equivalent for Electric Fence
 266  */
 267
 268 #define PAGESIZE 4096
 269
 270 /*
 271  * Design:
 272  *
 273  * We start by reserving as much virtual address space as Windows
 274  * will sensibly (or not sensibly) let us have. We flag it all as
 275  * invalid memory.
 276  *
 277  * Any allocation attempt is satisfied by committing one or more
 278  * pages, with an uncommitted page on either side. The returned
 279  * memory region is jammed up against the _end_ of the pages.
 280  *
 281  * Freeing anything causes instantaneous decommitment of the pages
 282  * involved, so stale pointers are caught as soon as possible.
 283  */
 284
 285 static int minefield_initialised = 0;
 286 static void *minefield_region = NULL;
 287 static long minefield_size = 0;
 288 static long minefield_npages = 0;
 289 static long minefield_curpos = 0;
 290 static unsigned short *minefield_admin = NULL;
 291 static void *minefield_pages = NULL;
 292
 293 static void minefield_admin_hide(int hide)
 294 {
 295     int access = hide ? PAGE_NOACCESS : PAGE_READWRITE;
 296     VirtualProtect(minefield_admin, minefield_npages * 2, access, NULL);
 297 }
 298
 299 static void minefield_init(void)
 300 {
 301     int size;
 302     int admin_size;
 303     int i;
 304
 305     for (size = 0x40000000; size > 0; size = ((size >> 3) * 7) & ~0xFFF) {
 306         minefield_region = VirtualAlloc(NULL, size,
 307                                         MEM_RESERVE, PAGE_NOACCESS);
 308         if (minefield_region)
 309             break;
 310     }
 311     minefield_size = size;
 312
 313     /*
 314      * Firstly, allocate a section of that to be the admin block.
 315      * We'll need a two-byte field for each page.
 316      */
 317     minefield_admin = minefield_region;
 318     minefield_npages = minefield_size / PAGESIZE;
 319     admin_size = (minefield_npages * 2 + PAGESIZE - 1) & ~(PAGESIZE - 1);
 320     minefield_npages = (minefield_size - admin_size) / PAGESIZE;
 321     minefield_pages = (char *) minefield_region + admin_size;
 322
 323     /*
 324      * Commit the admin region.
 325      */
 326     VirtualAlloc(minefield_admin, minefield_npages * 2,
 327                  MEM_COMMIT, PAGE_READWRITE);
 328
 329     /*
 330      * Mark all pages as unused (0xFFFF).
 331      */
 332     for (i = 0; i < minefield_npages; i++)
 333         minefield_admin[i] = 0xFFFF;
 334
 335     /*
 336      * Hide the admin region.
 337      */
 338     minefield_admin_hide(1);
 339
 340     minefield_initialised = 1;
 341 }
 342
 343 static void minefield_bomb(void)
 344 {
 345     div(1, *(int *) minefield_pages);
 346 }
 347
 348 static void *minefield_alloc(int size)
 349 {
 350     int npages;
 351     int pos, lim, region_end, region_start;
 352     int start;
 353     int i;
 354
 355     npages = (size + PAGESIZE - 1) / PAGESIZE;
 356
 357     minefield_admin_hide(0);
 358
 359     /*
 360      * Search from current position until we find a contiguous
 361      * bunch of npages+2 unused pages.
 362      */
 363     pos = minefield_curpos;
 364     lim = minefield_npages;
 365     while (1) {
 366         /* Skip over used pages. */
 367         while (pos < lim && minefield_admin[pos] != 0xFFFF)
 368             pos++;
 369         /* Count unused pages. */
 370         start = pos;
 371         while (pos < lim && pos - start < npages + 2 &&
 372                minefield_admin[pos] == 0xFFFF)
 373             pos++;
 374         if (pos - start == npages + 2)
 375             break;
 376         /* If we've reached the limit, reset the limit or stop. */
 377         if (pos >= lim) {
 378             if (lim == minefield_npages) {
 379                 /* go round and start again at zero */
 380                 lim = minefield_curpos;
 381                 pos = 0;
 382             } else {
 383                 minefield_admin_hide(1);
 384                 return NULL;
 385             }
 386         }
 387     }
 388
 389     minefield_curpos = pos - 1;
 390
 391     /*
 392      * We have npages+2 unused pages starting at start. We leave
 393      * the first and last of these alone and use the rest.
 394      */
 395     region_end = (start + npages + 1) * PAGESIZE;
 396     region_start = region_end - size;
 397     /* FIXME: could align here if we wanted */
 398
 399     /*
 400      * Update the admin region.
 401      */
 402     for (i = start + 2; i < start + npages + 1; i++)
 403         minefield_admin[i] = 0xFFFE;   /* used but no region starts here */
 404     minefield_admin[start + 1] = region_start % PAGESIZE;
 405
 406     minefield_admin_hide(1);
 407
 408     VirtualAlloc((char *) minefield_pages + region_start, size,
 409                  MEM_COMMIT, PAGE_READWRITE);
 410     return (char *) minefield_pages + region_start;
 411 }
 412
 413 static void minefield_free(void *ptr)
 414 {
 415     int region_start, i, j;
 416
 417     minefield_admin_hide(0);
 418
 419     region_start = (char *) ptr - (char *) minefield_pages;
 420     i = region_start / PAGESIZE;
 421     if (i < 0 || i >= minefield_npages ||
 422         minefield_admin[i] != region_start % PAGESIZE)
 423         minefield_bomb();
 424     for (j = i; j < minefield_npages && minefield_admin[j] != 0xFFFF; j++) {
 425         minefield_admin[j] = 0xFFFF;
 426     }
 427
 428     VirtualFree(ptr, j * PAGESIZE - region_start, MEM_DECOMMIT);
 429
 430     minefield_admin_hide(1);
 431 }
 432
 433 static int minefield_get_size(void *ptr)
 434 {
 435     int region_start, i, j;
 436
 437     minefield_admin_hide(0);
 438
 439     region_start = (char *) ptr - (char *) minefield_pages;
 440     i = region_start / PAGESIZE;
 441     if (i < 0 || i >= minefield_npages ||
 442         minefield_admin[i] != region_start % PAGESIZE)
 443         minefield_bomb();
 444     for (j = i; j < minefield_npages && minefield_admin[j] != 0xFFFF; j++);
 445
 446     minefield_admin_hide(1);
 447
 448     return j * PAGESIZE - region_start;
 449 }
 450
 451 void *minefield_c_malloc(size_t size)
 452 {
 453     if (!minefield_initialised)
 454         minefield_init();
 455     return minefield_alloc(size);
 456 }
 457
 458 void minefield_c_free(void *p)
 459 {
 460     if (!minefield_initialised)
 461         minefield_init();
 462     minefield_free(p);
 463 }
 464
 465 /*
 466  * realloc _always_ moves the chunk, for rapid detection of code
 467  * that assumes it won't.
 468  */
 469 void *minefield_c_realloc(void *p, size_t size)
 470 {
 471     size_t oldsize;
 472     void *q;
 473     if (!minefield_initialised)
 474         minefield_init();
 475     q = minefield_alloc(size);
 476     oldsize = minefield_get_size(p);
 477     memcpy(q, p, (oldsize < size ? oldsize : size));
 478     minefield_free(p);
 479     return q;
 480 }
 481
 482 #endif                          /* MINEFIELD */
 483
 484 FontSpec *fontspec_new(const char *name,
 485                         int bold, int height, int charset)
 486 {
 487     FontSpec *f = snew(FontSpec);
 488     f->name = dupstr(name);
 489     f->isbold = bold;
 490     f->height = height;
 491     f->charset = charset;
 492     return f;
 493 }
 494 FontSpec *fontspec_copy(const FontSpec *f)
 495 {
 496     return fontspec_new(f->name, f->isbold, f->height, f->charset);
 497 }
 498 void fontspec_free(FontSpec *f)
 499 {
 500     sfree(f->name);
 501     sfree(f);
 502 }
 503 int fontspec_serialise(FontSpec *f, void *vdata)
 504 {
 505     char *data = (char *)vdata;
 506     int len = strlen(f->name) + 1;     /* include trailing NUL */
 507     if (data) {
 508         strcpy(data, f->name);
 509         PUT_32BIT_MSB_FIRST(data + len, f->isbold);
 510         PUT_32BIT_MSB_FIRST(data + len + 4, f->height);
 511         PUT_32BIT_MSB_FIRST(data + len + 8, f->charset);
 512     }
 513     return len + 12;                   /* also include three 4-byte ints */
 514 }
 515 FontSpec *fontspec_deserialise(void *vdata, int maxsize, int *used)
 516 {
 517     char *data = (char *)vdata;
 518     char *end;
 519     if (maxsize < 13)
 520         return NULL;
 521     end = memchr(data, '\0', maxsize-12);
 522     if (!end)
 523         return NULL;
 524     end++;
 525     *used = end - data + 12;
 526     return fontspec_new(data,
 527                         GET_32BIT_MSB_FIRST(end),
 528                         GET_32BIT_MSB_FIRST(end + 4),
 529                         GET_32BIT_MSB_FIRST(end + 8));
 530 }