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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     From: @(#)mtree.8       8.2 (Berkeley) 12/11/93
  29 .\" $FreeBSD: src/usr.sbin/mtree/mtree.8,v 1.16.2.11 2003/03/11 22:31:29 trhodes Exp $
  30 .\" $DragonFly: src/usr.sbin/mtree/mtree.8,v 1.6 2007/10/20 13:43:00 swildner Exp $
  31 .\"
  32 .Dd February 26, 1999
  33 .Dt MTREE 8
  34 .Os
  35 .Sh NAME
  36 .Nm mtree
  37 .Nd map a directory hierarchy
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl LPUcdeinqrux
  41 .Bk -words
  42 .Op Fl f Ar spec
  43 .Ek
  44 .Bk -words
  45 .Op Fl K Ar keywords
  46 .Ek
  47 .Bk -words
  48 .Op Fl k Ar keywords
  49 .Ek
  50 .Bk -words
  51 .Op Fl p Ar path
  52 .Ek
  53 .Bk -words
  54 .Op Fl s Ar seed
  55 .Ek
  56 .Bk -words
  57 .Op Fl X Ar exclude-list
  58 .Ek
  59 .Sh DESCRIPTION
  60 The
  61 .Nm
  62 utility compares the file hierarchy rooted in the current directory against a
  63 specification read from the standard input.
  64 Messages are written to the standard output for any files whose
  65 characteristics do not match the specifications, or which are
  66 missing from either the file hierarchy or the specification.
  67 .Pp
  68 The options are as follows:
  69 .Bl -tag -width flag
  70 .It Fl L
  71 Follow all symbolic links in the file hierarchy.
  72 .It Fl P
  73 Don't follow symbolic links in the file hierarchy, instead consider
  74 the symbolic link itself in any comparisons. This is the default.
  75 .It Fl U
  76 Modify the owner, group and permissions of existing files to match
  77 the specification and create any missing directories or symbolic links.
  78 User, group and permissions must all be specified for missing directories
  79 to be created.
  80 Corrected mismatches are not considered errors.
  81 .It Fl c
  82 Print a specification for the file hierarchy to the standard output.
  83 .It Fl d
  84 Ignore everything except directory type files.
  85 .It Fl e
  86 Don't complain about files that are in the file hierarchy, but not in the
  87 specification.
  88 .It Fl i
  89 Indent the output 4 spaces each time a directory level is descended when
  90 create a specification with the
  91 .Fl c
  92 option.
  93 This does not affect either the /set statements or the comment before each
  94 directory.
  95 It does however affect the comment before the close of each directory.
  96 .It Fl n
  97 Do not emit pathname comments when creating a specification.  Normally
  98 a comment is emitted before each directory and before the close of that
  99 directory when using the
 100 .Fl c
 101 option.
 102 .It Fl q
 103 Quiet mode.  Do not complain when a
 104 .Dq missing
 105 directory cannot be created because it already exists.
 106 This occurs when the directory is a symbolic link.
 107 .It Fl r
 108 Remove any files in the file hierarchy that are not described in the
 109 specification.
 110 .It Fl u
 111 Same as
 112 .Fl U
 113 except a status of 2 is returned if the file hierarchy did not match
 114 the specification.
 115 .It Fl x
 116 Don't descend below mount points in the file hierarchy.
 117 .It Fl f Ar file
 118 Read the specification from
 119 .Ar file  ,
 120 instead of from the standard input.
 121 .It Fl K Ar keywords
 122 Add the specified (whitespace or comma separated)
 123 .Ar keywords
 124 to the current set of keywords.
 125 .It Fl k Ar keywords
 126 Use the ``type'' keyword plus the specified (whitespace or comma separated)
 127 .Ar keywords
 128 instead of the current set of keywords.
 129 .It Fl p Ar path
 130 Use the file hierarchy rooted in
 131 .Ar path  ,
 132 instead of the current directory.
 133 .It Fl s Ar seed
 134 Display a single checksum to the standard error output that represents all
 135 of the files for which the keyword
 136 .Cm cksum
 137 was specified.
 138 The checksum is seeded with the specified value.
 139 .It Fl X Ar exclude-list
 140 The specified file contains
 141 .Xr fnmatch 3
 142 patterns matching files to be excluded from
 143 the specification, one to a line.
 144 If the pattern contains a
 145 .Ql \&/
 146 character, it will be matched against entire pathnames (relative to
 147 the starting directory); otherwise,
 148 it will be matched against basenames only.  No comments are allowed in
 149 the
 150 .Ar exclude-list
 151 file.
 152 .El
 153 .Pp
 154 Specifications are mostly composed of ``keywords'', i.e. strings
 155 that specify values relating to files.
 156 No keywords have default values, and if a keyword has no value set, no
 157 checks based on it are performed.
 158 .Pp
 159 Currently supported keywords are as follows:
 160 .Bl -tag -width Cm
 161 .It Cm cksum
 162 The checksum of the file using the default algorithm specified by
 163 the
 164 .Xr cksum 1
 165 utility.
 166 .It Cm flags
 167 The file flags as a symbolic name.  See
 168 .Xr chflags 1
 169 for information on these names.  If no flags are to be set the string
 170 .Dq none
 171 may be used to override the current default.
 172 .It Cm ignore
 173 Ignore any file hierarchy below this file.
 174 .It Cm gid
 175 The file group as a numeric value.
 176 .It Cm gname
 177 The file group as a symbolic name.
 178 .It Cm md5digest
 179 The MD5 message digest of the file.
 180 .It Cm sha1digest
 181 The
 182 .Tn FIPS
 183 160-1
 184 .Pq Dq Tn SHA-1
 185 message digest of the file.
 186 .It Cm ripemd160digest
 187 The
 188 .Tn RIPEMD160
 189 message digest of the file.
 190 .It Cm mode
 191 The current file's permissions as a numeric (octal) or symbolic
 192 value.
 193 .It Cm nlink
 194 The number of hard links the file is expected to have.
 195 .It Cm nochange
 196 Make sure this file or directory exists but otherwise ignore all attributes.
 197 .It Cm uid
 198 The file owner as a numeric value.
 199 .It Cm uname
 200 The file owner as a symbolic name.
 201 .It Cm size
 202 The size, in bytes, of the file.
 203 .It Cm link
 204 The file the symbolic link is expected to reference.
 205 .It Cm time
 206 The last modification time of the file.
 207 .It Cm type
 208 The type of the file; may be set to any one of the following:
 209 .Pp
 210 .Bl -tag -width Cm -compact
 211 .It Cm block
 212 block special device
 213 .It Cm char
 214 character special device
 215 .It Cm dir
 216 directory
 217 .It Cm fifo
 218 fifo
 219 .It Cm file
 220 regular file
 221 .It Cm link
 222 symbolic link
 223 .It Cm socket
 224 socket
 225 .El
 226 .El
 227 .Pp
 228 The default set of keywords are
 229 .Cm flags ,
 230 .Cm gid ,
 231 .Cm mode ,
 232 .Cm nlink ,
 233 .Cm size ,
 234 .Cm link ,
 235 .Cm time ,
 236 and
 237 .Cm uid .
 238 .Pp
 239 There are four types of lines in a specification.
 240 .Pp
 241 The first type of line sets a global value for a keyword, and consists of
 242 the string ``/set'' followed by whitespace, followed by sets of keyword/value
 243 pairs, separated by whitespace.
 244 Keyword/value pairs consist of a keyword, followed by an equals sign
 245 (``=''), followed by a value, without whitespace characters.
 246 Once a keyword has been set, its value remains unchanged until either
 247 reset or unset.
 248 .Pp
 249 The second type of line unsets keywords and consists of the string
 250 ``/unset'', followed by whitespace, followed by one or more keywords,
 251 separated by whitespace.
 252 .Pp
 253 The third type of line is a file specification and consists of a file
 254 name, followed by whitespace, followed by zero or more whitespace
 255 separated keyword/value pairs.
 256 The file name may be preceded by whitespace characters.
 257 The file name may contain any of the standard file name matching
 258 characters (``['', ``]'', ``?'' or ``*''), in which case files
 259 in the hierarchy will be associated with the first pattern that
 260 they match.
 261 .Pp
 262 Each of the keyword/value pairs consist of a keyword, followed by an
 263 equals sign (``=''), followed by the keyword's value, without
 264 whitespace characters.
 265 These values override, without changing, the global value of the
 266 corresponding keyword.
 267 .Pp
 268 All paths are relative.
 269 Specifying a directory will cause subsequent files to be searched
 270 for in that directory hierarchy.
 271 Which brings us to the last type of line in a specification: a line
 272 containing only the string
 273 .Dq Pa ..\&
 274 causes the current directory
 275 path to ascend one level.
 276 .Pp
 277 Empty lines and lines whose first non-whitespace character is a hash
 278 mark (``#'') are ignored.
 279 .Pp
 280 The
 281 .Nm
 282 utility exits with a status of 0 on success, 1 if any error occurred,
 283 and 2 if the file hierarchy did not match the specification.
 284 A status of 2 is converted to a status of 0 if the
 285 .Fl U
 286 option is used.
 287 .Sh FILES
 288 .Bl -tag -width /etc/mtree -compact
 289 .It Pa /etc/mtree
 290 system specification directory
 291 .El
 292 .Sh EXIT STATUS
 293 .Ex -std
 294 .Sh EXAMPLES
 295 To detect system binaries that have been ``trojan horsed'', it is recommended
 296 that
 297 .Nm
 298 .Fl K
 299 .Cm sha1digest
 300 be run on the file systems, and a copy of the results stored on a different
 301 machine, or, at least, in encrypted form.
 302 The output file itself should be digested using the
 303 .Xr md5 1
 304 utility.
 305 Then, periodically,
 306 .Nm
 307 and
 308 .Xr md5 1
 309 should be run against the on-line specifications.
 310 While it is possible for the bad guys to change the on-line specifications
 311 to conform to their modified binaries, it is believed to be
 312 impractical for them to create a modified specification which has
 313 the same MD5 digest as the original.
 314 .Pp
 315 The
 316 .Fl d
 317 and
 318 .Fl u
 319 options can be used in combination to create directory hierarchies
 320 for distributions and other such things; the files in
 321 .Pa /etc/mtree
 322 were used to create almost all directories in this
 323 .Dx
 324 distribution.
 325 .Pp
 326 To create an
 327 .Pa /etc/mtree
 328 style BSD.*.dist file, use
 329 .Nm
 330 .Fl c
 331 .Fl d
 332 .Fl i
 333 .Fl n
 334 .Fl k
 335 .Cm uname,gname,mode,nochange .
 336 .Sh SEE ALSO
 337 .Xr chflags 1 ,
 338 .Xr chgrp 1 ,
 339 .Xr chmod 1 ,
 340 .Xr cksum 1 ,
 341 .Xr md5 1 ,
 342 .Xr stat 2 ,
 343 .Xr fts 3 ,
 344 .Xr md5 3 ,
 345 .Xr chown 8
 346 .Sh HISTORY
 347 The
 348 .Nm
 349 utility appeared in
 350 .Bx 4.3 Reno .
 351 The
 352 .Tn MD5
 353 digest capability was added in
 354 .Fx 2.1 ,
 355 in response to the widespread use of programs which can spoof
 356 .Xr cksum 1 .
 357 The
 358 .Tn SHA-1
 359 and
 360 .Tn RIPEMD160
 361 digests were added in
 362 .Fx 4.0 ,
 363 as new attacks have demonstrated weaknesses in
 364 .Tn MD5 .
 365 Support for file flags was added in
 366 .Fx 4.0 ,
 367 and mostly comes from
 368 .Nx .