granicus.if.org Git - shadow/blob - man/subuid.5.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3    Copyright (c) 2013 Eric W. Biederman
   4    All rights reserved.
   5
   6    Redistribution and use in source and binary forms, with or without
   7    modification, are permitted provided that the following conditions
   8    are met:
   9    1. Redistributions of source code must retain the above copyright
  10       notice, this list of conditions and the following disclaimer.
  11    2. Redistributions in binary form must reproduce the above copyright
  12       notice, this list of conditions and the following disclaimer in the
  13       documentation and/or other materials provided with the distribution.
  14    3. The name of the copyright holders or contributors may not be used to
  15       endorse or promote products derived from this software without
  16       specific prior written permission.
  17
  18    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  21    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
  22    HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 -->
  30 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
  31   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  32 <!-- SHADOW-CONFIG-HERE -->
  33 ]>
  34 <refentry id='subuid.5'>
  35   <refmeta>
  36     <refentrytitle>subuid</refentrytitle>
  37     <manvolnum>5</manvolnum>
  38     <refmiscinfo class="sectdesc">File Formats and Conversions</refmiscinfo>
  39     <refmiscinfo class="source">shadow-utils</refmiscinfo>
  40     <refmiscinfo class="version">&SHADOW_UTILS_VERSION;</refmiscinfo>
  41   </refmeta>
  42   <refnamediv id='name'>
  43     <refname>subuid</refname>
  44     <refpurpose>the subordinate uid file</refpurpose>
  45   </refnamediv>
  46
  47   <refsect1 id='description'>
  48     <title>DESCRIPTION</title>
  49     <para>
  50       Each line in <filename>/etc/subuid</filename> contains
  51       a user name and a range of subordinate user ids that user
  52       is allowed to use.
  53
  54       This is specified with three fields delimited by colons
  55       (<quote>:</quote>).
  56       These fields are:
  57     </para>
  58     <itemizedlist mark='bullet'>
  59       <listitem>
  60         <para>login name or UID</para>
  61       </listitem>
  62       <listitem>
  63         <para>numerical subordinate user ID</para>
  64       </listitem>
  65       <listitem>
  66         <para>numerical subordinate user ID count</para>
  67       </listitem>
  68     </itemizedlist>
  69
  70     <para>
  71       This file specifies the user IDs that ordinary users can use, with
  72       the <command>newuidmap</command> command, to configure uid mapping
  73       in a user namespace.
  74     </para>
  75
  76     <para>
  77       Multiple ranges may be specified per user.
  78     </para>
  79
  80     <para>
  81       When large number of entries (10000-100000 or more) are defined in
  82       <filename>/etc/subuid</filename>, parsing performance penalty will
  83       become noticeable. In this case it is recommended to use UIDs
  84       instead of login names. Benchmarks have shown speed-ups up to 20x.
  85     </para>
  86
  87   </refsect1>
  88
  89   <refsect1 id='files'>
  90     <title>FILES</title>
  91     <variablelist>
  92       <varlistentry>
  93         <term><filename>/etc/subuid</filename></term>
  94         <listitem>
  95           <para>Per user subordinate user IDs.</para>
  96         </listitem>
  97       </varlistentry>
  98       <varlistentry>
  99         <term><filename>/etc/subuid-</filename></term>
 100         <listitem>
 101           <para>Backup file for /etc/subuid.</para>
 102         </listitem>
 103       </varlistentry>
 104     </variablelist>
 105   </refsect1>
 106
 107   <refsect1 id='see_also'>
 108     <title>SEE ALSO</title>
 109     <para>
 110       <citerefentry>
 111         <refentrytitle>login.defs</refentrytitle><manvolnum>5</manvolnum>
 112       </citerefentry>,
 113       <citerefentry>
 114         <refentrytitle>newgidmap</refentrytitle><manvolnum>1</manvolnum>
 115       </citerefentry>,
 116       <citerefentry>
 117         <refentrytitle>newuidmap</refentrytitle><manvolnum>1</manvolnum>
 118       </citerefentry>,
 119       <citerefentry>
 120         <refentrytitle>newusers</refentrytitle><manvolnum>1</manvolnum>
 121       </citerefentry>,
 122       <citerefentry>
 123         <refentrytitle>subgid</refentrytitle><manvolnum>5</manvolnum>
 124       </citerefentry>,
 125       <citerefentry>
 126         <refentrytitle>useradd</refentrytitle><manvolnum>8</manvolnum>
 127       </citerefentry>,
 128       <citerefentry>
 129         <refentrytitle>userdel</refentrytitle><manvolnum>8</manvolnum>
 130       </citerefentry>,
 131       <citerefentry>
 132         <refentrytitle>usermod</refentrytitle><manvolnum>8</manvolnum>
 133       </citerefentry>,
 134       <citerefentry>
 135         <refentrytitle>user_namespaces</refentrytitle><manvolnum>7</manvolnum>
 136       </citerefentry>.
 137     </para>
 138   </refsect1>
 139 </refentry>