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