From f0970d1193ebddbfcd2ba9523a0f956aed2bd4cc Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 26 Feb 2018 08:38:14 -0500 Subject: [PATCH 01/16] Add documentation for the safe_open() and safe_open_ex() functions. --- src/apply-default-acl.c | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/src/apply-default-acl.c b/src/apply-default-acl.c index 188c1f2..3cf3060 100644 --- a/src/apply-default-acl.c +++ b/src/apply-default-acl.c @@ -42,6 +42,21 @@ #define SNPRINTF_ERROR -1 #define STAT_ERROR -1 + +/** + * @brief The recursive portion of the @c safe_open function, used to + * open a file descriptor in a symlink-safe way when combined with + * the @c O_NOFOLLOW flag. + * + * @param at_fd + * A file descriptor relative to which @c pathname will be opened. + * + * @param pathname + * The path to the file/directory/whatever whose descriptor you want. + * + * @return a file descriptor for @c pathname if everything goes well, + * and @c OPEN_ERROR if not. + */ int safe_open_ex(int at_fd, char* pathname, int flags) { if (pathname != NULL && strlen(pathname) == 0) { /* Oops, went one level to deep with nothing to do. */ @@ -79,6 +94,29 @@ int safe_open_ex(int at_fd, char* pathname, int flags) { } +/** + * @brief A version of @c open that is completely symlink-safe when + * used with the @c O_NOFOLLOW flag. + * + * The @c openat function exists to ensure that you can anchor one + * path to a particular directory while opening it; however, if you + * open "b/c/d" relative to "/a", then even the @c openat function will + * still follow symlinks in the "b" component. This can be exploited + * by an attacker to make you open the wrong path. + * + * To avoid that problem, this function uses a recursive + * implementation that opens every path from the root, one level at a + * time. So "a" is opened relative to "/", and then "b" is opened + * relative to "/a", and then "c" is opened relative to "/a/b", + * etc. When the @c O_NOFOLLOW flag is used, this approach ensures + * that no symlinks in any component are followed. + * + * @param pathname + * The path to the file/directory/whatever whose descriptor you want. + * + * @return a file descriptor for @c pathname if everything goes well, + * and @c OPEN_ERROR if not. + */ int safe_open(const char* pathname, int flags) { if (pathname == NULL || strlen(pathname) == 0 || pathname[0] == '\0') { /* error? */ -- 2.43.2 From fce58c087eff25e4af70012ae05607cdfe5f2abf Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 26 Feb 2018 08:41:16 -0500 Subject: [PATCH 02/16] Update the man page to say that symlinks are ignored in all path components. --- doc/man/apply-default-acl.1 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/man/apply-default-acl.1 b/doc/man/apply-default-acl.1 index bfbb724..683919b 100644 --- a/doc/man/apply-default-acl.1 +++ b/doc/man/apply-default-acl.1 @@ -12,7 +12,8 @@ apply-default-acl \- Apply default POSIX ACLs to files and directories. .P If the directory containing \fIpath\fR has a default ACL, the ACL on \fIpath\fR is replaced with that default. Neither symbolic nor hard -links are followed. +links are followed; symbolic links are ignored in all path components +to avoid a dangerous race condition. .P By default, a heuristic is used to determine whether or not the -- 2.43.2 From 7ce092ba47607098bb57695396357b8eab90e81b Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 26 Feb 2018 09:40:18 -0500 Subject: [PATCH 03/16] Split most functions off into a separate shared library. --- autogen.sh | 4 +- configure.ac | 5 +- run-tests.sh | 15 +- src/Makefile.am | 7 +- src/apply-default-acl.c | 831 +-------------------------------------- src/libadacl.c | 832 ++++++++++++++++++++++++++++++++++++++++ src/libadacl.h | 25 ++ 7 files changed, 879 insertions(+), 840 deletions(-) create mode 100644 src/libadacl.c create mode 100644 src/libadacl.h diff --git a/autogen.sh b/autogen.sh index cabc6bd..e7ae7a0 100755 --- a/autogen.sh +++ b/autogen.sh @@ -1,4 +1,2 @@ # Regenerate the junk that autotools wants to have around. -aclocal -automake --foreign --add-missing -Wall -Werror -autoconf +autoreconf --force --install diff --git a/configure.ac b/configure.ac index c279015..b3afe4a 100644 --- a/configure.ac +++ b/configure.ac @@ -3,12 +3,13 @@ AC_PREREQ([2.68]) AC_INIT([apply-default-acl], [0.0.6], [michael@orlitzky.com]) -AM_INIT_AUTOMAKE +AM_INIT_AUTOMAKE([foreign]) # don't bug me a bout README, NEWS, etc. AC_CONFIG_SRCDIR([src/apply-default-acl.c]) AC_CONFIG_FILES([Makefile src/Makefile]) # Checks for programs. AC_PROG_CC +AM_PROG_AR # Predefined header checks. AC_HEADER_STAT # sys/stat.h @@ -20,4 +21,6 @@ AC_TYPE_MODE_T AC_CHECK_HEADERS([ fcntl.h ftw.h getopt.h libgen.h sys/acl.h sys/libacl.h ]) AC_CHECK_HEADERS([ sys/types.h unistd.h ]) +LT_INIT + AC_OUTPUT diff --git a/run-tests.sh b/run-tests.sh index d75e91e..e4ca376 100755 --- a/run-tests.sh +++ b/run-tests.sh @@ -671,14 +671,16 @@ compare # If we call apply-default-acl on a single file that does not exist, # we get the expected error. TESTNUM=25 -ACTUAL=$( ${BIN} test/nonexistent 2>&1 ) -EXPECTED="${BIN}: test/nonexistent: No such file or directory" +ACTUAL=$( "${BIN}" test/nonexistent 2>&1 ) +ACTUAL="${ACTUAL#*: }" +EXPECTED="test/nonexistent: No such file or directory" compare # Same as the previous test, but with --recursive. TESTNUM=26 -ACTUAL=$( ${BIN} --recursive test/nonexistent 2>&1 ) -EXPECTED="${BIN}: test/nonexistent: No such file or directory" +ACTUAL=$( "${BIN}" --recursive test/nonexistent 2>&1 ) +ACTUAL="${ACTUAL#*: }" +EXPECTED="test/nonexistent: No such file or directory" compare # If we call apply-default-acl on more than one file, it should report any @@ -687,8 +689,9 @@ TESTNUM=27 DUMMY1="${TESTDIR}/dummy1" DUMMY2="${TESTDIR}/dummy2" touch "${DUMMY1}" "${DUMMY2}" -ACTUAL=$( ${BIN} "${DUMMY1}" test/nonexistent "${DUMMY2}" 2>&1 ) -EXPECTED="${BIN}: test/nonexistent: No such file or directory" +ACTUAL=$( "${BIN}" "${DUMMY1}" test/nonexistent "${DUMMY2}" 2>&1 ) +ACTUAL="${ACTUAL#*: }" +EXPECTED="test/nonexistent: No such file or directory" compare diff --git a/src/Makefile.am b/src/Makefile.am index f2d86ec..dd95ec1 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,2 +1,7 @@ +lib_LTLIBRARIES = libadacl.la +libadacl_la_SOURCES = libadacl.c libadacl.h +libadacl_la_LIBADD = -lacl +include_HEADERS = libadacl.h + bin_PROGRAMS = apply-default-acl -apply_default_acl_LDFLAGS = -lacl +apply_default_acl_LDADD = libadacl.la diff --git a/src/apply-default-acl.c b/src/apply-default-acl.c index 3cf3060..c075059 100644 --- a/src/apply-default-acl.c +++ b/src/apply-default-acl.c @@ -1,7 +1,7 @@ /** * @file apply-default-acl.c * - * @brief The entire implementation. + * @brief The command-line interface. * */ @@ -13,165 +13,12 @@ #include /* AT_FOO constants */ #include /* nftw() et al. */ #include -#include /* basename(), dirname() */ -#include /* PATH_MAX */ #include #include #include -#include -#include #include -/* ACLs */ -#include /* acl_get_perm, not portable */ -#include -#include - -/* Most of the libacl functions return 1 for success, 0 for failure, - and -1 on error */ -#define ACL_ERROR -1 -#define ACL_FAILURE 0 -#define ACL_SUCCESS 1 - -/* Even though most other library functions reliably return -1 for - * error, it feels a little wrong to re-use the ACL_ERROR constant. - */ -#define CLOSE_ERROR -1 -#define NFTW_ERROR -1 -#define OPEN_ERROR -1 -#define SNPRINTF_ERROR -1 -#define STAT_ERROR -1 - - -/** - * @brief The recursive portion of the @c safe_open function, used to - * open a file descriptor in a symlink-safe way when combined with - * the @c O_NOFOLLOW flag. - * - * @param at_fd - * A file descriptor relative to which @c pathname will be opened. - * - * @param pathname - * The path to the file/directory/whatever whose descriptor you want. - * - * @return a file descriptor for @c pathname if everything goes well, - * and @c OPEN_ERROR if not. - */ -int safe_open_ex(int at_fd, char* pathname, int flags) { - if (pathname != NULL && strlen(pathname) == 0) { - /* Oops, went one level to deep with nothing to do. */ - return at_fd; - } - - char* firstslash = strchr(pathname, '/'); - if (firstslash == NULL) { - /* No more slashes, this is the base case. */ - int r = openat(at_fd, pathname, flags); - return r; - } - - /* Temporarily disable the slash, so that the subsequent call to - openat() opens only the next directory (and doesn't recurse). */ - *firstslash = '\0'; - int fd = safe_open_ex(at_fd, pathname, flags); - if (fd == OPEN_ERROR) { - if (errno != ELOOP) { - /* Don't output anything if we ignore a symlink */ - perror("safe_open_ex (safe_open_ex)"); - } - return OPEN_ERROR; - } - - /* The ++ is safe because there needs to be at least a null byte - after the first slash, even if it's the last real character in - the string. */ - int result = safe_open_ex(fd, firstslash+1, flags); - if (close(fd) == CLOSE_ERROR) { - perror("safe_open_ex (close)"); - return OPEN_ERROR; - } - return result; -} - - -/** - * @brief A version of @c open that is completely symlink-safe when - * used with the @c O_NOFOLLOW flag. - * - * The @c openat function exists to ensure that you can anchor one - * path to a particular directory while opening it; however, if you - * open "b/c/d" relative to "/a", then even the @c openat function will - * still follow symlinks in the "b" component. This can be exploited - * by an attacker to make you open the wrong path. - * - * To avoid that problem, this function uses a recursive - * implementation that opens every path from the root, one level at a - * time. So "a" is opened relative to "/", and then "b" is opened - * relative to "/a", and then "c" is opened relative to "/a/b", - * etc. When the @c O_NOFOLLOW flag is used, this approach ensures - * that no symlinks in any component are followed. - * - * @param pathname - * The path to the file/directory/whatever whose descriptor you want. - * - * @return a file descriptor for @c pathname if everything goes well, - * and @c OPEN_ERROR if not. - */ -int safe_open(const char* pathname, int flags) { - if (pathname == NULL || strlen(pathname) == 0 || pathname[0] == '\0') { - /* error? */ - return OPEN_ERROR; - } - - char abspath[PATH_MAX]; - int snprintf_result = 0; - if (strchr(pathname, '/') == pathname) { - /* pathname is already absolute; just copy it. */ - snprintf_result = snprintf(abspath, PATH_MAX, "%s", pathname); - } - else { - /* Concatenate the current working directory and pathname into an - * absolute path. We use realpath() ONLY on the cwd part, and not - * on the pathname part, because realpath() resolves symlinks. And - * the whole point of all this crap is to avoid following symlinks - * in the pathname. - * - * Using realpath() on the cwd lets us operate on relative paths - * while we're sitting in a directory that happens to have a - * symlink in it; for example: cd /var/run && apply-default-acl foo. - */ - char* cwd = get_current_dir_name(); - if (cwd == NULL) { - perror("safe_open (get_current_dir_name)"); - return OPEN_ERROR; - } - - char abs_cwd[PATH_MAX]; - if (realpath(cwd, abs_cwd) == NULL) { - perror("safe_open (realpath)"); - free(cwd); - return OPEN_ERROR; - } - snprintf_result = snprintf(abspath, PATH_MAX, "%s/%s", abs_cwd, pathname); - free(cwd); - } - if (snprintf_result == SNPRINTF_ERROR || snprintf_result > PATH_MAX) { - perror("safe_open (snprintf)"); - return OPEN_ERROR; - } - - int fd = open("/", flags); - if (strcmp(abspath, "/") == 0) { - return fd; - } - - int result = safe_open_ex(fd, abspath+1, flags); - if (close(fd) == CLOSE_ERROR) { - perror("safe_open (close)"); - return OPEN_ERROR; - } - return result; -} +#include "libadacl.h" @@ -208,680 +55,6 @@ bool path_accessible(const char* path) { } - -/** - * @brief Update (or create) an entry in an @b minimal ACL. - * - * This function will not work if @c aclp contains extended - * entries. This is fine for our purposes, since we call @c wipe_acls - * on each path before applying the default to it. - * - * The assumption that there are no extended entries makes things much - * simpler. For example, we only have to update the @c ACL_USER_OBJ, - * @c ACL_GROUP_OBJ, and @c ACL_OTHER entries -- all others can simply - * be created anew. This means we don't have to fool around comparing - * named-user/group entries. - * - * @param aclp - * A pointer to the acl_t structure whose entry we want to modify. - * - * @param entry - * The new entry. If @c entry contains a user/group/other entry, we - * update the existing one. Otherwise we create a new entry. - * - * @return If there is an unexpected library error, @c ACL_ERROR is - * returned. Otherwise, @c ACL_SUCCESS. - * - */ -int acl_set_entry(acl_t* aclp, acl_entry_t entry) { - - acl_tag_t entry_tag; - if (acl_get_tag_type(entry, &entry_tag) == ACL_ERROR) { - perror("acl_set_entry (acl_get_tag_type)"); - return ACL_ERROR; - } - - acl_permset_t entry_permset; - if (acl_get_permset(entry, &entry_permset) == ACL_ERROR) { - perror("acl_set_entry (acl_get_permset)"); - return ACL_ERROR; - } - - acl_entry_t existing_entry; - /* Loop through the given ACL looking for matching entries. */ - int result = acl_get_entry(*aclp, ACL_FIRST_ENTRY, &existing_entry); - - while (result == ACL_SUCCESS) { - acl_tag_t existing_tag = ACL_UNDEFINED_TAG; - - if (acl_get_tag_type(existing_entry, &existing_tag) == ACL_ERROR) { - perror("set_acl_tag_permset (acl_get_tag_type)"); - return ACL_ERROR; - } - - if (existing_tag == entry_tag) { - if (entry_tag == ACL_USER_OBJ || - entry_tag == ACL_GROUP_OBJ || - entry_tag == ACL_OTHER) { - /* Only update for these three since all other tags will have - been wiped. These three are guaranteed to exist, so if we - match one of them, we're allowed to return ACL_SUCCESS - below and bypass the rest of the function. */ - acl_permset_t existing_permset; - if (acl_get_permset(existing_entry, &existing_permset) == ACL_ERROR) { - perror("acl_set_entry (acl_get_permset)"); - return ACL_ERROR; - } - - if (acl_set_permset(existing_entry, entry_permset) == ACL_ERROR) { - perror("acl_set_entry (acl_set_permset)"); - return ACL_ERROR; - } - - return ACL_SUCCESS; - } - - } - - result = acl_get_entry(*aclp, ACL_NEXT_ENTRY, &existing_entry); - } - - /* This catches both the initial acl_get_entry and the ones at the - end of the loop. */ - if (result == ACL_ERROR) { - perror("acl_set_entry (acl_get_entry)"); - return ACL_ERROR; - } - - /* If we've made it this far, we need to add a new entry to the - ACL. */ - acl_entry_t new_entry; - - /* The acl_create_entry() function can allocate new memory and/or - * change the location of the ACL structure entirely. When that - * happens, the value pointed to by aclp is updated, which means - * that a new acl_t gets "passed out" to our caller, eventually to - * be fed to acl_free(). In other words, we should still be freeing - * the right thing, even if the value pointed to by aclp changes. - */ - if (acl_create_entry(aclp, &new_entry) == ACL_ERROR) { - perror("acl_set_entry (acl_create_entry)"); - return ACL_ERROR; - } - - if (acl_set_tag_type(new_entry, entry_tag) == ACL_ERROR) { - perror("acl_set_entry (acl_set_tag_type)"); - return ACL_ERROR; - } - - if (acl_set_permset(new_entry, entry_permset) == ACL_ERROR) { - perror("acl_set_entry (acl_set_permset)"); - return ACL_ERROR; - } - - if (entry_tag == ACL_USER || entry_tag == ACL_GROUP) { - /* We need to set the qualifier too. */ - void* entry_qual = acl_get_qualifier(entry); - if (entry_qual == (void*)NULL) { - perror("acl_set_entry (acl_get_qualifier)"); - return ACL_ERROR; - } - - if (acl_set_qualifier(new_entry, entry_qual) == ACL_ERROR) { - perror("acl_set_entry (acl_set_qualifier)"); - return ACL_ERROR; - } - } - - return ACL_SUCCESS; -} - - - -/** - * @brief Determine the number of entries in the given ACL. - * - * @param acl - * The ACL to inspect. - * - * @return Either the non-negative number of entries in @c acl, or - * @c ACL_ERROR on error. - */ -int acl_entry_count(acl_t acl) { - - acl_entry_t entry; - int entry_count = 0; - int result = acl_get_entry(acl, ACL_FIRST_ENTRY, &entry); - - while (result == ACL_SUCCESS) { - entry_count++; - result = acl_get_entry(acl, ACL_NEXT_ENTRY, &entry); - } - - if (result == ACL_ERROR) { - perror("acl_entry_count (acl_get_entry)"); - return ACL_ERROR; - } - - return entry_count; -} - - - -/** - * @brief Determine whether or not the given ACL is minimal. - * - * An ACL is minimal if it has fewer than four entries. - * - * @param acl - * The ACL whose minimality is in question. - * - * @return - * - @c ACL_SUCCESS - @c acl is minimal - * - @c ACL_FAILURE - @c acl is not minimal - * - @c ACL_ERROR - Unexpected library error - */ -int acl_is_minimal(acl_t acl) { - - int ec = acl_entry_count(acl); - - if (ec == ACL_ERROR) { - perror("acl_is_minimal (acl_entry_count)"); - return ACL_ERROR; - } - - if (ec < 4) { - return ACL_SUCCESS; - } - else { - return ACL_FAILURE; - } -} - - - -/** - * @brief Determine whether the given ACL's mask denies execute. - * - * @param acl - * The ACL whose mask we want to check. - * - * @return - * - @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(acl_t acl) { - - acl_entry_t entry; - int ge_result = acl_get_entry(acl, ACL_FIRST_ENTRY, &entry); - - while (ge_result == ACL_SUCCESS) { - acl_tag_t tag = ACL_UNDEFINED_TAG; - - if (acl_get_tag_type(entry, &tag) == ACL_ERROR) { - perror("acl_execute_masked (acl_get_tag_type)"); - return ACL_ERROR; - } - - if (tag == ACL_MASK) { - /* This is the mask entry, get its permissions, and see if - execute is specified. */ - acl_permset_t permset; - - if (acl_get_permset(entry, &permset) == ACL_ERROR) { - perror("acl_execute_masked (acl_get_permset)"); - return ACL_ERROR; - } - - int gp_result = acl_get_perm(permset, ACL_EXECUTE); - if (gp_result == ACL_ERROR) { - perror("acl_execute_masked (acl_get_perm)"); - return ACL_ERROR; - } - - if (gp_result == ACL_FAILURE) { - /* No execute bit set in the mask; execute not allowed. */ - return ACL_SUCCESS; - } - } - - ge_result = acl_get_entry(acl, ACL_NEXT_ENTRY, &entry); - } - - return ACL_FAILURE; -} - - - -/** - * @brief Determine whether @c fd is executable by anyone. - * - * - * This is used as part of the heuristic to determine whether or not - * we should mask the execute bit when inheriting an ACL. If @c fd - * describes a file, we check the @a effective permissions, contrary - * to what setfacl does. - * - * @param fd - * The file descriptor to check. - * - * @param sp - * A pointer to a stat structure for @c fd. - * - * @return - * - @c ACL_SUCCESS - Someone has effective execute permissions on @c fd. - * - @c ACL_FAILURE - Nobody can execute @c fd. - * - @c ACL_ERROR - Unexpected library error. - */ -int any_can_execute(int fd, const struct stat* sp) { - acl_t acl = acl_get_fd(fd); - - if (acl == (acl_t)NULL) { - perror("any_can_execute (acl_get_file)"); - return ACL_ERROR; - } - - /* Our return value. */ - int result = ACL_FAILURE; - - if (acl_is_minimal(acl)) { - if (sp->st_mode & (S_IXUSR | S_IXOTH | S_IXGRP)) { - result = ACL_SUCCESS; - goto cleanup; - } - else { - result = ACL_FAILURE; - goto cleanup; - } - } - - acl_entry_t entry; - 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; - - if (acl_get_tag_type(entry, &tag) == ACL_ERROR) { - perror("any_can_execute_or (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; - - if (acl_get_permset(entry, &permset) == ACL_ERROR) { - perror("any_can_execute_or (acl_get_permset)"); - result = ACL_ERROR; - goto cleanup; - } - - int gp_result = acl_get_perm(permset, ACL_EXECUTE); - if (gp_result == ACL_ERROR) { - perror("any_can_execute (acl_get_perm)"); - result = ACL_ERROR; - goto cleanup; - } - - if (gp_result == 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; - } - } - - ge_result = acl_get_entry(acl, ACL_NEXT_ENTRY, &entry); - } - - if (ge_result == ACL_ERROR) { - perror("any_can_execute (acl_get_entry)"); - result = ACL_ERROR; - goto cleanup; - } - - cleanup: - acl_free(acl); - return result; -} - - - -/** - * @brief Set @c acl as the default ACL on @c path. - * - * This overwrites any existing default ACL on @c path. If @c path is - * not a directory, we return ACL_ERROR and @c errno is set. - * - * @param path - * 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 assigned successfully. - * - @c ACL_ERROR - Unexpected library error. - */ -int assign_default_acl(const char* path, acl_t acl) { - - if (path == NULL) { - errno = EINVAL; - perror("assign_default_acl (args)"); - return ACL_ERROR; - } - - /* 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("assign_default_acl (acl_dup)"); - return ACL_ERROR; /* Nothing to clean up in this case. */ - } - - if (acl_set_file(path, ACL_TYPE_DEFAULT, path_acl) == ACL_ERROR) { - perror("assign_default_acl (acl_set_file)"); - result = ACL_ERROR; - } - - acl_free(path_acl); - return result; -} - - - -/** - * @brief Remove all @c ACL_TYPE_ACCESS entries from the given file - * descriptor, leaving the UNIX permission bits. - * - * @param fd - * The file descriptor whose ACLs we want to wipe. - * - * @return - * - @c ACL_SUCCESS - The ACLs were wiped successfully, or none - * existed in the first place. - * - @c ACL_ERROR - Unexpected library error. - */ -int wipe_acls(int fd) { - /* Initialize an empty ACL, and then overwrite the one on "fd" with it. */ - acl_t empty_acl = acl_init(0); - - if (empty_acl == (acl_t)NULL) { - perror("wipe_acls (acl_init)"); - return ACL_ERROR; - } - - if (acl_set_fd(fd, empty_acl) == ACL_ERROR) { - perror("wipe_acls (acl_set_fd)"); - acl_free(empty_acl); - return ACL_ERROR; - } - - acl_free(empty_acl); - return ACL_SUCCESS; -} - - - -/** - * @brief Apply parent default ACL to a path. - * - * This overwrites any existing ACLs on @c path. - * - * @param path - * The path whose ACL we would like to reset to its default. - * - * @param sp - * A pointer to a stat structure for @c path, or @c NULL if you don't - * have one handy. - * - * @param no_exec_mask - * The value (either true or false) of the --no-exec-mask flag. - * - * @return - * - @c ACL_SUCCESS - The parent default ACL was inherited successfully. - * - @c ACL_FAILURE - The target path is not a regular file/directory, - * or the parent of @c path is not a directory. - * - @c ACL_ERROR - Unexpected library error. - */ -int apply_default_acl(const char* path, - const struct stat* sp, - bool no_exec_mask) { - - if (path == NULL) { - errno = EINVAL; - perror("apply_default_acl (args)"); - return ACL_ERROR; - } - - /* Define these next three variables here because we may have to - * jump to the cleanup routine which expects them to exist. - */ - - /* Our return value. */ - int result = ACL_SUCCESS; - - /* The default ACL on path's parent directory */ - acl_t defacl = (acl_t)NULL; - - /* The file descriptor corresponding to "path" */ - int fd = 0; - - /* Get the parent directory of "path" with dirname(), which happens - * to murder its argument and necessitates a path_copy. - */ - char* path_copy = strdup(path); - if (path_copy == NULL) { - perror("apply_default_acl (strdup)"); - return ACL_ERROR; - } - char* parent = dirname(path_copy); - - fd = safe_open(path, O_NOFOLLOW); - if (fd == OPEN_ERROR) { - if (errno == ELOOP) { - result = ACL_FAILURE; /* hit a symlink */ - goto cleanup; - } - else { - perror("apply_default_acl (open fd)"); - result = ACL_ERROR; - goto cleanup; - } - } - - - /* 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. There is TOCTOU - * race condition here, but the window is as small as possible - * between when we open the file descriptor (look above) and when we - * fstat it. - * - * Note: we only need to call fstat ourselves if we weren't passed a - * valid pointer to a stat structure (nftw does that). - */ - if (sp == NULL) { - struct stat s; - if (fstat(fd, &s) == STAT_ERROR) { - perror("apply_default_acl (fstat)"); - goto cleanup; - } - - sp = &s; - } - - if (!S_ISDIR(sp->st_mode)) { - /* If it's not a directory, make sure it's a regular, - non-hard-linked file. */ - if (!S_ISREG(sp->st_mode) || sp->st_nlink != 1) { - result = ACL_FAILURE; - goto cleanup; - } - } - - - /* Default to not masking the exec bit; i.e. applying the default - ACL literally. If --no-exec-mask was not specified, then we try - to "guess" whether or not to mask the exec bit. This behavior - is modeled after the capital 'X' perms of setfacl. */ - bool allow_exec = true; - - if (!no_exec_mask) { - /* Never mask the execute bit on directories. */ - int ace_result = any_can_execute(fd,sp) || S_ISDIR(sp->st_mode); - - if (ace_result == ACL_ERROR) { - perror("apply_default_acl (any_can_execute)"); - result = ACL_ERROR; - goto cleanup; - } - - allow_exec = (bool)ace_result; - } - - defacl = acl_get_file(parent, ACL_TYPE_DEFAULT); - - if (defacl == (acl_t)NULL) { - perror("apply_default_acl (acl_get_file)"); - result = ACL_ERROR; - goto cleanup; - } - - if (wipe_acls(fd) == ACL_ERROR) { - perror("apply_default_acl (wipe_acls)"); - result = ACL_ERROR; - goto cleanup; - } - - /* Do this after wipe_acls(), otherwise we'll overwrite the wiped - ACL with this one. */ - acl_t acl = acl_get_fd(fd); - if (acl == (acl_t)NULL) { - perror("apply_default_acl (acl_get_fd)"); - result = ACL_ERROR; - goto cleanup; - } - - /* If it's a directory, inherit the parent's default. We sure hope - * that "path" still points to the same thing that "fd" and this - * "sp" describe. If not, we may wind up trying to set a default ACL - * on a file, and this will throw an error. I guess that's what we - * want to do? - */ - if (S_ISDIR(sp->st_mode) && assign_default_acl(path, defacl) == ACL_ERROR) { - perror("apply_default_acl (assign_default_acl)"); - result = ACL_ERROR; - goto cleanup; - } - - acl_entry_t entry; - int ge_result = acl_get_entry(defacl, ACL_FIRST_ENTRY, &entry); - - while (ge_result == ACL_SUCCESS) { - acl_tag_t tag = ACL_UNDEFINED_TAG; - - if (acl_get_tag_type(entry, &tag) == ACL_ERROR) { - perror("apply_default_acl (acl_get_tag_type)"); - result = ACL_ERROR; - goto cleanup; - } - - - /* We've got an entry/tag from the default ACL. Get its permset. */ - acl_permset_t permset; - if (acl_get_permset(entry, &permset) == ACL_ERROR) { - perror("apply_default_acl (acl_get_permset)"); - result = ACL_ERROR; - goto cleanup; - } - - /* If this is a default mask, fix it up. */ - if (tag == ACL_MASK || - tag == ACL_USER_OBJ || - tag == ACL_GROUP_OBJ || - tag == ACL_OTHER) { - - if (!allow_exec) { - /* The mask doesn't affect acl_user_obj, acl_group_obj (in - minimal ACLs) or acl_other entries, so if execute should be - masked, we have to do it manually. */ - if (acl_delete_perm(permset, ACL_EXECUTE) == ACL_ERROR) { - perror("apply_default_acl (acl_delete_perm)"); - result = ACL_ERROR; - goto cleanup; - } - - if (acl_set_permset(entry, permset) == ACL_ERROR) { - perror("apply_default_acl (acl_set_permset)"); - result = ACL_ERROR; - goto cleanup; - } - } - } - - /* Finally, add the permset to the access ACL. It's actually - * important that we pass in the address of "acl" here, and not - * "acl" itself. Why? The call to acl_create_entry() within - * acl_set_entry() can allocate new memory for the entry. - * Sometimes that can be done in-place, in which case everything - * is cool and the new memory gets released when we call - * acl_free(acl). - * - * But occasionally, the whole ACL structure will have to be moved - * in order to allocate the extra space. When that happens, - * acl_create_entry() modifies the pointer it was passed (in this - * case, &acl) to point to the new location. We want to call - * acl_free() on the new location, and since acl_free() gets - * called right here, we need acl_create_entry() to update the - * value of "acl". To do that, it needs the address of "acl". - */ - if (acl_set_entry(&acl, entry) == ACL_ERROR) { - perror("apply_default_acl (acl_set_entry)"); - result = ACL_ERROR; - goto cleanup; - } - - ge_result = acl_get_entry(defacl, ACL_NEXT_ENTRY, &entry); - } - - /* Catches the first acl_get_entry as well as the ones at the end of - the loop. */ - if (ge_result == ACL_ERROR) { - perror("apply_default_acl (acl_get_entry)"); - result = ACL_ERROR; - goto cleanup; - } - - if (acl_set_fd(fd, acl) == ACL_ERROR) { - perror("apply_default_acl (acl_set_fd)"); - result = ACL_ERROR; - goto cleanup; - } - - cleanup: - free(path_copy); - if (defacl != (acl_t)NULL) { - acl_free(defacl); - } - if (fd >= 0 && close(fd) == CLOSE_ERROR) { - perror("apply_default_acl (close)"); - result = ACL_ERROR; - } - return result; -} - - - /** * @brief Display program usage information. * diff --git a/src/libadacl.c b/src/libadacl.c new file mode 100644 index 0000000..28d5782 --- /dev/null +++ b/src/libadacl.c @@ -0,0 +1,832 @@ +/** + * @file libadacl.c + * + * @brief The adacl (apply default acl) shared library. + * + */ + +/* Enables get_current_dir_name() in unistd.h */ +#define _GNU_SOURCE + +#include +#include +#include /* basename(), dirname() */ +#include /* PATH_MAX */ +#include +#include +#include +#include +#include +#include /* get_current_dir_name() */ + +/* ACLs */ +#include /* acl_get_perm, not portable */ +#include +#include + +#include "libadacl.h" + + +/** + * @brief The recursive portion of the @c safe_open function, used to + * open a file descriptor in a symlink-safe way when combined with + * the @c O_NOFOLLOW flag. + * + * @param at_fd + * A file descriptor relative to which @c pathname will be opened. + * + * @param pathname + * The path to the file/directory/whatever whose descriptor you want. + * + * @return a file descriptor for @c pathname if everything goes well, + * and @c OPEN_ERROR if not. + */ +int safe_open_ex(int at_fd, char* pathname, int flags) { + if (pathname != NULL && strlen(pathname) == 0) { + /* Oops, went one level to deep with nothing to do. */ + return at_fd; + } + + char* firstslash = strchr(pathname, '/'); + if (firstslash == NULL) { + /* No more slashes, this is the base case. */ + int r = openat(at_fd, pathname, flags); + return r; + } + + /* Temporarily disable the slash, so that the subsequent call to + openat() opens only the next directory (and doesn't recurse). */ + *firstslash = '\0'; + int fd = safe_open_ex(at_fd, pathname, flags); + if (fd == OPEN_ERROR) { + if (errno != ELOOP) { + /* Don't output anything if we ignore a symlink */ + perror("safe_open_ex (safe_open_ex)"); + } + return OPEN_ERROR; + } + + /* The ++ is safe because there needs to be at least a null byte + after the first slash, even if it's the last real character in + the string. */ + int result = safe_open_ex(fd, firstslash+1, flags); + if (close(fd) == CLOSE_ERROR) { + perror("safe_open_ex (close)"); + return OPEN_ERROR; + } + return result; +} + + +/** + * @brief A version of @c open that is completely symlink-safe when + * used with the @c O_NOFOLLOW flag. + * + * The @c openat function exists to ensure that you can anchor one + * path to a particular directory while opening it; however, if you + * open "b/c/d" relative to "/a", then even the @c openat function will + * still follow symlinks in the "b" component. This can be exploited + * by an attacker to make you open the wrong path. + * + * To avoid that problem, this function uses a recursive + * implementation that opens every path from the root, one level at a + * time. So "a" is opened relative to "/", and then "b" is opened + * relative to "/a", and then "c" is opened relative to "/a/b", + * etc. When the @c O_NOFOLLOW flag is used, this approach ensures + * that no symlinks in any component are followed. + * + * @param pathname + * The path to the file/directory/whatever whose descriptor you want. + * + * @return a file descriptor for @c pathname if everything goes well, + * and @c OPEN_ERROR if not. + */ +int safe_open(const char* pathname, int flags) { + if (pathname == NULL || strlen(pathname) == 0 || pathname[0] == '\0') { + /* error? */ + return OPEN_ERROR; + } + + char abspath[PATH_MAX]; + int snprintf_result = 0; + if (strchr(pathname, '/') == pathname) { + /* pathname is already absolute; just copy it. */ + snprintf_result = snprintf(abspath, PATH_MAX, "%s", pathname); + } + else { + /* Concatenate the current working directory and pathname into an + * absolute path. We use realpath() ONLY on the cwd part, and not + * on the pathname part, because realpath() resolves symlinks. And + * the whole point of all this crap is to avoid following symlinks + * in the pathname. + * + * Using realpath() on the cwd lets us operate on relative paths + * while we're sitting in a directory that happens to have a + * symlink in it; for example: cd /var/run && apply-default-acl foo. + */ + char* cwd = get_current_dir_name(); + if (cwd == NULL) { + perror("safe_open (get_current_dir_name)"); + return OPEN_ERROR; + } + + char abs_cwd[PATH_MAX]; + if (realpath(cwd, abs_cwd) == NULL) { + perror("safe_open (realpath)"); + free(cwd); + return OPEN_ERROR; + } + snprintf_result = snprintf(abspath, PATH_MAX, "%s/%s", abs_cwd, pathname); + free(cwd); + } + if (snprintf_result == SNPRINTF_ERROR || snprintf_result > PATH_MAX) { + perror("safe_open (snprintf)"); + return OPEN_ERROR; + } + + int fd = open("/", flags); + if (strcmp(abspath, "/") == 0) { + return fd; + } + + int result = safe_open_ex(fd, abspath+1, flags); + if (close(fd) == CLOSE_ERROR) { + perror("safe_open (close)"); + return OPEN_ERROR; + } + return result; +} + + + + +/** + * @brief Update (or create) an entry in an @b minimal ACL. + * + * This function will not work if @c aclp contains extended + * entries. This is fine for our purposes, since we call @c wipe_acls + * on each path before applying the default to it. + * + * The assumption that there are no extended entries makes things much + * simpler. For example, we only have to update the @c ACL_USER_OBJ, + * @c ACL_GROUP_OBJ, and @c ACL_OTHER entries -- all others can simply + * be created anew. This means we don't have to fool around comparing + * named-user/group entries. + * + * @param aclp + * A pointer to the acl_t structure whose entry we want to modify. + * + * @param entry + * The new entry. If @c entry contains a user/group/other entry, we + * update the existing one. Otherwise we create a new entry. + * + * @return If there is an unexpected library error, @c ACL_ERROR is + * returned. Otherwise, @c ACL_SUCCESS. + * + */ +int acl_set_entry(acl_t* aclp, acl_entry_t entry) { + + acl_tag_t entry_tag; + if (acl_get_tag_type(entry, &entry_tag) == ACL_ERROR) { + perror("acl_set_entry (acl_get_tag_type)"); + return ACL_ERROR; + } + + acl_permset_t entry_permset; + if (acl_get_permset(entry, &entry_permset) == ACL_ERROR) { + perror("acl_set_entry (acl_get_permset)"); + return ACL_ERROR; + } + + acl_entry_t existing_entry; + /* Loop through the given ACL looking for matching entries. */ + int result = acl_get_entry(*aclp, ACL_FIRST_ENTRY, &existing_entry); + + while (result == ACL_SUCCESS) { + acl_tag_t existing_tag = ACL_UNDEFINED_TAG; + + if (acl_get_tag_type(existing_entry, &existing_tag) == ACL_ERROR) { + perror("set_acl_tag_permset (acl_get_tag_type)"); + return ACL_ERROR; + } + + if (existing_tag == entry_tag) { + if (entry_tag == ACL_USER_OBJ || + entry_tag == ACL_GROUP_OBJ || + entry_tag == ACL_OTHER) { + /* Only update for these three since all other tags will have + been wiped. These three are guaranteed to exist, so if we + match one of them, we're allowed to return ACL_SUCCESS + below and bypass the rest of the function. */ + acl_permset_t existing_permset; + if (acl_get_permset(existing_entry, &existing_permset) == ACL_ERROR) { + perror("acl_set_entry (acl_get_permset)"); + return ACL_ERROR; + } + + if (acl_set_permset(existing_entry, entry_permset) == ACL_ERROR) { + perror("acl_set_entry (acl_set_permset)"); + return ACL_ERROR; + } + + return ACL_SUCCESS; + } + + } + + result = acl_get_entry(*aclp, ACL_NEXT_ENTRY, &existing_entry); + } + + /* This catches both the initial acl_get_entry and the ones at the + end of the loop. */ + if (result == ACL_ERROR) { + perror("acl_set_entry (acl_get_entry)"); + return ACL_ERROR; + } + + /* If we've made it this far, we need to add a new entry to the + ACL. */ + acl_entry_t new_entry; + + /* The acl_create_entry() function can allocate new memory and/or + * change the location of the ACL structure entirely. When that + * happens, the value pointed to by aclp is updated, which means + * that a new acl_t gets "passed out" to our caller, eventually to + * be fed to acl_free(). In other words, we should still be freeing + * the right thing, even if the value pointed to by aclp changes. + */ + if (acl_create_entry(aclp, &new_entry) == ACL_ERROR) { + perror("acl_set_entry (acl_create_entry)"); + return ACL_ERROR; + } + + if (acl_set_tag_type(new_entry, entry_tag) == ACL_ERROR) { + perror("acl_set_entry (acl_set_tag_type)"); + return ACL_ERROR; + } + + if (acl_set_permset(new_entry, entry_permset) == ACL_ERROR) { + perror("acl_set_entry (acl_set_permset)"); + return ACL_ERROR; + } + + if (entry_tag == ACL_USER || entry_tag == ACL_GROUP) { + /* We need to set the qualifier too. */ + void* entry_qual = acl_get_qualifier(entry); + if (entry_qual == (void*)NULL) { + perror("acl_set_entry (acl_get_qualifier)"); + return ACL_ERROR; + } + + if (acl_set_qualifier(new_entry, entry_qual) == ACL_ERROR) { + perror("acl_set_entry (acl_set_qualifier)"); + return ACL_ERROR; + } + } + + return ACL_SUCCESS; +} + + + +/** + * @brief Determine the number of entries in the given ACL. + * + * @param acl + * The ACL to inspect. + * + * @return Either the non-negative number of entries in @c acl, or + * @c ACL_ERROR on error. + */ +int acl_entry_count(acl_t acl) { + + acl_entry_t entry; + int entry_count = 0; + int result = acl_get_entry(acl, ACL_FIRST_ENTRY, &entry); + + while (result == ACL_SUCCESS) { + entry_count++; + result = acl_get_entry(acl, ACL_NEXT_ENTRY, &entry); + } + + if (result == ACL_ERROR) { + perror("acl_entry_count (acl_get_entry)"); + return ACL_ERROR; + } + + return entry_count; +} + + + +/** + * @brief Determine whether or not the given ACL is minimal. + * + * An ACL is minimal if it has fewer than four entries. + * + * @param acl + * The ACL whose minimality is in question. + * + * @return + * - @c ACL_SUCCESS - @c acl is minimal + * - @c ACL_FAILURE - @c acl is not minimal + * - @c ACL_ERROR - Unexpected library error + */ +int acl_is_minimal(acl_t acl) { + + int ec = acl_entry_count(acl); + + if (ec == ACL_ERROR) { + perror("acl_is_minimal (acl_entry_count)"); + return ACL_ERROR; + } + + if (ec < 4) { + return ACL_SUCCESS; + } + else { + return ACL_FAILURE; + } +} + + + +/** + * @brief Determine whether the given ACL's mask denies execute. + * + * @param acl + * The ACL whose mask we want to check. + * + * @return + * - @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(acl_t acl) { + + acl_entry_t entry; + int ge_result = acl_get_entry(acl, ACL_FIRST_ENTRY, &entry); + + while (ge_result == ACL_SUCCESS) { + acl_tag_t tag = ACL_UNDEFINED_TAG; + + if (acl_get_tag_type(entry, &tag) == ACL_ERROR) { + perror("acl_execute_masked (acl_get_tag_type)"); + return ACL_ERROR; + } + + if (tag == ACL_MASK) { + /* This is the mask entry, get its permissions, and see if + execute is specified. */ + acl_permset_t permset; + + if (acl_get_permset(entry, &permset) == ACL_ERROR) { + perror("acl_execute_masked (acl_get_permset)"); + return ACL_ERROR; + } + + int gp_result = acl_get_perm(permset, ACL_EXECUTE); + if (gp_result == ACL_ERROR) { + perror("acl_execute_masked (acl_get_perm)"); + return ACL_ERROR; + } + + if (gp_result == ACL_FAILURE) { + /* No execute bit set in the mask; execute not allowed. */ + return ACL_SUCCESS; + } + } + + ge_result = acl_get_entry(acl, ACL_NEXT_ENTRY, &entry); + } + + return ACL_FAILURE; +} + + + +/** + * @brief Determine whether @c fd is executable by anyone. + * + * + * This is used as part of the heuristic to determine whether or not + * we should mask the execute bit when inheriting an ACL. If @c fd + * describes a file, we check the @a effective permissions, contrary + * to what setfacl does. + * + * @param fd + * The file descriptor to check. + * + * @param sp + * A pointer to a stat structure for @c fd. + * + * @return + * - @c ACL_SUCCESS - Someone has effective execute permissions on @c fd. + * - @c ACL_FAILURE - Nobody can execute @c fd. + * - @c ACL_ERROR - Unexpected library error. + */ +int any_can_execute(int fd, const struct stat* sp) { + acl_t acl = acl_get_fd(fd); + + if (acl == (acl_t)NULL) { + perror("any_can_execute (acl_get_file)"); + return ACL_ERROR; + } + + /* Our return value. */ + int result = ACL_FAILURE; + + if (acl_is_minimal(acl)) { + if (sp->st_mode & (S_IXUSR | S_IXOTH | S_IXGRP)) { + result = ACL_SUCCESS; + goto cleanup; + } + else { + result = ACL_FAILURE; + goto cleanup; + } + } + + acl_entry_t entry; + 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; + + if (acl_get_tag_type(entry, &tag) == ACL_ERROR) { + perror("any_can_execute_or (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; + + if (acl_get_permset(entry, &permset) == ACL_ERROR) { + perror("any_can_execute_or (acl_get_permset)"); + result = ACL_ERROR; + goto cleanup; + } + + int gp_result = acl_get_perm(permset, ACL_EXECUTE); + if (gp_result == ACL_ERROR) { + perror("any_can_execute (acl_get_perm)"); + result = ACL_ERROR; + goto cleanup; + } + + if (gp_result == 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; + } + } + + ge_result = acl_get_entry(acl, ACL_NEXT_ENTRY, &entry); + } + + if (ge_result == ACL_ERROR) { + perror("any_can_execute (acl_get_entry)"); + result = ACL_ERROR; + goto cleanup; + } + + cleanup: + acl_free(acl); + return result; +} + + + +/** + * @brief Set @c acl as the default ACL on @c path. + * + * This overwrites any existing default ACL on @c path. If @c path is + * not a directory, we return ACL_ERROR and @c errno is set. + * + * @param path + * 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 assigned successfully. + * - @c ACL_ERROR - Unexpected library error. + */ +int assign_default_acl(const char* path, acl_t acl) { + + if (path == NULL) { + errno = EINVAL; + perror("assign_default_acl (args)"); + return ACL_ERROR; + } + + /* 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("assign_default_acl (acl_dup)"); + return ACL_ERROR; /* Nothing to clean up in this case. */ + } + + if (acl_set_file(path, ACL_TYPE_DEFAULT, path_acl) == ACL_ERROR) { + perror("assign_default_acl (acl_set_file)"); + result = ACL_ERROR; + } + + acl_free(path_acl); + return result; +} + + + +/** + * @brief Remove all @c ACL_TYPE_ACCESS entries from the given file + * descriptor, leaving the UNIX permission bits. + * + * @param fd + * The file descriptor whose ACLs we want to wipe. + * + * @return + * - @c ACL_SUCCESS - The ACLs were wiped successfully, or none + * existed in the first place. + * - @c ACL_ERROR - Unexpected library error. + */ +int wipe_acls(int fd) { + /* Initialize an empty ACL, and then overwrite the one on "fd" with it. */ + acl_t empty_acl = acl_init(0); + + if (empty_acl == (acl_t)NULL) { + perror("wipe_acls (acl_init)"); + return ACL_ERROR; + } + + if (acl_set_fd(fd, empty_acl) == ACL_ERROR) { + perror("wipe_acls (acl_set_fd)"); + acl_free(empty_acl); + return ACL_ERROR; + } + + acl_free(empty_acl); + return ACL_SUCCESS; +} + + + +/** + * @brief Apply parent default ACL to a path. + * + * This overwrites any existing ACLs on @c path. + * + * @param path + * The path whose ACL we would like to reset to its default. + * + * @param sp + * A pointer to a stat structure for @c path, or @c NULL if you don't + * have one handy. + * + * @param no_exec_mask + * The value (either true or false) of the --no-exec-mask flag. + * + * @return + * - @c ACL_SUCCESS - The parent default ACL was inherited successfully. + * - @c ACL_FAILURE - The target path is not a regular file/directory, + * or the parent of @c path is not a directory. + * - @c ACL_ERROR - Unexpected library error. + */ +int apply_default_acl(const char* path, + const struct stat* sp, + bool no_exec_mask) { + + if (path == NULL) { + errno = EINVAL; + perror("apply_default_acl (args)"); + return ACL_ERROR; + } + + /* Define these next three variables here because we may have to + * jump to the cleanup routine which expects them to exist. + */ + + /* Our return value. */ + int result = ACL_SUCCESS; + + /* The default ACL on path's parent directory */ + acl_t defacl = (acl_t)NULL; + + /* The file descriptor corresponding to "path" */ + int fd = 0; + + /* Get the parent directory of "path" with dirname(), which happens + * to murder its argument and necessitates a path_copy. + */ + char* path_copy = strdup(path); + if (path_copy == NULL) { + perror("apply_default_acl (strdup)"); + return ACL_ERROR; + } + char* parent = dirname(path_copy); + + fd = safe_open(path, O_NOFOLLOW); + if (fd == OPEN_ERROR) { + if (errno == ELOOP) { + result = ACL_FAILURE; /* hit a symlink */ + goto cleanup; + } + else { + perror("apply_default_acl (open fd)"); + result = ACL_ERROR; + goto cleanup; + } + } + + + /* 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. There is TOCTOU + * race condition here, but the window is as small as possible + * between when we open the file descriptor (look above) and when we + * fstat it. + * + * Note: we only need to call fstat ourselves if we weren't passed a + * valid pointer to a stat structure (nftw does that). + */ + if (sp == NULL) { + struct stat s; + if (fstat(fd, &s) == STAT_ERROR) { + perror("apply_default_acl (fstat)"); + goto cleanup; + } + + sp = &s; + } + + if (!S_ISDIR(sp->st_mode)) { + /* If it's not a directory, make sure it's a regular, + non-hard-linked file. */ + if (!S_ISREG(sp->st_mode) || sp->st_nlink != 1) { + result = ACL_FAILURE; + goto cleanup; + } + } + + + /* Default to not masking the exec bit; i.e. applying the default + ACL literally. If --no-exec-mask was not specified, then we try + to "guess" whether or not to mask the exec bit. This behavior + is modeled after the capital 'X' perms of setfacl. */ + bool allow_exec = true; + + if (!no_exec_mask) { + /* Never mask the execute bit on directories. */ + int ace_result = any_can_execute(fd,sp) || S_ISDIR(sp->st_mode); + + if (ace_result == ACL_ERROR) { + perror("apply_default_acl (any_can_execute)"); + result = ACL_ERROR; + goto cleanup; + } + + allow_exec = (bool)ace_result; + } + + defacl = acl_get_file(parent, ACL_TYPE_DEFAULT); + + if (defacl == (acl_t)NULL) { + perror("apply_default_acl (acl_get_file)"); + result = ACL_ERROR; + goto cleanup; + } + + if (wipe_acls(fd) == ACL_ERROR) { + perror("apply_default_acl (wipe_acls)"); + result = ACL_ERROR; + goto cleanup; + } + + /* Do this after wipe_acls(), otherwise we'll overwrite the wiped + ACL with this one. */ + acl_t acl = acl_get_fd(fd); + if (acl == (acl_t)NULL) { + perror("apply_default_acl (acl_get_fd)"); + result = ACL_ERROR; + goto cleanup; + } + + /* If it's a directory, inherit the parent's default. We sure hope + * that "path" still points to the same thing that "fd" and this + * "sp" describe. If not, we may wind up trying to set a default ACL + * on a file, and this will throw an error. I guess that's what we + * want to do? + */ + if (S_ISDIR(sp->st_mode) && assign_default_acl(path, defacl) == ACL_ERROR) { + perror("apply_default_acl (assign_default_acl)"); + result = ACL_ERROR; + goto cleanup; + } + + acl_entry_t entry; + int ge_result = acl_get_entry(defacl, ACL_FIRST_ENTRY, &entry); + + while (ge_result == ACL_SUCCESS) { + acl_tag_t tag = ACL_UNDEFINED_TAG; + + if (acl_get_tag_type(entry, &tag) == ACL_ERROR) { + perror("apply_default_acl (acl_get_tag_type)"); + result = ACL_ERROR; + goto cleanup; + } + + + /* We've got an entry/tag from the default ACL. Get its permset. */ + acl_permset_t permset; + if (acl_get_permset(entry, &permset) == ACL_ERROR) { + perror("apply_default_acl (acl_get_permset)"); + result = ACL_ERROR; + goto cleanup; + } + + /* If this is a default mask, fix it up. */ + if (tag == ACL_MASK || + tag == ACL_USER_OBJ || + tag == ACL_GROUP_OBJ || + tag == ACL_OTHER) { + + if (!allow_exec) { + /* The mask doesn't affect acl_user_obj, acl_group_obj (in + minimal ACLs) or acl_other entries, so if execute should be + masked, we have to do it manually. */ + if (acl_delete_perm(permset, ACL_EXECUTE) == ACL_ERROR) { + perror("apply_default_acl (acl_delete_perm)"); + result = ACL_ERROR; + goto cleanup; + } + + if (acl_set_permset(entry, permset) == ACL_ERROR) { + perror("apply_default_acl (acl_set_permset)"); + result = ACL_ERROR; + goto cleanup; + } + } + } + + /* Finally, add the permset to the access ACL. It's actually + * important that we pass in the address of "acl" here, and not + * "acl" itself. Why? The call to acl_create_entry() within + * acl_set_entry() can allocate new memory for the entry. + * Sometimes that can be done in-place, in which case everything + * is cool and the new memory gets released when we call + * acl_free(acl). + * + * But occasionally, the whole ACL structure will have to be moved + * in order to allocate the extra space. When that happens, + * acl_create_entry() modifies the pointer it was passed (in this + * case, &acl) to point to the new location. We want to call + * acl_free() on the new location, and since acl_free() gets + * called right here, we need acl_create_entry() to update the + * value of "acl". To do that, it needs the address of "acl". + */ + if (acl_set_entry(&acl, entry) == ACL_ERROR) { + perror("apply_default_acl (acl_set_entry)"); + result = ACL_ERROR; + goto cleanup; + } + + ge_result = acl_get_entry(defacl, ACL_NEXT_ENTRY, &entry); + } + + /* Catches the first acl_get_entry as well as the ones at the end of + the loop. */ + if (ge_result == ACL_ERROR) { + perror("apply_default_acl (acl_get_entry)"); + result = ACL_ERROR; + goto cleanup; + } + + if (acl_set_fd(fd, acl) == ACL_ERROR) { + perror("apply_default_acl (acl_set_fd)"); + result = ACL_ERROR; + goto cleanup; + } + + cleanup: + free(path_copy); + if (defacl != (acl_t)NULL) { + acl_free(defacl); + } + if (fd >= 0 && close(fd) == CLOSE_ERROR) { + perror("apply_default_acl (close)"); + result = ACL_ERROR; + } + return result; +} diff --git a/src/libadacl.h b/src/libadacl.h new file mode 100644 index 0000000..d2c9785 --- /dev/null +++ b/src/libadacl.h @@ -0,0 +1,25 @@ +/** + * @file libadacl.h + * + * @brief The public API for libadacl. + * + */ + +/* Most of the libacl functions return 1 for success, 0 for failure, + and -1 on error */ +#define ACL_ERROR -1 +#define ACL_FAILURE 0 +#define ACL_SUCCESS 1 + +/* Even though most other library functions reliably return -1 for + * error, it feels a little wrong to re-use the ACL_ERROR constant. + */ +#define CLOSE_ERROR -1 +#define NFTW_ERROR -1 +#define OPEN_ERROR -1 +#define SNPRINTF_ERROR -1 +#define STAT_ERROR -1 + +int apply_default_acl(const char* path, + const struct stat* sp, + bool no_exec_mask); -- 2.43.2 From bf1ac1a44c7ae16f8c01cfe9ce1c8f930e3957e6 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 26 Feb 2018 09:59:48 -0500 Subject: [PATCH 04/16] Clean up a few "include" statements, and document them. --- src/apply-default-acl.c | 15 +++++++-------- src/libadacl.c | 23 +++++++++++------------ 2 files changed, 18 insertions(+), 20 deletions(-) diff --git a/src/apply-default-acl.c b/src/apply-default-acl.c index c075059..f8ae4cd 100644 --- a/src/apply-default-acl.c +++ b/src/apply-default-acl.c @@ -9,14 +9,13 @@ #define _XOPEN_SOURCE 500 #define _GNU_SOURCE -#include -#include /* AT_FOO constants */ -#include /* nftw() et al. */ -#include -#include -#include -#include -#include +#include /* AT_FOO constants */ +#include /* nftw() et al. */ +#include /* getopt_long() */ +#include /* the "bool" type */ +#include /* perror() */ +#include /* EXIT_FAILURE, EXIT_SUCCESS */ +#include /* faccessat() */ #include "libadacl.h" diff --git a/src/libadacl.c b/src/libadacl.c index 28d5782..69f2073 100644 --- a/src/libadacl.c +++ b/src/libadacl.c @@ -8,21 +8,20 @@ /* Enables get_current_dir_name() in unistd.h */ #define _GNU_SOURCE -#include -#include -#include /* basename(), dirname() */ -#include /* PATH_MAX */ -#include -#include -#include -#include -#include -#include /* get_current_dir_name() */ +#include /* ELOOP, EINVAL, etc. */ +#include /* openat() */ +#include /* basename(), dirname() */ +#include /* PATH_MAX */ +#include /* the "bool" type */ +#include /* perror(), snprintf() */ +#include /* free() */ +#include /* strdup() */ +#include /* fstat() */ +#include /* get_current_dir_name() */ /* ACLs */ #include /* acl_get_perm, not portable */ -#include -#include +#include /* all other acl_foo functions */ #include "libadacl.h" -- 2.43.2 From f785b1da4fcfab5410a7aebacf6d6327176d58fa Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 26 Feb 2018 13:13:56 -0500 Subject: [PATCH 05/16] libadacl: improve safe_open() error message when given bad args. --- src/libadacl.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/libadacl.c b/src/libadacl.c index 69f2073..1fb54a8 100644 --- a/src/libadacl.c +++ b/src/libadacl.c @@ -102,7 +102,8 @@ int safe_open_ex(int at_fd, char* pathname, int flags) { */ int safe_open(const char* pathname, int flags) { if (pathname == NULL || strlen(pathname) == 0 || pathname[0] == '\0') { - /* error? */ + errno = EINVAL; + perror("safe_open (args)"); return OPEN_ERROR; } -- 2.43.2 From a662358647653b8d7f4f2dbfc5ca2802f38c60c8 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 26 Feb 2018 13:27:18 -0500 Subject: [PATCH 06/16] Rename apply_default_acl() to apply_default_acl_ex() and add a wrapper. The old apply_default_acl() function has a weird second argument that will usually be NULL for other users of the library. Instead of making them deal with that design choice, the old apply_default_acl() function was renamed t apply_default_acl_ex(), and a new apply_default_acl() was added with no second argument to wrap the former. --- src/apply-default-acl.c | 6 ++-- src/libadacl.c | 68 +++++++++++++++++++++++++++++------------ src/libadacl.h | 8 +++-- 3 files changed, 56 insertions(+), 26 deletions(-) diff --git a/src/apply-default-acl.c b/src/apply-default-acl.c index f8ae4cd..e5b989a 100644 --- a/src/apply-default-acl.c +++ b/src/apply-default-acl.c @@ -91,7 +91,7 @@ int apply_default_acl_nftw(const char *target, int info, struct FTW *ftw) { - if (apply_default_acl(target, sp, false)) { + if (apply_default_acl_ex(target, sp, false)) { return FTW_CONTINUE; } else { @@ -113,7 +113,7 @@ int apply_default_acl_nftw_x(const char *target, int info, struct FTW *ftw) { - if (apply_default_acl(target, sp, true)) { + if (apply_default_acl_ex(target, sp, true)) { return FTW_CONTINUE; } else { @@ -247,7 +247,7 @@ int main(int argc, char* argv[]) { } else { /* It's either a normal file, or we're not operating recursively. */ - reapp_result = apply_default_acl(target, NULL, no_exec_mask); + reapp_result = apply_default_acl(target, no_exec_mask); } if (!reapp_result) { diff --git a/src/libadacl.c b/src/libadacl.c index 1fb54a8..08b13b8 100644 --- a/src/libadacl.c +++ b/src/libadacl.c @@ -604,13 +604,13 @@ int wipe_acls(int fd) { * or the parent of @c path is not a directory. * - @c ACL_ERROR - Unexpected library error. */ -int apply_default_acl(const char* path, - const struct stat* sp, - bool no_exec_mask) { +int apply_default_acl_ex(const char* path, + const struct stat* sp, + bool no_exec_mask) { if (path == NULL) { errno = EINVAL; - perror("apply_default_acl (args)"); + perror("apply_default_acl_ex (args)"); return ACL_ERROR; } @@ -632,7 +632,7 @@ int apply_default_acl(const char* path, */ char* path_copy = strdup(path); if (path_copy == NULL) { - perror("apply_default_acl (strdup)"); + perror("apply_default_acl_ex (strdup)"); return ACL_ERROR; } char* parent = dirname(path_copy); @@ -644,7 +644,7 @@ int apply_default_acl(const char* path, goto cleanup; } else { - perror("apply_default_acl (open fd)"); + perror("apply_default_acl_ex (open fd)"); result = ACL_ERROR; goto cleanup; } @@ -664,7 +664,7 @@ int apply_default_acl(const char* path, if (sp == NULL) { struct stat s; if (fstat(fd, &s) == STAT_ERROR) { - perror("apply_default_acl (fstat)"); + perror("apply_default_acl_ex (fstat)"); goto cleanup; } @@ -692,7 +692,7 @@ int apply_default_acl(const char* path, int ace_result = any_can_execute(fd,sp) || S_ISDIR(sp->st_mode); if (ace_result == ACL_ERROR) { - perror("apply_default_acl (any_can_execute)"); + perror("apply_default_acl_ex (any_can_execute)"); result = ACL_ERROR; goto cleanup; } @@ -703,13 +703,13 @@ int apply_default_acl(const char* path, defacl = acl_get_file(parent, ACL_TYPE_DEFAULT); if (defacl == (acl_t)NULL) { - perror("apply_default_acl (acl_get_file)"); + perror("apply_default_acl_ex (acl_get_file)"); result = ACL_ERROR; goto cleanup; } if (wipe_acls(fd) == ACL_ERROR) { - perror("apply_default_acl (wipe_acls)"); + perror("apply_default_acl_ex (wipe_acls)"); result = ACL_ERROR; goto cleanup; } @@ -718,7 +718,7 @@ int apply_default_acl(const char* path, ACL with this one. */ acl_t acl = acl_get_fd(fd); if (acl == (acl_t)NULL) { - perror("apply_default_acl (acl_get_fd)"); + perror("apply_default_acl_ex (acl_get_fd)"); result = ACL_ERROR; goto cleanup; } @@ -730,7 +730,7 @@ int apply_default_acl(const char* path, * want to do? */ if (S_ISDIR(sp->st_mode) && assign_default_acl(path, defacl) == ACL_ERROR) { - perror("apply_default_acl (assign_default_acl)"); + perror("apply_default_acl_ex (assign_default_acl)"); result = ACL_ERROR; goto cleanup; } @@ -742,7 +742,7 @@ int apply_default_acl(const char* path, acl_tag_t tag = ACL_UNDEFINED_TAG; if (acl_get_tag_type(entry, &tag) == ACL_ERROR) { - perror("apply_default_acl (acl_get_tag_type)"); + perror("apply_default_acl_ex (acl_get_tag_type)"); result = ACL_ERROR; goto cleanup; } @@ -751,7 +751,7 @@ int apply_default_acl(const char* path, /* We've got an entry/tag from the default ACL. Get its permset. */ acl_permset_t permset; if (acl_get_permset(entry, &permset) == ACL_ERROR) { - perror("apply_default_acl (acl_get_permset)"); + perror("apply_default_acl_ex (acl_get_permset)"); result = ACL_ERROR; goto cleanup; } @@ -767,13 +767,13 @@ int apply_default_acl(const char* path, minimal ACLs) or acl_other entries, so if execute should be masked, we have to do it manually. */ if (acl_delete_perm(permset, ACL_EXECUTE) == ACL_ERROR) { - perror("apply_default_acl (acl_delete_perm)"); + perror("apply_default_acl_ex (acl_delete_perm)"); result = ACL_ERROR; goto cleanup; } if (acl_set_permset(entry, permset) == ACL_ERROR) { - perror("apply_default_acl (acl_set_permset)"); + perror("apply_default_acl_ex (acl_set_permset)"); result = ACL_ERROR; goto cleanup; } @@ -797,7 +797,7 @@ int apply_default_acl(const char* path, * value of "acl". To do that, it needs the address of "acl". */ if (acl_set_entry(&acl, entry) == ACL_ERROR) { - perror("apply_default_acl (acl_set_entry)"); + perror("apply_default_acl_ex (acl_set_entry)"); result = ACL_ERROR; goto cleanup; } @@ -808,13 +808,13 @@ int apply_default_acl(const char* path, /* Catches the first acl_get_entry as well as the ones at the end of the loop. */ if (ge_result == ACL_ERROR) { - perror("apply_default_acl (acl_get_entry)"); + perror("apply_default_acl_ex (acl_get_entry)"); result = ACL_ERROR; goto cleanup; } if (acl_set_fd(fd, acl) == ACL_ERROR) { - perror("apply_default_acl (acl_set_fd)"); + perror("apply_default_acl_ex (acl_set_fd)"); result = ACL_ERROR; goto cleanup; } @@ -825,8 +825,36 @@ int apply_default_acl(const char* path, acl_free(defacl); } if (fd >= 0 && close(fd) == CLOSE_ERROR) { - perror("apply_default_acl (close)"); + perror("apply_default_acl_ex (close)"); result = ACL_ERROR; } return result; } + + + +/** + * @brief The friendly interface to @c apply_default_acl_ex. + * + * The @c apply_default_acl_ex function holds the real implementation + * of this function, but it takes a weird second argument that most + * people won't care about (a stat structure). But, we use that + * argument for the recursive mode of the CLI, so it's there. + * + * If you don't have a stat structure for your @c path, use this instead. + * + * @param path + * The path whose ACL we would like to reset to its default. + * + * @param no_exec_mask + * The value (either true or false) of the --no-exec-mask flag. + * + * @return + * - @c ACL_SUCCESS - The parent default ACL was inherited successfully. + * - @c ACL_FAILURE - The target path is not a regular file/directory, + * or the parent of @c path is not a directory. + * - @c ACL_ERROR - Unexpected library error. + */ +int apply_default_acl(const char* path, bool no_exec_mask) { + return apply_default_acl_ex(path, NULL, no_exec_mask); +} diff --git a/src/libadacl.h b/src/libadacl.h index d2c9785..a846c88 100644 --- a/src/libadacl.h +++ b/src/libadacl.h @@ -20,6 +20,8 @@ #define SNPRINTF_ERROR -1 #define STAT_ERROR -1 -int apply_default_acl(const char* path, - const struct stat* sp, - bool no_exec_mask); +int apply_default_acl_ex(const char* path, + const struct stat* sp, + bool no_exec_mask); + +int apply_default_acl(const char* path, bool no_exec_mask); -- 2.43.2 From 81233b65dc8bbccba15394751f240ad59f15f342 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 26 Feb 2018 13:30:20 -0500 Subject: [PATCH 07/16] libadacl: update failure return value docs for apply_default_acl(). --- src/libadacl.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/libadacl.c b/src/libadacl.c index 08b13b8..b25a43b 100644 --- a/src/libadacl.c +++ b/src/libadacl.c @@ -600,8 +600,7 @@ int wipe_acls(int fd) { * * @return * - @c ACL_SUCCESS - The parent default ACL was inherited successfully. - * - @c ACL_FAILURE - The target path is not a regular file/directory, - * or the parent of @c path is not a directory. + * - @c ACL_FAILURE - If symlinks or hard links are encountered. * - @c ACL_ERROR - Unexpected library error. */ int apply_default_acl_ex(const char* path, @@ -851,7 +850,7 @@ int apply_default_acl_ex(const char* path, * * @return * - @c ACL_SUCCESS - The parent default ACL was inherited successfully. - * - @c ACL_FAILURE - The target path is not a regular file/directory, + * - @c ACL_FAILURE - If symlinks or hard links are encountered. * or the parent of @c path is not a directory. * - @c ACL_ERROR - Unexpected library error. */ -- 2.43.2 From d9b820de67813a5e2b92e4249e5a25cf8d884720 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 26 Feb 2018 13:52:27 -0500 Subject: [PATCH 08/16] Move a few constants out of the libadacl.h header to where they are used. --- src/apply-default-acl.c | 2 ++ src/libadacl.c | 9 +++++++++ src/libadacl.h | 12 ++---------- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/src/apply-default-acl.c b/src/apply-default-acl.c index e5b989a..7a67052 100644 --- a/src/apply-default-acl.c +++ b/src/apply-default-acl.c @@ -20,6 +20,8 @@ #include "libadacl.h" +#define NFTW_ERROR -1 + /** * @brief Determine whether or not the given path is accessible. diff --git a/src/libadacl.c b/src/libadacl.c index b25a43b..8e36230 100644 --- a/src/libadacl.c +++ b/src/libadacl.c @@ -26,6 +26,15 @@ #include "libadacl.h" +/* Even though most other library functions reliably return -1 for + * error, it feels a little wrong to re-use the ACL_ERROR constant. + */ +#define CLOSE_ERROR -1 +#define OPEN_ERROR -1 +#define SNPRINTF_ERROR -1 +#define STAT_ERROR -1 + + /** * @brief The recursive portion of the @c safe_open function, used to * open a file descriptor in a symlink-safe way when combined with diff --git a/src/libadacl.h b/src/libadacl.h index a846c88..c70487a 100644 --- a/src/libadacl.h +++ b/src/libadacl.h @@ -6,20 +6,12 @@ */ /* Most of the libacl functions return 1 for success, 0 for failure, - and -1 on error */ + * and -1 on error. We follow suit. +*/ #define ACL_ERROR -1 #define ACL_FAILURE 0 #define ACL_SUCCESS 1 -/* Even though most other library functions reliably return -1 for - * error, it feels a little wrong to re-use the ACL_ERROR constant. - */ -#define CLOSE_ERROR -1 -#define NFTW_ERROR -1 -#define OPEN_ERROR -1 -#define SNPRINTF_ERROR -1 -#define STAT_ERROR -1 - int apply_default_acl_ex(const char* path, const struct stat* sp, bool no_exec_mask); -- 2.43.2 From 19d5c29838b8eadb11dae11cd01aae6c49db108e Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 26 Feb 2018 13:53:46 -0500 Subject: [PATCH 09/16] Upgrade our Doxyfile automatically with doxygen -u. --- Doxyfile | 2487 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 1563 insertions(+), 924 deletions(-) diff --git a/Doxyfile b/Doxyfile index 3758b60..4459d8f 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,110 +1,129 @@ -# Doxyfile 1.7.6.1 +# Doxyfile 1.8.13 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored. +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. # The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" "). +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or sequence of words) that should -# identify the project. Note that if you do not use Doxywizard you need -# to put quotes around the project name if it contains spaces. +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. PROJECT_NAME = "apply-default-acl" -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer -# a quick idea about the purpose of the project. Keep the description short. +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "A utility to apply default POSIX ACLs to files and directories." -# With the PROJECT_LOGO tag one can specify an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. -# Doxygen will copy the logo to the output directory. +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. PROJECT_LOGO = -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. OUTPUT_DIRECTORY = doc -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. CREATE_SUBDIRS = NO +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. +# The default value is: YES. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# doxygen will generate a detailed section even if there is only a brief # description. +# The default value is: NO. ALWAYS_DETAILED_SEC = NO @@ -112,228 +131,285 @@ ALWAYS_DETAILED_SEC = NO # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. +# The default value is: NO. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. JAVADOC_AUTOBRIEF = NO -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. QT_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 8 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding -# "class=itcl::class" will allow you to use the command class in the -# itcl::class meaning. +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. TCL_SUBST = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this -# tag. The format is ext=language, where ext is a file extension, and language -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. EXTENSION_MAPPING = +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. +# The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. +# The default value is: NO. CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. SIP_SUPPORT = NO -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. IDL_PROPERTY_SUPPORT = NO # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first +# tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. +# The default value is: NO. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. SUBGROUPING = NO -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and -# unions are shown inside the group in which they are included (e.g. using -# @ingroup) instead of on a separate page (for HTML and Man pages) or -# section (for LaTeX and RTF). +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. INLINE_GROUPED_CLASSES = NO -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and -# unions with only public data fields will be shown inline in the documentation -# of the scope in which they are defined (i.e. file, namespace, or group -# documentation), provided this scope is documented. If set to NO (the default), -# structs, classes, and unions are shown on a separate page (for HTML and Man -# pages) or section (for LaTeX and RTF). +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. INLINE_SIMPLE_STRUCTS = NO -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. TYPEDEF_HIDES_STRUCT = NO -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penalty. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. - -SYMBOL_CACHE_SIZE = 0 - -# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be -# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given -# their name and scope. Since this can be an expensive process and often the -# same symbol appear multiple times in the code, doxygen keeps a cache of -# pre-resolved symbols. If the cache is too small doxygen will become slower. -# If the cache is too large, memory is wasted. The cache size is given by this -# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 @@ -341,342 +417,406 @@ LOOKUP_CACHE_SIZE = 0 # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. EXTRACT_ALL = NO -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. EXTRACT_PRIVATE = YES -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. EXTRACT_STATIC = YES -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. EXTRACT_LOCAL_CLASSES = NO -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespaces are hidden. +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. +# The default value is: system dependent. CASE_SENSE_NAMES = YES -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. SHOW_INCLUDE_FILES = YES -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. FORCE_LOCAL_INCLUDES = NO -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. SORT_BRIEF_DOCS = NO -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. SORT_GROUP_NAMES = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. SORT_BY_SCOPE_NAME = NO -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to -# do proper type resolution of all parameters of a function it will reject a -# match between the prototype and the implementation of a member function even -# if there is only one candidate or it is obvious which candidate to choose -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen -# will still accept a match between prototype and implementation in such cases. +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. STRICT_PROTO_MATCHING = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. +# The default value is: YES. SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. SHOW_FILES = YES -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. -# This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. The create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted -# DoxygenLayout.xml will be used as the name of the layout file. +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. LAYOUT_FILE = -# The CITE_BIB_FILES tag can be used to specify one or more bib files -# containing the references data. This must be a list of .bib files. The -# .bib extension is automatically appended if omitted. Using this command -# requires the bibtex tool to be installed. See also -# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style -# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this -# feature you need bibtex and perl available in the search path. +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. WARN_IF_UNDOCUMENTED = NO -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. WARN_IF_DOC_ERROR = YES -# The WARN_NO_PARAMDOC option can be enabled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. WARN_NO_PARAMDOC = YES -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- -# configuration options related to the input files +# Configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. INPUT = src # This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.for *.vhd *.vhdl +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. FILE_PATTERNS = *.c -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. +# # Note that relative paths are relative to the directory from which doxygen is # run. @@ -685,14 +825,16 @@ EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. +# The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = @@ -701,756 +843,1130 @@ EXCLUDE_PATTERNS = # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. -# If FILTER_PATTERNS is specified, this tag will be -# ignored. +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) -# and it is also possible to disable source filtering for a specific pattern -# using *.ext= (so without naming a filter). This option only has effect when -# FILTER_SOURCE_FILES is enabled. +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + #--------------------------------------------------------------------------- -# configuration options related to source browsing +# Configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. SOURCE_BROWSER = NO -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. REFERENCED_BY_RELATION = NO -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. REFERENCES_RELATION = NO -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. -# Otherwise they will link to the documentation. +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. REFERENCES_LINK_SOURCE = YES -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. ALPHABETICAL_INDEX = YES -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. Note that when using a custom header you are responsible -# for the proper inclusion of any scripts and style sheets that doxygen -# needs, which is dependent on the configuration options used. -# It is advised to generate a default header using "doxygen -w html -# header.html footer.html stylesheet.css YourConfigFile" and then modify -# that header. Note that the header is subject to change so you typically -# have to redo this when upgrading to a newer version of doxygen or when -# changing the value of configuration settings such as GENERATE_TREEVIEW! +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# style sheet in the HTML output directory as well, or it will be erased! +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the -# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that -# the files will be copied as-is; there are no commands or markers available. +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the style sheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be # written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# -# Qt Help Project / Filter Attributes. +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project -# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) -# at top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. Since the tabs have the same information as the -# navigation tree you can set this option to NO if you already set -# GENERATE_TREEVIEW to YES. +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. -# Since the tree basically has the same information as the tab index you -# could consider to set DISABLE_INDEX to NO when enabling this option. +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values -# (range [0,1..20]) that doxygen will group on one line in the generated HTML -# documentation. Note that a value of 0 will completely suppress the enum -# values from appearing in the overview section. +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. - -USE_INLINE_TREES = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO -# When MathJax is enabled you need to specify the location relative to the -# HTML output directory using the MATHJAX_RELPATH option. The destination -# directory should contain the MathJax.js script. For instance, if the mathjax -# directory is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the -# mathjax.org site, so you can quickly see the result without installing -# MathJax, but it is strongly recommended to install a local copy of MathJax -# before deployment. +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://www.mathjax.org/mathjax -# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension -# names that should be enabled during MathJax rendering. +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /