Blame setcifsacl.rst.in

Packit Service 09cdfc
==========
Packit Service 09cdfc
setcifsacl
Packit Service 09cdfc
==========
Packit Service 09cdfc
Packit Service 09cdfc
------------------------------------------------------------------------------------------------
Packit Service 09cdfc
Userspace helper to alter an ACL in a security descriptor for Common Internet File System (CIFS)
Packit Service 09cdfc
------------------------------------------------------------------------------------------------
Packit Service 09cdfc
:Manual section: 1
Packit Service 09cdfc
Packit Service 09cdfc
********
Packit Service 09cdfc
SYNOPSIS
Packit Service 09cdfc
********
Packit Service 09cdfc
Packit Service 664a73
  setcifsacl [-v|-a|-D|-M|-S] "{one or more ACEs}" {file system object}
Packit Service 09cdfc
Packit Service 09cdfc
***********
Packit Service 09cdfc
DESCRIPTION
Packit Service 09cdfc
***********
Packit Service 09cdfc
Packit Service 09cdfc
This tool is part of the cifs-utils suite.
Packit Service 09cdfc
Packit Service 664a73
``setcifsacl`` is a userspace helper program for the Linux CIFS client
Packit Service 664a73
file system. It is intended to alter an ACL of a security descriptor
Packit Service 664a73
for a file system object. Whether a security descriptor to be set is
Packit Service 09cdfc
applied or not is determined by the CIFS/SMB server.
Packit Service 09cdfc
Packit Service 09cdfc
This program uses a plugin to handle the mapping of user and group
Packit Service 664a73
names to SIDs. *@pluginpath@* should be a symlink that points to the
Packit Service 09cdfc
correct plugin to use.
Packit Service 09cdfc
Packit Service 09cdfc
*******
Packit Service 09cdfc
OPTIONS
Packit Service 09cdfc
*******
Packit Service 09cdfc
Packit Service 664a73
-h
Packit Service 664a73
  Print usage message and exit.
Packit Service 09cdfc
Packit Service 664a73
-v
Packit Service 664a73
  Print version number and exit.
Packit Service 09cdfc
Packit Service 664a73
-a
Packit Service 664a73
  Add one or more ACEs to an ACL of a security descriptor.  An ACE is
Packit Service 664a73
  added even if the same ACE exists in the ACL.
Packit Service 09cdfc
Packit Service 664a73
-D
Packit Service 664a73
 Delete one or more ACEs from an ACL of a security descriptor.  Entire
Packit Service 664a73
 ACE has to match in an existing ACL for the listed ACEs to be deleted.
Packit Service 09cdfc
Packit Service 664a73
-M
Packit Service 664a73
  Modify one or more ACEs from an ACL of a security descriptor.  SID and
Packit Service 664a73
  type are used to match for existing ACEs to be modified with the list
Packit Service 664a73
  of ACEs specified.
Packit Service 09cdfc
Packit Service 664a73
-S
Packit Service 664a73
  Set an ACL of security descriptor with the list of ACEs Existing ACL
Packit Service 664a73
  is replaced entirely with the specified ACEs.
Packit Service 09cdfc
Packit Service 664a73
  Every ACE entry starts with "ACL:" One or more ACEs are specified
Packit Service 664a73
  within double quotes.  Multiple ACEs are separated by a comma.
Packit Service 09cdfc
Packit Service 664a73
  Following fields of an ACE can be modified with possible values:
Packit Service 09cdfc
Packit Service 664a73
  - ``SID`` - Either a name or a raw SID value.
Packit Service 664a73
  - ``type`` - ALLOWED (0x0), DENIED (0x1), OBJECT_ALLOWED (0x5), OBJECT_DENIED (0x6)
Packit Service 664a73
  - ``flags`` - OBJECT_INHERIT_FLAG (OI or 0x1),
Packit Service 664a73
    CONTAINER_INHERIT_FLAG (CI or 0x2), NO_PROPAGATE_INHERIT_FLAG (NI
Packit Service 664a73
    or 0x4), INHERIT_ONLY_FLAG (IO or 0x8), INHERITED_ACE_FLAG (IA or
Packit Service 664a73
    0x10) or a combination/OR of these values.
Packit Service 664a73
  - ``mask``  - Either one of FULL, CHANGE, READ, a combination of R W X D P O, or a hex value.
Packit Service 09cdfc
Packit Service 09cdfc
********
Packit Service 09cdfc
EXAMPLES
Packit Service 09cdfc
********
Packit Service 09cdfc
Packit Service 09cdfc
Add an ACE
Packit Service 09cdfc
==========
Packit Service 09cdfc
Packit Service 664a73
  setcifsacl -a "ACL:CIFSTESTDOM\user2:DENIED/0x1/D" <file_name>
Packit Service 664a73
  setcifsacl -a "ACL:CIFSTESTDOM\user1:ALLOWED/OI|CI|NI/D" <file_name>
Packit Service 09cdfc
Packit Service 09cdfc
Delete an ACE
Packit Service 09cdfc
=============
Packit Service 09cdfc
Packit Service 664a73
  setcifsacl -D "ACL:S-1-1-0:0x1/OI/0x1201ff" <file_name>
Packit Service 09cdfc
Packit Service 09cdfc
Modify an ACE
Packit Service 09cdfc
=============
Packit Service 09cdfc
Packit Service 664a73
  setcifsacl -M "ACL:CIFSTESTDOM\user1:ALLOWED/0x1f/CHANGE" <file_name>
Packit Service 09cdfc
Packit Service 09cdfc
Set an ACL
Packit Service 09cdfc
==========
Packit Service 09cdfc
Packit Service 664a73
  setcifsacl -S "ACL:CIFSTESTDOM\Administrator:0x0/0x0/FULL,ACL:CIFSTESTDOM\user2:0x0/0x0/FULL" <file_name>
Packit Service 09cdfc
Packit Service 09cdfc
*****
Packit Service 09cdfc
NOTES
Packit Service 09cdfc
*****
Packit Service 09cdfc
Packit Service 09cdfc
Kernel support for getcifsacl/setcifsacl utilities was initially
Packit Service 09cdfc
introduced in the 2.6.37 kernel.
Packit Service 09cdfc
Packit Service 09cdfc
********
Packit Service 09cdfc
SEE ALSO
Packit Service 09cdfc
********
Packit Service 09cdfc
Packit Service 09cdfc
mount.cifs(8), getcifsacl(1)
Packit Service 09cdfc
Packit Service 09cdfc
******
Packit Service 09cdfc
AUTHOR
Packit Service 09cdfc
******
Packit Service 09cdfc
Packit Service 09cdfc
Shirish Pargaonkar wrote the setcifsacl program.
Packit Service 09cdfc
Packit Service 09cdfc
The Linux CIFS Mailing list is the preferred place to ask questions
Packit Service 09cdfc
regarding these programs.