docs-xml/manpages/smbcacls.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="smbcacls.1">
   4
   5 <refmeta>
   6         <refentrytitle>smbcacls</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">User Commands</refmiscinfo>
  10         <refmiscinfo class="version">3.6</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>smbcacls</refname>
  16         <refpurpose>Set or get ACLs on an NT file or directory names</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>smbcacls</command>
  22                 <arg choice="req">//server/share</arg>
  23                 <arg choice="req">/filename</arg>
  24                 <arg choice="opt">-D|--delete acls</arg>
  25                 <arg choice="opt">-M|--modify acls</arg>
  26                 <arg choice="opt">-a|--add acls</arg>
  27                 <arg choice="opt">-S|--set acls</arg>
  28                 <arg choice="opt">-C|--chown name</arg>
  29                 <arg choice="opt">-G|--chgrp name</arg>
  30                 <arg choice="opt">-I allow|romove|copy</arg>
  31                 <arg choice="opt">--numeric</arg>
  32                 <arg choice="opt">-t</arg>
  33                 <arg choice="opt">-U username</arg>
  34                 <arg choice="opt">-h</arg>
  35                 <arg choice="opt">-d</arg>
  36         </cmdsynopsis>
  37 </refsynopsisdiv>
  38
  39 <refsect1>
  40         <title>DESCRIPTION</title>
  41
  42         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  43         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  44
  45         <para>The <command>smbcacls</command> program manipulates NT Access Control
  46         Lists (ACLs) on SMB file shares. </para>
  47 </refsect1>
  48
  49
  50 <refsect1>
  51         <title>OPTIONS</title>
  52
  53         <para>The following options are available to the <command>smbcacls</command> program.
  54         The format of ACLs is described in the section ACL FORMAT </para>
  55
  56
  57         <variablelist>
  58                 <varlistentry>
  59                 <term>-a|--add acls</term>
  60                 <listitem><para>Add the ACLs specified to the ACL list.  Existing
  61                 access control entries are unchanged. </para></listitem>
  62                 </varlistentry>
  63
  64
  65
  66                 <varlistentry>
  67                 <term>-M|--modify acls</term>
  68                 <listitem><para>Modify the mask value (permissions) for the ACLs
  69                 specified on the command line.  An error will be printed for each
  70                 ACL specified that was not already present in the ACL list
  71                 </para></listitem>
  72                 </varlistentry>
  73
  74
  75
  76                 <varlistentry>
  77                 <term>-D|--delete acls</term>
  78                 <listitem><para>Delete any ACLs specified on the command line.
  79                 An error will be printed for each ACL specified that was not
  80                 already present in the ACL list. </para></listitem>
  81                 </varlistentry>
  82
  83
  84
  85                 <varlistentry>
  86                 <term>-S|--set acls</term>
  87                 <listitem><para>This command sets the ACLs on the file with
  88                 only the ones specified on the command line.  All other ACLs are
  89                 erased. Note that the ACL specified must contain at least a revision,
  90                 type, owner and group for the call to succeed. </para></listitem>
  91                 </varlistentry>
  92
  93
  94
  95                 <varlistentry>
  96                 <term>-C|--chown name</term>
  97                 <listitem><para>The owner of a file or directory can be changed
  98                 to the name given using the <parameter>-C</parameter> option.
  99                 The name can be a sid in the form S-1-x-y-z or a name resolved
 100                 against the server specified in the first argument. </para>
 101
 102                 <para>This command is a shortcut for -M OWNER:name.
 103                 </para></listitem>
 104                 </varlistentry>
 105
 106
 107
 108                 <varlistentry>
 109                 <term>-G|--chgrp name</term>
 110                 <listitem><para>The group owner of a file or directory can
 111                 be changed to the name given using the <parameter>-G</parameter>
 112                 option.  The name can be a sid in the form S-1-x-y-z or a name
 113                 resolved against the server specified n the first argument.
 114                 </para>
 115
 116                 <para>This command is a shortcut for -M GROUP:name.</para></listitem>
 117                 </varlistentry>
 118
 119
 120
 121                 <varlistentry>
 122                 <term>-I|--inherit allow|remove|copy</term>
 123                 <listitem><para>Set or unset the windows "Allow inheritable
 124                 permissions" check box using the <parameter>-I</parameter>
 125                 option.  To set the check box pass allow. To unset the check
 126                 box pass either remove or copy. Remove will remove all
 127                 inherited acls. Copy will copy all the inherited acls.
 128                 </para></listitem>
 129
 130                 </varlistentry>
 131
 132
 133
 134                 <varlistentry>
 135                 <term>--numeric</term>
 136                 <listitem><para>This option displays all ACL information in numeric
 137                 format.  The default is to convert SIDs to names and ACE types
 138                 and masks to a readable string format.  </para></listitem>
 139                 </varlistentry>
 140
 141                 <varlistentry>
 142                 <term>-t|--test-args</term>
 143                 <listitem><para>
 144                 Don't actually do anything, only validate the correctness of
 145                 the arguments.
 146                 </para></listitem>
 147                 </varlistentry>
 148
 149                 &stdarg.help;
 150                 &stdarg.server.debug;
 151                 &popt.common.samba;
 152                 &popt.common.credentials;
 153         </variablelist>
 154 </refsect1>
 155
 156
 157 <refsect1>
 158         <title>ACL FORMAT</title>
 159
 160         <para>The format of an ACL is one or more ACL entries separated by
 161         either commas or newlines.  An ACL entry is one of the following: </para>
 162
 163 <para><programlisting>
 164 REVISION:&lt;revision number&gt;
 165 OWNER:&lt;sid or name&gt;
 166 GROUP:&lt;sid or name&gt;
 167 ACL:&lt;sid or name&gt;:&lt;type&gt;/&lt;flags&gt;/&lt;mask&gt;
 168 </programlisting></para>
 169
 170
 171         <para>The revision of the ACL specifies the internal Windows
 172         NT ACL revision for the security descriptor.
 173         If not specified it defaults to 1.  Using values other than 1 may
 174         cause strange behaviour. </para>
 175
 176         <para>The owner and group specify the owner and group sids for the
 177         object.  If a SID in the format S-1-x-y-z is specified this is used,
 178         otherwise the name specified is resolved using the server on which
 179         the file or directory resides. </para>
 180
 181         <para>ACLs specify permissions granted to the SID.  This SID again
 182         can be specified in S-1-x-y-z format or as a name in which case
 183         it is resolved against the server on which the file or directory
 184         resides.  The type, flags and mask values determine the type of
 185         access granted to the SID. </para>
 186
 187         <para>The type can be either ALLOWED or DENIED to allow/deny access
 188         to the SID. The flags values are generally zero for file ACLs and
 189         either 9 or 2 for directory ACLs.  Some common flags are: </para>
 190
 191         <itemizedlist>
 192                 <listitem><para><constant>#define SEC_ACE_FLAG_OBJECT_INHERIT           0x1</constant></para></listitem>
 193                 <listitem><para><constant>#define SEC_ACE_FLAG_CONTAINER_INHERIT        0x2</constant></para></listitem>
 194                 <listitem><para><constant>#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT     0x4</constant></para></listitem>
 195                 <listitem><para><constant>#define SEC_ACE_FLAG_INHERIT_ONLY             0x8</constant></para></listitem>
 196         </itemizedlist>
 197
 198         <para>At present flags can only be specified as decimal or
 199         hexadecimal values.</para>
 200
 201         <para>The mask is a value which expresses the access right
 202         granted to the SID. It can be given as a decimal or hexadecimal value,
 203         or by using one of the following text strings which map to the NT
 204         file permissions of the same name. </para>
 205
 206         <itemizedlist>
 207                 <listitem><para><emphasis>R</emphasis> - Allow read access </para></listitem>
 208                 <listitem><para><emphasis>W</emphasis> - Allow write access</para></listitem>
 209                 <listitem><para><emphasis>X</emphasis> - Execute permission on the object</para></listitem>
 210                 <listitem><para><emphasis>D</emphasis> - Delete the object</para></listitem>
 211                 <listitem><para><emphasis>P</emphasis> - Change permissions</para></listitem>
 212                 <listitem><para><emphasis>O</emphasis> - Take ownership</para></listitem>
 213         </itemizedlist>
 214
 215
 216         <para>The following combined permissions can be specified:</para>
 217
 218
 219         <itemizedlist>
 220                 <listitem><para><emphasis>READ</emphasis> -  Equivalent to 'RX'
 221                 permissions</para></listitem>
 222                 <listitem><para><emphasis>CHANGE</emphasis> - Equivalent to 'RXWD' permissions
 223                 </para></listitem>
 224                 <listitem><para><emphasis>FULL</emphasis> - Equivalent to 'RWXDPO'
 225                 permissions</para></listitem>
 226         </itemizedlist>
 227         </refsect1>
 228
 229 <refsect1>
 230         <title>EXIT STATUS</title>
 231
 232         <para>The <command>smbcacls</command> program sets the exit status
 233         depending on the success or otherwise of the operations performed.
 234         The exit status may be one of the following values. </para>
 235
 236         <para>If the operation succeeded, smbcacls returns and exit
 237         status of 0.  If <command>smbcacls</command> couldn't connect to the specified server,
 238         or there was an error getting or setting the ACLs, an exit status
 239         of 1 is returned.  If there was an error parsing any command line
 240         arguments, an exit status of 2 is returned. </para>
 241 </refsect1>
 242
 243 <refsect1>
 244         <title>VERSION</title>
 245
 246         <para>This man page is correct for version 3 of the Samba suite.</para>
 247 </refsect1>
 248
 249 <refsect1>
 250         <title>AUTHOR</title>
 251
 252         <para>The original Samba software and related utilities
 253         were created by Andrew Tridgell. Samba is now developed
 254         by the Samba Team as an Open Source project similar
 255         to the way the Linux kernel is developed.</para>
 256
 257         <para><command>smbcacls</command> was written by Andrew Tridgell
 258         and Tim Potter.</para>
 259
 260         <para>The conversion to DocBook for Samba 2.2 was done
 261         by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done
 262         by Alexander Bokovoy.</para>
 263 </refsect1>
 264
 265 </refentry>