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