summaryrefslogtreecommitdiff
path: root/docs/htmldocs/smbcacls.1.html
blob: f987680f33f96e5bd1de7fd47bca1db238cf6ddc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<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.59.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 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>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">Samba(7)</a> suite.</p><p>The <b>smbcacls</b> program manipulates NT Access Control
	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>smbcacls</b> program.  
	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 
		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 
		specified on the command line.  An error will be printed for each 
		ACL specified that was not already present in the ACL list
		</p></dd><dt><span class="term">-D acls</span></dt><dd><p>Delete any ACLs specified on the command line.  
		An error will be printed for each ACL specified that was not 
		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 
		only the ones specified on the command line.  All other ACLs are 
		erased. Note that the ACL specified must contain at least a revision,
		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 
		specified service.  The username may be of the form &quot;username&quot; in 
		which case the user is prompted to enter in a password and the 
		workgroup specified in the <a href="smb.conf.5.html">smb.conf(5)</a> file is 
		used, or &quot;username%password&quot;  or &quot;DOMAIN\username%password&quot; and the 
		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 
		to the name given using the <i><tt>-C</tt></i> option.  
		The name can be a sid in the form S-1-x-y-z or a name resolved 
		against the server specified in the first argument. </p><p>This command is a shortcut for -M OWNER:name. 
		</p></dd><dt><span class="term">-G name</span></dt><dd><p>The group owner of a file or directory can 
		be changed to the name given using the <i><tt>-G</tt></i> 
		option.  The name can be a sid in the form S-1-x-y-z or a name 
		resolved against the server specified n the first argument.
		</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 
		format.  The default is to convert SIDs to names and ACE types 
		and masks to a readable string format.  </p></dd><dt><span class="term">-t</span></dt><dd><p>
		Don't actually do anything, only validate the correctness of 
		the arguments.
		</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for 
<b>smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the 
configuration details required by the server.  The 
information in this file includes server-specific
information such as what printcap file to use, as well 
as descriptions of all the services that the server is 
to provide. See <a href="smb.conf.5.html" target="_top"><tt>
smb.conf(5)</tt></a> for more information.
The default configuration file name is determined at 
compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i><tt>debuglevel</tt></i> is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.</p><p>The higher this value, the more detail will be 
logged to the log files about the activities of the 
server. At level 0, only critical errors and serious 
warnings will be logged. Level 1 is a reasonable level for
day to day running - it generates a small amount of 
information about operations carried out.</p><p>Levels above 1 will generate considerable 
amounts of log data, and should only be used when 
investigating a problem. Levels above 3 are designed for 
use only by developers and generate HUGE amounts of log
data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will 
override the <a href="smb.conf.5.html#loglevel" target="_top">log
level</a> parameter in the <a href="smb.conf.5.html" target="_top">
<tt>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
<tt>&quot;.client&quot;</tt> will be appended. The log file is
never removed by the client.
</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 
	either commas or newlines.  An ACL entry is one of the following: </p><pre class="programlisting"> 
REVISION:&lt;revision number&gt;
OWNER:&lt;sid or name&gt;
GROUP:&lt;sid or name&gt;
ACL:&lt;sid or name&gt;:&lt;type&gt;/&lt;flags&gt;/&lt;mask&gt;
</pre><p>The revision of the ACL specifies the internal Windows 
	NT ACL revision for the security descriptor.  
	If not specified it defaults to 1.  Using values other than 1 may 
	cause strange behaviour. </p><p>The owner and group specify the owner and group sids for the 
	object.  If a SID in the format CWS-1-x-y-z is specified this is used, 
	otherwise the name specified is resolved using the server on which 
	the file or directory resides. </p><p>ACLs specify permissions granted to the SID.  This SID again 
	can be specified in CWS-1-x-y-z format or as a name in which case 
	it is resolved against the server on which the file or directory 
	resides.  The type, flags and mask values determine the type of 
	access granted to the SID. </p><p>The type can be either 0 or 1 corresponding to ALLOWED or 
	DENIED access to the SID.  The flags values are generally
	zero for file ACLs and either 9 or 2 for directory ACLs.  Some 
	common flags are: </p><div class="itemizedlist"><ul type="disc"><li><p><tt>#define SEC_ACE_FLAG_OBJECT_INHERIT     	0x1</tt></p></li><li><p><tt>#define SEC_ACE_FLAG_CONTAINER_INHERIT  	0x2</tt></p></li><li><p><tt>#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT     0x4</tt></p></li><li><p><tt>#define SEC_ACE_FLAG_INHERIT_ONLY       	0x8</tt></p></li></ul></div><p>At present flags can only be specified as decimal or 
	hexadecimal values.</p><p>The mask is a value which expresses the access right 
	granted to the SID. It can be given as a decimal or hexadecimal value, 
	or by using one of the following text strings which map to the NT 
	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'
		permissions</p></li><li><p><span class="emphasis"><em>CHANGE</em></span> - Equivalent to 'RXWD' permissions
		</p></li><li><p><span class="emphasis"><em>FULL</em></span> - Equivalent to 'RWXDPO' 
		permissions</p></li></ul></div></div><div class="refsect1" lang="en"><h2>EXIT STATUS</h2><p>The <b>smbcacls</b> program sets the exit status 
	depending on the success or otherwise of the operations performed.  
	The exit status may be one of the following values. </p><p>If the operation succeeded, smbcacls returns and exit 
	status of 0.  If <b>smbcacls</b> couldn't connect to the specified server, 
	or there was an error getting or setting the ACLs, an exit status 
	of 1 is returned.  If there was an error parsing any command line 
	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 
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar 
	to the way the Linux kernel is developed.</p><p><b>smbcacls</b> was written by Andrew Tridgell 
	and Tim Potter.</p><p>The conversion to DocBook for Samba 2.2 was done 
	by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done
	by Alexander Bokovoy.</p></div></div></body></html>