lib/tempname.c

   1 /* tempname.c - generate the name of a temporary file.
   2
   3    Copyright (C) 1991-2003, 2005-2007, 2009-2012 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 /* Extracted from glibc sysdeps/posix/tempname.c.  See also tmpdir.c.  */
  19
  20 #if !_LIBC
  21 # include <config.h>
  22 # include "tempname.h"
  23 #endif
  24
  25 #include <sys/types.h>
  26 #include <assert.h>
  27
  28 #include <errno.h>
  29 #ifndef __set_errno
  30 # define __set_errno(Val) errno = (Val)
  31 #endif
  32
  33 #include <stdio.h>
  34 #ifndef P_tmpdir
  35 # define P_tmpdir "/tmp"
  36 #endif
  37 #ifndef TMP_MAX
  38 # define TMP_MAX 238328
  39 #endif
  40 #ifndef __GT_FILE
  41 # define __GT_FILE      0
  42 # define __GT_DIR       1
  43 # define __GT_NOCREATE  2
  44 #endif
  45 #if !_LIBC && (GT_FILE != __GT_FILE || GT_DIR != __GT_DIR       \
  46                || GT_NOCREATE != __GT_NOCREATE)
  47 # error report this to bug-gnulib@gnu.org
  48 #endif
  49
  50 #include <stddef.h>
  51 #include <stdlib.h>
  52 #include <string.h>
  53
  54 #include <fcntl.h>
  55 #include <sys/time.h>
  56 #include <stdint.h>
  57 #include <unistd.h>
  58
  59 #include <sys/stat.h>
  60
  61 #if _LIBC
  62 # define struct_stat64 struct stat64
  63 #else
  64 # define struct_stat64 struct stat
  65 # define __gen_tempname gen_tempname
  66 # define __getpid getpid
  67 # define __gettimeofday gettimeofday
  68 # define __mkdir mkdir
  69 # define __open open
  70 # define __lxstat64(version, file, buf) lstat (file, buf)
  71 #endif
  72
  73 #if ! (HAVE___SECURE_GETENV || _LIBC)
  74 # define __secure_getenv getenv
  75 #endif
  76
  77 #ifdef _LIBC
  78 # include <hp-timing.h>
  79 # if HP_TIMING_AVAIL
  80 #  define RANDOM_BITS(Var) \
  81   if (__builtin_expect (value == UINT64_C (0), 0))                            \
  82     {                                                                         \
  83       /* If this is the first time this function is used initialize           \
  84          the variable we accumulate the value in to some somewhat             \
  85          random value.  If we'd not do this programs at startup time          \
  86          might have a reduced set of possible names, at least on slow         \
  87          machines.  */                                                        \
  88       struct timeval tv;                                                      \
  89       __gettimeofday (&tv, NULL);                                             \
  90       value = ((uint64_t) tv.tv_usec << 16) ^ tv.tv_sec;                      \
  91     }                                                                         \
  92   HP_TIMING_NOW (Var)
  93 # endif
  94 #endif
  95
  96 /* Use the widest available unsigned type if uint64_t is not
  97    available.  The algorithm below extracts a number less than 62**6
  98    (approximately 2**35.725) from uint64_t, so ancient hosts where
  99    uintmax_t is only 32 bits lose about 3.725 bits of randomness,
 100    which is better than not having mkstemp at all.  */
 101 #if !defined UINT64_MAX && !defined uint64_t
 102 # define uint64_t uintmax_t
 103 #endif
 104
 105 #if _LIBC
 106 /* Return nonzero if DIR is an existent directory.  */
 107 static int
 108 direxists (const char *dir)
 109 {
 110   struct_stat64 buf;
 111   return __xstat64 (_STAT_VER, dir, &buf) == 0 && S_ISDIR (buf.st_mode);
 112 }
 113
 114 /* Path search algorithm, for tmpnam, tmpfile, etc.  If DIR is
 115    non-null and exists, uses it; otherwise uses the first of $TMPDIR,
 116    P_tmpdir, /tmp that exists.  Copies into TMPL a template suitable
 117    for use with mk[s]temp.  Will fail (-1) if DIR is non-null and
 118    doesn't exist, none of the searched dirs exists, or there's not
 119    enough space in TMPL. */
 120 int
 121 __path_search (char *tmpl, size_t tmpl_len, const char *dir, const char *pfx,
 122                int try_tmpdir)
 123 {
 124   const char *d;
 125   size_t dlen, plen;
 126
 127   if (!pfx || !pfx[0])
 128     {
 129       pfx = "file";
 130       plen = 4;
 131     }
 132   else
 133     {
 134       plen = strlen (pfx);
 135       if (plen > 5)
 136         plen = 5;
 137     }
 138
 139   if (try_tmpdir)
 140     {
 141       d = __secure_getenv ("TMPDIR");
 142       if (d != NULL && direxists (d))
 143         dir = d;
 144       else if (dir != NULL && direxists (dir))
 145         /* nothing */ ;
 146       else
 147         dir = NULL;
 148     }
 149   if (dir == NULL)
 150     {
 151       if (direxists (P_tmpdir))
 152         dir = P_tmpdir;
 153       else if (strcmp (P_tmpdir, "/tmp") != 0 && direxists ("/tmp"))
 154         dir = "/tmp";
 155       else
 156         {
 157           __set_errno (ENOENT);
 158           return -1;
 159         }
 160     }
 161
 162   dlen = strlen (dir);
 163   while (dlen > 1 && dir[dlen - 1] == '/')
 164     dlen--;                     /* remove trailing slashes */
 165
 166   /* check we have room for "${dir}/${pfx}XXXXXX\0" */
 167   if (tmpl_len < dlen + 1 + plen + 6 + 1)
 168     {
 169       __set_errno (EINVAL);
 170       return -1;
 171     }
 172
 173   sprintf (tmpl, "%.*s/%.*sXXXXXX", (int) dlen, dir, (int) plen, pfx);
 174   return 0;
 175 }
 176 #endif /* _LIBC */
 177
 178 /* These are the characters used in temporary file names.  */
 179 static const char letters[] =
 180 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
 181
 182 /* Generate a temporary file name based on TMPL.  TMPL must match the
 183    rules for mk[s]temp (i.e. end in "XXXXXX", possibly with a suffix).
 184    The name constructed does not exist at the time of the call to
 185    __gen_tempname.  TMPL is overwritten with the result.
 186
 187    KIND may be one of:
 188    __GT_NOCREATE:       simply verify that the name does not exist
 189                         at the time of the call.
 190    __GT_FILE:           create the file using open(O_CREAT|O_EXCL)
 191                         and return a read-write fd.  The file is mode 0600.
 192    __GT_DIR:            create a directory, which will be mode 0700.
 193
 194    We use a clever algorithm to get hard-to-predict names. */
 195 int
 196 __gen_tempname (char *tmpl, int suffixlen, int flags, int kind)
 197 {
 198   int len;
 199   char *XXXXXX;
 200   static uint64_t value;
 201   uint64_t random_time_bits;
 202   unsigned int count;
 203   int fd = -1;
 204   int save_errno = errno;
 205   struct_stat64 st;
 206
 207   /* A lower bound on the number of temporary files to attempt to
 208      generate.  The maximum total number of temporary file names that
 209      can exist for a given template is 62**6.  It should never be
 210      necessary to try all these combinations.  Instead if a reasonable
 211      number of names is tried (we define reasonable as 62**3) fail to
 212      give the system administrator the chance to remove the problems.  */
 213 #define ATTEMPTS_MIN (62 * 62 * 62)
 214
 215   /* The number of times to attempt to generate a temporary file.  To
 216      conform to POSIX, this must be no smaller than TMP_MAX.  */
 217 #if ATTEMPTS_MIN < TMP_MAX
 218   unsigned int attempts = TMP_MAX;
 219 #else
 220   unsigned int attempts = ATTEMPTS_MIN;
 221 #endif
 222
 223   len = strlen (tmpl);
 224   if (len < 6 + suffixlen || memcmp (&tmpl[len - 6 - suffixlen], "XXXXXX", 6))
 225     {
 226       __set_errno (EINVAL);
 227       return -1;
 228     }
 229
 230   /* This is where the Xs start.  */
 231   XXXXXX = &tmpl[len - 6 - suffixlen];
 232
 233   /* Get some more or less random data.  */
 234 #ifdef RANDOM_BITS
 235   RANDOM_BITS (random_time_bits);
 236 #else
 237   {
 238     struct timeval tv;
 239     __gettimeofday (&tv, NULL);
 240     random_time_bits = ((uint64_t) tv.tv_usec << 16) ^ tv.tv_sec;
 241   }
 242 #endif
 243   value += random_time_bits ^ __getpid ();
 244
 245   for (count = 0; count < attempts; value += 7777, ++count)
 246     {
 247       uint64_t v = value;
 248
 249       /* Fill in the random bits.  */
 250       XXXXXX[0] = letters[v % 62];
 251       v /= 62;
 252       XXXXXX[1] = letters[v % 62];
 253       v /= 62;
 254       XXXXXX[2] = letters[v % 62];
 255       v /= 62;
 256       XXXXXX[3] = letters[v % 62];
 257       v /= 62;
 258       XXXXXX[4] = letters[v % 62];
 259       v /= 62;
 260       XXXXXX[5] = letters[v % 62];
 261
 262       switch (kind)
 263         {
 264         case __GT_FILE:
 265           fd = __open (tmpl,
 266                        (flags & ~O_ACCMODE)
 267                        | O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
 268           break;
 269
 270         case __GT_DIR:
 271           fd = __mkdir (tmpl, S_IRUSR | S_IWUSR | S_IXUSR);
 272           break;
 273
 274         case __GT_NOCREATE:
 275           /* This case is backward from the other three.  __gen_tempname
 276              succeeds if __xstat fails because the name does not exist.
 277              Note the continue to bypass the common logic at the bottom
 278              of the loop.  */
 279           if (__lxstat64 (_STAT_VER, tmpl, &st) < 0)
 280             {
 281               if (errno == ENOENT)
 282                 {
 283                   __set_errno (save_errno);
 284                   return 0;
 285                 }
 286               else
 287                 /* Give up now. */
 288                 return -1;
 289             }
 290           continue;
 291
 292         default:
 293           assert (! "invalid KIND in __gen_tempname");
 294           abort ();
 295         }
 296
 297       if (fd >= 0)
 298         {
 299           __set_errno (save_errno);
 300           return fd;
 301         }
 302       else if (errno != EEXIST)
 303         return -1;
 304     }
 305
 306   /* We got out of the loop because we ran out of combinations to try.  */
 307   __set_errno (EEXIST);
 308   return -1;
 309 }