lib/libcr/stdio/mktemp.3

   1 .\" Copyright (c) 1989, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)mktemp.3    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/stdio/mktemp.3,v 1.11.2.6 2001/12/14 18:33:57 ru Exp $
  34 .\" $DragonFly: src/lib/libcr/stdio/Attic/mktemp.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  35 .\"
  36 .Dd February 11, 1998
  37 .Dt MKTEMP 3
  38 .Os
  39 .Sh NAME
  40 .Nm mktemp
  41 .Nd make temporary file name (unique)
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .Ft char *
  47 .Fn mktemp "char *template"
  48 .Ft int
  49 .Fn mkstemp "char *template"
  50 .Ft int
  51 .Fn mkstemps "char *template" "int suffixlen"
  52 .Ft char *
  53 .Fn mkdtemp "char *template"
  54 .Sh DESCRIPTION
  55 The
  56 .Fn mktemp
  57 function
  58 takes the given file name template and overwrites a portion of it
  59 to create a file name.
  60 This file name is guaranteed not to exist at the time of function invocation
  61 and is suitable for use
  62 by the application.
  63 The template may be any file name with some number of
  64 .Ql X Ns s
  65 appended
  66 to it, for example
  67 .Pa /tmp/temp.XXXXXX .
  68 The trailing
  69 .Ql X Ns s
  70 are replaced with a
  71 unique alphanumeric combination.
  72 The number of unique file names
  73 .Fn mktemp
  74 can return depends on the number of
  75 .Ql X Ns s
  76 provided; six
  77 .Ql X Ns s
  78 will
  79 result in
  80 .Fn mktemp
  81 selecting one of 56800235584 (62 ** 6) possible temporary file names.
  82 .Pp
  83 The
  84 .Fn mkstemp
  85 function
  86 makes the same replacement to the template and creates the template file,
  87 mode 0600, returning a file descriptor opened for reading and writing.
  88 This avoids the race between testing for a file's existence and opening it
  89 for use.
  90 .Pp
  91 The
  92 .Fn mkstemps
  93 function acts the same as
  94 .Fn mkstemp ,
  95 except it permits a suffix to exist in the template.
  96 The template should be of the form
  97 .Pa /tmp/tmpXXXXXXsuffix .
  98 .Fn mkstemps
  99 is told the length of the suffix string.
 100 .Pp
 101 The
 102 .Fn mkdtemp
 103 function makes the same replacement to the template as in
 104 .Xr mktemp 3
 105 and creates the template directory, mode 0700.
 106 .Sh RETURN VALUES
 107 The
 108 .Fn mktemp
 109 and
 110 .Fn mkdtemp
 111 functions return a pointer to the template on success and
 112 .Dv NULL
 113 on failure.
 114 The
 115 .Fn mkstemp
 116 and
 117 .Fn mkstemps
 118 functions
 119 return \-1 if no suitable file could be created.
 120 If either call fails an error code is placed in the global variable
 121 .Va errno .
 122 .Sh ERRORS
 123 The
 124 .Fn mkstemp ,
 125 .Fn mkstemps
 126 and
 127 .Fn mkdtemp
 128 functions
 129 may set
 130 .Va errno
 131 to one of the following values:
 132 .Bl -tag -width Er
 133 .It Bq Er ENOTDIR
 134 The pathname portion of the template is not an existing directory.
 135 .El
 136 .Pp
 137 The
 138 .Fn mkstemp ,
 139 .Fn mkstemps
 140 and
 141 .Fn mkdtemp
 142 functions
 143 may also set
 144 .Va errno
 145 to any value specified by the
 146 .Xr stat 2
 147 function.
 148 .Pp
 149 The
 150 .Fn mkstemp
 151 and
 152 .Fn mkstemps
 153 functions
 154 may also set
 155 .Va errno
 156 to any value specified by the
 157 .Xr open 2
 158 function.
 159 .Pp
 160 The
 161 .Fn mkdtemp
 162 function
 163 may also set
 164 .Va errno
 165 to any value specified by the
 166 .Xr mkdir 2
 167 function.
 168 .Sh NOTES
 169 A common problem that results in a core dump is that the programmer
 170 passes in a read-only string to
 171 .Fn mktemp ,
 172 .Fn mkstemp ,
 173 .Fn mkstemps
 174 or
 175 .Fn mkdtemp .
 176 This is common with programs that were developed before
 177 .St -isoC
 178 compilers were common.
 179 For example, calling
 180 .Fn mkstemp
 181 with an argument of
 182 .Qq /tmp/tempfile.XXXXXX
 183 will result in a core dump due to
 184 .Fn mkstemp
 185 attempting to modify the string constant that was given.
 186 If the program in question makes heavy use of that type
 187 of function call, you do have the option of compiling the program
 188 so that it will store string constants in a writable segment of memory.
 189 See
 190 .Xr gcc 1
 191 for more information.
 192 .Sh BUGS
 193 This family of functions produces filenames which can be guessed,
 194 though the risk is minimized when large numbers of
 195 .Ql X Ns s
 196 are used to
 197 increase the number of possible temporary filenames.
 198 This makes the race in
 199 .Fn mktemp ,
 200 between testing for a file's existence (in the
 201 .Fn mktemp
 202 function call)
 203 and opening it for use
 204 (later in the user application)
 205 particularly dangerous from a security perspective.
 206 Whenever it is possible,
 207 .Fn mkstemp
 208 should be used instead, since it does not have the race condition.
 209 If
 210 .Fn mkstemp
 211 cannot be used, the filename created by
 212 .Fn mktemp
 213 should be created using the
 214 .Dv O_EXCL
 215 flag to
 216 .Xr open 2
 217 and the return status of the call should be tested for failure.
 218 This will ensure that the program does not continue blindly
 219 in the event that an attacker has already created the file
 220 with the intention of manipulating or reading its contents.
 221 .Sh SEE ALSO
 222 .Xr chmod 2 ,
 223 .Xr getpid 2 ,
 224 .Xr mkdir 2 ,
 225 .Xr open 2 ,
 226 .Xr stat 2
 227 .Sh HISTORY
 228 A
 229 .Fn mktemp
 230 function appeared in
 231 .At v7 .
 232 The
 233 .Fn mkstemp
 234 function appeared in
 235 .Bx 4.4 .
 236 The
 237 .Fn mkdtemp
 238 function first appeared in
 239 .Ox 2.2 ,
 240 and later in
 241 .Fx 3.2 .
 242 The
 243 .Fn mkstemps
 244 function first appeared in
 245 .Ox 2.4 ,
 246 and later in
 247 .Fx 3.4 .