lib/mkdtemp.c

   1 /* Copyright (C) 1999, 2001-2003, 2006 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   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, or (at your option)
   7    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 along
  15    with this program; if not, write to the Free Software Foundation,
  16    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  17
  18 /* Extracted from misc/mkdtemp.c and sysdeps/posix/tempname.c.  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 # include "config.h"
  22 #endif
  23
  24 /* Specification.  */
  25 #include "mkdtemp.h"
  26
  27 #include <errno.h>
  28 #ifndef __set_errno
  29 # define __set_errno(Val) errno = (Val)
  30 #endif
  31
  32 #include <stddef.h>
  33 #include <stdlib.h>
  34 #include <string.h>
  35
  36 #include <stdio.h>
  37 #ifndef TMP_MAX
  38 # define TMP_MAX 238328
  39 #endif
  40
  41 #if HAVE_STDINT_H || _LIBC
  42 # include <stdint.h>
  43 #endif
  44 #if HAVE_INTTYPES_H
  45 # include <inttypes.h>
  46 #endif
  47
  48 #include <unistd.h>
  49
  50 #if HAVE_GETTIMEOFDAY || _LIBC
  51 # if HAVE_SYS_TIME_H || _LIBC
  52 #  include <sys/time.h>
  53 # endif
  54 #else
  55 # if HAVE_TIME_H || _LIBC
  56 #  include <time.h>
  57 # endif
  58 #endif
  59
  60 #include <sys/stat.h>
  61 #if STAT_MACROS_BROKEN
  62 # undef S_ISDIR
  63 #endif
  64 #if !defined S_ISDIR && defined S_IFDIR
  65 # define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)
  66 #endif
  67 #if !S_IRUSR && S_IREAD
  68 # define S_IRUSR S_IREAD
  69 #endif
  70 #if !S_IRUSR
  71 # define S_IRUSR 00400
  72 #endif
  73 #if !S_IWUSR && S_IWRITE
  74 # define S_IWUSR S_IWRITE
  75 #endif
  76 #if !S_IWUSR
  77 # define S_IWUSR 00200
  78 #endif
  79 #if !S_IXUSR && S_IEXEC
  80 # define S_IXUSR S_IEXEC
  81 #endif
  82 #if !S_IXUSR
  83 # define S_IXUSR 00100
  84 #endif
  85
  86 #ifdef __MINGW32__
  87 # include <io.h>
  88 /* mingw's _mkdir() function has 1 argument, but we pass 2 arguments.
  89    Therefore we have to disable the argument count checking.  */
  90 # define mkdir ((int (*)()) _mkdir)
  91 #endif
  92
  93 #if !_LIBC
  94 # define __getpid getpid
  95 # define __gettimeofday gettimeofday
  96 # define __mkdir mkdir
  97 #endif
  98
  99 /* Use the widest available unsigned type if uint64_t is not
 100    available.  The algorithm below extracts a number less than 62**6
 101    (approximately 2**35.725) from uint64_t, so ancient hosts where
 102    uintmax_t is only 32 bits lose about 3.725 bits of randomness,
 103    which is better than not having mkstemp at all.  */
 104 #if !defined UINT64_MAX && !defined uint64_t
 105 # define uint64_t uintmax_t
 106 #endif
 107
 108 /* These are the characters used in temporary filenames.  */
 109 static const char letters[] =
 110 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
 111
 112 /* Generate a temporary file name based on TMPL.  TMPL must match the
 113    rules for mk[s]temp (i.e. end in "XXXXXX").  The name constructed
 114    does not exist at the time of the call to __gen_tempname.  TMPL is
 115    overwritten with the result.
 116
 117    KIND is:
 118    __GT_DIR:            create a directory, which will be mode 0700.
 119
 120    We use a clever algorithm to get hard-to-predict names. */
 121 static int
 122 gen_tempname (char *tmpl)
 123 {
 124   int len;
 125   char *XXXXXX;
 126   static uint64_t value;
 127   uint64_t random_time_bits;
 128   int count, fd = -1;
 129   int save_errno = errno;
 130
 131   len = strlen (tmpl);
 132   if (len < 6 || strcmp (&tmpl[len - 6], "XXXXXX"))
 133     {
 134       __set_errno (EINVAL);
 135       return -1;
 136     }
 137
 138   /* This is where the Xs start.  */
 139   XXXXXX = &tmpl[len - 6];
 140
 141   /* Get some more or less random data.  */
 142 #ifdef RANDOM_BITS
 143   RANDOM_BITS (random_time_bits);
 144 #else
 145 # if HAVE_GETTIMEOFDAY || _LIBC
 146   {
 147     struct timeval tv;
 148     __gettimeofday (&tv, NULL);
 149     random_time_bits = ((uint64_t) tv.tv_usec << 16) ^ tv.tv_sec;
 150   }
 151 # else
 152   random_time_bits = time (NULL);
 153 # endif
 154 #endif
 155   value += random_time_bits ^ __getpid ();
 156
 157   for (count = 0; count < TMP_MAX; value += 7777, ++count)
 158     {
 159       uint64_t v = value;
 160
 161       /* Fill in the random bits.  */
 162       XXXXXX[0] = letters[v % 62];
 163       v /= 62;
 164       XXXXXX[1] = letters[v % 62];
 165       v /= 62;
 166       XXXXXX[2] = letters[v % 62];
 167       v /= 62;
 168       XXXXXX[3] = letters[v % 62];
 169       v /= 62;
 170       XXXXXX[4] = letters[v % 62];
 171       v /= 62;
 172       XXXXXX[5] = letters[v % 62];
 173
 174       fd = __mkdir (tmpl, S_IRUSR | S_IWUSR | S_IXUSR);
 175
 176       if (fd >= 0)
 177         {
 178           __set_errno (save_errno);
 179           return fd;
 180         }
 181       else if (errno != EEXIST)
 182         return -1;
 183     }
 184
 185   /* We got out of the loop because we ran out of combinations to try.  */
 186   __set_errno (EEXIST);
 187   return -1;
 188 }
 189
 190 /* Generate a unique temporary directory from TEMPLATE.
 191    The last six characters of TEMPLATE must be "XXXXXX";
 192    they are replaced with a string that makes the filename unique.
 193    The directory is created, mode 700, and its name is returned.
 194    (This function comes from OpenBSD.) */
 195 char *
 196 mkdtemp (char *template)
 197 {
 198   if (gen_tempname (template))
 199     return NULL;
 200   else
 201     return template;
 202 }