ACL_SET_FILE(3)

πŸ’– ACL_SET_FILE(3) β€” bestie, we're setting ACLs by filename πŸ’–

okay so real talk: this is a page from the Library Functions Manual, and it's literally all about acl_set_file and acl_set_file_at. Two little functions. Massive main character energy. Let's get into it 🫢


✨ NAME ✨

acl_set_file, acl_set_file_at β€” set an ACL by filename


🌸 LIBRARY 🌸

Linux Access Control Lists library (libacl, -lacl).


πŸŽ€ SYNOPSIS πŸŽ€

#include <sys/types.h>
#include <sys/acl.h>

int
acl_set_file(const char *path_p, acl_type_t type, acl_t acl);

int
acl_set_file_at(int dirfd, const char *path_p, int at_flags,
    acl_type_t type, acl_t acl);

πŸ’… DESCRIPTION πŸ’…

So acl_set_file() does one of two things, depending on the vibes you send it: it associates an access ACL with a file or directory, or it associates a default ACL with a directory. The pathname for whatever file or directory you're targeting goes in the argument path_p. And heads up β€” if path_p is a symbolic link, acl_set_file() operates on the file or directory the link refers to. No sneaky link-tricking around here πŸ’€

Also, permission check: the effective user ID of the process must match the owner of the file or directory, or the process must have the CAP_FOWNER capability, otherwise the request is not gonna succeed. Sorry bestie, that's just the rules.

The argument type is what tells the function whether you're setting the access ACL or the default ACL associated with path_p. If type is ACL_TYPE_ACCESS, the access ACL of path_p shall be set. If type is ACL_TYPE_DEFAULT, the default ACL of path_p shall be set. And if type specifies a type of ACL that cannot be associated with path_p? Then the function fails. Periodt. 😭

The acl parameter must reference a valid ACL according to the rules described on the acl_valid(3) manual page β€” that's required if type is ACL_TYPE_ACCESS. If type is ACL_TYPE_DEFAULT, it must either reference a valid ACL or an ACL with zero ACL entries. And here's the iconic part: if acl references an empty ACL, then acl_set_file() removes any default ACL associated with the directory referred to by path_p. Empty ACL = yeet the default ACL ✨

πŸ¦‹ acl_set_file_at() πŸ¦‹

acl_set_file_at() operates in exactly the same way as acl_set_file(), except for the differences described right here. Same energy, tiny plot twists:

  • If the pathname given in path_p is relative, then it is interpreted relative to the directory referred to by the file descriptor dirfd β€” rather than relative to the current working directory of the calling process, as is done by acl_set_file().
  • If path_p is relative and dirfd is the special value AT_FDCWD, then path_p is interpreted relative to the current working directory of the calling process (like acl_set_file() does).
  • If path_p is absolute, then dirfd is ignored. Bye dirfd πŸ‘‹

The at_flags argument can either be 0, or include one or more of the following flags ORed together:

  • AT_EMPTY_PATH β€” If path_p is an empty string, operate on the file referred to by dirfd (which may have been obtained using the open(2) O_PATH flag). In this case, dirfd can refer to any type of file, not just a directory, and the behavior of acl_set_file_at() is similar to that of acl_set_fd().
  • AT_SYMLINK_NOFOLLOW β€” If path_p refers to a symbolic link, do not dereference it: instead, fail the operation and set the global variable errno to ENOTSUP. This indicates that the symbolic link cannot have ACLs.

⭐ RETURN VALUE ⭐

The acl_set_file() and acl_set_file_at() functions return the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error. That's it, that's the whole story.


πŸ”₯ ERRORS πŸ”₯

If any of the following conditions occur, the acl_set_file() and acl_set_file_at() functions return -1 and set errno to the corresponding value:

  • [EACCES]
    • Search permission is denied for a component of the path prefix or the object exists and the process does not have appropriate access rights.
    • Argument type specifies a type of ACL that cannot be associated with path_p.
  • [EBADF] β€” The argument path_p is relative but the argument dirfd is neither AT_FDCWD nor a valid file descriptor.
  • [EINVAL]
    • The argument acl does not point to a valid ACL.
    • The ACL has more entries than the file referred to by path_p can obtain.
    • The type parameter is not ACL_TYPE_ACCESS or ACL_TYPE_DEFAULT.
    • The type parameter is ACL_TYPE_DEFAULT, but the file referred to by path_p is not a directory.
    • An invalid flag was specified in the at_flags argument.
  • [ENAMETOOLONG] β€” The length of the argument path_p is too long.
  • [ENOENT] β€” The named object does not exist or the argument path_p points to an empty string.
  • [ENOSPC] β€” The directory or file system that would contain the new ACL cannot be extended or the file system is out of file allocation resources.
  • [ENOTDIR]
    • A component of the path prefix is not a directory.
    • The argument path_p is relative and the argument dirfd is a file descriptor referring to a file other than a directory.
  • [ENOTSUP]
    • The argument at_flags includes the flag AT_SYMLINK_NOFOLLOW and path_p is a symbolic link.
    • The file identified by path_p cannot be associated with the ACL because the file system on which the file is located does not support this.
  • [EPERM] β€” The process does not have appropriate privilege to perform the operation to set the ACL.
  • [EROFS] β€” This function requires modification of a file system which is currently read-only.

🌈 STANDARDS 🌈

IEEE Std 1003.1e draft 17 (β€œPOSIX.1e”, abandoned) β€” yeah, abandoned, we don't talk about it πŸ’€

The behavior of acl_set_file() when the acl parameter refers to an empty ACL and the type parameter is ACL_TYPE_DEFAULT is an extension in the Linux implementation, in order that all values returned by acl_get_file() can be passed to acl_set_file(). The POSIX.1e function for removing a default ACL is acl_delete_def_file().

Function acl_get_file_at() is a Linux specific extension.


πŸ’œ SEE ALSO πŸ’œ

acl_delete_def_file(3), acl_get_file(3), acl_set_fd(3), acl_valid(3), acl(5)


πŸ‘‘ AUTHOR πŸ‘‘

Derived from the FreeBSD manual pages written by Robert N M Watson <rwatson@FreeBSD.org>, and adapted for Linux by Andreas Gruenbacher <andreas.gruenbacher@gmail.com>.


and that's the whole page, bestie πŸŽ€ this one's from the Linux ACL collection, dated June 5, 2026 β€” go forth and set those ACLs responsibly, mwah πŸ’–βœ¨

πŸ“¦ where this page comes from