chiark - git - mdw - checkpath/blob - tmpdir.1

   1 .\" -*-nroff-*-
   2 .TH tmpdir 1 "6 April 1999" "Local tools"
   3 .SH NAME
   4 tmpdir \- choose, or check a choice of, temporary directory
   5 .SH SYNOPSIS
   6 .B tmpdir
   7 .RB [ \-bcqv ]
   8 .RB [ \-C
   9 .IR dir ]
  10 .RB [ \-g
  11 .IR group ]
  12 .SH USAGE
  13 The
  14 .B tmpdir
  15 program creates a secure place for temporary files to be stored, and
  16 outputs an assignment to the
  17 .B TMPDIR
  18 variable suitable for execution by a shell.
  19 .PP
  20 Many programs aren't sufficiently careful about how they handle
  21 temporary files.  For example, if a program which creates files in
  22 .B /tmp
  23 without making careful checks beforehand, a malicious user who can
  24 predict the name that the program will use can create a symbolic link
  25 with that name: when run, the program will then overwrite some file
  26 using your current privileges.  Similarly, many programs create
  27 temporary files using generous default permissions, which may well be a
  28 mistake.
  29 .PP
  30 The
  31 .B tmpdir
  32 program finds a secure place for temporary files, creating one if
  33 necessary.  The criteria it uses to choose a place are as follows:
  34 .IP "   1."
  35 The temporary directory must be owned by the user, and have mode 700
  36 (i.e., readable, writable and searchable only by the owner).
  37 .IP "   2."
  38 The path through the filesystem to the temporary directory must be
  39 secure against modifications by other malicious users.  See the
  40 .BR chkpath (1)
  41 manual page for a description of how this is done: the two programs work
  42 in the same way.
  43 .PP
  44 First,
  45 .B tmpdir
  46 checks to see whether the current value of the
  47 .B TMPDIR
  48 environment variable is a secure place for temporary files.  If so, it
  49 is accepted immediately.  Otherwise, it tries to find or create a
  50 directory in
  51 .B /tmp
  52 (on the assumption that this is a fast disk suitable for temporary
  53 files), with the name
  54 .BI /tmp/ user \- suffix
  55 for some
  56 .IR suffix .
  57 If that fails, it tries to create a directory in your home directory,
  58 with the name
  59 .BI ~/tmp\- suffix\fR.
  60 If
  61 .I that
  62 fails too, then
  63 .B tmpdir
  64 gives up: if your home directory's not secure (or full) than a secure
  65 temporary directory is the least of your worries.
  66 .SS Options
  67 The following options are supported:
  68 .TP
  69 .BI "\-C, \-\-check " dir
  70 Don't try to find a temporary directory; just see whether
  71 .I dir
  72 is secure, and exit successfully if it is (and unsuccessfully if it
  73 isn't).
  74 .TP
  75 .B "\-b, \-\-bourne"
  76 Output an assignment using Bourne shell syntax.  The default is to
  77 examine the user's shell and decide which syntax to use based on that.
  78 .TP
  79 .B "\-c, \-\-cshell"
  80 Output an assignment using C shell syntax.
  81 .TP
  82 .BI "\-g, \-\-group " group
  83 Trust (the members of)
  84 .IR group :
  85 consider directories they can write to be safe.
  86 .TP
  87 .B "\-q, \-\-quiet"
  88 Be less verbose; cancel out a
  89 .B \-v
  90 option.
  91 .TP
  92 .B "-v, \-\-verbose"
  93 Report problems to standard error.  Repeat for more verbosity.
  94 .SH BUGS
  95 None known.
  96 .SH SEE ALSO
  97 .BR chkpath (1),
  98 .BR checkpath (3),
  99 .BR tmpnam (3),
 100 .BR tmpfile (3).
 101 .SH AUTHOR
 102 Mark Wooding (mdw@distorted.org.uk).