daemon/file.c

   1 /* libguestfs - the guestfsd daemon
   2  * Copyright (C) 2009 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 #include <config.h>
  20
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <unistd.h>
  25 #include <fcntl.h>
  26 #include <sys/stat.h>
  27
  28 #include "guestfs_protocol.h"
  29 #include "daemon.h"
  30 #include "actions.h"
  31
  32 int
  33 do_touch (const char *path)
  34 {
  35   int fd;
  36   int r;
  37   struct stat buf;
  38
  39   /* RHBZ#582484: Restrict touch to regular files.  It's also OK
  40    * here if the file does not exist, since we will create it.
  41    */
  42   CHROOT_IN;
  43   r = lstat (path, &buf);
  44   CHROOT_OUT;
  45
  46   if (r == -1) {
  47     if (errno != ENOENT) {
  48       reply_with_perror ("lstat: %s", path);
  49       return -1;
  50     }
  51   } else {
  52     if (! S_ISREG (buf.st_mode)) {
  53       reply_with_error ("%s: touch can only be used on a regular files", path);
  54       return -1;
  55     }
  56   }
  57
  58   CHROOT_IN;
  59   fd = open (path, O_WRONLY | O_CREAT | O_NOCTTY, 0666);
  60   CHROOT_OUT;
  61
  62   if (fd == -1) {
  63     reply_with_perror ("open: %s", path);
  64     return -1;
  65   }
  66
  67   r = futimens (fd, NULL);
  68   if (r == -1) {
  69     reply_with_perror ("futimens: %s", path);
  70     close (fd);
  71     return -1;
  72   }
  73
  74   if (close (fd) == -1) {
  75     reply_with_perror ("close: %s", path);
  76     return -1;
  77   }
  78
  79   return 0;
  80 }
  81
  82 char *
  83 do_cat (const char *path)
  84 {
  85   int fd;
  86   int alloc, size, r, max;
  87   char *buf, *buf2;
  88
  89   CHROOT_IN;
  90   fd = open (path, O_RDONLY);
  91   CHROOT_OUT;
  92
  93   if (fd == -1) {
  94     reply_with_perror ("open: %s", path);
  95     return NULL;
  96   }
  97
  98   /* Read up to GUESTFS_MESSAGE_MAX - <overhead> bytes.  If it's
  99    * larger than that, we need to return an error instead (for
 100    * correctness).
 101    */
 102   max = GUESTFS_MESSAGE_MAX - 1000;
 103   buf = NULL;
 104   size = alloc = 0;
 105
 106   for (;;) {
 107     if (size >= alloc) {
 108       alloc += 8192;
 109       if (alloc > max) {
 110         reply_with_error ("%s: file is too large for message buffer",
 111                           path);
 112         free (buf);
 113         close (fd);
 114         return NULL;
 115       }
 116       buf2 = realloc (buf, alloc);
 117       if (buf2 == NULL) {
 118         reply_with_perror ("realloc");
 119         free (buf);
 120         close (fd);
 121         return NULL;
 122       }
 123       buf = buf2;
 124     }
 125
 126     r = read (fd, buf + size, alloc - size);
 127     if (r == -1) {
 128       reply_with_perror ("read: %s", path);
 129       free (buf);
 130       close (fd);
 131       return NULL;
 132     }
 133     if (r == 0) {
 134       buf[size] = '\0';
 135       break;
 136     }
 137     if (r > 0)
 138       size += r;
 139   }
 140
 141   if (close (fd) == -1) {
 142     reply_with_perror ("close: %s", path);
 143     free (buf);
 144     return NULL;
 145   }
 146
 147   return buf;                   /* caller will free */
 148 }
 149
 150 char **
 151 do_read_lines (const char *path)
 152 {
 153   char **r = NULL;
 154   int size = 0, alloc = 0;
 155   FILE *fp;
 156   char *line = NULL;
 157   size_t len = 0;
 158   ssize_t n;
 159
 160   CHROOT_IN;
 161   fp = fopen (path, "r");
 162   CHROOT_OUT;
 163
 164   if (!fp) {
 165     reply_with_perror ("fopen: %s", path);
 166     return NULL;
 167   }
 168
 169   while ((n = getline (&line, &len, fp)) != -1) {
 170     /* Remove either LF or CRLF. */
 171     if (n >= 2 && line[n-2] == '\r' && line[n-1] == '\n')
 172       line[n-2] = '\0';
 173     else if (n >= 1 && line[n-1] == '\n')
 174       line[n-1] = '\0';
 175
 176     if (add_string (&r, &size, &alloc, line) == -1) {
 177       free (line);
 178       fclose (fp);
 179       return NULL;
 180     }
 181   }
 182
 183   free (line);
 184
 185   if (add_string (&r, &size, &alloc, NULL) == -1) {
 186     fclose (fp);
 187     return NULL;
 188   }
 189
 190   if (fclose (fp) == EOF) {
 191     reply_with_perror ("fclose: %s", path);
 192     free_strings (r);
 193     return NULL;
 194   }
 195
 196   return r;
 197 }
 198
 199 int
 200 do_rm (const char *path)
 201 {
 202   int r;
 203
 204   CHROOT_IN;
 205   r = unlink (path);
 206   CHROOT_OUT;
 207
 208   if (r == -1) {
 209     reply_with_perror ("%s", path);
 210     return -1;
 211   }
 212
 213   return 0;
 214 }
 215
 216 int
 217 do_chmod (int mode, const char *path)
 218 {
 219   int r;
 220
 221   if (mode < 0) {
 222     reply_with_error ("%s: mode is negative", path);
 223     return -1;
 224   }
 225
 226   CHROOT_IN;
 227   r = chmod (path, mode);
 228   CHROOT_OUT;
 229
 230   if (r == -1) {
 231     reply_with_perror ("%s: 0%o", path, mode);
 232     return -1;
 233   }
 234
 235   return 0;
 236 }
 237
 238 int
 239 do_chown (int owner, int group, const char *path)
 240 {
 241   int r;
 242
 243   CHROOT_IN;
 244   r = chown (path, owner, group);
 245   CHROOT_OUT;
 246
 247   if (r == -1) {
 248     reply_with_perror ("%s: %d.%d", path, owner, group);
 249     return -1;
 250   }
 251
 252   return 0;
 253 }
 254
 255 int
 256 do_lchown (int owner, int group, const char *path)
 257 {
 258   int r;
 259
 260   CHROOT_IN;
 261   r = lchown (path, owner, group);
 262   CHROOT_OUT;
 263
 264   if (r == -1) {
 265     reply_with_perror ("%s: %d.%d", path, owner, group);
 266     return -1;
 267   }
 268
 269   return 0;
 270 }
 271
 272 int
 273 do_write_file (const char *path, const char *content, int size)
 274 {
 275   int fd;
 276
 277   /* This call is deprecated, and it has a broken interface.  New code
 278    * should use the 'guestfs_write' call instead.  Because we used an
 279    * XDR string type, 'content' cannot contain ASCII NUL and 'size'
 280    * must never be longer than the string.  We must check this to
 281    * ensure random stuff from XDR or daemon memory isn't written to
 282    * the file (RHBZ#597135).
 283    */
 284   if (size < 0) {
 285     reply_with_error ("size cannot be negative");
 286     return -1;
 287   }
 288
 289   /* Note content_len must be small because of the limits on protocol
 290    * message size.
 291    */
 292   int content_len = (int) strlen (content);
 293
 294   if (size == 0)
 295     size = content_len;
 296   else if (size > content_len) {
 297     reply_with_error ("size parameter is larger than string content");
 298     return -1;
 299   }
 300
 301   CHROOT_IN;
 302   fd = open (path, O_WRONLY | O_TRUNC | O_CREAT | O_NOCTTY, 0666);
 303   CHROOT_OUT;
 304
 305   if (fd == -1) {
 306     reply_with_perror ("open: %s", path);
 307     return -1;
 308   }
 309
 310   if (xwrite (fd, content, size) == -1) {
 311     reply_with_perror ("write");
 312     close (fd);
 313     return -1;
 314   }
 315
 316   if (close (fd) == -1) {
 317     reply_with_perror ("close: %s", path);
 318     return -1;
 319   }
 320
 321   return 0;
 322 }
 323
 324 int
 325 do_write (const char *path, const char *content, size_t size)
 326 {
 327   int fd;
 328
 329   CHROOT_IN;
 330   fd = open (path, O_WRONLY | O_TRUNC | O_CREAT | O_NOCTTY, 0666);
 331   CHROOT_OUT;
 332
 333   if (fd == -1) {
 334     reply_with_perror ("open: %s", path);
 335     return -1;
 336   }
 337
 338   if (xwrite (fd, content, size) == -1) {
 339     reply_with_perror ("write");
 340     close (fd);
 341     return -1;
 342   }
 343
 344   if (close (fd) == -1) {
 345     reply_with_perror ("close: %s", path);
 346     return -1;
 347   }
 348
 349   return 0;
 350 }
 351
 352 char *
 353 do_read_file (const char *path, size_t *size_r)
 354 {
 355   int fd;
 356   struct stat statbuf;
 357   char *r;
 358
 359   CHROOT_IN;
 360   fd = open (path, O_RDONLY);
 361   CHROOT_OUT;
 362
 363   if (fd == -1) {
 364     reply_with_perror ("open: %s", path);
 365     return NULL;
 366   }
 367
 368   if (fstat (fd, &statbuf) == -1) {
 369     reply_with_perror ("fstat: %s", path);
 370     close (fd);
 371     return NULL;
 372   }
 373
 374   /* The actual limit on messages is smaller than this.  This
 375    * check just limits the amount of memory we'll try and allocate
 376    * here.  If the message is larger than the real limit, that will
 377    * be caught later when we try to serialize the message.
 378    */
 379   if (statbuf.st_size >= GUESTFS_MESSAGE_MAX) {
 380     reply_with_error ("%s: file is too large for the protocol, use guestfs_download instead", path);
 381     close (fd);
 382     return NULL;
 383   }
 384   r = malloc (statbuf.st_size);
 385   if (r == NULL) {
 386     reply_with_perror ("malloc");
 387     close (fd);
 388     return NULL;
 389   }
 390
 391   if (xread (fd, r, statbuf.st_size) == -1) {
 392     reply_with_perror ("read: %s", path);
 393     close (fd);
 394     free (r);
 395     return NULL;
 396   }
 397
 398   if (close (fd) == -1) {
 399     reply_with_perror ("close: %s", path);
 400     free (r);
 401     return NULL;
 402   }
 403
 404   /* Mustn't touch *size_r until we are sure that we won't return any
 405    * error (RHBZ#589039).
 406    */
 407   *size_r = statbuf.st_size;
 408   return r;
 409 }
 410
 411 static char *
 412 pread_fd (int fd, int count, int64_t offset, size_t *size_r,
 413           const char *display_path)
 414 {
 415   ssize_t r;
 416   char *buf;
 417
 418   if (count < 0) {
 419     reply_with_error ("count is negative");
 420     close (fd);
 421     return NULL;
 422   }
 423
 424   if (offset < 0) {
 425     reply_with_error ("offset is negative");
 426     close (fd);
 427     return NULL;
 428   }
 429
 430   /* The actual limit on messages is smaller than this.  This check
 431    * just limits the amount of memory we'll try and allocate in the
 432    * function.  If the message is larger than the real limit, that
 433    * will be caught later when we try to serialize the message.
 434    */
 435   if (count >= GUESTFS_MESSAGE_MAX) {
 436     reply_with_error ("%s: count is too large for the protocol, use smaller reads", display_path);
 437     close (fd);
 438     return NULL;
 439   }
 440
 441   buf = malloc (count);
 442   if (buf == NULL) {
 443     reply_with_perror ("malloc");
 444     close (fd);
 445     return NULL;
 446   }
 447
 448   r = pread (fd, buf, count, offset);
 449   if (r == -1) {
 450     reply_with_perror ("pread: %s", display_path);
 451     close (fd);
 452     free (buf);
 453     return NULL;
 454   }
 455
 456   if (close (fd) == -1) {
 457     reply_with_perror ("close: %s", display_path);
 458     close (fd);
 459     free (buf);
 460     return NULL;
 461   }
 462
 463   /* Mustn't touch *size_r until we are sure that we won't return any
 464    * error (RHBZ#589039).
 465    */
 466   *size_r = r;
 467   return buf;
 468 }
 469
 470 char *
 471 do_pread (const char *path, int count, int64_t offset, size_t *size_r)
 472 {
 473   int fd;
 474
 475   CHROOT_IN;
 476   fd = open (path, O_RDONLY);
 477   CHROOT_OUT;
 478
 479   if (fd == -1) {
 480     reply_with_perror ("open: %s", path);
 481     return NULL;
 482   }
 483
 484   return pread_fd (fd, count, offset, size_r, path);
 485 }
 486
 487 char *
 488 do_pread_device (const char *device, int count, int64_t offset, size_t *size_r)
 489 {
 490   int fd = open (device, O_RDONLY);
 491   if (fd == -1) {
 492     reply_with_perror ("open: %s", device);
 493     return NULL;
 494   }
 495
 496   return pread_fd (fd, count, offset, size_r, device);
 497 }
 498
 499 static int
 500 pwrite_fd (int fd, const char *content, size_t size, int64_t offset,
 501            const char *display_path)
 502 {
 503   ssize_t r;
 504
 505   r = pwrite (fd, content, size, offset);
 506   if (r == -1) {
 507     reply_with_perror ("pwrite: %s", display_path);
 508     close (fd);
 509     return -1;
 510   }
 511
 512   if (close (fd) == -1) {
 513     reply_with_perror ("close: %s", display_path);
 514     close (fd);
 515     return -1;
 516   }
 517
 518   return r;
 519 }
 520
 521 int
 522 do_pwrite (const char *path, const char *content, size_t size, int64_t offset)
 523 {
 524   int fd;
 525
 526   if (offset < 0) {
 527     reply_with_error ("offset is negative");
 528     return -1;
 529   }
 530
 531   CHROOT_IN;
 532   fd = open (path, O_WRONLY);
 533   CHROOT_OUT;
 534
 535   if (fd == -1) {
 536     reply_with_perror ("open: %s", path);
 537     return -1;
 538   }
 539
 540   return pwrite_fd (fd, content, size, offset, path);
 541 }
 542
 543 int
 544 do_pwrite_device (const char *device, const char *content, size_t size,
 545                   int64_t offset)
 546 {
 547   if (offset < 0) {
 548     reply_with_error ("offset is negative");
 549     return -1;
 550   }
 551
 552   int fd = open (device, O_WRONLY);
 553   if (fd == -1) {
 554     reply_with_perror ("open: %s", device);
 555     return -1;
 556   }
 557
 558   return pwrite_fd (fd, content, size, offset, device);
 559 }
 560
 561 /* This runs the 'file' command. */
 562 char *
 563 do_file (const char *path)
 564 {
 565   char *buf = NULL;
 566   const char *display_path = path;
 567
 568   int is_dev = STRPREFIX (path, "/dev/");
 569
 570   if (!is_dev) {
 571     buf = sysroot_path (path);
 572     if (!buf) {
 573       reply_with_perror ("malloc");
 574       return NULL;
 575     }
 576     path = buf;
 577
 578     /* For non-dev, check this is a regular file, else just return the
 579      * file type as a string (RHBZ#582484).
 580      */
 581     struct stat statbuf;
 582     if (lstat (path, &statbuf) == -1) {
 583       reply_with_perror ("lstat: %s", display_path);
 584       free (buf);
 585       return NULL;
 586     }
 587
 588     if (! S_ISREG (statbuf.st_mode)) {
 589       char *ret;
 590
 591       free (buf);
 592
 593       if (S_ISDIR (statbuf.st_mode))
 594         ret = strdup ("directory");
 595       else if (S_ISCHR (statbuf.st_mode))
 596         ret = strdup ("character device");
 597       else if (S_ISBLK (statbuf.st_mode))
 598         ret = strdup ("block device");
 599       else if (S_ISFIFO (statbuf.st_mode))
 600         ret = strdup ("FIFO");
 601       else if (S_ISLNK (statbuf.st_mode))
 602         ret = strdup ("symbolic link");
 603       else if (S_ISSOCK (statbuf.st_mode))
 604         ret = strdup ("socket");
 605       else
 606         ret = strdup ("unknown, not regular file");
 607
 608       if (ret == NULL)
 609         reply_with_perror ("strdup");
 610       return ret;
 611     }
 612   }
 613
 614   /* Which flags to use?  For /dev paths, follow links because
 615    * /dev/VG/LV is a symbolic link.
 616    */
 617   const char *flags = is_dev ? "-zbsL" : "-zb";
 618
 619   char *out, *err;
 620   int r = command (&out, &err, "file", flags, path, NULL);
 621   free (buf);
 622
 623   if (r == -1) {
 624     free (out);
 625     reply_with_error ("%s: %s", display_path, err);
 626     free (err);
 627     return NULL;
 628   }
 629   free (err);
 630
 631   /* We need to remove the trailing \n from output of file(1). */
 632   size_t len = strlen (out);
 633   if (len > 0 && out[len-1] == '\n')
 634     out[len-1] = '\0';
 635
 636   return out;                   /* caller frees */
 637 }
 638
 639 /* zcat | file */
 640 char *
 641 do_zfile (const char *method, const char *path)
 642 {
 643   int len;
 644   const char *zcat;
 645   char *cmd;
 646   FILE *fp;
 647   char line[256];
 648
 649   if (STREQ (method, "gzip") || STREQ (method, "compress"))
 650     zcat = "zcat";
 651   else if (STREQ (method, "bzip2"))
 652     zcat = "bzcat";
 653   else {
 654     reply_with_error ("unknown method");
 655     return NULL;
 656   }
 657
 658   if (asprintf_nowarn (&cmd, "%s %R | file -bsL -", zcat, path) == -1) {
 659     reply_with_perror ("asprintf");
 660     return NULL;
 661   }
 662
 663   if (verbose)
 664     fprintf (stderr, "%s\n", cmd);
 665
 666   fp = popen (cmd, "r");
 667   if (fp == NULL) {
 668     reply_with_perror ("%s", cmd);
 669     free (cmd);
 670     return NULL;
 671   }
 672
 673   free (cmd);
 674
 675   if (fgets (line, sizeof line, fp) == NULL) {
 676     reply_with_perror ("fgets");
 677     fclose (fp);
 678     return NULL;
 679   }
 680
 681   if (fclose (fp) == -1) {
 682     reply_with_perror ("fclose");
 683     return NULL;
 684   }
 685
 686   len = strlen (line);
 687   if (len > 0 && line[len-1] == '\n')
 688     line[len-1] = '\0';
 689
 690   return strdup (line);
 691 }
 692
 693 int64_t
 694 do_filesize (const char *path)
 695 {
 696   int r;
 697   struct stat buf;
 698
 699   CHROOT_IN;
 700   r = stat (path, &buf);        /* follow symlinks */
 701   CHROOT_OUT;
 702
 703   if (r == -1) {
 704     reply_with_perror ("%s", path);
 705     return -1;
 706   }
 707
 708   return buf.st_size;
 709 }