usr.sbin/mtree/mtree.8

   1 .\" Copyright (c) 1989, 1990, 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 .\"     From: @(#)mtree.8       8.2 (Berkeley) 12/11/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd February 26, 1999
  36 .Dt MTREE 8
  37 .Os
  38 .Sh NAME
  39 .Nm mtree
  40 .Nd map a directory hierarchy
  41 .Sh SYNOPSIS
  42 .Nm mtree
  43 .Op Fl cdeinrUux
  44 .Op Fl f Ar spec
  45 .Op Fl K Ar keywords
  46 .Op Fl k Ar keywords
  47 .Op Fl p Ar path
  48 .Op Fl s Ar seed
  49 .Sh DESCRIPTION
  50 The utility
  51 .Nm mtree
  52 compares the file hierarchy rooted in the current directory against a
  53 specification read from the standard input.
  54 Messages are written to the standard output for any files whose
  55 characteristics do not match the specifications, or which are
  56 missing from either the file hierarchy or the specification.
  57 .Pp
  58 The options are as follows:
  59 .Bl -tag -width flag
  60 .It Fl c
  61 Print a specification for the file hierarchy to the standard output.
  62 .It Fl d
  63 Ignore everything except directory type files.
  64 .It Fl e
  65 Don't complain about files that are in the file hierarchy, but not in the
  66 specification.
  67 .It Fl f Ar file
  68 Read the specification from
  69 .Ar file  ,
  70 instead of from the standard input.
  71 .It Fl i
  72 Indent the output 4 spaces each time a directory level is descended when
  73 create a specification with the
  74 .Fl c
  75 option.
  76 This does not effect either the /set statements or the comment before each
  77 directory.
  78 It does however effect the comment before the close of each directory.
  79 .It Fl K Ar keywords
  80 Add the specified (whitespace or comma separated)
  81 .Ar keywords
  82 to the current set of keywords.
  83 .It Fl k Ar keywords
  84 Use the ``type'' keyword plus the specified (whitespace or comma separated)
  85 .Ar keywords
  86 instead of the current set of keywords.
  87 .It Fl n
  88 Do not emit pathname comments when creating a specification.  Normally
  89 a comment is emitted before each directory and before the close of that
  90 directory when using the
  91 .Fl c
  92 option.
  93 .It Fl p Ar path
  94 Use the file hierarchy rooted in
  95 .Ar path  ,
  96 instead of the current directory.
  97 .It Fl r
  98 Remove any files in the file hierarchy that are not described in the
  99 specification.
 100 .It Fl s Ar seed
 101 Display a single checksum to the standard error output that represents all
 102 of the files for which the keyword
 103 .Cm cksum
 104 was specified.
 105 The checksum is seeded with the specified value.
 106 .It Fl U
 107 Modify the owner, group, and permissions of existing files to match
 108 the specification and create any missing directories.
 109 User, group, and permissions must all be specified for missing directories
 110 to be created.
 111 Exit with a status of 0 on success, 1 if any error occurred,
 112 a mismatch is not considered an error if it was corrected.
 113 .It Fl u
 114 Same as
 115 .Fl U
 116 except a status of 2 is returned if the file hierarchy did not match
 117 the specification.
 118 .It Fl x
 119 Don't descend below mount points in the file hierarchy.
 120 .El
 121 .Pp
 122 Specifications are mostly composed of ``keywords'', i.e. strings that
 123 that specify values relating to files.
 124 No keywords have default values, and if a keyword has no value set, no
 125 checks based on it are performed.
 126 .Pp
 127 Currently supported keywords are as follows:
 128 .Bl -tag -width Cm
 129 .It Cm cksum
 130 The checksum of the file using the default algorithm specified by
 131 the
 132 .Xr cksum 1
 133 utility.
 134 .It Cm ignore
 135 Ignore any file hierarchy below this file.
 136 .It Cm gid
 137 The file group as a numeric value.
 138 .It Cm gname
 139 The file group as a symbolic name.
 140 .It Cm md5digest
 141 The MD5 message digest of the file.
 142 .It Cm sha1digest
 143 The
 144 .Tn FIPS
 145 160-1
 146 .Pq Dq Tn SHA-1
 147 message digest of the file.
 148 .It Cm ripemd160digest
 149 The
 150 .Tn RIPEMD160
 151 message digest of the file.
 152 .It Cm mode
 153 The current file's permissions as a numeric (octal) or symbolic
 154 value.
 155 .It Cm nlink
 156 The number of hard links the file is expected to have.
 157 .It Cm nochange
 158 Make sure this file or directory exists but otherwise ignore all attributes.
 159 .It Cm uid
 160 The file owner as a numeric value.
 161 .It Cm uname
 162 The file owner as a symbolic name.
 163 .It Cm size
 164 The size, in bytes, of the file.
 165 .It Cm link
 166 The file the symbolic link is expected to reference.
 167 .It Cm time
 168 The last modification time of the file.
 169 .It Cm type
 170 The type of the file; may be set to any one of the following:
 171 .sp
 172 .Bl -tag -width Cm -compact
 173 .It Cm block
 174 block special device
 175 .It Cm char
 176 character special device
 177 .It Cm dir
 178 directory
 179 .It Cm fifo
 180 fifo
 181 .It Cm file
 182 regular file
 183 .It Cm link
 184 symbolic link
 185 .It Cm socket
 186 socket
 187 .El
 188 .El
 189 .Pp
 190 The default set of keywords are
 191 .Cm gid ,
 192 .Cm mode ,
 193 .Cm nlink ,
 194 .Cm size ,
 195 .Cm link ,
 196 .Cm time ,
 197 and
 198 .Cm uid .
 199 .Pp
 200 There are four types of lines in a specification.
 201 .Pp
 202 The first type of line sets a global value for a keyword, and consists of
 203 the string ``/set'' followed by whitespace, followed by sets of keyword/value
 204 pairs, separated by whitespace.
 205 Keyword/value pairs consist of a keyword, followed by an equals sign
 206 (``=''), followed by a value, without whitespace characters.
 207 Once a keyword has been set, its value remains unchanged until either
 208 reset or unset.
 209 .Pp
 210 The second type of line unsets keywords and consists of the string
 211 ``/unset'', followed by whitespace, followed by one or more keywords,
 212 separated by whitespace.
 213 .Pp
 214 The third type of line is a file specification and consists of a file
 215 name, followed by whitespace, followed by zero or more whitespace
 216 separated keyword/value pairs.
 217 The file name may be preceded by whitespace characters.
 218 The file name may contain any of the standard file name matching
 219 characters (``['', ``]'', ``?'' or ``*''), in which case files
 220 in the hierarchy will be associated with the first pattern that
 221 they match.
 222 .Pp
 223 Each of the keyword/value pairs consist of a keyword, followed by an
 224 equals sign (``=''), followed by the keyword's value, without
 225 whitespace characters.
 226 These values override, without changing, the global value of the
 227 corresponding keyword.
 228 .Pp
 229 All paths are relative.
 230 Specifying a directory will cause subsequent files to be searched
 231 for in that directory hierarchy.
 232 Which brings us to the last type of line in a specification: a line
 233 containing only the string
 234 .Dq Nm \&..
 235 causes the current directory
 236 path to ascend one level.
 237 .Pp
 238 Empty lines and lines whose first non-whitespace character is a hash
 239 mark (``#'') are ignored.
 240 .Pp
 241 The
 242 .Nm
 243 utility exits with a status of 0 on success, 1 if any error occurred,
 244 and 2 if the file hierarchy did not match the specification.
 245 A status of 2 is converted to a status of 0 if the
 246 .Fl U
 247 option is used.
 248 .Sh EXAMPLES
 249 To detect system binaries that have been ``trojan horsed'', it is recommended
 250 that
 251 .Nm
 252 .Fl K
 253 .Cm sha1digest
 254 be run on the file systems, and a copy of the results stored on a different
 255 machine, or, at least, in encrypted form.
 256 The output file itself should be digested using the
 257 .Xr md5 1
 258 utility.
 259 Then, periodically,
 260 .Nm
 261 and
 262 .Xr md5 1
 263 should be run against the on-line specifications.
 264 While it is possible for the bad guys to change the on-line specifications
 265 to conform to their modified binaries, it is believed to be
 266 impractical for them to create a modified specification which has
 267 the same MD5 digest as the original.
 268 .Pp
 269 The
 270 .Fl d
 271 and
 272 .Fl u
 273 options can be used in combination to create directory hierarchies
 274 for distributions and other such things; the files in
 275 .Pa /etc/mtree
 276 were used to create almost all directories in this
 277 .Tn FreeBSD
 278 distribution.
 279 .Sh FILES
 280 .Bl -tag -width /etc/mtree -compact
 281 .It Pa /etc/mtree
 282 system specification directory
 283 .El
 284 .Sh SEE ALSO
 285 .Xr chgrp 1 ,
 286 .Xr chmod 1 ,
 287 .Xr cksum 1 ,
 288 .Xr md5 1 ,
 289 .Xr stat 2 ,
 290 .Xr fts 3 ,
 291 .Xr md5 3 ,
 292 .Xr chown 8
 293 .Sh HISTORY
 294 The
 295 .Nm
 296 utility appeared in
 297 .Bx 4.3 Reno .
 298 The
 299 .Tn MD5
 300 digest capability was added in
 301 .Fx 2.1 ,
 302 in response to the widespread use of programs which can spoof
 303 .Xr cksum 1 .
 304 The
 305 .Tn SHA-1
 306 and
 307 .Tn RIPEMD160
 308 digests were added in
 309 .Fx 4.0 ,
 310 as new attacks have demonstrated weaknesses in
 311 .Tn MD5 .