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 if the given file descriptor might refer to an
43 * The file descriptor whose link count we want to investigate.
45 * @return true if we are certain that @c fd does not describe a hard
46 * link, and false otherwise. In case of error, false is returned,
47 * because we are not sure that @c fd is not a hard link.
49 bool is_hardlink_safe(int fd
) {
54 if (fstat(fd
, &s
) == 0) {
55 return (s
.st_nlink
== 1 || S_ISDIR(s
.st_mode
));
64 * @brief Determine whether or not the given file descriptor is for
68 * The file descriptor to test for regular-fileness.
70 * @return true if @c fd describes a regular file, and false otherwise.
72 bool is_regular_file(int fd
) {
78 if (fstat(fd
, &s
) == 0) {
79 return S_ISREG(s
.st_mode
);
89 * @brief Determine whether or not the given path is accessible.
94 * @return true if @c path is accessible to the current effective
95 * user/group, false otherwise.
97 bool path_accessible(const char* path
) {
102 /* Test for access using the effective user and group rather than
104 int flags
= AT_EACCESS
;
106 /* Don't follow symlinks when checking for a path's existence,
107 since we won't follow them to set its ACLs either. */
108 flags
|= AT_SYMLINK_NOFOLLOW
;
110 /* If the path is relative, interpret it relative to the current
111 working directory (just like the access() system call). */
112 if (faccessat(AT_FDCWD
, path
, F_OK
, flags
) == 0) {
123 * @brief Determine whether or not the given path is a directory.
128 * @return true if @c path is a directory, false otherwise.
130 bool is_path_directory(const char* path
) {
136 if (lstat(path
, &s
) == 0) {
137 return S_ISDIR(s
.st_mode
);
146 * @brief Determine whether or not the given file descriptor is for
150 * The file descriptor whose directoryness is in question.
152 * @return true if @c fd describes a directory, and false otherwise.
154 bool is_directory(int fd
) {
160 if (fstat(fd
, &s
) == 0) {
161 return S_ISDIR(s
.st_mode
);
171 * @brief Update (or create) an entry in an @b minimal ACL.
173 * This function will not work if @c aclp contains extended
174 * entries. This is fine for our purposes, since we call @c wipe_acls
175 * on each path before applying the default to it.
177 * The assumption that there are no extended entries makes things much
178 * simpler. For example, we only have to update the @c ACL_USER_OBJ,
179 * @c ACL_GROUP_OBJ, and @c ACL_OTHER entries -- all others can simply
180 * be created anew. This means we don't have to fool around comparing
181 * named-user/group entries.
184 * A pointer to the acl_t structure whose entry we want to modify.
187 * The new entry. If @c entry contains a user/group/other entry, we
188 * update the existing one. Otherwise we create a new entry.
190 * @return If there is an unexpected library error, @c ACL_ERROR is
191 * returned. Otherwise, @c ACL_SUCCESS.
194 int acl_set_entry(acl_t
* aclp
,
198 if (acl_get_tag_type(entry
, &entry_tag
) == ACL_ERROR
) {
199 perror("acl_set_entry (acl_get_tag_type)");
203 acl_permset_t entry_permset
;
204 if (acl_get_permset(entry
, &entry_permset
) == ACL_ERROR
) {
205 perror("acl_set_entry (acl_get_permset)");
209 acl_entry_t existing_entry
;
210 /* Loop through the given ACL looking for matching entries. */
211 int result
= acl_get_entry(*aclp
, ACL_FIRST_ENTRY
, &existing_entry
);
213 while (result
== ACL_SUCCESS
) {
214 acl_tag_t existing_tag
= ACL_UNDEFINED_TAG
;
216 if (acl_get_tag_type(existing_entry
, &existing_tag
) == ACL_ERROR
) {
217 perror("set_acl_tag_permset (acl_get_tag_type)");
221 if (existing_tag
== entry_tag
) {
222 if (entry_tag
== ACL_USER_OBJ
||
223 entry_tag
== ACL_GROUP_OBJ
||
224 entry_tag
== ACL_OTHER
) {
225 /* Only update for these three since all other tags will have
226 been wiped. These three are guaranteed to exist, so if we
227 match one of them, we're allowed to return ACL_SUCCESS
228 below and bypass the rest of the function. */
229 acl_permset_t existing_permset
;
230 if (acl_get_permset(existing_entry
, &existing_permset
) == ACL_ERROR
) {
231 perror("acl_set_entry (acl_get_permset)");
235 if (acl_set_permset(existing_entry
, entry_permset
) == ACL_ERROR
) {
236 perror("acl_set_entry (acl_set_permset)");
245 result
= acl_get_entry(*aclp
, ACL_NEXT_ENTRY
, &existing_entry
);
248 /* This catches both the initial acl_get_entry and the ones at the
250 if (result
== ACL_ERROR
) {
251 perror("acl_set_entry (acl_get_entry)");
255 /* If we've made it this far, we need to add a new entry to the
257 acl_entry_t new_entry
;
259 /* The acl_create_entry() function can allocate new memory and/or
260 * change the location of the ACL structure entirely. When that
261 * happens, the value pointed to by aclp is updated, which means
262 * that a new acl_t gets "passed out" to our caller, eventually to
263 * be fed to acl_free(). In other words, we should still be freeing
264 * the right thing, even if the value pointed to by aclp changes.
266 if (acl_create_entry(aclp
, &new_entry
) == ACL_ERROR
) {
267 perror("acl_set_entry (acl_create_entry)");
271 if (acl_set_tag_type(new_entry
, entry_tag
) == ACL_ERROR
) {
272 perror("acl_set_entry (acl_set_tag_type)");
276 if (acl_set_permset(new_entry
, entry_permset
) == ACL_ERROR
) {
277 perror("acl_set_entry (acl_set_permset)");
281 if (entry_tag
== ACL_USER
|| entry_tag
== ACL_GROUP
) {
282 /* We need to set the qualifier too. */
283 void* entry_qual
= acl_get_qualifier(entry
);
284 if (entry_qual
== (void*)NULL
) {
285 perror("acl_set_entry (acl_get_qualifier)");
289 if (acl_set_qualifier(new_entry
, entry_qual
) == ACL_ERROR
) {
290 perror("acl_set_entry (acl_set_qualifier)");
301 * @brief Determine the number of entries in the given ACL.
304 * The ACL to inspect.
306 * @return Either the non-negative number of entries in @c acl, or
307 * @c ACL_ERROR on error.
309 int acl_entry_count(acl_t acl
) {
313 int result
= acl_get_entry(acl
, ACL_FIRST_ENTRY
, &entry
);
315 while (result
== ACL_SUCCESS
) {
317 result
= acl_get_entry(acl
, ACL_NEXT_ENTRY
, &entry
);
320 if (result
== ACL_ERROR
) {
321 perror("acl_entry_count (acl_get_entry)");
331 * @brief Determine whether or not the given ACL is minimal.
333 * An ACL is minimal if it has fewer than four entries.
336 * The ACL whose minimality is in question.
339 * - @c ACL_SUCCESS - @c acl is minimal
340 * - @c ACL_FAILURE - @c acl is not minimal
341 * - @c ACL_ERROR - Unexpected library error
343 int acl_is_minimal(acl_t acl
) {
345 int ec
= acl_entry_count(acl
);
347 if (ec
== ACL_ERROR
) {
348 perror("acl_is_minimal (acl_entry_count)");
363 * @brief Determine whether the given ACL's mask denies execute.
366 * The ACL whose mask we want to check.
369 * - @c ACL_SUCCESS - The @c acl has a mask which denies execute.
370 * - @c ACL_FAILURE - The @c acl has a mask which does not deny execute.
371 * - @c ACL_ERROR - Unexpected library error.
373 int acl_execute_masked(acl_t acl
) {
376 int ge_result
= acl_get_entry(acl
, ACL_FIRST_ENTRY
, &entry
);
378 while (ge_result
== ACL_SUCCESS
) {
379 acl_tag_t tag
= ACL_UNDEFINED_TAG
;
381 if (acl_get_tag_type(entry
, &tag
) == ACL_ERROR
) {
382 perror("acl_execute_masked (acl_get_tag_type)");
386 if (tag
== ACL_MASK
) {
387 /* This is the mask entry, get its permissions, and see if
388 execute is specified. */
389 acl_permset_t permset
;
391 if (acl_get_permset(entry
, &permset
) == ACL_ERROR
) {
392 perror("acl_execute_masked (acl_get_permset)");
396 int gp_result
= acl_get_perm(permset
, ACL_EXECUTE
);
397 if (gp_result
== ACL_ERROR
) {
398 perror("acl_execute_masked (acl_get_perm)");
402 if (gp_result
== ACL_FAILURE
) {
403 /* No execute bit set in the mask; execute not allowed. */
408 ge_result
= acl_get_entry(acl
, ACL_NEXT_ENTRY
, &entry
);
417 * @brief Determine whether @c fd is executable (by anyone) or a
420 * This is used as part of the heuristic to determine whether or not
421 * we should mask the execute bit when inheriting an ACL. If @c fd
422 * describes a directory, the answer is a clear-cut yes. This behavior
423 * is modeled after the capital 'X' perms of setfacl.
425 * If @c fd describes a file, we check the @a effective permissions,
426 * contrary to what setfacl does.
429 * The file descriptor to check.
432 * - @c ACL_SUCCESS - @c fd describes a directory, or someone has effective
434 * - @c ACL_FAILURE - @c fd describes a regular file and nobody can execute
436 * - @c ACL_ERROR - Unexpected library error.
438 int any_can_execute_or_dir(int fd
) {
440 if (is_directory(fd
)) {
441 /* That was easy... */
445 acl_t acl
= acl_get_fd(fd
);
447 if (acl
== (acl_t
)NULL
) {
448 perror("any_can_execute_or_dir (acl_get_file)");
452 /* Our return value. */
453 int result
= ACL_FAILURE
;
455 if (acl_is_minimal(acl
)) {
457 if (fstat(fd
, &s
) == -1) {
458 perror("any_can_execute_or_dir (fstat)");
462 if (s
.st_mode
& (S_IXUSR
| S_IXOTH
| S_IXGRP
)) {
463 result
= ACL_SUCCESS
;
467 result
= ACL_FAILURE
;
473 int ge_result
= acl_get_entry(acl
, ACL_FIRST_ENTRY
, &entry
);
475 while (ge_result
== ACL_SUCCESS
) {
476 /* The first thing we do is check to see if this is a mask
477 entry. If it is, we skip it entirely. */
478 acl_tag_t tag
= ACL_UNDEFINED_TAG
;
480 if (acl_get_tag_type(entry
, &tag
) == ACL_ERROR
) {
481 perror("any_can_execute_or_dir (acl_get_tag_type)");
486 if (tag
== ACL_MASK
) {
487 ge_result
= acl_get_entry(acl
, ACL_NEXT_ENTRY
, &entry
);
491 /* Ok, so it's not a mask entry. Check the execute perms. */
492 acl_permset_t permset
;
494 if (acl_get_permset(entry
, &permset
) == ACL_ERROR
) {
495 perror("any_can_execute_or_dir (acl_get_permset)");
500 int gp_result
= acl_get_perm(permset
, ACL_EXECUTE
);
501 if (gp_result
== ACL_ERROR
) {
502 perror("any_can_execute_or_dir (acl_get_perm)");
507 if (gp_result
== ACL_SUCCESS
) {
508 /* Only return ACL_SUCCESS if this execute bit is not masked. */
509 if (acl_execute_masked(acl
) != ACL_SUCCESS
) {
510 result
= ACL_SUCCESS
;
515 ge_result
= acl_get_entry(acl
, ACL_NEXT_ENTRY
, &entry
);
518 if (ge_result
== ACL_ERROR
) {
519 perror("any_can_execute_or_dir (acl_get_entry)");
532 * @brief Set @c acl as the default ACL on @c path if it's a directory.
534 * This overwrites any existing default ACL on @c path. If no default
535 * ACL exists, then one is created. If @c path is not a directory, we
536 * return ACL_FAILURE but no error is raised.
539 * The target directory whose ACL we wish to replace or create.
542 * The ACL to set as default on @c path.
545 * - @c ACL_SUCCESS - The default ACL was assigned successfully.
546 * - @c ACL_FAILURE - If @c path is not a directory.
547 * - @c ACL_ERROR - Unexpected library error.
549 int assign_default_acl(const char* path
, acl_t acl
) {
556 if (!is_path_directory(path
)) {
560 /* Our return value; success unless something bad happens. */
561 int result
= ACL_SUCCESS
;
562 acl_t path_acl
= acl_dup(acl
);
564 if (path_acl
== (acl_t
)NULL
) {
565 perror("assign_default_acl (acl_dup)");
566 return ACL_ERROR
; /* Nothing to clean up in this case. */
569 if (acl_set_file(path
, ACL_TYPE_DEFAULT
, path_acl
) == ACL_ERROR
) {
570 perror("assign_default_acl (acl_set_file)");
581 * @brief Remove all @c ACL_TYPE_ACCESS entries from the given file
582 * descriptor, leaving the UNIX permission bits.
585 * The file descriptor whose ACLs we want to wipe.
588 * - @c ACL_SUCCESS - The ACLs were wiped successfully, or none
589 * existed in the first place.
590 * - @c ACL_ERROR - Unexpected library error.
592 int wipe_acls(int fd
) {
593 /* Initialize an empty ACL, and then overwrite the one on "fd" with it. */
594 acl_t empty_acl
= acl_init(0);
596 if (empty_acl
== (acl_t
)NULL
) {
597 perror("wipe_acls (acl_init)");
601 if (acl_set_fd(fd
, empty_acl
) == ACL_ERROR
) {
602 perror("wipe_acls (acl_set_fd)");
614 * @brief Apply parent default ACL to a path.
616 * This overwrites any existing ACLs on @c path.
619 * The path whose ACL we would like to reset to its default.
621 * @param no_exec_mask
622 * The value (either true or false) of the --no-exec-mask flag.
625 * - @c ACL_SUCCESS - The parent default ACL was inherited successfully.
626 * - @c ACL_FAILURE - The target path is not a regular file/directory,
627 * or the parent of @c path is not a directory.
628 * - @c ACL_ERROR - Unexpected library error.
630 int apply_default_acl(const char* path
, bool no_exec_mask
) {
637 /* Define these next three variables here because we may have to
638 * jump to the cleanup routine which expects them to exist.
641 /* Our return value. */
642 int result
= ACL_SUCCESS
;
644 /* The default ACL on path's parent directory */
645 acl_t defacl
= (acl_t
)NULL
;
647 /* The file descriptor corresponding to "path" */
650 /* Split "path" into base/dirname parts to be used with openat().
651 * We duplicate the strings involved because dirname/basename mangle
654 char* path_copy
= strdup(path
);
655 if (path_copy
== NULL
) {
656 perror("apply_default_acl (strdup)");
659 char* parent
= dirname(path_copy
);
661 fd
= open(path
, O_NOFOLLOW
);
663 if (errno
== ELOOP
) {
664 result
= ACL_FAILURE
; /* hit a symlink */
668 perror("apply_default_acl (open fd)");
675 /* Refuse to operate on hard links, which can be abused by an
676 * attacker to trick us into changing the ACL on a file we didn't
677 * intend to; namely the "target" of the hard link. There is TOCTOU
678 * race condition here, but the window is as small as possible
679 * between when we open the file descriptor (look above) and when we
682 if (!is_hardlink_safe(fd
)) {
683 result
= ACL_FAILURE
;
687 if (!is_regular_file(fd
) && !is_directory(fd
)) {
688 result
= ACL_FAILURE
;
692 /* Default to not masking the exec bit; i.e. applying the default
693 ACL literally. If --no-exec-mask was not specified, then we try
694 to "guess" whether or not to mask the exec bit. */
695 bool allow_exec
= true;
698 int ace_result
= any_can_execute_or_dir(fd
);
700 if (ace_result
== ACL_ERROR
) {
701 perror("apply_default_acl (any_can_execute_or_dir)");
706 allow_exec
= (bool)ace_result
;
709 defacl
= acl_get_file(parent
, ACL_TYPE_DEFAULT
);
711 if (defacl
== (acl_t
)NULL
) {
712 perror("apply_default_acl (acl_get_file)");
717 if (wipe_acls(fd
) == ACL_ERROR
) {
718 perror("apply_default_acl (wipe_acls)");
723 /* Do this after wipe_acls(), otherwise we'll overwrite the wiped
724 ACL with this one. */
725 acl_t acl
= acl_get_fd(fd
);
726 if (acl
== (acl_t
)NULL
) {
727 perror("apply_default_acl (acl_get_fd)");
732 /* If it's a directory, inherit the parent's default. */
733 if (assign_default_acl(path
, defacl
) == ACL_ERROR
) {
734 perror("apply_default_acl (assign_default_acl)");
740 int ge_result
= acl_get_entry(defacl
, ACL_FIRST_ENTRY
, &entry
);
742 while (ge_result
== ACL_SUCCESS
) {
743 acl_tag_t tag
= ACL_UNDEFINED_TAG
;
745 if (acl_get_tag_type(entry
, &tag
) == ACL_ERROR
) {
746 perror("apply_default_acl (acl_get_tag_type)");
752 /* We've got an entry/tag from the default ACL. Get its permset. */
753 acl_permset_t permset
;
754 if (acl_get_permset(entry
, &permset
) == ACL_ERROR
) {
755 perror("apply_default_acl (acl_get_permset)");
760 /* If this is a default mask, fix it up. */
761 if (tag
== ACL_MASK
||
762 tag
== ACL_USER_OBJ
||
763 tag
== ACL_GROUP_OBJ
||
767 /* The mask doesn't affect acl_user_obj, acl_group_obj (in
768 minimal ACLs) or acl_other entries, so if execute should be
769 masked, we have to do it manually. */
770 if (acl_delete_perm(permset
, ACL_EXECUTE
) == ACL_ERROR
) {
771 perror("apply_default_acl (acl_delete_perm)");
776 if (acl_set_permset(entry
, permset
) == ACL_ERROR
) {
777 perror("apply_default_acl (acl_set_permset)");
784 /* Finally, add the permset to the access ACL. It's actually
785 * important that we pass in the address of "acl" here, and not
786 * "acl" itself. Why? The call to acl_create_entry() within
787 * acl_set_entry() can allocate new memory for the entry.
788 * Sometimes that can be done in-place, in which case everything
789 * is cool and the new memory gets released when we call
792 * But occasionally, the whole ACL structure will have to be moved
793 * in order to allocate the extra space. When that happens,
794 * acl_create_entry() modifies the pointer it was passed (in this
795 * case, &acl) to point to the new location. We want to call
796 * acl_free() on the new location, and since acl_free() gets
797 * called right here, we need acl_create_entry() to update the
798 * value of "acl". To do that, it needs the address of "acl".
800 if (acl_set_entry(&acl
, entry
) == ACL_ERROR
) {
801 perror("apply_default_acl (acl_set_entry)");
806 ge_result
= acl_get_entry(defacl
, ACL_NEXT_ENTRY
, &entry
);
809 /* Catches the first acl_get_entry as well as the ones at the end of
811 if (ge_result
== ACL_ERROR
) {
812 perror("apply_default_acl (acl_get_entry)");
817 if (acl_set_fd(fd
, acl
) == ACL_ERROR
) {
818 perror("apply_default_acl (acl_set_fd)");
825 if (defacl
!= (acl_t
)NULL
) {
828 if (fd
>= 0 && close(fd
) == -1) {
829 perror("apply_default_acl (close)");
838 * @brief Display program usage information.
840 * @param program_name
841 * The program name to use in the output.
844 void usage(const char* program_name
) {
845 printf("Apply any applicable default ACLs to the given files or "
847 printf("Usage: %s [flags] <target1> [<target2> [ <target3>...]]\n\n",
850 printf(" -h, --help Print this help message\n");
851 printf(" -r, --recursive Act on any given directories recursively\n");
852 printf(" -x, --no-exec-mask Apply execute permissions unconditionally\n");
859 * @brief Wrapper around @c apply_default_acl() for use with @c nftw().
861 * For parameter information, see the @c nftw man page.
863 * @return If the ACL was applied to @c target successfully, we return
864 * @c FTW_CONTINUE to signal to @ nftw() that we should proceed onto
865 * the next file or directory. Otherwise, we return @c FTW_STOP to
869 int apply_default_acl_nftw(const char *target
,
870 const struct stat
*s
,
874 if (apply_default_acl(target
, false)) {
885 * @brief Wrapper around @c apply_default_acl() for use with @c nftw().
887 * This is identical to @c apply_default_acl_nftw(), except it passes
888 * @c true to @c apply_default_acl() as its no_exec_mask argument.
891 int apply_default_acl_nftw_x(const char *target
,
892 const struct stat
*s
,
896 if (apply_default_acl(target
, true)) {
907 * @brief Recursive version of @c apply_default_acl().
909 * If @c target is a directory, we use @c nftw() to call @c
910 * apply_default_acl() recursively on all of its children. Otherwise,
911 * we just delegate to @c apply_default_acl().
913 * We ignore symlinks for consistency with chmod -r.
916 * The root (path) of the recursive application.
918 * @param no_exec_mask
919 * The value (either true or false) of the --no-exec-mask flag.
922 * If @c target is not a directory, we return the result of
923 * calling @c apply_default_acl() on @c target. Otherwise, we convert
924 * the return value of @c nftw(). If @c nftw() succeeds (returns 0),
925 * then we return @c true. Otherwise, we return @c false.
927 * If there is an error, it will be reported via @c perror, but
928 * we still return @c false.
930 bool apply_default_acl_recursive(const char *target
, bool no_exec_mask
) {
932 if (!is_path_directory(target
)) {
933 return apply_default_acl(target
, no_exec_mask
);
936 int max_levels
= 256;
937 int flags
= FTW_PHYS
; /* Don't follow links. */
939 /* There are two separate functions that could be passed to
940 nftw(). One passes no_exec_mask = true to apply_default_acl(),
941 and the other passes no_exec_mask = false. Since the function we
942 pass to nftw() cannot have parameters, we have to create separate
943 options and make the decision here. */
944 int (*fn
)(const char *, const struct stat
*, int, struct FTW
*) = NULL
;
945 fn
= no_exec_mask
? apply_default_acl_nftw_x
: apply_default_acl_nftw
;
947 int nftw_result
= nftw(target
, fn
, max_levels
, flags
);
949 if (nftw_result
== 0) {
954 /* nftw will return -1 on error, or if the supplied function
955 * (apply_default_acl_nftw) returns a non-zero result, nftw will
958 if (nftw_result
== -1) {
959 perror("apply_default_acl_recursive (nftw)");
968 * @brief Call apply_default_acl (possibly recursively) on each
969 * command-line argument.
971 * @return Either @c EXIT_FAILURE or @c EXIT_SUCCESS. If everything
972 * goes as expected, we return @c EXIT_SUCCESS. Otherwise, we return
975 int main(int argc
, char* argv
[]) {
982 bool recursive
= false;
983 bool no_exec_mask
= false;
985 struct option long_options
[] = {
986 /* These options set a flag. */
987 {"help", no_argument
, NULL
, 'h'},
988 {"recursive", no_argument
, NULL
, 'r'},
989 {"no-exec-mask", no_argument
, NULL
, 'x'},
995 while ((opt
= getopt_long(argc
, argv
, "hrx", long_options
, NULL
)) != -1) {
1004 no_exec_mask
= true;
1008 return EXIT_FAILURE
;
1012 int result
= EXIT_SUCCESS
;
1015 for (arg_index
= optind
; arg_index
< argc
; arg_index
++) {
1016 const char* target
= argv
[arg_index
];
1017 bool reapp_result
= false;
1019 /* Make sure we can access the given path before we go out of our
1020 * way to please it. Doing this check outside of
1021 * apply_default_acl() lets us spit out a better error message for
1024 if (!path_accessible(target
)) {
1025 fprintf(stderr
, "%s: %s: No such file or directory\n", argv
[0], target
);
1026 result
= EXIT_FAILURE
;
1031 reapp_result
= apply_default_acl_recursive(target
, no_exec_mask
);
1034 /* It's either a normal file, or we're not operating recursively. */
1035 reapp_result
= apply_default_acl(target
, no_exec_mask
);
1038 if (!reapp_result
) {
1039 result
= EXIT_FAILURE
;