man3/mkstemp.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\" and Copyright (C) 2008, Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\" References consulted:
  27 .\"     Linux libc source code
  28 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  29 .\"     386BSD man pages
  30 .\" Modified Sat Jul 24 18:48:48 1993 by Rik Faith (faith@cs.unc.edu)
  31 .\" Modified 980310, aeb
  32 .\" Modified 990328, aeb
  33 .\" 2008-06-19, mtk, Added mkostemp(); various other changes
  34 .\"
  35 .TH MKSTEMP 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  36 .SH NAME
  37 mkstemp, mkostemp, mkstemps, mkostemps \- create a unique temporary file
  38 .SH SYNOPSIS
  39 .nf
  40 .B #include <stdlib.h>
  41 .PP
  42 .BI "int mkstemp(char *" template );
  43 .BI "int mkostemp(char *" template ", int " flags );
  44 .BI "int mkstemps(char *" template ", int " suffixlen );
  45 .BI "int mkostemps(char *" template ", int " suffixlen ", int " flags );
  46 .fi
  47 .PP
  48 .RS -4
  49 Feature Test Macro Requirements for glibc (see
  50 .BR feature_test_macros (7)):
  51 .RE
  52 .PP
  53 .BR mkstemp ():
  54 .nf
  55     _XOPEN_SOURCE >= 500
  56 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
  57         || /* Since glibc 2.12: */ _POSIX_C_SOURCE >= 200809L
  58         || /* Glibc <= 2.19: */ _SVID_SOURCE || _BSD_SOURCE
  59 .fi
  60 .PP
  61 .BR mkostemp ():
  62 .nf
  63     _GNU_SOURCE
  64 .fi
  65 .PP
  66 .BR mkstemps ():
  67 .nf
  68     /* Glibc since 2.19: */ _DEFAULT_SOURCE
  69         || /* Glibc <= 2.19: */ _SVID_SOURCE || _BSD_SOURCE
  70 .fi
  71 .PP
  72 .BR mkostemps ():
  73 .nf
  74     _GNU_SOURCE
  75 .fi
  76 .SH DESCRIPTION
  77 The
  78 .BR mkstemp ()
  79 function generates a unique temporary filename from
  80 .IR template ,
  81 creates and opens the file,
  82 and returns an open file descriptor for the file.
  83 .PP
  84 The last six characters of
  85 .I template
  86 must be "XXXXXX" and these are replaced with a string that makes the
  87 filename unique.
  88 Since it will be modified,
  89 .I template
  90 must not be a string constant, but should be declared as a character array.
  91 .PP
  92 The file is created with
  93 permissions 0600, that is, read plus write for owner only.
  94 The returned file descriptor provides both read and write access to the file.
  95 The file is opened with the
  96 .BR open (2)
  97 .B O_EXCL
  98 flag, guaranteeing that the caller is the process that creates the file.
  99 .PP
 100 The
 101 .BR mkostemp ()
 102 function is like
 103 .BR mkstemp (),
 104 with the difference that the following bits\(emwith the same meaning as for
 105 .BR open (2)\(emmay
 106 be specified in
 107 .IR flags :
 108 .BR O_APPEND ,
 109 .BR O_CLOEXEC ,
 110 and
 111 .BR O_SYNC .
 112 Note that when creating the file,
 113 .BR mkostemp ()
 114 includes the values
 115 .BR O_RDWR ,
 116 .BR O_CREAT ,
 117 and
 118 .BR O_EXCL
 119 in the
 120 .I flags
 121 argument given to
 122 .BR open (2);
 123 including these values in the
 124 .I flags
 125 argument given to
 126 .BR mkostemp ()
 127 is unnecessary, and produces errors on some
 128 .\" Reportedly, FreeBSD
 129 systems.
 130 .PP
 131 The
 132 .BR mkstemps ()
 133 function is like
 134 .BR mkstemp (),
 135 except that the string in
 136 .I template
 137 contains a suffix of
 138 .I suffixlen
 139 characters.
 140 Thus,
 141 .I template
 142 is of the form
 143 .IR "prefixXXXXXXsuffix" ,
 144 and the string XXXXXX is modified as for
 145 .BR mkstemp ().
 146 .PP
 147 The
 148 .BR mkostemps ()
 149 function is to
 150 .BR mkstemps ()
 151 as
 152 .BR mkostemp ()
 153 is to
 154 .BR mkstemp ().
 155 .SH RETURN VALUE
 156 On success, these functions return the file descriptor
 157 of the temporary file.
 158 On error, \-1 is returned, and
 159 .I errno
 160 is set to indicate the error.
 161 .SH ERRORS
 162 .TP
 163 .B EEXIST
 164 Could not create a unique temporary filename.
 165 Now the contents of \fItemplate\fP are undefined.
 166 .TP
 167 .B EINVAL
 168 For
 169 .BR mkstemp ()
 170 and
 171 .BR mkostemp ():
 172 The last six characters of \fItemplate\fP were not XXXXXX;
 173 now \fItemplate\fP is unchanged.
 174 .IP
 175 For
 176 .BR mkstemps ()
 177 and
 178 .BR mkostemps ():
 179 .I template
 180 is less than
 181 .I "(6 + suffixlen)"
 182 characters long, or the last 6 characters before the suffix in
 183 .I template
 184 were not XXXXXX.
 185 .PP
 186 These functions may also fail with any of the errors described for
 187 .BR open (2).
 188 .SH VERSIONS
 189 .BR mkostemp ()
 190 is available since glibc 2.7.
 191 .BR mkstemps ()
 192 and
 193 .BR mkostemps ()
 194 are available since glibc 2.11.
 195 .SH ATTRIBUTES
 196 For an explanation of the terms used in this section, see
 197 .BR attributes (7).
 198 .ad l
 199 .nh
 200 .TS
 201 allbox;
 202 lbx lb lb
 203 l l l.
 204 Interface       Attribute       Value
 205 T{
 206 .BR mkstemp (),
 207 .BR mkostemp (),
 208 .BR mkstemps (),
 209 .BR mkostemps ()
 210 T}      Thread safety   MT-Safe
 211 .TE
 212 .hy
 213 .ad
 214 .sp 1
 215 .SH CONFORMING TO
 216 .BR mkstemp ():
 217 4.3BSD, POSIX.1-2001.
 218 .PP
 219 .BR mkstemps ():
 220 unstandardized, but appears on several other systems.
 221 .\" mkstemps() appears to be at least on the BSDs, Mac OS X, Solaris,
 222 .\" and Tru64.
 223 .PP
 224 .BR mkostemp ()
 225 and
 226 .BR mkostemps ():
 227 are glibc extensions.
 228 .SH NOTES
 229 In glibc versions 2.06 and earlier, the file is created with permissions 0666,
 230 that is, read and write for all users.
 231 This old behavior may be
 232 a security risk, especially since other UNIX flavors use 0600,
 233 and somebody might overlook this detail when porting programs.
 234 POSIX.1-2008 adds a requirement that the file be created with mode 0600.
 235 .PP
 236 More generally, the POSIX specification of
 237 .BR mkstemp ()
 238 does not say anything
 239 about file modes, so the application should make sure its
 240 file mode creation mask (see
 241 .BR umask (2))
 242 is set appropriately before calling
 243 .BR mkstemp ()
 244 (and
 245 .BR mkostemp ()).
 246 .\"
 247 .\" The prototype for
 248 .\" .BR mkstemp ()
 249 .\" is in
 250 .\" .I <unistd.h>
 251 .\" for libc4, libc5, glibc1; glibc2 follows POSIX.1 and has the prototype in
 252 .\" .IR <stdlib.h> .
 253 .SH SEE ALSO
 254 .BR mkdtemp (3),
 255 .BR mktemp (3),
 256 .BR tempnam (3),
 257 .BR tmpfile (3),
 258 .BR tmpnam (3)