sharesec: Document -v/--view
[Samba.git] / docs-xml / manpages / sharesec.1.xml
blob1e1f6c3e668e199c0270d0664125fbde06ea6dd6
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">
5 <refmeta>
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.0</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>sharesec</refname>
16         <refpurpose>Set or get share ACLs</refpurpose>
17 </refnamediv>
19 <refsynopsisdiv>
20         <cmdsynopsis>
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">-M, --machine-sid</arg>
30                 <arg choice="opt">-F, --force</arg>
31                 <arg choice="opt">-d, --debuglevel=DEBUGLEVEL</arg>
32                 <arg choice="opt">-s, --configfile=CONFIGFILE</arg>
33                 <arg choice="opt">-l, --log-basename=LOGFILEBASE</arg>
34                 <arg choice="opt">-V, --version</arg>
35                 <arg choice="opt">-?, --help</arg>
36                 <arg choice="opt">--usage</arg>
37         </cmdsynopsis>
38 </refsynopsisdiv>
40 <refsect1>
41         <title>DESCRIPTION</title>
43         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
44         <manvolnum>7</manvolnum></citerefentry> suite.</para>
46         <para>The <command>sharesec</command> program manipulates share permissions
47         on SMB file shares.</para>
48 </refsect1>
51 <refsect1>
52         <title>OPTIONS</title>
54         <para>The following options are available to the <command>sharesec</command> program.
55         The format of ACLs is described in the section ACL FORMAT </para>
57         <variablelist>
58                 <varlistentry>
59                 <term>-a|--add=ACL</term>
60                 <listitem><para>Add the ACEs specified to the ACL list.
61                 </para></listitem>
62                 </varlistentry>
64                 <varlistentry>
65                 <term>-D|--delete</term>
66                 <listitem><para>Delete the entire security descriptor.
67                 </para></listitem>
68                 </varlistentry>
70                 <varlistentry>
71                 <term>-F|--force</term>
72                 <listitem><para>Force storing the ACL.
73                 </para></listitem>
74                 </varlistentry>
76                 <varlistentry>
77                 <term>-m|--modify=ACL</term>
78                 <listitem><para>Modify existing ACEs.
79                 </para></listitem>
80                 </varlistentry>
82                 <varlistentry>
83                 <term>-M|--machine-sid</term>
84                 <listitem><para>Initialize the machine SID.
85                 </para></listitem>
86                 </varlistentry>
88                 <varlistentry>
89                 <term>-r|--remove=ACL</term>
90                 <listitem><para>Remove ACEs.
91                 </para></listitem>
92                 </varlistentry>
94                 <varlistentry>
95                 <term>-R|--replace=ACLS</term>
96                 <listitem><para>
97                 Overwrite an existing share permission ACL.
98                 </para></listitem>
99                 </varlistentry>
101                 <varlistentry>
102                 <term>-v|--view</term>
103                 <listitem><para>
104                 List a share acl
105                 </para></listitem>
106                 </varlistentry>
108                 &stdarg.help;
109                 &stdarg.server.debug;
110                 &popt.common.samba;
111         </variablelist>
112 </refsect1>
115 <refsect1>
116         <title>ACL FORMAT</title>
118         <para>The format of an ACL is one or more ACL entries separated by
119         either commas or newlines.  An ACL entry is one of the following: </para>
121         <para><programlisting>
122         REVISION:&lt;revision number&gt;
123         OWNER:&lt;sid or name&gt;
124         GROUP:&lt;sid or name&gt;
125         ACL:&lt;sid or name&gt;:&lt;type&gt;/&lt;flags&gt;/&lt;mask&gt;
126         </programlisting></para>
128         <para>The revision of the ACL specifies the internal Windows
129         NT ACL revision for the security descriptor.
130         If not specified it defaults to 1. Using values other than 1 may
131         cause strange behaviour.</para>
133         <para>The owner and group specify the owner and group SIDs for the
134         object. If a SID in the format S-1-x-y-z is specified this is used,
135         otherwise the name specified is resolved using the server on which
136         the file or directory resides.</para>
138         <para>ACLs specify permissions granted to the SID. This SID
139         can be specified in S-1-x-y-z format or as a name in which case
140         it is resolved against the server on which the file or directory
141         resides.  The type, flags and mask values determine the type of
142         access granted to the SID.</para>
144         <para>The type can be either ALLOWED or DENIED to allow/deny access
145         to the SID. The flags values are generally zero for share ACLs.
146         </para>
148         <para>The mask is a value which expresses the access right
149         granted to the SID. It can be given as a decimal or hexadecimal value,
150         or by using one of the following text strings which map to the NT
151         file permissions of the same name.</para>
153         <itemizedlist>
154                 <listitem><para><emphasis>R</emphasis> - Allow read access </para></listitem>
155                 <listitem><para><emphasis>W</emphasis> - Allow write access</para></listitem>
156                 <listitem><para><emphasis>X</emphasis> - Execute permission on the object</para></listitem>
157                 <listitem><para><emphasis>D</emphasis> - Delete the object</para></listitem>
158                 <listitem><para><emphasis>P</emphasis> - Change permissions</para></listitem>
159                 <listitem><para><emphasis>O</emphasis> - Take ownership</para></listitem>
160         </itemizedlist>
162         <para>The following combined permissions can be specified:</para>
164         <itemizedlist>
165                 <listitem><para><emphasis>READ</emphasis> -  Equivalent to 'RX'
166                 permissions</para></listitem>
167                 <listitem><para><emphasis>CHANGE</emphasis> - Equivalent to 'RXWD' permissions
168                 </para></listitem>
169                 <listitem><para><emphasis>FULL</emphasis> - Equivalent to 'RWXDPO'
170                 permissions</para></listitem>
171         </itemizedlist>
172         </refsect1>
174 <refsect1>
175         <title>EXIT STATUS</title>
177         <para>The <command>sharesec</command> program sets the exit status
178         depending on the success or otherwise of the operations performed.
179         The exit status may be one of the following values. </para>
181         <para>If the operation succeeded, sharesec returns and exit
182         status of 0.  If <command>sharesec</command> couldn't connect to the specified server,
183         or there was an error getting or setting the ACLs, an exit status
184         of 1 is returned.  If there was an error parsing any command line
185         arguments, an exit status of 2 is returned. </para>
186 </refsect1>
188 <refsect1>
189         <title>EXAMPLES</title>
191         <para>Add full access for SID
192         <parameter>S-1-5-21-1866488690-1365729215-3963860297-17724</parameter> on
193         <parameter>share</parameter>:
194         </para>
196         <programlisting>
197         host:~ # sharesec share -a S-1-5-21-1866488690-1365729215-3963860297-17724:ALLOWED/0/FULL
198         </programlisting>
200         <para>List all ACEs for <parameter>share</parameter>:
201         </para>
203         <programlisting>
204         host:~ # sharesec share -v
205         REVISION:1
206         OWNER:(NULL SID)
207         GROUP:(NULL SID)
208         ACL:S-1-1-0:ALLOWED/0/0x101f01ff
209         ACL:S-1-5-21-1866488690-1365729215-3963860297-17724:ALLOWED/0/FULL
210         </programlisting>
211 </refsect1>
213 <refsect1>
214         <title>VERSION</title>
216         <para>This man page is correct for version 3 of the Samba suite.</para>
217 </refsect1>
219 <refsect1>
220         <title>AUTHOR</title>
221         <para>The original Samba software and related utilities
222         were created by Andrew Tridgell. Samba is now developed
223         by the Samba Team as an Open Source project similar
224         to the way the Linux kernel is developed.</para>
225 </refsect1>
227 </refentry>