docs/htmldocs/smbcacls.1.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbcacls</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbcacls.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>smbcacls &#8212; Set or get ACLs on an NT file or directory names</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">smbcacls</tt>  {//server/share} {filename} [-D acls] [-M acls] [-A acls] [-S acls] [-C name] [-G name] [-n] [-t] [-U username] [-h] [-d]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p>The <b class="command">smbcacls</b> program manipulates NT Access Control
   2         Lists (ACLs) on SMB file shares. </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><p>The following options are available to the <b class="command">smbcacls</b> program.
   3         The format of ACLs is described in the section ACL FORMAT </p><div class="variablelist"><dl><dt><span class="term">-A acls</span></dt><dd><p>Add the ACLs specified to the ACL list.  Existing
   4                 access control entries are unchanged. </p></dd><dt><span class="term">-M acls</span></dt><dd><p>Modify the mask value (permissions) for the ACLs
   5                 specified on the command line.  An error will be printed for each
   6                 ACL specified that was not already present in the ACL list
   7                 </p></dd><dt><span class="term">-D acls</span></dt><dd><p>Delete any ACLs specified on the command line.
   8                 An error will be printed for each ACL specified that was not
   9                 already present in the ACL list. </p></dd><dt><span class="term">-S acls</span></dt><dd><p>This command sets the ACLs on the file with
  10                 only the ones specified on the command line.  All other ACLs are
  11                 erased. Note that the ACL specified must contain at least a revision,
  12                 type, owner and group for the call to succeed. </p></dd><dt><span class="term">-U username</span></dt><dd><p>Specifies a username used to connect to the
  13                 specified service.  The username may be of the form &quot;username&quot; in
  14                 which case the user is prompted to enter in a password and the
  15                 workgroup specified in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file is
  16                 used, or &quot;username%password&quot;  or &quot;DOMAIN\username%password&quot; and the
  17                 password and workgroup names are used as provided. </p></dd><dt><span class="term">-C name</span></dt><dd><p>The owner of a file or directory can be changed
  18                 to the name given using the <i class="parameter"><tt>-C</tt></i> option.
  19                 The name can be a sid in the form S-1-x-y-z or a name resolved
  20                 against the server specified in the first argument. </p><p>This command is a shortcut for -M OWNER:name.
  21                 </p></dd><dt><span class="term">-G name</span></dt><dd><p>The group owner of a file or directory can
  22                 be changed to the name given using the <i class="parameter"><tt>-G</tt></i>
  23                 option.  The name can be a sid in the form S-1-x-y-z or a name
  24                 resolved against the server specified n the first argument.
  25                 </p><p>This command is a shortcut for -M GROUP:name.</p></dd><dt><span class="term">-n</span></dt><dd><p>This option displays all ACL information in numeric
  26                 format.  The default is to convert SIDs to names and ACE types
  27                 and masks to a readable string format.  </p></dd><dt><span class="term">-t</span></dt><dd><p>
  28                 Don't actually do anything, only validate the correctness of
  29                 the arguments.
  30                 </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
  31 </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for
  32 <b class="command">smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
  33 configuration details required by the server.  The
  34 information in this file includes server-specific
  35 information such as what printcap file to use, as well
  36 as descriptions of all the services that the server is
  37 to provide. See <a href="smb.conf.5.html" target="_top"><tt class="filename">
  38 smb.conf(5)</tt></a> for more information.
  39 The default configuration file name is determined at
  40 compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer
  41 from 0 to 10.  The default value if this parameter is
  42 not specified is zero.</p><p>The higher this value, the more detail will be
  43 logged to the log files about the activities of the
  44 server. At level 0, only critical errors and serious
  45 warnings will be logged. Level 1 is a reasonable level for
  46 day to day running - it generates a small amount of
  47 information about operations carried out.</p><p>Levels above 1 will generate considerable
  48 amounts of log data, and should only be used when
  49 investigating a problem. Levels above 3 are designed for
  50 use only by developers and generate HUGE amounts of log
  51 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
  52 override the <a href="smb.conf.5.html#loglevel" target="_top">log
  53 level</a> parameter in the <a href="smb.conf.5.html" target="_top">
  54 <tt class="filename">smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
  55 <tt class="constant">&quot;.client&quot;</tt> will be appended. The log file is
  56 never removed by the client.
  57 </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>ACL FORMAT</h2><p>The format of an ACL is one or more ACL entries separated by
  58         either commas or newlines.  An ACL entry is one of the following: </p><pre class="programlisting">
  59 REVISION:&lt;revision number&gt;
  60 OWNER:&lt;sid or name&gt;
  61 GROUP:&lt;sid or name&gt;
  62 ACL:&lt;sid or name&gt;:&lt;type&gt;/&lt;flags&gt;/&lt;mask&gt;
  63 </pre><p>The revision of the ACL specifies the internal Windows
  64         NT ACL revision for the security descriptor.
  65         If not specified it defaults to 1.  Using values other than 1 may
  66         cause strange behaviour. </p><p>The owner and group specify the owner and group sids for the
  67         object.  If a SID in the format CWS-1-x-y-z is specified this is used,
  68         otherwise the name specified is resolved using the server on which
  69         the file or directory resides. </p><p>ACLs specify permissions granted to the SID.  This SID again
  70         can be specified in CWS-1-x-y-z format or as a name in which case
  71         it is resolved against the server on which the file or directory
  72         resides.  The type, flags and mask values determine the type of
  73         access granted to the SID. </p><p>The type can be either 0 or 1 corresponding to ALLOWED or
  74         DENIED access to the SID.  The flags values are generally
  75         zero for file ACLs and either 9 or 2 for directory ACLs.  Some
  76         common flags are: </p><div class="itemizedlist"><ul type="disc"><li><p><tt class="constant">#define SEC_ACE_FLAG_OBJECT_INHERIT         0x1</tt></p></li><li><p><tt class="constant">#define SEC_ACE_FLAG_CONTAINER_INHERIT     0x2</tt></p></li><li><p><tt class="constant">#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT     0x4</tt></p></li><li><p><tt class="constant">#define SEC_ACE_FLAG_INHERIT_ONLY               0x8</tt></p></li></ul></div><p>At present flags can only be specified as decimal or
  77         hexadecimal values.</p><p>The mask is a value which expresses the access right
  78         granted to the SID. It can be given as a decimal or hexadecimal value,
  79         or by using one of the following text strings which map to the NT
  80         file permissions of the same name. </p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>R</em></span> - Allow read access </p></li><li><p><span class="emphasis"><em>W</em></span> - Allow write access</p></li><li><p><span class="emphasis"><em>X</em></span> - Execute permission on the object</p></li><li><p><span class="emphasis"><em>D</em></span> - Delete the object</p></li><li><p><span class="emphasis"><em>P</em></span> - Change permissions</p></li><li><p><span class="emphasis"><em>O</em></span> - Take ownership</p></li></ul></div><p>The following combined permissions can be specified:</p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>READ</em></span> -  Equivalent to 'RX'
  81                 permissions</p></li><li><p><span class="emphasis"><em>CHANGE</em></span> - Equivalent to 'RXWD' permissions
  82                 </p></li><li><p><span class="emphasis"><em>FULL</em></span> - Equivalent to 'RWXDPO'
  83                 permissions</p></li></ul></div></div><div class="refsect1" lang="en"><h2>EXIT STATUS</h2><p>The <b class="command">smbcacls</b> program sets the exit status
  84         depending on the success or otherwise of the operations performed.
  85         The exit status may be one of the following values. </p><p>If the operation succeeded, smbcacls returns and exit
  86         status of 0.  If <b class="command">smbcacls</b> couldn't connect to the specified server,
  87         or there was an error getting or setting the ACLs, an exit status
  88         of 1 is returned.  If there was an error parsing any command line
  89         arguments, an exit status of 2 is returned. </p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities
  90         were created by Andrew Tridgell. Samba is now developed
  91         by the Samba Team as an Open Source project similar
  92         to the way the Linux kernel is developed.</p><p><b class="command">smbcacls</b> was written by Andrew Tridgell
  93         and Tim Potter.</p><p>The conversion to DocBook for Samba 2.2 was done
  94         by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done
  95         by Alexander Bokovoy.</p></div></div></body></html>