man3/mktemp.3

   1 .\" Copyright (C) 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 18:48:06 1993 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified Fri Jun 23 01:26:34 1995 by Andries Brouwer (aeb@cwi.nl)
  31 .\" (prompted by Scott Burkett <scottb@IntNet.net>)
  32 .\" Modified Sun Mar 28 23:44:38 1999 by Andries Brouwer (aeb@cwi.nl)
  33 .\"
  34 .TH MKTEMP 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  35 .SH NAME
  36 mktemp \- make a unique temporary filename
  37 .SH SYNOPSIS
  38 .nf
  39 .B #include <stdlib.h>
  40 .PP
  41 .BI "char *mktemp(char *" template );
  42 .fi
  43 .PP
  44 .RS -4
  45 Feature Test Macro Requirements for glibc (see
  46 .BR feature_test_macros (7)):
  47 .RE
  48 .PP
  49 .BR mktemp ():
  50 .nf
  51     Since glibc 2.12:
  52         (_XOPEN_SOURCE >= 500) && ! (_POSIX_C_SOURCE >= 200112L)
  53             || /* Glibc since 2.19: */ _DEFAULT_SOURCE
  54             || /* Glibc <= 2.19: */ _SVID_SOURCE || _BSD_SOURCE
  55     Before glibc 2.12:
  56         _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE >= 500
  57 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
  58 .fi
  59 .SH DESCRIPTION
  60 .IR "Never use this function" ;
  61 see BUGS.
  62 .PP
  63 The
  64 .BR mktemp ()
  65 function generates a unique temporary filename
  66 from \fItemplate\fP.
  67 The last six characters of \fItemplate\fP must
  68 be XXXXXX and these are replaced with a string that makes the
  69 filename unique.
  70 Since it will be modified,
  71 .I template
  72 must not be a string constant, but should be declared as a character array.
  73 .SH RETURN VALUE
  74 The
  75 .BR mktemp ()
  76 function always returns \fItemplate\fP.
  77 If a unique name was created, the last six bytes of \fItemplate\fP will
  78 have been modified in such a way that the resulting name is unique
  79 (i.e., does not exist already)
  80 If a unique name could not be created,
  81 \fItemplate\fP is made an empty string, and
  82 .I errno
  83 is set to indicate the error.
  84 .SH ERRORS
  85 .TP
  86 .B EINVAL
  87 The last six characters of \fItemplate\fP were not XXXXXX.
  88 .SH ATTRIBUTES
  89 For an explanation of the terms used in this section, see
  90 .BR attributes (7).
  91 .ad l
  92 .nh
  93 .TS
  94 allbox;
  95 lbx lb lb
  96 l l l.
  97 Interface       Attribute       Value
  98 T{
  99 .BR mktemp ()
 100 T}      Thread safety   MT-Safe
 101 .TE
 102 .hy
 103 .ad
 104 .sp 1
 105 .SH CONFORMING TO
 106 4.3BSD, POSIX.1-2001.
 107 POSIX.1-2008 removes the specification of
 108 .BR mktemp ().
 109 .\" .SH NOTES
 110 .\" The prototype is in
 111 .\" .I <unistd.h>
 112 .\" for libc4, libc5, glibc1; glibc2 follows the Single UNIX Specification
 113 .\" and has the prototype in
 114 .\" .IR <stdlib.h> .
 115 .SH BUGS
 116 Never use
 117 .BR mktemp ().
 118 Some implementations follow 4.3BSD
 119 and replace XXXXXX by the current process ID and a single letter,
 120 so that at most 26 different names can be returned.
 121 Since on the one hand the names are easy to guess, and on the other
 122 hand there is a race between testing whether the name exists and
 123 opening the file, every use of
 124 .BR mktemp ()
 125 is a security risk.
 126 The race is avoided by
 127 .BR mkstemp (3)
 128 and
 129 .BR mkdtemp (3).
 130 .SH SEE ALSO
 131 .BR mktemp (1),
 132 .BR mkdtemp (3),
 133 .BR mkstemp (3),
 134 .BR tempnam (3),
 135 .BR tmpfile (3),
 136 .BR tmpnam (3)