docs/htmldocs/smbcacls.1.html


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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>smbcacls</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="SMBCACLS.1"
></A
>smbcacls</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5"
></A
><H2
>Name</H2
>smbcacls&nbsp;--&nbsp;Set or get ACLs on an NT file or directory names</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN8"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>smbcacls</B
>  {//server/share} {filename} [-U username] [-A acls] [-M acls] [-D acls] [-S acls] [-C name] [-G name] [-n] [-h]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN22"
></A
><H2
>DESCRIPTION</H2
><P
>This tool is part of the <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>Samba</SPAN
>(7)</SPAN
> suite.</P
><P
>The <B
CLASS="COMMAND"
>smbcacls</B
> program manipulates NT Access Control
	Lists (ACLs) on SMB file shares. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN30"
></A
><H2
>OPTIONS</H2
><P
>The following options are available to the <B
CLASS="COMMAND"
>smbcacls</B
> program.  
	The format of ACLs is described in the section ACL FORMAT </P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>-A acls</DT
><DD
><P
>Add the ACLs specified to the ACL list.  Existing 
		access control entries are unchanged. </P
></DD
><DT
>-M acls</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
>-D acls</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
>-S acls</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
>-U username</DT
><DD
><P
>Specifies a username used to connect to the 
		specified service.  The username may be of the form "username" in 
		which case the user is prompted to enter in a password and the 
		workgroup specified in the <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>smb.conf</SPAN
>(5)</SPAN
> file is 
		used, or "username%password"  or "DOMAIN\username%password" and the 
		password and workgroup names are used as provided. </P
></DD
><DT
>-C name</DT
><DD
><P
>The owner of a file or directory can be changed 
		to the name given using the <VAR
CLASS="PARAMETER"
>-C</VAR
> 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
>-G name</DT
><DD
><P
>The group owner of a file or directory can 
		be changed to the name given using the <VAR
CLASS="PARAMETER"
>-G</VAR
> 
		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
>-n</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
>-h</DT
><DD
><P
>Print usage information on the <B
CLASS="COMMAND"
>smbcacls
		</B
> program.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN79"
></A
><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
><P
><PRE
CLASS="PROGRAMLISTING"
> 
REVISION:&#60;revision number&#62;
OWNER:&#60;sid or name&#62;
GROUP:&#60;sid or name&#62;
ACL:&#60;sid or name&#62;:&#60;type&#62;/&#60;flags&#62;/&#60;mask&#62;</PRE
></P
><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
><P
></P
><UL
><LI
><P
><CODE
CLASS="CONSTANT"
>#define SEC_ACE_FLAG_OBJECT_INHERIT     	0x1</CODE
></P
></LI
><LI
><P
><CODE
CLASS="CONSTANT"
>#define SEC_ACE_FLAG_CONTAINER_INHERIT  	0x2</CODE
></P
></LI
><LI
><P
><CODE
CLASS="CONSTANT"
>#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT     0x4</CODE
></P
></LI
><LI
><P
><CODE
CLASS="CONSTANT"
>#define SEC_ACE_FLAG_INHERIT_ONLY       	0x8</CODE
></P
></LI
></UL
><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
><P
></P
><UL
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>R</I
></SPAN
> - Allow read access </P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>W</I
></SPAN
> - Allow write access</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>X</I
></SPAN
> - Execute permission on the object</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>D</I
></SPAN
> - Delete the object</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>P</I
></SPAN
> - Change permissions</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>O</I
></SPAN
> - Take ownership</P
></LI
></UL
><P
>The following combined permissions can be specified:</P
><P
></P
><UL
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>READ</I
></SPAN
> -  Equivalent to 'RX'
		permissions</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>CHANGE</I
></SPAN
> - Equivalent to 'RXWD' permissions
		</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>FULL</I
></SPAN
> - Equivalent to 'RWXDPO' 
		permissions</P
></LI
></UL
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN133"
></A
><H2
>EXIT STATUS</H2
><P
>The <B
CLASS="COMMAND"
>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
CLASS="COMMAND"
>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"
><A
NAME="AEN139"
></A
><H2
>VERSION</H2
><P
>This man page is correct for version 2.2 of the Samba suite.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN142"
></A
><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
CLASS="COMMAND"
>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
></BODY
></HTML
>