src/secure_save.c

   1 /*
   2  * Geeqie
   3  * Copyright (C) 2008 The Geeqie Team
   4  *
   5  * based on the code developped for ELinks by Laurent Monin
   6  *
   7  * This software is released under the GNU General Public License (GNU GPL).
   8  * Please read the included file COPYING for more information.
   9  * This software comes with no warranty of any kind, use at your own risk!
  10  */
  11
  12 #include <glib/gstdio.h>
  13 #include <errno.h>
  14 #include <utime.h>
  15
  16 #include "main.h"
  17 #include "secure_save.h"
  18
  19
  20 /* ABOUT SECURE SAVE */
  21 /* This code was borrowed from the ELinks project (http://elinks.cz)
  22  * It was originally written by me (Laurent Monin aka Zas) and heavily
  23  * modified and improved by all ELinks contributors.
  24  * This code was released under the GPLv2 licence.
  25  * It was modified to be included in geeqie on 2008/04/05 */
  26
  27 /* If ssi->secure_save is TRUE:
  28  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  29  *
  30  * A call to secure_open("/home/me/.confdir/filename", mask) will open a file
  31  * named "filename.tmp_XXXXXX" in /home/me/.confdir/ and return a pointer to a
  32  * structure SecureSaveInfo on success or NULL on error.
  33  *
  34  * filename.tmp_XXXXXX can't conflict with any file since it's created using
  35  * mkstemp(). XXXXXX is a random string.
  36  *
  37  * Subsequent write operations are done using returned SecureSaveInfo FILE *
  38  * field named fp.
  39  *
  40  * If an error is encountered, SecureSaveInfo int field named err is set
  41  * (automatically if using secure_fp*() functions or by programmer)
  42  *
  43  * When secure_close() is called, "filename.tmp_XXXXXX" is flushed and closed,
  44  * and if SecureSaveInfo err field has a value of zero, "filename.tmp_XXXXXX"
  45  * is renamed to "filename". If this succeeded, then secure_close() returns 0.
  46  *
  47  * WARNING: since rename() is used, any symlink called "filename" may be
  48  * replaced by a regular file. If destination file isn't a regular file,
  49  * then secsave is disabled for that file.
  50  *
  51  * If ssi->secure_save is FALSE:
  52  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  53  *
  54  * No temporary file is created, "filename" is truncated, all operations are
  55  * done on it, no rename nor flush occur, symlinks are preserved.
  56  *
  57  * In both cases:
  58  * ~~~~~~~~~~~~~
  59  *
  60  * Access rights are affected by secure_open() mask parameter.
  61  */
  62
  63 /* FIXME: locking system on files about to be rewritten ? */
  64 /* FIXME: Low risk race conditions about ssi->file_name. */
  65
  66 SecureSaveErrno secsave_errno = SS_ERR_NONE;
  67
  68
  69 /** Open a file for writing in a secure way. @returns a pointer to a
  70  * structure secure_save_info on success, or NULL on failure. */
  71 static SecureSaveInfo *
  72 secure_open_umask(const gchar *file_name)
  73 {
  74         struct stat st;
  75         SecureSaveInfo *ssi;
  76
  77         secsave_errno = SS_ERR_NONE;
  78
  79         ssi = g_new0(SecureSaveInfo, 1);
  80         if (!ssi) {
  81                 secsave_errno = SS_ERR_OUT_OF_MEM;
  82                 goto end;
  83         }
  84
  85         ssi->secure_save = TRUE;
  86         ssi->preserve_perms = TRUE;
  87         ssi->unlink_on_error = TRUE;
  88
  89         ssi->file_name = g_strdup(file_name);
  90         if (!ssi->file_name) {
  91                 secsave_errno = SS_ERR_OUT_OF_MEM;
  92                 goto free_f;
  93         }
  94
  95         /* Check properties of final file. */
  96 #ifndef NO_UNIX_SOFTLINKS
  97         if (lstat(ssi->file_name, &st)) {
  98 #else
  99         if (stat(ssi->file_name, &st)) {
 100 #endif
 101                 /* We ignore error caused by file inexistence. */
 102                 if (errno != ENOENT) {
 103                         /* lstat() error. */
 104                         ssi->err = errno;
 105                         secsave_errno = SS_ERR_STAT;
 106                         goto free_file_name;
 107                 }
 108         } else {
 109                 if (!S_ISREG(st.st_mode)) {
 110                         /* Not a regular file, secure_save is disabled. */
 111                         ssi->secure_save = FALSE;
 112                 } else {
 113 #ifdef HAVE_ACCESS
 114                         /* XXX: access() do not work with setuid programs. */
 115                         if (access(ssi->file_name, R_OK | W_OK) < 0) {
 116                                 ssi->err = errno;
 117                                 secsave_errno = SS_ERR_ACCESS;
 118                                 goto free_file_name;
 119                         }
 120 #else
 121                         FILE *f1;
 122
 123                         /* We still have a race condition here between
 124                          * [l]stat() and fopen() */
 125
 126                         f1 = fopen(ssi->file_name, "rb+");
 127                         if (f1) {
 128                                 fclose(f1);
 129                         } else {
 130                                 ssi->err = errno;
 131                                 secsave_errno = SS_ERR_OPEN_READ;
 132                                 goto free_file_name;
 133                         }
 134 #endif
 135                 }
 136         }
 137
 138         if (ssi->secure_save) {
 139                 /* We use a random name for temporary file, mkstemp() opens
 140                  * the file and return a file descriptor named fd, which is
 141                  * then converted to FILE * using fdopen().
 142                  */
 143                 gint fd;
 144                 gchar *randname = g_strconcat(ssi->file_name, ".tmp_XXXXXX", NULL);
 145
 146                 if (!randname) {
 147                         secsave_errno = SS_ERR_OUT_OF_MEM;
 148                         goto free_file_name;
 149                 }
 150
 151                 /* No need to use safe_mkstemp() here. --Zas */
 152                 fd = g_mkstemp(randname);
 153                 if (fd == -1) {
 154                         secsave_errno = SS_ERR_MKSTEMP;
 155                         g_free(randname);
 156                         goto free_file_name;
 157                 }
 158
 159                 ssi->fp = fdopen(fd, "wb");
 160                 if (!ssi->fp) {
 161                         secsave_errno = SS_ERR_OPEN_WRITE;
 162                         ssi->err = errno;
 163                         g_free(randname);
 164                         goto free_file_name;
 165                 }
 166
 167                 ssi->tmp_file_name = randname;
 168         } else {
 169                 /* No need to create a temporary file here. */
 170                 ssi->fp = fopen(ssi->file_name, "wb");
 171                 if (!ssi->fp) {
 172                         secsave_errno = SS_ERR_OPEN_WRITE;
 173                         ssi->err = errno;
 174                         goto free_file_name;
 175                 }
 176         }
 177
 178         return ssi;
 179
 180 free_file_name:
 181         g_free(ssi->file_name);
 182         ssi->file_name = NULL;
 183
 184 free_f:
 185         g_free(ssi);
 186         ssi = NULL;
 187
 188 end:
 189         return NULL;
 190 }
 191
 192 SecureSaveInfo *
 193 secure_open(const gchar *file_name)
 194 {
 195         SecureSaveInfo *ssi;
 196         mode_t saved_mask;
 197 #ifdef CONFIG_OS_WIN32
 198         /* There is neither S_IRWXG nor S_IRWXO under crossmingw32-gcc */
 199         const mode_t mask = 0177;
 200 #else
 201         const mode_t mask = S_IXUSR | S_IRWXG | S_IRWXO;
 202 #endif
 203
 204         saved_mask = umask(mask);
 205         ssi = secure_open_umask(file_name);
 206         umask(saved_mask);
 207
 208         return ssi;
 209 }
 210
 211 /** Close a file opened with secure_open(). Rreturns 0 on success,
 212  * errno or -1 on failure.
 213  */
 214 gint
 215 secure_close(SecureSaveInfo *ssi)
 216 {
 217         gint ret = -1;
 218
 219         if (!ssi) return ret;
 220         if (!ssi->fp) goto free;
 221
 222         if (ssi->err) { /* Keep previous errno. */
 223                 ret = ssi->err;
 224                 fclose(ssi->fp); /* Close file */
 225                 goto free;
 226         }
 227
 228         /* Ensure data is effectively written to disk, we first flush libc buffers
 229          * using fflush(), then fsync() to flush kernel buffers, and finally call
 230          * fclose() (which call fflush() again, but the first one is needed since
 231          * it doesn't make much sense to flush kernel buffers and then libc buffers,
 232          * while closing file releases file descriptor we need to call fsync(). */
 233 #if defined(HAVE_FFLUSH) || defined(HAVE_FSYNC)
 234         if (ssi->secure_save) {
 235                 gint fail = 0;
 236
 237 #ifdef HAVE_FFLUSH
 238                 fail = (fflush(ssi->fp) == EOF);
 239 #endif
 240
 241 #ifdef HAVE_FSYNC
 242                 if (!fail) fail = fsync(fileno(ssi->fp));
 243 #endif
 244
 245                 if (fail) {
 246                         ret = errno;
 247                         secsave_errno = SS_ERR_OTHER;
 248
 249                         fclose(ssi->fp); /* Close file, ignore errors. */
 250                         goto free;
 251                 }
 252         }
 253 #endif
 254
 255         /* Close file. */
 256         if (fclose(ssi->fp) == EOF) {
 257                 ret = errno;
 258                 secsave_errno = SS_ERR_OTHER;
 259                 goto free;
 260         }
 261
 262         if (ssi->secure_save && ssi->file_name && ssi->tmp_file_name) {
 263                 struct stat st;
 264
 265                 /* FIXME: Race condition on ssi->file_name. The file
 266                  * named ssi->file_name may have changed since
 267                  * secure_open() call (where we stat() file and
 268                  * more..).  */
 269 #ifndef NO_UNIX_SOFTLINKS
 270                 if (lstat(ssi->file_name, &st) == 0)
 271 #else
 272                 if (stat(ssi->file_name, &st) == 0)
 273 #endif
 274                         {
 275                         /* set the dest file attributes to that of source (ignoring errors) */
 276                         if (ssi->preserve_perms)
 277                                 {
 278                                 chown(ssi->tmp_file_name, st.st_uid, st.st_gid);
 279                                 chmod(ssi->tmp_file_name, st.st_mode);
 280                                 }
 281
 282                         if (ssi->preserve_mtime)
 283                                 {
 284                                 struct utimbuf tb;
 285
 286                                 tb.actime = st.st_atime;
 287                                 tb.modtime = st.st_mtime;
 288                                 utime(ssi->tmp_file_name, &tb);
 289                                 }
 290                         }
 291                 DEBUG_3("rename %s -> %s", ssi->tmp_file_name, ssi->file_name);
 292                 if (rename(ssi->tmp_file_name, ssi->file_name) == -1) {
 293                         ret = errno;
 294                         secsave_errno = SS_ERR_RENAME;
 295                         goto free;
 296                 }
 297         }
 298
 299         ret = 0;        /* Success. */
 300
 301 free:
 302         if (ssi->tmp_file_name)
 303                 {
 304                 if (ret && ssi->unlink_on_error) unlink(ssi->tmp_file_name);
 305                 g_free(ssi->tmp_file_name);
 306                 }
 307         if (ssi->file_name) g_free(ssi->file_name);
 308         if (ssi) g_free(ssi);
 309
 310         return ret;
 311 }
 312
 313
 314 /** fputs() wrapper, set ssi->err to errno on error. If ssi->err is set when
 315  * called, it immediatly returns EOF.
 316  */
 317 gint
 318 secure_fputs(SecureSaveInfo *ssi, const gchar *s)
 319 {
 320         gint ret;
 321
 322         if (!ssi || !ssi->fp || ssi->err) return EOF;
 323
 324         ret = fputs(s, ssi->fp);
 325         if (ret == EOF) {
 326                 secsave_errno = SS_ERR_OTHER;
 327                 ssi->err = errno;
 328         }
 329
 330         return ret;
 331 }
 332
 333
 334 /** fputc() wrapper, set ssi->err to errno on error. If ssi->err is set when
 335  * called, it immediatly returns EOF.
 336  */
 337 gint
 338 secure_fputc(SecureSaveInfo *ssi, gint c)
 339 {
 340         gint ret;
 341
 342         if (!ssi || !ssi->fp || ssi->err) return EOF;
 343
 344         ret = fputc(c, ssi->fp);
 345         if (ret == EOF) {
 346                 ssi->err = errno;
 347                 secsave_errno = SS_ERR_OTHER;
 348         }
 349
 350         return ret;
 351 }
 352
 353 /** fprintf() wrapper, set ssi->err to errno on error and return a negative
 354  * value. If ssi->err is set when called, it immediatly returns -1.
 355  */
 356 gint
 357 secure_fprintf(SecureSaveInfo *ssi, const gchar *format, ...)
 358 {
 359         va_list ap;
 360         gint ret;
 361
 362         if (!ssi || !ssi->fp || ssi->err) return -1;
 363
 364         va_start(ap, format);
 365         ret = vfprintf(ssi->fp, format, ap);
 366         if (ret < 0) ssi->err = errno;
 367         va_end(ap);
 368
 369         return ret;
 370 }
 371
 372 /** fwrite() wrapper, set ssi->err to errno on error and return a value less than
 373  * the number of elements to write. If ssi->err is set when called, it immediatly returns 0.
 374  */
 375 size_t
 376 secure_fwrite(gconstpointer ptr, size_t size, size_t nmemb, SecureSaveInfo *ssi)
 377 {
 378         size_t ret;
 379
 380         if (!ssi || !ssi->fp || ssi->err) return 0;
 381
 382         ret = fwrite(ptr, size, nmemb, ssi->fp);
 383         if (ret < nmemb)
 384                 {
 385                 ssi->err = errno;
 386                 secsave_errno = SS_ERR_OTHER;
 387                 }
 388
 389         return ret;
 390 }
 391
 392 gchar *
 393 secsave_strerror(SecureSaveErrno secsave_error)
 394 {
 395         switch (secsave_error) {
 396         case SS_ERR_OPEN_READ:
 397                 return _("Cannot read the file");
 398         case SS_ERR_STAT:
 399                 return _("Cannot get file status");
 400         case SS_ERR_ACCESS:
 401                 return _("Cannot access the file");
 402         case SS_ERR_MKSTEMP:
 403                 return _("Cannot create temp file");
 404         case SS_ERR_RENAME:
 405                 return _("Cannot rename the file");
 406         case SS_ERR_DISABLED:
 407                 return _("File saving disabled by option");
 408         case SS_ERR_OUT_OF_MEM:
 409                 return _("Out of memory");
 410         case SS_ERR_OPEN_WRITE:
 411                 return _("Cannot write the file");
 412         case SS_ERR_NONE: /* Impossible. */
 413         case SS_ERR_OTHER:
 414         default:
 415                 return _("Secure file saving error");
 416         }
 417 }
 418 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */