docs-xml/smbdotconf/security/rootdirectory.xml

   1 <samba:parameter name="root directory"
   2                  context="G"
   3                  type="string"
   4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   5 <synonym>root</synonym>
   6 <synonym>root dir</synonym>
   7 <description>
   8     <para>The server will <command moreinfo="none">chroot()</command> (i.e.
   9     Change its root directory) to this directory on startup. This is
  10     not strictly necessary for secure operation. Even without it the
  11     server will deny access to files not in one of the service entries.
  12     It may also check for, and deny access to, soft links to other
  13     parts of the filesystem, or attempts to use &quot;..&quot; in file names
  14     to access other directories (depending on the setting of the
  15         <smbconfoption name="wide smbconfoptions"/> parameter).
  16     </para>
  17
  18     <para>Adding a <parameter moreinfo="none">root directory</parameter> entry other
  19     than &quot;/&quot; adds an extra level of security, but at a price. It
  20     absolutely ensures that no access is given to files not in the
  21     sub-tree specified in the <parameter moreinfo="none">root directory</parameter>
  22     option, <emphasis>including</emphasis> some files needed for
  23     complete operation of the server. To maintain full operability
  24     of the server you will need to mirror some system files
  25     into the <parameter moreinfo="none">root directory</parameter> tree. In particular
  26     you will need to mirror <filename moreinfo="none">/etc/passwd</filename> (or a
  27     subset of it), and any binaries or configuration files needed for
  28     printing (if required). The set of files that must be mirrored is
  29     operating system dependent.</para>
  30 </description>
  31
  32 <value type="default"></value>
  33 <value type="example">/homes/smb</value>
  34 </samba:parameter>