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="sharesec.1">
6 <refentrytitle>sharesec</refentrytitle>
7 <manvolnum>1</manvolnum>
8 <refmiscinfo class="source">Samba</refmiscinfo>
9 <refmiscinfo class="manual">User Commands</refmiscinfo>
10 <refmiscinfo class="version">4.1</refmiscinfo>
15 <refname>sharesec</refname>
16 <refpurpose>Set or get share ACLs</refpurpose>
21 <command>sharesec</command>
22 <arg choice="req">sharename</arg>
23 <arg choice="opt">-r, --remove=ACL</arg>
24 <arg choice="opt">-m, --modify=ACL</arg>
25 <arg choice="opt">-a, --add=ACL</arg>
26 <arg choice="opt">-R, --replace=ACLs</arg>
27 <arg choice="opt">-D, --delete</arg>
28 <arg choice="opt">-v, --view</arg>
29 <arg choice="opt">--view-all</arg>
30 <arg choice="opt">-M, --machine-sid</arg>
31 <arg choice="opt">-F, --force</arg>
32 <arg choice="opt">-d, --debuglevel=DEBUGLEVEL</arg>
33 <arg choice="opt">-s, --configfile=CONFIGFILE</arg>
34 <arg choice="opt">-l, --log-basename=LOGFILEBASE</arg>
35 <arg choice="opt">--version</arg>
36 <arg choice="opt">-?, --help</arg>
37 <arg choice="opt">--usage</arg>
38 <arg choice="opt">-S, --setsddl=STRING</arg>
39 <arg choice="opt">-V, --viewsddl</arg>
44 <title>DESCRIPTION</title>
46 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
47 <manvolnum>7</manvolnum></citerefentry> suite.</para>
49 <para>The <command>sharesec</command> program manipulates share permissions
50 on SMB file shares.</para>
55 <title>OPTIONS</title>
57 <para>The following options are available to the <command>sharesec</command> program.
58 The format of ACLs is described in the section ACL FORMAT </para>
62 <term>-a|--add=ACL</term>
63 <listitem><para>Add the ACEs specified to the ACL list.
68 <term>-D|--delete</term>
69 <listitem><para>Delete the entire security descriptor.
74 <term>-F|--force</term>
75 <listitem><para>Force storing the ACL.
80 <term>-m|--modify=ACL</term>
81 <listitem><para>Modify existing ACEs.
86 <term>-M|--machine-sid</term>
87 <listitem><para>Initialize the machine SID.
92 <term>-r|--remove=ACL</term>
93 <listitem><para>Remove ACEs.
98 <term>-R|--replace=ACLS</term>
100 Overwrite an existing share permission ACL.
105 <term>-v|--view</term>
112 <term>--view-all</term>
119 <term>-S|--setsddl=STRING</term>
121 Set security descriptor by providing ACL in SDDL format.
126 <term>-V|--viewsddl</term>
128 List a share acl in SDDL format.
133 &stdarg.server.debug;
140 <title>ACL FORMAT</title>
142 <para>The format of an ACL is one or more ACL entries separated by
143 either commas or newlines. An ACL entry is one of the following: </para>
145 <para><programlisting>
146 REVISION:<revision number>
147 OWNER:<sid or name>
148 GROUP:<sid or name>
149 ACL:<sid or name>:<type>/<flags>/<mask>
150 </programlisting></para>
152 <para>The revision of the ACL specifies the internal Windows
153 NT ACL revision for the security descriptor.
154 If not specified it defaults to 1. Using values other than 1 may
155 cause strange behaviour.</para>
157 <para>The owner and group specify the owner and group SIDs for the
158 object. If a SID in the format S-1-x-y-z is specified this is used,
159 otherwise the name specified is resolved using the server on which
160 the file or directory resides.</para>
162 <para>ACLs specify permissions granted to the SID. This SID
163 can be specified in S-1-x-y-z format or as a name in which case
164 it is resolved against the server on which the file or directory
165 resides. The type, flags and mask values determine the type of
166 access granted to the SID.</para>
168 <para>The type can be either ALLOWED or DENIED to allow/deny access
169 to the SID. The flags values are generally zero for share ACLs.
172 <para>The mask is a value which expresses the access right
173 granted to the SID. It can be given as a decimal or hexadecimal value,
174 or by using one of the following text strings which map to the NT
175 file permissions of the same name.</para>
178 <listitem><para><emphasis>R</emphasis> - Allow read access </para></listitem>
179 <listitem><para><emphasis>W</emphasis> - Allow write access</para></listitem>
180 <listitem><para><emphasis>X</emphasis> - Execute permission on the object</para></listitem>
181 <listitem><para><emphasis>D</emphasis> - Delete the object</para></listitem>
182 <listitem><para><emphasis>P</emphasis> - Change permissions</para></listitem>
183 <listitem><para><emphasis>O</emphasis> - Take ownership</para></listitem>
186 <para>The following combined permissions can be specified:</para>
189 <listitem><para><emphasis>READ</emphasis> - Equivalent to 'RX'
190 permissions</para></listitem>
191 <listitem><para><emphasis>CHANGE</emphasis> - Equivalent to 'RXWD' permissions
193 <listitem><para><emphasis>FULL</emphasis> - Equivalent to 'RWXDPO'
194 permissions</para></listitem>
199 <title>EXIT STATUS</title>
201 <para>The <command>sharesec</command> program sets the exit status
202 depending on the success or otherwise of the operations performed.
203 The exit status may be one of the following values. </para>
205 <para>If the operation succeeded, sharesec returns and exit
206 status of 0. If <command>sharesec</command> couldn't connect to the specified server,
207 or there was an error getting or setting the ACLs, an exit status
208 of 1 is returned. If there was an error parsing any command line
209 arguments, an exit status of 2 is returned. </para>
213 <title>EXAMPLES</title>
215 <para>Add full access for SID
216 <parameter>S-1-5-21-1866488690-1365729215-3963860297-17724</parameter> on
217 <parameter>share</parameter>:
221 host:~ # sharesec share -a S-1-5-21-1866488690-1365729215-3963860297-17724:ALLOWED/0/FULL
224 <para>List all ACEs for <parameter>share</parameter>:
228 host:~ # sharesec share -v
232 ACL:S-1-1-0:ALLOWED/0/0x101f01ff
233 ACL:S-1-5-21-1866488690-1365729215-3963860297-17724:ALLOWED/0/FULL
238 <title>VERSION</title>
240 <para>This man page is correct for version 3 of the Samba suite.</para>
244 <title>AUTHOR</title>
245 <para>The original Samba software and related utilities
246 were created by Andrew Tridgell. Samba is now developed
247 by the Samba Team as an Open Source project similar
248 to the way the Linux kernel is developed.</para>