2 * @file apply-default-acl.c
4 * @brief The entire implementation.
8 /* On Linux, ftw.h needs this special voodoo to work. */
9 #define _XOPEN_SOURCE 500
13 #include <fcntl.h> /* AT_FOO constants */
14 #include <ftw.h> /* nftw() et al. */
16 #include <libgen.h> /* basename(), dirname() */
25 #include <acl/libacl.h> /* acl_get_perm, not portable */
26 #include <sys/types.h>
29 /* Most of the libacl functions return 1 for success, 0 for failure,
39 * @brief Determine whether or not the given path is accessible.
44 * @return true if @c path is accessible to the current effective
45 * user/group, false otherwise.
47 bool path_accessible(const char* path
) {
52 /* Test for access using the effective user and group rather than
54 int flags
= AT_EACCESS
;
56 /* Don't follow symlinks when checking for a path's existence,
57 since we won't follow them to set its ACLs either. */
58 flags
|= AT_SYMLINK_NOFOLLOW
;
60 /* If the path is relative, interpret it relative to the current
61 working directory (just like the access() system call). */
62 if (faccessat(AT_FDCWD
, path
, F_OK
, flags
) == 0) {
73 * @brief Determine whether or not the given path is a directory.
78 * @return true if @c path is a directory, false otherwise.
80 bool is_path_directory(const char* path
) {
86 if (lstat(path
, &s
) == 0) {
87 return S_ISDIR(s
.st_mode
);
98 * @brief Update (or create) an entry in an @b minimal ACL.
100 * This function will not work if @c aclp contains extended
101 * entries. This is fine for our purposes, since we call @c wipe_acls
102 * on each path before applying the default to it.
104 * The assumption that there are no extended entries makes things much
105 * simpler. For example, we only have to update the @c ACL_USER_OBJ,
106 * @c ACL_GROUP_OBJ, and @c ACL_OTHER entries -- all others can simply
107 * be created anew. This means we don't have to fool around comparing
108 * named-user/group entries.
111 * A pointer to the acl_t structure whose entry we want to modify.
114 * The new entry. If @c entry contains a user/group/other entry, we
115 * update the existing one. Otherwise we create a new entry.
117 * @return If there is an unexpected library error, @c ACL_ERROR is
118 * returned. Otherwise, @c ACL_SUCCESS.
121 int acl_set_entry(acl_t
* aclp
, acl_entry_t entry
) {
124 if (acl_get_tag_type(entry
, &entry_tag
) == ACL_ERROR
) {
125 perror("acl_set_entry (acl_get_tag_type)");
129 acl_permset_t entry_permset
;
130 if (acl_get_permset(entry
, &entry_permset
) == ACL_ERROR
) {
131 perror("acl_set_entry (acl_get_permset)");
135 acl_entry_t existing_entry
;
136 /* Loop through the given ACL looking for matching entries. */
137 int result
= acl_get_entry(*aclp
, ACL_FIRST_ENTRY
, &existing_entry
);
139 while (result
== ACL_SUCCESS
) {
140 acl_tag_t existing_tag
= ACL_UNDEFINED_TAG
;
142 if (acl_get_tag_type(existing_entry
, &existing_tag
) == ACL_ERROR
) {
143 perror("set_acl_tag_permset (acl_get_tag_type)");
147 if (existing_tag
== entry_tag
) {
148 if (entry_tag
== ACL_USER_OBJ
||
149 entry_tag
== ACL_GROUP_OBJ
||
150 entry_tag
== ACL_OTHER
) {
151 /* Only update for these three since all other tags will have
152 been wiped. These three are guaranteed to exist, so if we
153 match one of them, we're allowed to return ACL_SUCCESS
154 below and bypass the rest of the function. */
155 acl_permset_t existing_permset
;
156 if (acl_get_permset(existing_entry
, &existing_permset
) == ACL_ERROR
) {
157 perror("acl_set_entry (acl_get_permset)");
161 if (acl_set_permset(existing_entry
, entry_permset
) == ACL_ERROR
) {
162 perror("acl_set_entry (acl_set_permset)");
171 result
= acl_get_entry(*aclp
, ACL_NEXT_ENTRY
, &existing_entry
);
174 /* This catches both the initial acl_get_entry and the ones at the
176 if (result
== ACL_ERROR
) {
177 perror("acl_set_entry (acl_get_entry)");
181 /* If we've made it this far, we need to add a new entry to the
183 acl_entry_t new_entry
;
185 /* The acl_create_entry() function can allocate new memory and/or
186 * change the location of the ACL structure entirely. When that
187 * happens, the value pointed to by aclp is updated, which means
188 * that a new acl_t gets "passed out" to our caller, eventually to
189 * be fed to acl_free(). In other words, we should still be freeing
190 * the right thing, even if the value pointed to by aclp changes.
192 if (acl_create_entry(aclp
, &new_entry
) == ACL_ERROR
) {
193 perror("acl_set_entry (acl_create_entry)");
197 if (acl_set_tag_type(new_entry
, entry_tag
) == ACL_ERROR
) {
198 perror("acl_set_entry (acl_set_tag_type)");
202 if (acl_set_permset(new_entry
, entry_permset
) == ACL_ERROR
) {
203 perror("acl_set_entry (acl_set_permset)");
207 if (entry_tag
== ACL_USER
|| entry_tag
== ACL_GROUP
) {
208 /* We need to set the qualifier too. */
209 void* entry_qual
= acl_get_qualifier(entry
);
210 if (entry_qual
== (void*)NULL
) {
211 perror("acl_set_entry (acl_get_qualifier)");
215 if (acl_set_qualifier(new_entry
, entry_qual
) == ACL_ERROR
) {
216 perror("acl_set_entry (acl_set_qualifier)");
227 * @brief Determine the number of entries in the given ACL.
230 * The ACL to inspect.
232 * @return Either the non-negative number of entries in @c acl, or
233 * @c ACL_ERROR on error.
235 int acl_entry_count(acl_t acl
) {
239 int result
= acl_get_entry(acl
, ACL_FIRST_ENTRY
, &entry
);
241 while (result
== ACL_SUCCESS
) {
243 result
= acl_get_entry(acl
, ACL_NEXT_ENTRY
, &entry
);
246 if (result
== ACL_ERROR
) {
247 perror("acl_entry_count (acl_get_entry)");
257 * @brief Determine whether or not the given ACL is minimal.
259 * An ACL is minimal if it has fewer than four entries.
262 * The ACL whose minimality is in question.
265 * - @c ACL_SUCCESS - @c acl is minimal
266 * - @c ACL_FAILURE - @c acl is not minimal
267 * - @c ACL_ERROR - Unexpected library error
269 int acl_is_minimal(acl_t acl
) {
271 int ec
= acl_entry_count(acl
);
273 if (ec
== ACL_ERROR
) {
274 perror("acl_is_minimal (acl_entry_count)");
289 * @brief Determine whether the given ACL's mask denies execute.
292 * The ACL whose mask we want to check.
295 * - @c ACL_SUCCESS - The @c acl has a mask which denies execute.
296 * - @c ACL_FAILURE - The @c acl has a mask which does not deny execute.
297 * - @c ACL_ERROR - Unexpected library error.
299 int acl_execute_masked(acl_t acl
) {
302 int ge_result
= acl_get_entry(acl
, ACL_FIRST_ENTRY
, &entry
);
304 while (ge_result
== ACL_SUCCESS
) {
305 acl_tag_t tag
= ACL_UNDEFINED_TAG
;
307 if (acl_get_tag_type(entry
, &tag
) == ACL_ERROR
) {
308 perror("acl_execute_masked (acl_get_tag_type)");
312 if (tag
== ACL_MASK
) {
313 /* This is the mask entry, get its permissions, and see if
314 execute is specified. */
315 acl_permset_t permset
;
317 if (acl_get_permset(entry
, &permset
) == ACL_ERROR
) {
318 perror("acl_execute_masked (acl_get_permset)");
322 int gp_result
= acl_get_perm(permset
, ACL_EXECUTE
);
323 if (gp_result
== ACL_ERROR
) {
324 perror("acl_execute_masked (acl_get_perm)");
328 if (gp_result
== ACL_FAILURE
) {
329 /* No execute bit set in the mask; execute not allowed. */
334 ge_result
= acl_get_entry(acl
, ACL_NEXT_ENTRY
, &entry
);
343 * @brief Determine whether @c fd is executable by anyone.
346 * This is used as part of the heuristic to determine whether or not
347 * we should mask the execute bit when inheriting an ACL. If @c fd
348 * describes a file, we check the @a effective permissions, contrary
349 * to what setfacl does.
352 * The file descriptor to check.
355 * A pointer to a stat structure for @c fd.
358 * - @c ACL_SUCCESS - Someone has effective execute permissions on @c fd.
359 * - @c ACL_FAILURE - Nobody can execute @c fd.
360 * - @c ACL_ERROR - Unexpected library error.
362 int any_can_execute(int fd
, const struct stat
* sp
) {
363 acl_t acl
= acl_get_fd(fd
);
365 if (acl
== (acl_t
)NULL
) {
366 perror("any_can_execute (acl_get_file)");
370 /* Our return value. */
371 int result
= ACL_FAILURE
;
373 if (acl_is_minimal(acl
)) {
374 if (sp
->st_mode
& (S_IXUSR
| S_IXOTH
| S_IXGRP
)) {
375 result
= ACL_SUCCESS
;
379 result
= ACL_FAILURE
;
385 int ge_result
= acl_get_entry(acl
, ACL_FIRST_ENTRY
, &entry
);
387 while (ge_result
== ACL_SUCCESS
) {
388 /* The first thing we do is check to see if this is a mask
389 entry. If it is, we skip it entirely. */
390 acl_tag_t tag
= ACL_UNDEFINED_TAG
;
392 if (acl_get_tag_type(entry
, &tag
) == ACL_ERROR
) {
393 perror("any_can_execute_or (acl_get_tag_type)");
398 if (tag
== ACL_MASK
) {
399 ge_result
= acl_get_entry(acl
, ACL_NEXT_ENTRY
, &entry
);
403 /* Ok, so it's not a mask entry. Check the execute perms. */
404 acl_permset_t permset
;
406 if (acl_get_permset(entry
, &permset
) == ACL_ERROR
) {
407 perror("any_can_execute_or (acl_get_permset)");
412 int gp_result
= acl_get_perm(permset
, ACL_EXECUTE
);
413 if (gp_result
== ACL_ERROR
) {
414 perror("any_can_execute (acl_get_perm)");
419 if (gp_result
== ACL_SUCCESS
) {
420 /* Only return ACL_SUCCESS if this execute bit is not masked. */
421 if (acl_execute_masked(acl
) != ACL_SUCCESS
) {
422 result
= ACL_SUCCESS
;
427 ge_result
= acl_get_entry(acl
, ACL_NEXT_ENTRY
, &entry
);
430 if (ge_result
== ACL_ERROR
) {
431 perror("any_can_execute (acl_get_entry)");
444 * @brief Set @c acl as the default ACL on @c path if it's a directory.
446 * This overwrites any existing default ACL on @c path. If no default
447 * ACL exists, then one is created. If @c path is not a directory, we
448 * return ACL_FAILURE but no error is raised.
451 * The target directory whose ACL we wish to replace or create.
454 * The ACL to set as default on @c path.
457 * - @c ACL_SUCCESS - The default ACL was assigned successfully.
458 * - @c ACL_FAILURE - If @c path is not a directory.
459 * - @c ACL_ERROR - Unexpected library error.
461 int assign_default_acl(const char* path
, acl_t acl
) {
465 perror("assign_default_acl (args)");
469 if (!is_path_directory(path
)) {
473 /* Our return value; success unless something bad happens. */
474 int result
= ACL_SUCCESS
;
475 acl_t path_acl
= acl_dup(acl
);
477 if (path_acl
== (acl_t
)NULL
) {
478 perror("assign_default_acl (acl_dup)");
479 return ACL_ERROR
; /* Nothing to clean up in this case. */
482 if (acl_set_file(path
, ACL_TYPE_DEFAULT
, path_acl
) == ACL_ERROR
) {
483 perror("assign_default_acl (acl_set_file)");
494 * @brief Remove all @c ACL_TYPE_ACCESS entries from the given file
495 * descriptor, leaving the UNIX permission bits.
498 * The file descriptor whose ACLs we want to wipe.
501 * - @c ACL_SUCCESS - The ACLs were wiped successfully, or none
502 * existed in the first place.
503 * - @c ACL_ERROR - Unexpected library error.
505 int wipe_acls(int fd
) {
506 /* Initialize an empty ACL, and then overwrite the one on "fd" with it. */
507 acl_t empty_acl
= acl_init(0);
509 if (empty_acl
== (acl_t
)NULL
) {
510 perror("wipe_acls (acl_init)");
514 if (acl_set_fd(fd
, empty_acl
) == ACL_ERROR
) {
515 perror("wipe_acls (acl_set_fd)");
527 * @brief Apply parent default ACL to a path.
529 * This overwrites any existing ACLs on @c path.
532 * The path whose ACL we would like to reset to its default.
535 * A pointer to a stat structure for @c path, or @c NULL if you don't
538 * @param no_exec_mask
539 * The value (either true or false) of the --no-exec-mask flag.
542 * - @c ACL_SUCCESS - The parent default ACL was inherited successfully.
543 * - @c ACL_FAILURE - The target path is not a regular file/directory,
544 * or the parent of @c path is not a directory.
545 * - @c ACL_ERROR - Unexpected library error.
547 int apply_default_acl(const char* path
,
548 const struct stat
* sp
,
553 perror("apply_default_acl (args)");
557 /* Define these next three variables here because we may have to
558 * jump to the cleanup routine which expects them to exist.
561 /* Our return value. */
562 int result
= ACL_SUCCESS
;
564 /* The default ACL on path's parent directory */
565 acl_t defacl
= (acl_t
)NULL
;
567 /* The file descriptor corresponding to "path" */
570 /* Split "path" into base/dirname parts to be used with openat().
571 * We duplicate the strings involved because dirname/basename mangle
574 char* path_copy
= strdup(path
);
575 if (path_copy
== NULL
) {
576 perror("apply_default_acl (strdup)");
579 char* parent
= dirname(path_copy
);
581 fd
= open(path
, O_NOFOLLOW
);
583 if (errno
== ELOOP
) {
584 result
= ACL_FAILURE
; /* hit a symlink */
588 perror("apply_default_acl (open fd)");
595 /* Refuse to operate on hard links, which can be abused by an
596 * attacker to trick us into changing the ACL on a file we didn't
597 * intend to; namely the "target" of the hard link. There is TOCTOU
598 * race condition here, but the window is as small as possible
599 * between when we open the file descriptor (look above) and when we
602 * Note: we only need to call fstat ourselves if we weren't passed a
603 * valid pointer to a stat structure (nftw does that).
607 if (fstat(fd
, &s
) == -1) {
608 perror("apply_default_acl (fstat)");
615 if (!S_ISDIR(sp
->st_mode
)) {
616 /* If it's not a directory, make sure it's a regular,
617 non-hard-linked file. */
618 if (!S_ISREG(sp
->st_mode
) || sp
->st_nlink
!= 1) {
619 result
= ACL_FAILURE
;
625 /* Default to not masking the exec bit; i.e. applying the default
626 ACL literally. If --no-exec-mask was not specified, then we try
627 to "guess" whether or not to mask the exec bit. This behavior
628 is modeled after the capital 'X' perms of setfacl. */
629 bool allow_exec
= true;
632 /* Never mask the execute bit on directories. */
633 int ace_result
= any_can_execute(fd
,sp
) || S_ISDIR(sp
->st_mode
);
635 if (ace_result
== ACL_ERROR
) {
636 perror("apply_default_acl (any_can_execute)");
641 allow_exec
= (bool)ace_result
;
644 defacl
= acl_get_file(parent
, ACL_TYPE_DEFAULT
);
646 if (defacl
== (acl_t
)NULL
) {
647 perror("apply_default_acl (acl_get_file)");
652 if (wipe_acls(fd
) == ACL_ERROR
) {
653 perror("apply_default_acl (wipe_acls)");
658 /* Do this after wipe_acls(), otherwise we'll overwrite the wiped
659 ACL with this one. */
660 acl_t acl
= acl_get_fd(fd
);
661 if (acl
== (acl_t
)NULL
) {
662 perror("apply_default_acl (acl_get_fd)");
667 /* If it's a directory, inherit the parent's default. */
668 if (assign_default_acl(path
, defacl
) == ACL_ERROR
) {
669 perror("apply_default_acl (assign_default_acl)");
675 int ge_result
= acl_get_entry(defacl
, ACL_FIRST_ENTRY
, &entry
);
677 while (ge_result
== ACL_SUCCESS
) {
678 acl_tag_t tag
= ACL_UNDEFINED_TAG
;
680 if (acl_get_tag_type(entry
, &tag
) == ACL_ERROR
) {
681 perror("apply_default_acl (acl_get_tag_type)");
687 /* We've got an entry/tag from the default ACL. Get its permset. */
688 acl_permset_t permset
;
689 if (acl_get_permset(entry
, &permset
) == ACL_ERROR
) {
690 perror("apply_default_acl (acl_get_permset)");
695 /* If this is a default mask, fix it up. */
696 if (tag
== ACL_MASK
||
697 tag
== ACL_USER_OBJ
||
698 tag
== ACL_GROUP_OBJ
||
702 /* The mask doesn't affect acl_user_obj, acl_group_obj (in
703 minimal ACLs) or acl_other entries, so if execute should be
704 masked, we have to do it manually. */
705 if (acl_delete_perm(permset
, ACL_EXECUTE
) == ACL_ERROR
) {
706 perror("apply_default_acl (acl_delete_perm)");
711 if (acl_set_permset(entry
, permset
) == ACL_ERROR
) {
712 perror("apply_default_acl (acl_set_permset)");
719 /* Finally, add the permset to the access ACL. It's actually
720 * important that we pass in the address of "acl" here, and not
721 * "acl" itself. Why? The call to acl_create_entry() within
722 * acl_set_entry() can allocate new memory for the entry.
723 * Sometimes that can be done in-place, in which case everything
724 * is cool and the new memory gets released when we call
727 * But occasionally, the whole ACL structure will have to be moved
728 * in order to allocate the extra space. When that happens,
729 * acl_create_entry() modifies the pointer it was passed (in this
730 * case, &acl) to point to the new location. We want to call
731 * acl_free() on the new location, and since acl_free() gets
732 * called right here, we need acl_create_entry() to update the
733 * value of "acl". To do that, it needs the address of "acl".
735 if (acl_set_entry(&acl
, entry
) == ACL_ERROR
) {
736 perror("apply_default_acl (acl_set_entry)");
741 ge_result
= acl_get_entry(defacl
, ACL_NEXT_ENTRY
, &entry
);
744 /* Catches the first acl_get_entry as well as the ones at the end of
746 if (ge_result
== ACL_ERROR
) {
747 perror("apply_default_acl (acl_get_entry)");
752 if (acl_set_fd(fd
, acl
) == ACL_ERROR
) {
753 perror("apply_default_acl (acl_set_fd)");
760 if (defacl
!= (acl_t
)NULL
) {
763 if (fd
>= 0 && close(fd
) == -1) {
764 perror("apply_default_acl (close)");
773 * @brief Display program usage information.
775 * @param program_name
776 * The program name to use in the output.
779 void usage(const char* program_name
) {
780 printf("Apply any applicable default ACLs to the given files or "
782 printf("Usage: %s [flags] <target1> [<target2> [ <target3>...]]\n\n",
785 printf(" -h, --help Print this help message\n");
786 printf(" -r, --recursive Act on any given directories recursively\n");
787 printf(" -x, --no-exec-mask Apply execute permissions unconditionally\n");
794 * @brief Wrapper around @c apply_default_acl() for use with @c nftw().
796 * For parameter information, see the @c nftw man page.
798 * @return If the ACL was applied to @c target successfully, we return
799 * @c FTW_CONTINUE to signal to @ nftw() that we should proceed onto
800 * the next file or directory. Otherwise, we return @c FTW_STOP to
804 int apply_default_acl_nftw(const char *target
,
805 const struct stat
*sp
,
809 if (apply_default_acl(target
, sp
, false)) {
820 * @brief Wrapper around @c apply_default_acl() for use with @c nftw().
822 * This is identical to @c apply_default_acl_nftw(), except it passes
823 * @c true to @c apply_default_acl() as its no_exec_mask argument.
826 int apply_default_acl_nftw_x(const char *target
,
827 const struct stat
*sp
,
831 if (apply_default_acl(target
, sp
, true)) {
842 * @brief Recursive version of @c apply_default_acl().
844 * If @c target is a directory, we use @c nftw() to call @c
845 * apply_default_acl() recursively on all of its children. Otherwise,
846 * we just delegate to @c apply_default_acl().
848 * We ignore symlinks for consistency with chmod -r.
851 * The root (path) of the recursive application.
853 * @param no_exec_mask
854 * The value (either true or false) of the --no-exec-mask flag.
857 * If @c target is not a directory, we return the result of
858 * calling @c apply_default_acl() on @c target. Otherwise, we convert
859 * the return value of @c nftw(). If @c nftw() succeeds (returns 0),
860 * then we return @c true. Otherwise, we return @c false.
862 * If there is an error, it will be reported via @c perror, but
863 * we still return @c false.
865 bool apply_default_acl_recursive(const char *target
, bool no_exec_mask
) {
867 if (!is_path_directory(target
)) {
868 return apply_default_acl(target
, NULL
, no_exec_mask
);
871 int max_levels
= 256;
872 int flags
= FTW_PHYS
; /* Don't follow links. */
874 /* There are two separate functions that could be passed to
875 nftw(). One passes no_exec_mask = true to apply_default_acl(),
876 and the other passes no_exec_mask = false. Since the function we
877 pass to nftw() cannot have parameters, we have to create separate
878 options and make the decision here. */
879 int (*fn
)(const char *, const struct stat
*, int, struct FTW
*) = NULL
;
880 fn
= no_exec_mask
? apply_default_acl_nftw_x
: apply_default_acl_nftw
;
882 int nftw_result
= nftw(target
, fn
, max_levels
, flags
);
884 if (nftw_result
== 0) {
889 /* nftw will return -1 on error, or if the supplied function
890 * (apply_default_acl_nftw) returns a non-zero result, nftw will
893 if (nftw_result
== -1) {
894 perror("apply_default_acl_recursive (nftw)");
903 * @brief Call apply_default_acl (possibly recursively) on each
904 * command-line argument.
906 * @return Either @c EXIT_FAILURE or @c EXIT_SUCCESS. If everything
907 * goes as expected, we return @c EXIT_SUCCESS. Otherwise, we return
910 int main(int argc
, char* argv
[]) {
917 bool recursive
= false;
918 bool no_exec_mask
= false;
920 struct option long_options
[] = {
921 /* These options set a flag. */
922 {"help", no_argument
, NULL
, 'h'},
923 {"recursive", no_argument
, NULL
, 'r'},
924 {"no-exec-mask", no_argument
, NULL
, 'x'},
930 while ((opt
= getopt_long(argc
, argv
, "hrx", long_options
, NULL
)) != -1) {
947 int result
= EXIT_SUCCESS
;
950 for (arg_index
= optind
; arg_index
< argc
; arg_index
++) {
951 const char* target
= argv
[arg_index
];
952 bool reapp_result
= false;
954 /* Make sure we can access the given path before we go out of our
955 * way to please it. Doing this check outside of
956 * apply_default_acl() lets us spit out a better error message for
959 if (!path_accessible(target
)) {
960 fprintf(stderr
, "%s: %s: No such file or directory\n", argv
[0], target
);
961 result
= EXIT_FAILURE
;
966 reapp_result
= apply_default_acl_recursive(target
, no_exec_mask
);
969 /* It's either a normal file, or we're not operating recursively. */
970 reapp_result
= apply_default_acl(target
, NULL
, no_exec_mask
);
974 result
= EXIT_FAILURE
;