sbin/mount_umap/mount_umap.8

   1 .\" Copyright (c) 1992, 1993, 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This code is derived from software donated to Berkeley by
   6 .\" Jan-Simon Pendry and from John Heidemann of the UCLA Ficus project.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)mount_umap.8        8.4 (Berkeley) 5/1/95
  37 .\" $FreeBSD: src/sbin/mount_umap/mount_umap.8,v 1.10.2.3 2001/12/20 16:44:17 ru Exp $
  38 .\"
  39 .Dd May 1, 1995
  40 .Dt MOUNT_UMAP 8
  41 .Os
  42 .Sh NAME
  43 .Nm mount_umap
  44 .Nd sample file system layer
  45 .Sh SYNOPSIS
  46 .Nm
  47 .Op Fl o Ar options
  48 .Fl u Ar uid-mapfile
  49 .Fl g Ar gid-mapfile
  50 .Ar target
  51 .Ar mount-point
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 command is used to mount a sub-tree of an existing file system
  56 that uses a different set of uids and gids than the local system.
  57 Such a file system could be mounted from a remote site via NFS or
  58 it could be a file system on removable media brought from some
  59 foreign location that uses a different password file.
  60 .Pp
  61 The
  62 .Nm
  63 command uses a set of files provided by the user to make correspondences
  64 between uids and gids in the sub-tree's original environment and
  65 some other set of ids in the local environment.  For instance, user
  66 smith might have uid 1000 in the original environment, while having
  67 uid 2000 in the local environment.  The
  68 .Nm
  69 command allows the subtree from smith's original environment to be
  70 mapped in such a way that all files with owning uid 1000 look like
  71 they are actually owned by uid 2000.
  72 .Pp
  73 The options are as follows:
  74 .Bl -tag -width indent
  75 .It Fl o
  76 Options are specified with a
  77 .Fl o
  78 flag followed by a comma separated string of options.
  79 See the
  80 .Xr mount 8
  81 man page for possible options and their meanings.
  82 .It Ar target
  83 Should be the current location of the sub-tree in the
  84 local system's name space.
  85 .It Ar mount-point
  86 Should be a directory
  87 where the mapped subtree is to be placed.
  88 .It Fl u Ar uid-mapfile
  89 .It Fl g Ar gid-mapfile
  90 Describe the mappings to be made between identifiers.
  91 Briefly, the format of these files is a count of the number of
  92 mappings on the first line, with each subsequent line containing
  93 a single mapping.  Each of these mappings consists of an id in
  94 the local environment and the corresponding id from the original environment,
  95 separated by white space.
  96 .Ar Uid-mapfile
  97 should contain all uid
  98 mappings, and
  99 .Ar gid-mapfile
 100 should contain all gid mappings.
 101 Any uids not mapped in
 102 .Ar uid-mapfile
 103 will be treated as user NOBODY,
 104 and any gids not mapped in
 105 .Ar gid-mapfile
 106 will be treated as group
 107 NULLGROUP.  At most 64 uids can be mapped for a given subtree, and
 108 at most 16 groups can be mapped by a given subtree.
 109 .El
 110 .Pp
 111 The mapfiles can be located anywhere in the file hierarchy, but they
 112 must be owned by root, and they must be writable only by root.
 113 .Nm Mount_umap
 114 will refuse to map the sub-tree if the ownership or permissions on
 115 these files are improper.  It will also balk if the count of mappings
 116 in the first line of the map files is not correct.
 117 .Pp
 118 The layer created by the
 119 .Nm
 120 command is meant to serve as a simple example of file system layering.
 121 It is not meant for production use.  The implementation is not very
 122 sophisticated.
 123 .Sh SEE ALSO
 124 .Xr mount 8 ,
 125 .Xr mount_null 8
 126 .Sh BUGS
 127 THIS FILESYSTEM TYPE IS NOT YET FULLY SUPPORTED (READ: IT DOESN'T WORK)
 128 AND USING IT MAY, IN FACT, DESTROY DATA ON YOUR SYSTEM.  USE AT YOUR
 129 OWN RISK.  BEWARE OF DOG.  SLIPPERY WHEN WET.
 130 .Pp
 131 This code also needs an owner in order to be less dangerous - serious
 132 hackers can apply by sending mail to
 133 .Aq hackers@FreeBSD.org
 134 and announcing
 135 their intent to take it over.
 136 .Sh HISTORY
 137 The
 138 .Nm
 139 utility first appeared in
 140 .Bx 4.4 .