setcifsacl.1.in

   1 '\" t
   2 .\"     Title: cifs.idmap
   3 .\"    Author: [see the "AUTHOR" section]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 08/19/2011
   6 .\"    Manual: System Administration tools
   7 .\"    Source: cifs-utils 4.0
   8 .\"  Language: English
   9 .\"
  10 .TH "SETCIFSACL" "1" "08/19/2011" "cifs-utils" "CIFS Access Control List Tools"
  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 setcifsacl \- Userspace helper to alter an ACL in a security descriptor for Common Internet File System (CIFS)
  23 .SH "SYNOPSIS"
  24 .HP \w'\ 'u
  25 setcifsacl [\-v|\-a|\-D|\-M|\-S] "{one or more ACEs}" {file system object}
  26 .SH "DESCRIPTION"
  27 .PP
  28 This tool is part of the cifs-utils suite\&.
  29 .PP
  30 setcifsacl is a userspace helper program for the Linux CIFS client file system.  It is intended to alter an ACL of a security descriptor for a file system object.
  31 Whether a security descriptor to be set is applied or not is determined by the CIFS/SMB server.
  32 .PP
  33 This program uses a plugin to handle the mapping of user and group names to SIDs. \fB@pluginpath@\fR should be a symlink that points to the correct plugin to use.
  34 .SH "OPTIONS"
  35 .PP
  36 -h
  37 .RS 4
  38 Print usage message and exit.
  39 .RE
  40 \-v
  41 .RS 4
  42 Print version number and exit\&.
  43 .RE
  44 \-a
  45 .RS 4
  46 Add one or more ACEs to an ACL of a security descriptor.
  47 An ACE is added even if the same ACE exists in the ACL.
  48 .RE
  49 \-D
  50 .RS 4
  51 Delete one or more ACEs from an ACL of a security descriptor.
  52 Entire ACE has to match in an existing ACL for the listed ACEs to be deleted.
  53 .RE
  54 \-M
  55 .RS 4
  56 Modify one or more ACEs from an ACL of a security descriptor.
  57 SID and type are used to match for existing ACEs to be modified with the list of ACEs specified.
  58 .RE
  59 \-S
  60 .RS 4
  61 Set an ACL of security descriptor with the list of ACEs
  62 Existing ACL is replaced entirely with the specified ACEs.
  63 .RE
  64 .PP
  65 Every ACE entry starts with "ACL:"
  66 One or more ACEs are specified within double quotes.
  67 Multiple ACEs are separated by a comma.
  68 .PP
  69 Following fields of an ACE can be modified with possible values:
  70 .PP
  71 SID: Either a name or a raw SID value.
  72 .PP
  73 type: ALLOWED (0x0), DENIED (0x1), OBJECT_ALLOWED (0x5), OBJECT_DENIED (0x6)
  74 .PP
  75 flags: OBJECT_INHERIT_FLAG (OI or 0x1), CONTAINER_INHERIT_FLAG (CI or 0x2), NO_PROPAGATE_INHERIT_FLAG (NI or 0x4), INHERIT_ONLY_FLAG (IO or 0x8), INHERITED_ACE_FLAG (IA or 0x10) or a combination/OR of these values.
  76 .PP
  77 mask: Either one of FULL, CHANGE, READ, a combination of R W X D P O, or a hex value
  78 .SH "EXAMPLES"
  79 .PP
  80 Add an ACE
  81 .br
  82 setcifsacl -a "ACL:CIFSTESTDOM\\user2:DENIED/0x1/D" <file_name>
  83 setcifsacl -a "ACL:CIFSTESTDOM\\user1:ALLOWED/OI|CI|NI/D" <file_name>
  84 .PP
  85 Delete an ACE
  86 .br
  87 setcifsacl -D "ACL:S-1-1-0:0x1/OI/0x1201ff" <file_name>
  88 .PP
  89 Modify an ACE
  90 .br
  91 setcifsacl -M "ACL:CIFSTESTDOM\\user1:ALLOWED/0x1f/CHANGE" <file_name>
  92 .PP
  93 Set an ACL
  94 .br
  95 setcifsacl -S "ACL:CIFSTESTDOM\\Administrator:0x0/0x0/FULL,
  96 .br
  97 ACL:CIFSTESTDOM\\user2:0x0/0x0/FULL" <file_name>
  98 .PP
  99 .SH "NOTES"
 100 .PP
 101 Kernel support for getcifsacl/setcifsacl utilities was initially introduced in the 2.6.37 kernel.
 102 .SH "SEE ALSO"
 103 .PP
 104 \fBmount.cifs\fR(8),
 105 \fBgetcifsacl\fR(1)
 106 .PP
 107 .SH "AUTHOR"
 108 .PP
 109 Shirish Pargaonkar wrote the setcifsacl program\&.
 110 .PP
 111 The
 112 Linux CIFS Mailing list
 113 is the preferred place to ask questions regarding these programs\&.