]> gitweb.michael.orlitzky.com - apply-default-acl.git/blobdiff - src/apply-default-acl.c
Have acl_execute_masked() take an acl_t rather than a path as its argument.
[apply-default-acl.git] / src / apply-default-acl.c
index 5fea3a30a6efcb9c7359d5f9a19d25de7ead83e5..a3c28fb59ca963db23f2dcf79150a320cf40c947 100644 (file)
@@ -10,6 +10,7 @@
 #define _GNU_SOURCE
 
 #include <errno.h>
+#include <fcntl.h>  /* AT_FOO constants */
 #include <ftw.h>    /* nftw() et al. */
 #include <getopt.h>
 #include <libgen.h> /* dirname()     */
@@ -50,19 +51,44 @@ mode_t get_mode(const char* path) {
   }
 
   struct stat s;
-  int result = stat(path, &s);
+  int result = lstat(path, &s);
 
   if (result == 0) {
     return s.st_mode;
   }
   else {
-    /* errno will be set already by stat() */
+    /* errno will be set already by lstat() */
     return result;
   }
 }
 
 
 
+/**
+ * @brief Determine if the given path might refer to an (unsafe) hard link.
+ *
+ * @param path
+ *   The path to test.
+ *
+ * @return true if we are certain that @c path does not refer to a hard
+ *   link, and false otherwise. In case of error, false is returned,
+ *   because we are not sure that @c path is not a hard link.
+ */
+bool is_hardlink_safe(const char* path) {
+  if (path == NULL) {
+    return false;
+  }
+  struct stat s;
+  int result = lstat(path, &s);
+  if (result == 0) {
+    return (s.st_nlink == 1 || S_ISDIR(s.st_mode));
+  }
+  else {
+    return false;
+  }
+}
+
+
 /**
  * @brief Determine whether or not the given path is a regular file.
  *
@@ -77,7 +103,7 @@ bool is_regular_file(const char* path) {
   }
 
   struct stat s;
-  int result = stat(path, &s);
+  int result = lstat(path, &s);
   if (result == 0) {
     return S_ISREG(s.st_mode);
   }
@@ -88,6 +114,42 @@ bool is_regular_file(const char* path) {
 
 
 
+/**
+ * @brief Determine whether or not the given path is accessible.
+ *
+ * @param path
+ *   The path to test.
+ *
+ * @return true if @c path is accessible to the current effective
+ *   user/group, false otherwise.
+ */
+bool path_accessible(const char* path) {
+  if (path == NULL) {
+    return false;
+  }
+
+  /*  Test for access using the effective user and group rather than
+      the real one. */
+  int flags = AT_EACCESS;
+
+  /* Don't follow symlinks when checking for a path's existence,
+     since we won't follow them to set its ACLs either. */
+  flags |= AT_SYMLINK_NOFOLLOW;
+
+  /* If the path is relative, interpret it relative to the current
+     working directory (just like the access() system call). */
+  int result = faccessat(AT_FDCWD, path, F_OK, flags);
+
+  if (result == 0) {
+    return true;
+  }
+  else {
+    return false;
+  }
+}
+
+
+
 /**
  * @brief Determine whether or not the given path is a directory.
  *
@@ -102,7 +164,7 @@ bool is_directory(const char* path) {
   }
 
   struct stat s;
-  int result = stat(path, &s);
+  int result = lstat(path, &s);
   if (result == 0) {
     return S_ISDIR(s.st_mode);
   }
@@ -309,29 +371,17 @@ int acl_is_minimal(acl_t* acl) {
 
 
 /**
- * @brief Determine whether the given path has an ACL whose mask
- *   denies execute.
+ * @brief Determine whether the given ACL's mask denies execute.
  *
- * @param path
- *   The path to check.
+ * @param acl
+ *   The ACL whose mask we want to check.
  *
  * @return
- *   - @c ACL_SUCCESS - @c path has a mask which denies execute.
- *   - @c ACL_FAILURE - The ACL for @c path does not deny execute,
- *     or @c path has no extended ACL at all.
+ *   - @c ACL_SUCCESS - The @c acl has a mask which denies execute.
+ *   - @c ACL_FAILURE - The @c acl has a mask which does not deny execute.
  *   - @c ACL_ERROR - Unexpected library error.
  */
-int acl_execute_masked(const char* path) {
-
-  acl_t acl = acl_get_file(path, ACL_TYPE_ACCESS);
-
-  if (acl == (acl_t)NULL) {
-    perror("acl_execute_masked (acl_get_file)");
-    return ACL_ERROR;
-  }
-
-  /* Our return value. */
-  int result = ACL_FAILURE;
+int acl_execute_masked(acl_t acl) {
 
   acl_entry_t entry;
   int ge_result = acl_get_entry(acl, ACL_FIRST_ENTRY, &entry);
@@ -342,8 +392,7 @@ int acl_execute_masked(const char* path) {
 
     if (tag_result == ACL_ERROR) {
        perror("acl_execute_masked (acl_get_tag_type)");
-       result = ACL_ERROR;
-       goto cleanup;
+       return ACL_ERROR;
     }
 
     if (tag == ACL_MASK) {
@@ -354,15 +403,13 @@ int acl_execute_masked(const char* path) {
       int ps_result = acl_get_permset(entry, &permset);
       if (ps_result == ACL_ERROR) {
        perror("acl_execute_masked (acl_get_permset)");
-       result = ACL_ERROR;
-       goto cleanup;
+       return ACL_ERROR;
       }
 
       int gp_result = acl_get_perm(permset, ACL_EXECUTE);
       if (gp_result == ACL_ERROR) {
        perror("acl_execute_masked (acl_get_perm)");
-       result = ACL_ERROR;
-       goto cleanup;
+       return ACL_ERROR;
       }
 
       if (gp_result == ACL_FAILURE) {
@@ -374,12 +421,11 @@ int acl_execute_masked(const char* path) {
     ge_result = acl_get_entry(acl, ACL_NEXT_ENTRY, &entry);
   }
 
- cleanup:
-  acl_free(acl);
-  return result;
+  return ACL_FAILURE;
 }
 
 
+
 /**
  * @brief Determine whether @c path is executable (by anyone) or a
  *   directory.
@@ -435,6 +481,23 @@ int any_can_execute_or_dir(const char* path) {
   int ge_result = acl_get_entry(acl, ACL_FIRST_ENTRY, &entry);
 
   while (ge_result == ACL_SUCCESS) {
+    /* The first thing we do is check to see if this is a mask
+       entry. If it is, we skip it entirely. */
+    acl_tag_t tag = ACL_UNDEFINED_TAG;
+    int tag_result = acl_get_tag_type(entry, &tag);
+
+    if (tag_result == ACL_ERROR) {
+      perror("any_can_execute_or_dir (acl_get_tag_type)");
+      result = ACL_ERROR;
+      goto cleanup;
+    }
+
+    if (tag == ACL_MASK) {
+      ge_result = acl_get_entry(acl, ACL_NEXT_ENTRY, &entry);
+      continue;
+    }
+
+    /* Ok, so it's not a mask entry. Check the execute perms. */
     acl_permset_t permset;
 
     int ps_result = acl_get_permset(entry, &permset);
@@ -452,8 +515,8 @@ int any_can_execute_or_dir(const char* path) {
     }
 
     if (gp_result == ACL_SUCCESS) {
-      /* Only return one if this execute bit is not masked. */
-      if (acl_execute_masked(path) != ACL_SUCCESS) {
+      /* Only return ACL_SUCCESS if this execute bit is not masked. */
+      if (acl_execute_masked(acl) != ACL_SUCCESS) {
        result = ACL_SUCCESS;
        goto cleanup;
       }
@@ -476,59 +539,49 @@ int any_can_execute_or_dir(const char* path) {
 
 
 /**
- * @brief Inherit the default ACL from @c parent to @c path.
- *
- * The @c parent parameter does not necessarily need to be the parent
- * of @c path, although that will usually be the case. This overwrites
- * any existing default ACL on @c path.
+ * @brief Set @c acl as the default ACL on @c path if it's a directory.
  *
- * @param parent
- *   The parent directory whose ACL we want to inherit.
+ * This overwrites any existing default ACL on @c path. If no default
+ * ACL exists, then one is created. If @c path is not a directory, we
+ * return ACL_FAILURE but no error is raised.
  *
  * @param path
- *   The target directory whose ACL we wish to overwrite (or create).
+ *   The target directory whose ACL we wish to replace or create.
+ *
+  * @param acl
+ *   The ACL to set as default on @c path.
  *
  * @return
- *   - @c ACL_SUCCESS - The default ACL was inherited successfully.
- *   - @c ACL_FAILURE - Either @c parent or @c path is not a directory.
+ *   - @c ACL_SUCCESS - The default ACL was assigned successfully.
+ *   - @c ACL_FAILURE - If @c path is not a directory.
  *   - @c ACL_ERROR - Unexpected library error.
  */
-int inherit_default_acl(const char* path, const char* parent) {
-
-  /* Our return value. */
-  int result = ACL_SUCCESS;
+int assign_default_acl(const char* path, acl_t acl) {
 
   if (path == NULL) {
     errno = ENOENT;
     return ACL_ERROR;
   }
 
-  if (!is_directory(path) || !is_directory(parent)) {
+  if (!is_directory(path)) {
     return ACL_FAILURE;
   }
 
-  acl_t parent_acl = acl_get_file(parent, ACL_TYPE_DEFAULT);
-  if (parent_acl == (acl_t)NULL) {
-    perror("inherit_default_acl (acl_get_file)");
-    return ACL_ERROR;
-  }
-
-  acl_t path_acl = acl_dup(parent_acl);
+    /* Our return value; success unless something bad happens. */
+  int result = ACL_SUCCESS;
+  acl_t path_acl = acl_dup(acl);
 
   if (path_acl == (acl_t)NULL) {
     perror("inherit_default_acl (acl_dup)");
-    acl_free(parent_acl);
-    return ACL_ERROR;
+    return ACL_ERROR; /* Nothing to clean up in this case. */
   }
 
   int sf_result = acl_set_file(path, ACL_TYPE_DEFAULT, path_acl);
   if (sf_result == -1) {
     perror("inherit_default_acl (acl_set_file)");
     result = ACL_ERROR;
-    goto cleanup;
   }
 
- cleanup:
   acl_free(path_acl);
   return result;
 }
@@ -623,6 +676,32 @@ int apply_default_acl(const char* path, bool no_exec_mask) {
     return ACL_ERROR;
   }
 
+  /* Refuse to operate on hard links, which can be abused by an
+   * attacker to trick us into changing the ACL on a file we didn't
+   * intend to; namely the "target" of the hard link. To truly prevent
+   * that sort of mischief, we should be using file descriptors for
+   * the target and its parent directory. Then modulo a tiny race
+   * condition, we would be sure that "path" and "parent" don't change
+   * their nature between the time that we test them and when we
+   * utilize them. For contrast, the same attacker is free to replace
+   * "path" with a hard link after is_hardlink_safe() has returned
+   * "true" below.
+   *
+   * Unfortunately, our API is lacking in this area. For example,
+   * acl_set_fd() is only capable of setting the ACL_TYPE_ACCESS list,
+   * and not the ACL_TYPE_DEFAULT. Apparently the only way to operate
+   * on default ACLs is through the path name, which is inherently
+   * unreliable since the acl_*_file() calls themselves might follow
+   * links (both hard and symbolic).
+   *
+   * Some improvement could still be made by using descriptors where
+   * possible -- this would shrink the exploit window -- but for now
+   * we use a naive implementation that only keeps honest men honest.
+  */
+  if (!is_hardlink_safe(path)) {
+    return ACL_FAILURE;
+  }
+
   if (!is_regular_file(path) && !is_directory(path)) {
     return ACL_FAILURE;
   }
@@ -680,7 +759,7 @@ int apply_default_acl(const char* path, bool no_exec_mask) {
   }
 
   /* If it's a directory, inherit the parent's default. */
-  int inherit_result = inherit_default_acl(path, parent);
+  int inherit_result = assign_default_acl(path, defacl);
   if (inherit_result == ACL_ERROR) {
     perror("apply_default_acl (inherit_acls)");
     result = ACL_ERROR;
@@ -776,7 +855,7 @@ int apply_default_acl(const char* path, bool no_exec_mask) {
  *   The program name to use in the output.
  *
  */
-void usage(char* program_name) {
+void usage(const char* program_name) {
   printf("Apply any applicable default ACLs to the given files or "
         "directories.\n\n");
   printf("Usage: %s [flags] <target1> [<target2> [ <target3>...]]\n\n",
@@ -953,11 +1032,22 @@ int main(int argc, char* argv[]) {
     const char* target = argv[arg_index];
     bool reapp_result = false;
 
+    /* Make sure we can access the given path before we go out of our
+     * way to please it. Doing this check outside of
+     * apply_default_acl() lets us spit out a better error message for
+     * typos, too.
+     */
+    if (!path_accessible(target)) {
+      fprintf(stderr, "%s: %s: No such file or directory\n", argv[0], target);
+      result = EXIT_FAILURE;
+      continue;
+    }
+
     if (recursive) {
       reapp_result = apply_default_acl_recursive(target, no_exec_mask);
     }
     else {
-      /* It's either normal file, or we're not operating recursively. */
+      /* It's either normal file, or we're not operating recursively. */
       reapp_result = apply_default_acl(target, no_exec_mask);
     }