View source for File Permissions Basics and ACL

This is an overview of how file permissions and Access-control Lists (ACL) work on POSIX-based file systems. This forms a primer to understanding how exactly the actions in [[Setting Default File Permissions]] work and how to debug them.

In short, ACL helps to control which users can read, write, or execute certain file objects, which are defined as anything in the file system (regular files, directories, symlinks, etc.). Note that ACL does ''not'' have complete authority on ''creating'' permissions for new file objects. 

In analogy, ACL is akin to the guest list at a club. Continuing the analogy, the OS kernel is the bouncer of the club, determining who can get in to which section of the club based on the ACL.

Much of the information presented here is written out in the [https://linux.die.net/man/5/acl ACL manpage]. This wiki hopefully serves as a primer for that manpage, as the terms it uses are different than the ones that are commonly presented and used when dealing with normal file permissions. I recommend reading the manpage if you're having to debug a permissions issue. It's not too long.

== Basics of Unix/POSIX File Permissions ==

=== What are they? ===

* All files and directories have permissions assigned to them via ACL entries
* There are three different "levels" of file permissions in a standard POSIX file system: read (<code>r</code>), write (<code>w</code>), and execute (<code>x</code>). 
** Read allows viewing the contents of the file/directory, and copying the files
** Write allows rewriting and deleting files. For a directory with write permissions, it also allows creation of subdirectories and creation of new files
** Execute allows files to be executed directly. 
*** Note that for script files (such as <code>bash</code> or <code>python</code>), they can still be run by passing the file to it's interpreter if the file is readable (ie. <code>bash non_executableScript.sh</code> is still possible if <code>non_executableScript.sh</code> has <code>rw-</code> permissions).
* ACL entries apply the three different "levels" of file permission onto 6 possible tags. From the ACL manpage, they are:

 ACL_USER_OBJ    The ACL_USER_OBJ entry denotes access rights for the file owner.
 
 ACL_USER        ACL_USER entries denote access rights for users identified by the entry's qualifier.
 
 ACL_GROUP_OBJ   The ACL_GROUP_OBJ entry denotes access rights for the file group.
 
 ACL_GROUP       ACL_GROUP entries denote access rights for groups identified by the entry's qualifier.
 
 ACL_MASK        The ACL_MASK entry denotes the maximum access rights that can be granted by entries of type ACL_USER, ACL_GROUP_OBJ, or ACL_GROUP.
 
 ACL_OTHER       The ACL_OTHER entry denotes access rights for processes that do not match any other entry in the ACL.

:*<code>ACL_USER_OBJ</code>, <code>ACL_GROUP_OBJ</code>, and <code>ACL_OTHER</code> correspond to the standard three user categories: file owner, file group, and "other". These three categories are the ones listed by <code>ls -l</code>. 
:**The file owner and file group are set to the user that originally created the file and their respective user group (though this can be changed using <code>chown</code>).
:*"Others" simply refers to all other users that are not the file owner and are not members of the file group. 
:*The other three tags, <code>ACL_MASK</code>, <code>ACL_GROUP</code>, and <code>ACL_USER</code>, are only used for [[File_Permissions_Basics_and_ACL#Custom Permissions|custom ACL entries]] that are set by a user.
:** Additionally, <code>ACL_MASK</code> is only required if <code>ACL_GROUP</code> or <code>ACL_USER</code> entries are utilized.

* The file permissions for <code>ACL_USER_OBJ</code>, <code>ACL_GROUP_OBJ</code>, and <code>ACL_OTHER</code> together form the file <code>mode</code> parameter
** This parameter is used by programs to set the permissions of files they create. This is discussed further in [[File_Permissions_Basics_and_ACL#Custom Permissions|the Custom Permissions section]].

==== Viewing Them ====

===== Using ls =====
The simplest and most common way of viewing the basic permissions of a file is by using <code>ls</code>. As an example, if you run <code>ls -l</code> on a directory, you might see:

 drwxr-x---+ 2 jrwrigh7 a1983 4.0K 2020-07-04 08:09 test2
 -rw-r-x---+ 1 jrwrigh7 a1983   38 2020-07-02 12:38 test2file
 lrwxrwxrwx  1 jrwrigh7 a1983    9 2020-07-04 08:40 test2fileLink -> test2file


The first block (<code>-rw-r-x---+</code>) shows the permissions of the file for the three primary ACL tags (<code>ACL_USER_OBJ</code>, <code>ACL_GROUP_OBJ</code>, and <code>ACL_OTHER</code>). (described below). The file owner is shown as <code>jrwrigh7</code> and the file group is <code>a1983</code>. These correspond to <code>ACL_USER_OBJ</code> and <code>ACL_GROUP_OBJ</code>.

'''Permissions Block:'''
* First character displays what kind of file it is, be it a link (<code>l</code>), directory (<code>d</code>), regular file (<code>-</code>), etc.
* The next 9 characters show the permissions for the <code>ACL_USER_OBJ</code>, <code>ACL_GROUP_OBJ</code>, and <code>ACL_OTHER</code>
** So for <code>test2file</code> in the above output:
*** File Owner: <code>rw-</code>
*** File Group: <code>r-x</code>
*** Others: <code>---</code>
* The last character is optional. A <code>+</code> means that there are other permission rules not displayed. This is where [[Setting_Default_File_Permissions#Setting ACL Rules|ACL rules]] come into play. 

See [https://www.gnu.org/software/coreutils/manual/html_node/What-information-is-listed.html#What-information-is-listed the ls coreutils manual] for more information on the 'long' format for <code>ls</code>.

===== Using getfacl =====

You can also use <code>getfacl</code> to get a more detailed look at the permissions of a file or directory. Simply running <code>getfacl</code> with a file object as it's argument will show the permissions for that file object:

 $ getfacl test2file
 # file: test2file
 # owner: jrwrigh7
 # group: a1983
 user::rw-
 group::r-x
 group:a1983:r-x
 mask::r-x
 other::---

This argument will show all permissions for a file object, including custom ones. <code>user::</code>, <code>group::</code>, and <code>other::</code> refer to the permissions set for the <code>ACL_USER_OBJ</code>, <code>ACL_GROUP_OBJ</code>, and <code>ACL_OTHER</code>. 

To set more specific permissions, a group or user can be inserted between the colons. This can be seen in the line <code>group:a1983:</code> where the members of the group have <code>r-x</code> permissions to the file. These permissions fall under the <code>ACL_USER</code> and <code>ACL_GROUP</code> tags.

If default ACL entries are used, they will also be displayed using <code>getfacl</code>. An example is presented below for the directory <code>test</code> (note that default ACL entries can ''only'' be applied to directories):

 $ getfacl test
 # file: test
 # owner: jrwrigh7
 # group: a1983
 user::rwx
 group::r-x
 group:a1983:r-x
 mask::r-x
 other::---
 default:user::rwx
 default:group::r-x
 default:group:a1983:r-x
 default:mask::r-x
 default:other::---

=== Permissions as Octal Numbers ===
The file <code>mode</code> is often conveyed in the form of three octal numbers (ie. base 8 numbers). It is very similar to how PHASTA handles specifying boundary conditions using bitwise logic.
The first bit handles read, the second bit handles write, and the third handles execute. 

{| class="wikitable" style="text-align:center;"
|-
! style="text-align:left;" | Permissions
! Execute bit
! Write Bit
! Read Bit
! Octal Number equivalent
|-
| style="text-align:left;" | <code>---</code>
| 0
| 0
| 0
| 0
|-
| style="text-align:left;" | <code>--x</code>
| 1
| 0
| 0
| 1
|-
| style="text-align:left;" | <code>-w-</code>
| 0
| 1
| 0
| 2
|-
| style="text-align:left;" | <code>-wx</code>
| 1
| 1
| 0
| 3
|-
| style="text-align:left;" | <code>r--</code>
| 0
| 0
| 1
| 4
|-
| style="text-align:left;" | <code>r-x</code>
| 1
| 0
| 1
| 5
|-
| style="text-align:left;" | <code>rw-</code>
| 0
| 1
| 1
| 6
|-
| style="text-align:left;" | <code>rwx</code>
| 1
| 1
| 1
| 7
|}

Using <code>test2file</code> as the example permissions block, it is stored as <code>110 101 000</code>. When translated into decimal, that equals <code>3 5 0</code>. 

Another way to think about it is that the octal number equivalent of a permission set = 1*x + 2*w + 4*r, where r, w, and x equal 1 or 0 depending on whether they're set or not.

== Custom Permissions ==

The other two tags, <code>ACL_GROUP</code> and <code>ACL_USER</code>, are for more custom permissions and are not set by default on a blank system. 
Different sets of permissions can be set on a per user and per group basis. 
For more information on complex interactions (ie. if a user has permissions set and is a member of a group that has its own custom permissions), I recommend seeing the ACL manpage section on the [https://linux.die.net/man/5/acl Access Check Algorithm]

=== What determines the permissions for a new file? ===

When a new file object is created, a new set of ACL entries must be created for that file object. There are three sources that determine what ACL entries will be set; <code>umask</code>, the "mode" parameter used by the program creating the file, and ACL entries of the parent directory of the file object being created.

==== umask ====

<code>umask</code> is a function that contains file permission settings for any file created by a user and it is unique to the user. The user can change it at anytime using the <code>umask</code> command. To see what it is set to, simply run <code>umask</code> with no arguments.

==== "Mode" Parameter ====

When a new file is created, the <code>syscall</code> <code>open()</code> (among others) is used and a file mode parameter must be chosen by that program. For example, `touch` will automatically apply the mode <code>666</code> to the file, which will make the file owner, file group, and "others" all have <code>rw-</code> permissions.

==== ACL Defaults ====

ACL default entries are set for a directory and are used for files and subdirectories created inside that directory. Note that ACL default entries can ''only'' be set for directories. 

=== How are new file permissions set? ===
This is simply a paraphrasing/rewording of the "Object Creation and Default ACLs" section of the [https://linux.die.net/man/5/acl ACL manpage].

When creating a file/subdirectory in a parent directory:

* If the parent directory '''does have default ACL rules''', only the ACL default entries of the parent directory and "mode" parameter are used:
** The new file/subdirectory first inherits the ACL default entries of its parent directory as its normal ACL entries
** The new file/subdirectory has its ACL entries adjusted such that no permissions exceed the "mode" parameter. 
*** The <code>ACL_USER_OBJ</code> and <code>ACL_OTHER</code> are changed directly
*** The <code>ACL_GROUP</code>, <code>ACL_GROUP_OBJ</code>, and <code>ACL_USER</code> are changed ''through'' adjusting the <code>ACL_MASK</code>
** Additionally, if a new subdirectory is created, it will inherit its parents default ACL rules. Note that a file ''cannot'' have default ACL rules set.

* If the parent directory '''does not have default ACL rules''', only <code>umask</code> and "mode" parameter are used:
** The new file/subdirectory's <code>ACL_USER_OBJ</code>, <code>ACL_GROUP_OBJ</code>, and <code>ACL_OTHER</code> are set based on the permissions set by <code>umask</code>
** The new file/subdirectory's are then adjusted to limit permissions to be no looser than the "mode" parameter

Note that this all means that if you have a default ACL rule that gives execute permissions to a group, the group will ''not'' have execute permissions by default ''unless'' the "mode" parameter also has execute permissions. Most compilers will use the execute permission bit for the "mode" parameter of it's executable, but other files will not.