| 1 | '\" t
|
|---|
| 2 | .\" Title: smbcacls
|
|---|
| 3 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 4 | .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
|---|
| 5 | .\" Date: 01/14/2010
|
|---|
| 6 | .\" Manual: User Commands
|
|---|
| 7 | .\" Source: Samba 3.3
|
|---|
| 8 | .\" Language: English
|
|---|
| 9 | .\"
|
|---|
| 10 | .TH "SMBCACLS" "1" "01/14/2010" "Samba 3\&.3" "User Commands"
|
|---|
| 11 | .\" -----------------------------------------------------------------
|
|---|
| 12 | .\" * set default formatting
|
|---|
| 13 | .\" -----------------------------------------------------------------
|
|---|
| 14 | .\" disable hyphenation
|
|---|
| 15 | .nh
|
|---|
| 16 | .\" disable justification (adjust text to left margin only)
|
|---|
| 17 | .ad l
|
|---|
| 18 | .\" -----------------------------------------------------------------
|
|---|
| 19 | .\" * MAIN CONTENT STARTS HERE *
|
|---|
| 20 | .\" -----------------------------------------------------------------
|
|---|
| 21 | .SH "NAME"
|
|---|
| 22 | smbcacls \- Set or get ACLs on an NT file or directory names
|
|---|
| 23 | .SH "SYNOPSIS"
|
|---|
| 24 | .HP \w'\ 'u
|
|---|
| 25 | smbcacls {//server/share} {filename} [\-D\ acls] [\-M\ acls] [\-a\ acls] [\-S\ acls] [\-C\ name] [\-G\ name] [\-\-numeric] [\-t] [\-U\ username] [\-h] [\-d]
|
|---|
| 26 | .SH "DESCRIPTION"
|
|---|
| 27 | .PP
|
|---|
| 28 | This tool is part of the
|
|---|
| 29 | \fBsamba\fR(7)
|
|---|
| 30 | suite\&.
|
|---|
| 31 | .PP
|
|---|
| 32 | The
|
|---|
| 33 | smbcacls
|
|---|
| 34 | program manipulates NT Access Control Lists (ACLs) on SMB file shares\&.
|
|---|
| 35 | .SH "OPTIONS"
|
|---|
| 36 | .PP
|
|---|
| 37 | The following options are available to the
|
|---|
| 38 | smbcacls
|
|---|
| 39 | program\&. The format of ACLs is described in the section ACL FORMAT
|
|---|
| 40 | .PP
|
|---|
| 41 | \-a acls
|
|---|
| 42 | .RS 4
|
|---|
| 43 | Add the ACLs specified to the ACL list\&. Existing access control entries are unchanged\&.
|
|---|
| 44 | .RE
|
|---|
| 45 | .PP
|
|---|
| 46 | \-M acls
|
|---|
| 47 | .RS 4
|
|---|
| 48 | 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
|
|---|
| 49 | .RE
|
|---|
| 50 | .PP
|
|---|
| 51 | \-D acls
|
|---|
| 52 | .RS 4
|
|---|
| 53 | 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\&.
|
|---|
| 54 | .RE
|
|---|
| 55 | .PP
|
|---|
| 56 | \-S acls
|
|---|
| 57 | .RS 4
|
|---|
| 58 | 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\&.
|
|---|
| 59 | .RE
|
|---|
| 60 | .PP
|
|---|
| 61 | \-U username
|
|---|
| 62 | .RS 4
|
|---|
| 63 | 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
|
|---|
| 64 | \fBsmb.conf\fR(5)
|
|---|
| 65 | file is used, or "username%password" or "DOMAIN\eusername%password" and the password and workgroup names are used as provided\&.
|
|---|
| 66 | .RE
|
|---|
| 67 | .PP
|
|---|
| 68 | \-C name
|
|---|
| 69 | .RS 4
|
|---|
| 70 | The owner of a file or directory can be changed to the name given using the
|
|---|
| 71 | \fI\-C\fR
|
|---|
| 72 | 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\&.
|
|---|
| 73 | .sp
|
|---|
| 74 | This command is a shortcut for \-M OWNER:name\&.
|
|---|
| 75 | .RE
|
|---|
| 76 | .PP
|
|---|
| 77 | \-G name
|
|---|
| 78 | .RS 4
|
|---|
| 79 | The group owner of a file or directory can be changed to the name given using the
|
|---|
| 80 | \fI\-G\fR
|
|---|
| 81 | 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\&.
|
|---|
| 82 | .sp
|
|---|
| 83 | This command is a shortcut for \-M GROUP:name\&.
|
|---|
| 84 | .RE
|
|---|
| 85 | .PP
|
|---|
| 86 | \-\-numeric
|
|---|
| 87 | .RS 4
|
|---|
| 88 | 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\&.
|
|---|
| 89 | .RE
|
|---|
| 90 | .PP
|
|---|
| 91 | \-t
|
|---|
| 92 | .RS 4
|
|---|
| 93 | Don\'t actually do anything, only validate the correctness of the arguments\&.
|
|---|
| 94 | .RE
|
|---|
| 95 | .PP
|
|---|
| 96 | \-h|\-\-help
|
|---|
| 97 | .RS 4
|
|---|
| 98 | Print a summary of command line options\&.
|
|---|
| 99 | .RE
|
|---|
| 100 | .PP
|
|---|
| 101 | \-d|\-\-debuglevel=level
|
|---|
| 102 | .RS 4
|
|---|
| 103 | \fIlevel\fR
|
|---|
| 104 | is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
|
|---|
| 105 | .sp
|
|---|
| 106 | 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\&.
|
|---|
| 107 | .sp
|
|---|
| 108 | 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\&.
|
|---|
| 109 | .sp
|
|---|
| 110 | Note that specifying this parameter here will override the
|
|---|
| 111 | \m[blue]\fB\%smb.conf.5.html#\fR\m[]
|
|---|
| 112 | parameter in the
|
|---|
| 113 | smb\&.conf
|
|---|
| 114 | file\&.
|
|---|
| 115 | .RE
|
|---|
| 116 | .PP
|
|---|
| 117 | \-V|\-\-version
|
|---|
| 118 | .RS 4
|
|---|
| 119 | Prints the program version number\&.
|
|---|
| 120 | .RE
|
|---|
| 121 | .PP
|
|---|
| 122 | \-s|\-\-configfile <configuration file>
|
|---|
| 123 | .RS 4
|
|---|
| 124 | 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
|
|---|
| 125 | smb\&.conf
|
|---|
| 126 | for more information\&. The default configuration file name is determined at compile time\&.
|
|---|
| 127 | .RE
|
|---|
| 128 | .PP
|
|---|
| 129 | \-l|\-\-log\-basename=logdirectory
|
|---|
| 130 | .RS 4
|
|---|
| 131 | Base directory name for log/debug files\&. The extension
|
|---|
| 132 | \fB"\&.progname"\fR
|
|---|
| 133 | will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
|
|---|
| 134 | .RE
|
|---|
| 135 | .SH "ACL FORMAT"
|
|---|
| 136 | .PP
|
|---|
| 137 | 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:
|
|---|
| 138 | .PP
|
|---|
| 139 | .if n \{\
|
|---|
| 140 | .RS 4
|
|---|
| 141 | .\}
|
|---|
| 142 | .nf
|
|---|
| 143 |
|
|---|
| 144 | REVISION:<revision number>
|
|---|
| 145 | OWNER:<sid or name>
|
|---|
| 146 | GROUP:<sid or name>
|
|---|
| 147 | ACL:<sid or name>:<type>/<flags>/<mask>
|
|---|
| 148 | .fi
|
|---|
| 149 | .if n \{\
|
|---|
| 150 | .RE
|
|---|
| 151 | .\}
|
|---|
| 152 | .PP
|
|---|
| 153 | 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\&.
|
|---|
| 154 | .PP
|
|---|
| 155 | The owner and group specify the owner and group sids for the object\&. If a SID in the format S\-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\&.
|
|---|
| 156 | .PP
|
|---|
| 157 | ACLs specify permissions granted to the SID\&. This SID again can be specified in S\-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\&.
|
|---|
| 158 | .PP
|
|---|
| 159 | The type can be either ALLOWED or DENIED to allow/deny 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:
|
|---|
| 160 | .sp
|
|---|
| 161 | .RS 4
|
|---|
| 162 | .ie n \{\
|
|---|
| 163 | \h'-04'\(bu\h'+03'\c
|
|---|
| 164 | .\}
|
|---|
| 165 | .el \{\
|
|---|
| 166 | .sp -1
|
|---|
| 167 | .IP \(bu 2.3
|
|---|
| 168 | .\}
|
|---|
| 169 | \fB#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1\fR
|
|---|
| 170 | .RE
|
|---|
| 171 | .sp
|
|---|
| 172 | .RS 4
|
|---|
| 173 | .ie n \{\
|
|---|
| 174 | \h'-04'\(bu\h'+03'\c
|
|---|
| 175 | .\}
|
|---|
| 176 | .el \{\
|
|---|
| 177 | .sp -1
|
|---|
| 178 | .IP \(bu 2.3
|
|---|
| 179 | .\}
|
|---|
| 180 | \fB#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2\fR
|
|---|
| 181 | .RE
|
|---|
| 182 | .sp
|
|---|
| 183 | .RS 4
|
|---|
| 184 | .ie n \{\
|
|---|
| 185 | \h'-04'\(bu\h'+03'\c
|
|---|
| 186 | .\}
|
|---|
| 187 | .el \{\
|
|---|
| 188 | .sp -1
|
|---|
| 189 | .IP \(bu 2.3
|
|---|
| 190 | .\}
|
|---|
| 191 | \fB#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4\fR
|
|---|
| 192 | .RE
|
|---|
| 193 | .sp
|
|---|
| 194 | .RS 4
|
|---|
| 195 | .ie n \{\
|
|---|
| 196 | \h'-04'\(bu\h'+03'\c
|
|---|
| 197 | .\}
|
|---|
| 198 | .el \{\
|
|---|
| 199 | .sp -1
|
|---|
| 200 | .IP \(bu 2.3
|
|---|
| 201 | .\}
|
|---|
| 202 | \fB#define SEC_ACE_FLAG_INHERIT_ONLY 0x8\fR
|
|---|
| 203 | .sp
|
|---|
| 204 | .RE
|
|---|
| 205 | .PP
|
|---|
| 206 | At present flags can only be specified as decimal or hexadecimal values\&.
|
|---|
| 207 | .PP
|
|---|
| 208 | 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\&.
|
|---|
| 209 | .sp
|
|---|
| 210 | .RS 4
|
|---|
| 211 | .ie n \{\
|
|---|
| 212 | \h'-04'\(bu\h'+03'\c
|
|---|
| 213 | .\}
|
|---|
| 214 | .el \{\
|
|---|
| 215 | .sp -1
|
|---|
| 216 | .IP \(bu 2.3
|
|---|
| 217 | .\}
|
|---|
| 218 | \fIR\fR
|
|---|
| 219 | \- Allow read access
|
|---|
| 220 | .RE
|
|---|
| 221 | .sp
|
|---|
| 222 | .RS 4
|
|---|
| 223 | .ie n \{\
|
|---|
| 224 | \h'-04'\(bu\h'+03'\c
|
|---|
| 225 | .\}
|
|---|
| 226 | .el \{\
|
|---|
| 227 | .sp -1
|
|---|
| 228 | .IP \(bu 2.3
|
|---|
| 229 | .\}
|
|---|
| 230 | \fIW\fR
|
|---|
| 231 | \- Allow write access
|
|---|
| 232 | .RE
|
|---|
| 233 | .sp
|
|---|
| 234 | .RS 4
|
|---|
| 235 | .ie n \{\
|
|---|
| 236 | \h'-04'\(bu\h'+03'\c
|
|---|
| 237 | .\}
|
|---|
| 238 | .el \{\
|
|---|
| 239 | .sp -1
|
|---|
| 240 | .IP \(bu 2.3
|
|---|
| 241 | .\}
|
|---|
| 242 | \fIX\fR
|
|---|
| 243 | \- Execute permission on the object
|
|---|
| 244 | .RE
|
|---|
| 245 | .sp
|
|---|
| 246 | .RS 4
|
|---|
| 247 | .ie n \{\
|
|---|
| 248 | \h'-04'\(bu\h'+03'\c
|
|---|
| 249 | .\}
|
|---|
| 250 | .el \{\
|
|---|
| 251 | .sp -1
|
|---|
| 252 | .IP \(bu 2.3
|
|---|
| 253 | .\}
|
|---|
| 254 | \fID\fR
|
|---|
| 255 | \- Delete the object
|
|---|
| 256 | .RE
|
|---|
| 257 | .sp
|
|---|
| 258 | .RS 4
|
|---|
| 259 | .ie n \{\
|
|---|
| 260 | \h'-04'\(bu\h'+03'\c
|
|---|
| 261 | .\}
|
|---|
| 262 | .el \{\
|
|---|
| 263 | .sp -1
|
|---|
| 264 | .IP \(bu 2.3
|
|---|
| 265 | .\}
|
|---|
| 266 | \fIP\fR
|
|---|
| 267 | \- Change permissions
|
|---|
| 268 | .RE
|
|---|
| 269 | .sp
|
|---|
| 270 | .RS 4
|
|---|
| 271 | .ie n \{\
|
|---|
| 272 | \h'-04'\(bu\h'+03'\c
|
|---|
| 273 | .\}
|
|---|
| 274 | .el \{\
|
|---|
| 275 | .sp -1
|
|---|
| 276 | .IP \(bu 2.3
|
|---|
| 277 | .\}
|
|---|
| 278 | \fIO\fR
|
|---|
| 279 | \- Take ownership
|
|---|
| 280 | .sp
|
|---|
| 281 | .RE
|
|---|
| 282 | .PP
|
|---|
| 283 | The following combined permissions can be specified:
|
|---|
| 284 | .sp
|
|---|
| 285 | .RS 4
|
|---|
| 286 | .ie n \{\
|
|---|
| 287 | \h'-04'\(bu\h'+03'\c
|
|---|
| 288 | .\}
|
|---|
| 289 | .el \{\
|
|---|
| 290 | .sp -1
|
|---|
| 291 | .IP \(bu 2.3
|
|---|
| 292 | .\}
|
|---|
| 293 | \fIREAD\fR
|
|---|
| 294 | \- Equivalent to \'RX\' permissions
|
|---|
| 295 | .RE
|
|---|
| 296 | .sp
|
|---|
| 297 | .RS 4
|
|---|
| 298 | .ie n \{\
|
|---|
| 299 | \h'-04'\(bu\h'+03'\c
|
|---|
| 300 | .\}
|
|---|
| 301 | .el \{\
|
|---|
| 302 | .sp -1
|
|---|
| 303 | .IP \(bu 2.3
|
|---|
| 304 | .\}
|
|---|
| 305 | \fICHANGE\fR
|
|---|
| 306 | \- Equivalent to \'RXWD\' permissions
|
|---|
| 307 | .RE
|
|---|
| 308 | .sp
|
|---|
| 309 | .RS 4
|
|---|
| 310 | .ie n \{\
|
|---|
| 311 | \h'-04'\(bu\h'+03'\c
|
|---|
| 312 | .\}
|
|---|
| 313 | .el \{\
|
|---|
| 314 | .sp -1
|
|---|
| 315 | .IP \(bu 2.3
|
|---|
| 316 | .\}
|
|---|
| 317 | \fIFULL\fR
|
|---|
| 318 | \- Equivalent to \'RWXDPO\' permissions
|
|---|
| 319 | .SH "EXIT STATUS"
|
|---|
| 320 | .PP
|
|---|
| 321 | The
|
|---|
| 322 | smbcacls
|
|---|
| 323 | 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\&.
|
|---|
| 324 | .PP
|
|---|
| 325 | If the operation succeeded, smbcacls returns and exit status of 0\&. If
|
|---|
| 326 | smbcacls
|
|---|
| 327 | 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\&.
|
|---|
| 328 | .SH "VERSION"
|
|---|
| 329 | .PP
|
|---|
| 330 | This man page is correct for version 3 of the Samba suite\&.
|
|---|
| 331 | .SH "AUTHOR"
|
|---|
| 332 | .PP
|
|---|
| 333 | 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\&.
|
|---|
| 334 | .PP
|
|---|
| 335 | smbcacls
|
|---|
| 336 | was written by Andrew Tridgell and Tim Potter\&.
|
|---|
| 337 | .PP
|
|---|
| 338 | 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\&.
|
|---|
