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