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 "../src/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
  38   CHROOT_IN;
  39   fd = open (path, O_WRONLY | O_CREAT | O_NOCTTY, 0666);
  40   CHROOT_OUT;
  41
  42   if (fd == -1) {
  43     reply_with_perror ("open: %s", path);
  44     return -1;
  45   }
  46
  47   r = futimens (fd, NULL);
  48   if (r == -1) {
  49     reply_with_perror ("futimens: %s", path);
  50     close (fd);
  51     return -1;
  52   }
  53
  54   if (close (fd) == -1) {
  55     reply_with_perror ("close: %s", path);
  56     return -1;
  57   }
  58
  59   return 0;
  60 }
  61
  62 char *
  63 do_cat (const char *path)
  64 {
  65   int fd;
  66   int alloc, size, r, max;
  67   char *buf, *buf2;
  68
  69   CHROOT_IN;
  70   fd = open (path, O_RDONLY);
  71   CHROOT_OUT;
  72
  73   if (fd == -1) {
  74     reply_with_perror ("open: %s", path);
  75     return NULL;
  76   }
  77
  78   /* Read up to GUESTFS_MESSAGE_MAX - <overhead> bytes.  If it's
  79    * larger than that, we need to return an error instead (for
  80    * correctness).
  81    */
  82   max = GUESTFS_MESSAGE_MAX - 1000;
  83   buf = NULL;
  84   size = alloc = 0;
  85
  86   for (;;) {
  87     if (size >= alloc) {
  88       alloc += 8192;
  89       if (alloc > max) {
  90         reply_with_error ("%s: file is too large for message buffer",
  91                           path);
  92         free (buf);
  93         close (fd);
  94         return NULL;
  95       }
  96       buf2 = realloc (buf, alloc);
  97       if (buf2 == NULL) {
  98         reply_with_perror ("realloc");
  99         free (buf);
 100         close (fd);
 101         return NULL;
 102       }
 103       buf = buf2;
 104     }
 105
 106     r = read (fd, buf + size, alloc - size);
 107     if (r == -1) {
 108       reply_with_perror ("read: %s", path);
 109       free (buf);
 110       close (fd);
 111       return NULL;
 112     }
 113     if (r == 0) {
 114       buf[size] = '\0';
 115       break;
 116     }
 117     if (r > 0)
 118       size += r;
 119   }
 120
 121   if (close (fd) == -1) {
 122     reply_with_perror ("close: %s", path);
 123     free (buf);
 124     return NULL;
 125   }
 126
 127   return buf;                   /* caller will free */
 128 }
 129
 130 char **
 131 do_read_lines (const char *path)
 132 {
 133   char **r = NULL;
 134   int size = 0, alloc = 0;
 135   FILE *fp;
 136   char *line = NULL;
 137   size_t len = 0;
 138   ssize_t n;
 139
 140   CHROOT_IN;
 141   fp = fopen (path, "r");
 142   CHROOT_OUT;
 143
 144   if (!fp) {
 145     reply_with_perror ("fopen: %s", path);
 146     return NULL;
 147   }
 148
 149   while ((n = getline (&line, &len, fp)) != -1) {
 150     /* Remove either LF or CRLF. */
 151     if (n >= 2 && line[n-2] == '\r' && line[n-1] == '\n')
 152       line[n-2] = '\0';
 153     else if (n >= 1 && line[n-1] == '\n')
 154       line[n-1] = '\0';
 155
 156     if (add_string (&r, &size, &alloc, line) == -1) {
 157       free (line);
 158       fclose (fp);
 159       return NULL;
 160     }
 161   }
 162
 163   free (line);
 164
 165   if (add_string (&r, &size, &alloc, NULL) == -1) {
 166     fclose (fp);
 167     return NULL;
 168   }
 169
 170   if (fclose (fp) == EOF) {
 171     reply_with_perror ("fclose: %s", path);
 172     free_strings (r);
 173     return NULL;
 174   }
 175
 176   return r;
 177 }
 178
 179 int
 180 do_rm (const char *path)
 181 {
 182   int r;
 183
 184   CHROOT_IN;
 185   r = unlink (path);
 186   CHROOT_OUT;
 187
 188   if (r == -1) {
 189     reply_with_perror ("%s", path);
 190     return -1;
 191   }
 192
 193   return 0;
 194 }
 195
 196 int
 197 do_chmod (int mode, const char *path)
 198 {
 199   int r;
 200
 201   if (mode < 0) {
 202     reply_with_error ("%s: mode is negative", path);
 203     return -1;
 204   }
 205
 206   CHROOT_IN;
 207   r = chmod (path, mode);
 208   CHROOT_OUT;
 209
 210   if (r == -1) {
 211     reply_with_perror ("%s: 0%o", path, mode);
 212     return -1;
 213   }
 214
 215   return 0;
 216 }
 217
 218 int
 219 do_chown (int owner, int group, const char *path)
 220 {
 221   int r;
 222
 223   CHROOT_IN;
 224   r = chown (path, owner, group);
 225   CHROOT_OUT;
 226
 227   if (r == -1) {
 228     reply_with_perror ("%s: %d.%d", path, owner, group);
 229     return -1;
 230   }
 231
 232   return 0;
 233 }
 234
 235 int
 236 do_lchown (int owner, int group, const char *path)
 237 {
 238   int r;
 239
 240   CHROOT_IN;
 241   r = lchown (path, owner, group);
 242   CHROOT_OUT;
 243
 244   if (r == -1) {
 245     reply_with_perror ("%s: %d.%d", path, owner, group);
 246     return -1;
 247   }
 248
 249   return 0;
 250 }
 251
 252 int
 253 do_write_file (const char *path, const char *content, int size)
 254 {
 255   int fd;
 256
 257   /* This call is deprecated, and it has a broken interface.  New code
 258    * should use the 'guestfs_write' call instead.  Because we used an
 259    * XDR string type, 'content' cannot contain ASCII NUL and 'size'
 260    * must never be longer than the string.  We must check this to
 261    * ensure random stuff from XDR or daemon memory isn't written to
 262    * the file (RHBZ#597135).
 263    */
 264   if (size < 0) {
 265     reply_with_error ("size cannot be negative");
 266     return -1;
 267   }
 268
 269   /* Note content_len must be small because of the limits on protocol
 270    * message size.
 271    */
 272   int content_len = (int) strlen (content);
 273
 274   if (size == 0)
 275     size = content_len;
 276   else if (size > content_len) {
 277     reply_with_error ("size parameter is larger than string content");
 278     return -1;
 279   }
 280
 281   CHROOT_IN;
 282   fd = open (path, O_WRONLY | O_TRUNC | O_CREAT | O_NOCTTY, 0666);
 283   CHROOT_OUT;
 284
 285   if (fd == -1) {
 286     reply_with_perror ("open: %s", path);
 287     return -1;
 288   }
 289
 290   if (xwrite (fd, content, size) == -1) {
 291     reply_with_perror ("write");
 292     close (fd);
 293     return -1;
 294   }
 295
 296   if (close (fd) == -1) {
 297     reply_with_perror ("close: %s", path);
 298     return -1;
 299   }
 300
 301   return 0;
 302 }
 303
 304 char *
 305 do_read_file (const char *path, size_t *size_r)
 306 {
 307   int fd;
 308   struct stat statbuf;
 309   char *r;
 310
 311   CHROOT_IN;
 312   fd = open (path, O_RDONLY);
 313   CHROOT_OUT;
 314
 315   if (fd == -1) {
 316     reply_with_perror ("open: %s", path);
 317     return NULL;
 318   }
 319
 320   if (fstat (fd, &statbuf) == -1) {
 321     reply_with_perror ("fstat: %s", path);
 322     close (fd);
 323     return NULL;
 324   }
 325
 326   /* The actual limit on messages is smaller than this.  This
 327    * check just limits the amount of memory we'll try and allocate
 328    * here.  If the message is larger than the real limit, that will
 329    * be caught later when we try to serialize the message.
 330    */
 331   if (statbuf.st_size >= GUESTFS_MESSAGE_MAX) {
 332     reply_with_error ("%s: file is too large for the protocol, use guestfs_download instead", path);
 333     close (fd);
 334     return NULL;
 335   }
 336   r = malloc (statbuf.st_size);
 337   if (r == NULL) {
 338     reply_with_perror ("malloc");
 339     close (fd);
 340     return NULL;
 341   }
 342
 343   if (xread (fd, r, statbuf.st_size) == -1) {
 344     reply_with_perror ("read: %s", path);
 345     close (fd);
 346     free (r);
 347     return NULL;
 348   }
 349
 350   if (close (fd) == -1) {
 351     reply_with_perror ("close: %s", path);
 352     free (r);
 353     return NULL;
 354   }
 355
 356   /* Mustn't touch *size_r until we are sure that we won't return any
 357    * error (RHBZ#589039).
 358    */
 359   *size_r = statbuf.st_size;
 360   return r;
 361 }
 362
 363 char *
 364 do_pread (const char *path, int count, int64_t offset, size_t *size_r)
 365 {
 366   int fd;
 367   ssize_t r;
 368   char *buf;
 369
 370   /* The actual limit on messages is smaller than this.  This check
 371    * just limits the amount of memory we'll try and allocate in the
 372    * function.  If the message is larger than the real limit, that
 373    * will be caught later when we try to serialize the message.
 374    */
 375   if (count >= GUESTFS_MESSAGE_MAX) {
 376     reply_with_error ("%s: count is too large for the protocol, use smaller reads", path);
 377     return NULL;
 378   }
 379
 380   CHROOT_IN;
 381   fd = open (path, O_RDONLY);
 382   CHROOT_OUT;
 383
 384   if (fd == -1) {
 385     reply_with_perror ("open: %s", path);
 386     return NULL;
 387   }
 388
 389   buf = malloc (count);
 390   if (buf == NULL) {
 391     reply_with_perror ("malloc");
 392     close (fd);
 393     return NULL;
 394   }
 395
 396   r = pread (fd, buf, count, offset);
 397   if (r == -1) {
 398     reply_with_perror ("pread: %s", path);
 399     close (fd);
 400     free (buf);
 401     return NULL;
 402   }
 403
 404   if (close (fd) == -1) {
 405     reply_with_perror ("close: %s", path);
 406     close (fd);
 407     free (buf);
 408     return NULL;
 409   }
 410
 411   /* Mustn't touch *size_r until we are sure that we won't return any
 412    * error (RHBZ#589039).
 413    */
 414   *size_r = r;
 415   return buf;
 416 }
 417
 418 /* This runs the 'file' command. */
 419 char *
 420 do_file (const char *path)
 421 {
 422   char *out, *err;
 423   int r, freeit = 0;
 424   char *buf;
 425   int len;
 426
 427   if (STREQLEN (path, "/dev/", 5))
 428     buf = (char *) path;
 429   else {
 430     buf = sysroot_path (path);
 431     if (!buf) {
 432       reply_with_perror ("malloc");
 433       return NULL;
 434     }
 435     freeit = 1;
 436   }
 437
 438   /* file(1) manpage claims "file returns 0 on success, and non-zero on
 439    * error", but this is evidently not true.  It always returns 0, in
 440    * every scenario I can think up.  So check the target is readable
 441    * first.
 442    */
 443   if (access (buf, R_OK) == -1) {
 444     if (freeit) free (buf);
 445     reply_with_perror ("access: %s", path);
 446     return NULL;
 447   }
 448
 449   r = command (&out, &err, "file", "-zbsL", buf, NULL);
 450   if (freeit) free (buf);
 451
 452   if (r == -1) {
 453     free (out);
 454     reply_with_error ("%s: %s", path, err);
 455     free (err);
 456     return NULL;
 457   }
 458   free (err);
 459
 460   /* We need to remove the trailing \n from output of file(1). */
 461   len = strlen (out);
 462   if (out[len-1] == '\n')
 463     out[len-1] = '\0';
 464
 465   return out;                   /* caller frees */
 466 }
 467
 468 /* zcat | file */
 469 char *
 470 do_zfile (const char *method, const char *path)
 471 {
 472   int len;
 473   const char *zcat;
 474   char *cmd;
 475   FILE *fp;
 476   char line[256];
 477
 478   if (STREQ (method, "gzip") || STREQ (method, "compress"))
 479     zcat = "zcat";
 480   else if (STREQ (method, "bzip2"))
 481     zcat = "bzcat";
 482   else {
 483     reply_with_error ("unknown method");
 484     return NULL;
 485   }
 486
 487   if (asprintf_nowarn (&cmd, "%s %R | file -bsL -", zcat, path) == -1) {
 488     reply_with_perror ("asprintf");
 489     return NULL;
 490   }
 491
 492   if (verbose)
 493     fprintf (stderr, "%s\n", cmd);
 494
 495   fp = popen (cmd, "r");
 496   if (fp == NULL) {
 497     reply_with_perror ("%s", cmd);
 498     free (cmd);
 499     return NULL;
 500   }
 501
 502   free (cmd);
 503
 504   if (fgets (line, sizeof line, fp) == NULL) {
 505     reply_with_perror ("fgets");
 506     fclose (fp);
 507     return NULL;
 508   }
 509
 510   if (fclose (fp) == -1) {
 511     reply_with_perror ("fclose");
 512     return NULL;
 513   }
 514
 515   len = strlen (line);
 516   if (len > 0 && line[len-1] == '\n')
 517     line[len-1] = '\0';
 518
 519   return strdup (line);
 520 }
 521
 522 int64_t
 523 do_filesize (const char *path)
 524 {
 525   int r;
 526   struct stat buf;
 527
 528   CHROOT_IN;
 529   r = stat (path, &buf);        /* follow symlinks */
 530   CHROOT_OUT;
 531
 532   if (r == -1) {
 533     reply_with_perror ("%s", path);
 534     return -1;
 535   }
 536
 537   return buf.st_size;
 538 }