original/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  2012-12-21 "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 .sp
  42 .BI "int mkstemp(char *" template );
  43 .sp
  44 .BI "int mkostemp(char *" template ", int " flags );
  45 .sp
  46 .BI "int mkstemps(char *" template ", int " suffixlen );
  47 .sp
  48 .BI "int mkostemps(char *" template ", int " suffixlen ", int " flags );
  49 .fi
  50 .sp
  51 .in -4n
  52 Feature Test Macro Requirements for glibc (see
  53 .BR feature_test_macros (7)):
  54 .in
  55 .sp
  56 .BR mkstemp ():
  57 .ad l
  58 .RS 4
  59 .PD 0
  60 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  61 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  62 .br
  63 || /* Since glibc 2.12: */ _POSIX_C_SOURCE\ >=\ 200112L
  64 .PD
  65 .RE
  66 .ad b
  67 .PP
  68 .BR mkostemp ():
  69 _GNU_SOURCE
  70 .br
  71 .BR mkstemps ():
  72 _BSD_SOURCE || _SVID_SOURCE
  73 .br
  74 .BR mkostemps ():
  75 _GNU_SOURCE
  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
  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
  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
 100 The
 101 .BR mkostemp ()
 102 function is like
 103 .BR mkstemp (),
 104 with the difference that flags as for
 105 .BR open (2)
 106 may be specified in
 107 .IR flags
 108 (e.g.,
 109 .BR O_APPEND ,
 110 .BR O_SYNC ).
 111
 112 The
 113 .BR mkstemps ()
 114 function is like
 115 .BR mkstemp (),
 116 except that the string in
 117 .I template
 118 contains a suffix of
 119 .I suffixlen
 120 characters.
 121 Thus,
 122 .I template
 123 is of the form
 124 .IR "prefixXXXXXXsuffix" ,
 125 and the string XXXXXX is modified as for
 126 .BR mkstemp ().
 127
 128 The
 129 .BR mkostemps ()
 130 function is to
 131 .BR mkstemps ()
 132 as
 133 .BR mkostemp ()
 134 is to
 135 .BR mkstemp ().
 136 .SH RETURN VALUE
 137 On success, these functions return the file descriptor
 138 of the temporary file.
 139 On error, \-1 is returned, and
 140 .I errno
 141 is set appropriately.
 142 .SH ERRORS
 143 .TP
 144 .B EEXIST
 145 Could not create a unique temporary filename.
 146 Now the contents of \fItemplate\fP are undefined.
 147 .TP
 148 .B EINVAL
 149 For
 150 .BR mkstemp ()
 151 and
 152 .BR mkostemp ():
 153 The last six characters of \fItemplate\fP were not XXXXXX;
 154 now \fItemplate\fP is unchanged.
 155 .sp
 156 For
 157 .BR mkstemps ()
 158 and
 159 .BR mkostemps ():
 160 .I template
 161 is less than
 162 .I "(6 + suffixlen)"
 163 characters long, or the last 6 characters before the suffix in
 164 .I template
 165 were not XXXXXX.
 166 .PP
 167 These functions may also fail with any of the errors described for
 168 .BR open (2).
 169 .SH VERSIONS
 170 .BR mkostemp ()
 171 is available since glibc 2.7.
 172 .BR mkstemps ()
 173 and
 174 .BR mkostemps ()
 175 are available since glibc 2.11.
 176 .SH CONFORMING TO
 177 .BR mkstemp ():
 178 4.3BSD, POSIX.1-2001.
 179
 180 .BR mkstemps ():
 181 unstandardized, but appears on several other systems.
 182 .\" mkstemps() appears to be at least on the BSDs, Mac OS X, Solaris,
 183 .\" and Tru64.
 184
 185 .BR mkostemp ()
 186 and
 187 .BR mkostemps ():
 188 are glibc extensions.
 189 .SH NOTES
 190 In glibc versions 2.06 and earlier, the file is created with permissions 0666,
 191 that is, read and write for all users.
 192 This old behavior may be
 193 a security risk, especially since other UNIX flavors use 0600,
 194 and somebody might overlook this detail when porting programs.
 195 POSIX.1-2008 adds a requirement that the file be created with mode 0600.
 196
 197 More generally, the POSIX specification of
 198 .BR mkstemp ()
 199 does not say anything
 200 about file modes, so the application should make sure its
 201 file mode creation mask (see
 202 .BR umask (2))
 203 is set appropriately before calling
 204 .BR mkstemp ()
 205 (and
 206 .BR mkostemp ()).
 207
 208 The prototype for
 209 .BR mktemp ()
 210 is in
 211 .I <unistd.h>
 212 for libc4, libc5, glibc1; glibc2 follows POSIX.1 and has the prototype in
 213 .IR <stdlib.h> .
 214 .SH SEE ALSO
 215 .BR mkdtemp (3),
 216 .BR mktemp (3),
 217 .BR tempnam (3),
 218 .BR tmpfile (3),
 219 .BR tmpnam (3)