users_file.c

Go to the documentation of this file.

/*
 * files.c      Read config files into memory.
 *
 * Version:     $Id: 8464bd60ea30cd61f2f103fe9fb0c1904817fde6 $
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 *
 * @copyright 2000,2006 The FreeRADIUS server project
 * @copyright 2000 Miquel van Smoorenburg (miquels@cistron.nl)
 * @copyright 2000 Alan DeKok (aland@freeradius.org)
 */
 
RCSID("$Id: 8464bd60ea30cd61f2f103fe9fb0c1904817fde6 $")
 
#include <freeradius-devel/server/log.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/server/users_file.h>
 
#include <freeradius-devel/util/misc.h>
#include <freeradius-devel/util/pair_legacy.h>
#include <freeradius-devel/util/syserror.h>
 
#include <sys/stat.h>
 
#include <fcntl.h>
 
static int pairlist_read_internal(TALLOC_CTX *ctx, fr_dict_t const *dict, char const *file, PAIR_LIST_LIST *list,
                                  bool complain, bool v3_compat, int *order);
 
static inline void line_error_marker(char const *src_file, int src_line,
                                     char const *user_file, int user_line,
                                     fr_sbuff_t *sbuff, char const *error)
{
        char                    *end;
        fr_sbuff_marker_t       start;
 
        fr_sbuff_marker(&start, sbuff);
        end = fr_sbuff_adv_to_chr(sbuff, SIZE_MAX, '\n');
        if (!end) end = fr_sbuff_end(sbuff);
        fr_sbuff_set(sbuff, &start);
        fr_sbuff_marker_release(&start);
 
        fr_log_marker(LOG_DST, L_ERR, src_file, src_line,
                      fr_sbuff_start(sbuff), end - fr_sbuff_start(sbuff),
                      fr_sbuff_used(sbuff), error, "%s[%d]: ", user_file, user_line);
}
/** Print out a line oriented error marker at the current position of the sbuff
 *
 * @param[in] _sbuff    to print error for.
 * @param[in] _error    message.
 */
#define ERROR_MARKER(_sbuff, _error) line_error_marker(__FILE__, __LINE__, file, lineno, _sbuff, _error)
 
static inline void line_error_marker_adj(char const *src_file, int src_line,
                                         char const *user_file, int user_line,
                                         fr_sbuff_t *sbuff, ssize_t marker_idx, char const *error)
{
        char                    *end;
        fr_sbuff_marker_t       start;
 
        fr_sbuff_marker(&start, sbuff);
        end = fr_sbuff_adv_to_chr(sbuff, SIZE_MAX, '\n');
        if (!end) end = fr_sbuff_end(sbuff);
        fr_sbuff_set(sbuff, &start);
        fr_sbuff_marker_release(&start);
 
        fr_log_marker(LOG_DST, L_ERR, src_file, src_line,
                      fr_sbuff_current(sbuff), end - fr_sbuff_current(sbuff),
                      marker_idx, error, "%s[%d]: ", user_file, user_line);
}
/** Print out a line oriented error marker relative to the current position of the sbuff
 *
 * @param[in] _sbuff    to print error for.
 * @param[in] _idx      Where the error occurred.
 * @param[in] _error    message.
 */
#define ERROR_MARKER_ADJ(_sbuff, _idx, _error) line_error_marker_adj(__FILE__, __LINE__, file, lineno, _sbuff, _idx, _error)
 
static fr_table_num_sorted_t const check_cmp_op_table[] = {
        { L("!*"),      T_OP_CMP_FALSE          },
        { L("!="),      T_OP_NE                 },
        { L("!~"),      T_OP_REG_NE             },
        { L("+="),      T_OP_ADD_EQ             },
        { L(":="),      T_OP_SET                },
        { L("<"),       T_OP_LT                 },
        { L("<="),      T_OP_LE                 },
        { L("="),       T_OP_EQ                 },
        { L("=*"),      T_OP_CMP_TRUE           },
        { L("=="),      T_OP_CMP_EQ             },
        { L("=~"),      T_OP_REG_EQ             },
        { L(">"),       T_OP_GT                 },
        { L(">="),      T_OP_GE                 }
};
static size_t check_cmp_op_table_len = NUM_ELEMENTS(check_cmp_op_table);
 
static const fr_sbuff_term_t name_terms = FR_SBUFF_TERMS(
                L("\t"),
                L("\n"),
                L(" "),
                L("#"),
);
 
static fr_sbuff_parse_rules_t const rhs_term = {
        .escapes = &(fr_sbuff_unescape_rules_t){
                .chr = '\\',
                /*
                 *      Allow barewords to contain whitespace
                 *      if they're escaped.
                 */
                .subs = {
                        ['\t'] = '\t',
                        ['\n'] = '\n',
                        [' '] = ' '
                },
                .do_hex = true,
                .do_oct = false
        },
        .terminals = &FR_SBUFF_TERMS(
                L(""),
                L("\t"),
                L("\n"),
                L("#"),
                L(","),
        )
};
 
/*
 *      Caller saw a $INCLUDE at the start of a line.
 */
static int users_include(TALLOC_CTX *ctx, fr_dict_t const *dict, fr_sbuff_t *sbuff, PAIR_LIST_LIST *list,
                         char const *file, int lineno, bool v3_compat, int *order)
{
        size_t          len;
        char            *newfile, c;
        char const      *p;
        fr_sbuff_marker_t name;
 
        fr_sbuff_advance(sbuff, 8);
 
        /*
         *      Skip spaces after the $INCLUDE.
         */
        if (fr_sbuff_adv_past_blank(sbuff, SIZE_MAX, NULL) == 0) {
                ERROR_MARKER(sbuff, "Unexpected text after $INCLUDE");
                return -1;
        }
 
        /*
         *      Remember when the name started, and skip over the name
         *      until spaces, comments, or LF
         */
        fr_sbuff_marker(&name, sbuff);
        len = fr_sbuff_adv_until(sbuff, SIZE_MAX, &name_terms, 0);
        if (len == 0) {
                ERROR_MARKER(sbuff, "No filename after $INCLUDE");
                fr_sbuff_marker_release(&name);
                return -1;
        }
 
        /*
         *      If the input file is a relative path, try to copy the
         *      leading directory from it.  If there's no leading
         *      directory, just use the $INCLUDE name as-is.
         *
         *      If there is a leading directory in the input name,
         *      paste that as the directory to the $INCLUDE name.
         *
         *      Otherwise the $INCLUDE name is an absolute path, use
         *      it as -is.
         */
        c = fr_sbuff_char(&name, '\0');
        if (c != '/') {
                p = strrchr(file, '/');
 
                if (!p) goto copy_name;
 
                newfile = talloc_asprintf(NULL, "%.*s/%.*s",
                                          (int) (p - file), file,
                                          (int) len, fr_sbuff_current(&name));
        } else {
        copy_name:
                newfile = talloc_asprintf(NULL, "%.*s", (int) len, fr_sbuff_current(&name));
        }
        fr_sbuff_marker_release(&name);
 
        /*
         *      Skip spaces and comments after the name.
         */
        fr_sbuff_adv_past_blank(sbuff, SIZE_MAX, NULL);
        if (fr_sbuff_next_if_char(sbuff, '#')) {
                (void) fr_sbuff_adv_to_chr(sbuff, SIZE_MAX, '\n');
        }
 
        /*
         *      There's no LF, but if we skip non-spaces and
         *      non-comments to find the LF, then there must be extra
         *      text after the filename.  That's an error.
         *
         *      Unless the line has EOF after the filename.  in which
         *      case this error will get hit, too.
         */
        if (!fr_sbuff_is_char(sbuff, '\n') &&
            (fr_sbuff_adv_to_chr(sbuff, SIZE_MAX, '\n') != NULL)) {
                ERROR_MARKER(sbuff, "Unexpected text after filename");
                talloc_free(newfile);
                return -1;
        }
 
        /*
         *      Read the $INCLUDEd file recursively.
         */
        if (pairlist_read_internal(ctx, dict, newfile, list, false, v3_compat, order) != 0) {
                ERROR("%s[%d]: Could not read included file %s: %s",
                      file, lineno, newfile, fr_syserror(errno));
                talloc_free(newfile);
                return -1;
        }
        talloc_free(newfile);
 
        return 0;
}
 
int pairlist_read(TALLOC_CTX *ctx, fr_dict_t const *dict, char const *file, PAIR_LIST_LIST *list, bool v3_compat)
{
        int order = 0;
 
        return pairlist_read_internal(ctx, dict, file, list, true, v3_compat, &order);
}
 
/*
 *      Read the users file. Return a PAIR_LIST.
 */
static int pairlist_read_internal(TALLOC_CTX *ctx, fr_dict_t const *dict, char const *file, PAIR_LIST_LIST *list, bool complain, bool v3_compat, int *order)
{
        char                    *q;
        int                     lineno          = 1;
        map_t                   *new_map, *relative_map;
        FILE                    *fp;
        fr_sbuff_t              sbuff;
        fr_sbuff_uctx_file_t    fctx;
        tmpl_rules_t            lhs_rules, rhs_rules;
        char                    *filename = talloc_strdup(ctx, file);
        char                    buffer[8192];
 
        DEBUG2("Reading file %s", file);
 
        /*
         *      Open the file.  The error message should be a little
         *      more useful...
         */
        if ((fp = fopen(file, "r")) == NULL) {
                if (complain) ERROR("Couldn't open %s for reading: %s", file, fr_syserror(errno));
                return -1;
        }
 
        fr_sbuff_init_file(&sbuff, &fctx, buffer, sizeof(buffer), fp, SIZE_MAX);
 
        lhs_rules = (tmpl_rules_t) {
                .attr = {
                        .dict_def = dict,
                        .list_def = request_attr_request,
                        .list_presence = TMPL_ATTR_LIST_ALLOW,
                },
                .literals_safe_for = FR_VALUE_BOX_SAFE_FOR_ANY,
 
        };
        rhs_rules = (tmpl_rules_t) {
                .attr = {
                        .dict_def = dict,
                        .list_def = request_attr_request,
                        .list_presence = TMPL_ATTR_LIST_ALLOW,
                        .bare_word_enum = v3_compat,
                },
                .literals_safe_for = FR_VALUE_BOX_SAFE_FOR_ANY,
        };
 
        while (true) {
                size_t          len;
                ssize_t         slen;
                bool            comma;
                bool            leading_spaces;
                PAIR_LIST       *t;
 
                /*
                 *      If the line is empty or has only comments,
                 *      then we don't care about leading spaces.
                 */
                leading_spaces = (fr_sbuff_adv_past_blank(&sbuff, SIZE_MAX, NULL) > 0);
                if (fr_sbuff_next_if_char(&sbuff, '#')) {
                        (void) fr_sbuff_adv_to_chr(&sbuff, SIZE_MAX, '\n');
                }
                if (fr_sbuff_next_if_char(&sbuff, '\n')) {
                        lineno++;
                        continue;
                }
 
                /*
                 *      We're trying to read a key value.  It MUST have
                 *      been at the start of the line.  So whatever
                 *      this is, it's wrong.
                 */
                if (leading_spaces) {
                        ERROR_MARKER(&sbuff, "Entry does not begin with a key value");
                fail:
                        fclose(fp);
                        return -1;
                }
 
                /*
                 *      $INCLUDE filename.  This will do some sanity checks, and then add the new entries to
                 *      the tail of the current list.
                 */
                if (fr_sbuff_is_str(&sbuff, "$INCLUDE", 8)) {
                        if (users_include(ctx, dict, &sbuff, list, file, lineno, v3_compat, order) < 0) goto fail;
 
                        if (fr_sbuff_next_if_char(&sbuff, '\n')) {
                                lineno++;
                                continue;
                        }
 
                        /*
                         *      The next character is not LF, but the
                         *      function skipped to LF.  So, by
                         *      process of elimination, we must be at
                         *      EOF.
                         */
                        break;
                } /* else it wasn't $INCLUDE */
 
                /*
                 *      We MUST be either at a valid entry, OR at EOF.
                 */
                MEM(t = talloc_zero(ctx, PAIR_LIST));
                map_list_init(&t->check);
                map_list_init(&t->reply);
                t->filename = filename;
                t->lineno = lineno;
                t->order = (*order)++;
 
                /*
                 *      Copy the name from the entry.
                 */
                if (fr_sbuff_out_abstrncpy_until(t, &q, &len, &sbuff, SIZE_MAX, &name_terms, NULL) < 0) {
                        ERROR_MARKER(&sbuff, "Failed reading entry name");
                        talloc_free(t);
                        goto fail;
                }
                if (len == 0) {
                        talloc_free(t);
                        break;
                }
                t->name = q;
 
                lhs_rules.attr.list_def = request_attr_control;
                comma = false;
 
check_item:
                /*
                 *      Skip spaces before the item, and allow the
                 *      check list to end on comment or LF.
                 *
                 *      Note that we _don't_ call map_afrom_substr() to
                 *      skip spaces, as it will skip LF, too!
                 */
                (void) fr_sbuff_adv_past_blank(&sbuff, SIZE_MAX, NULL);
                if (fr_sbuff_is_char(&sbuff, '#')) goto check_item_comment;
                if (fr_sbuff_is_char(&sbuff, '\n')) goto check_item_end;
 
                /*
                 *      Try to parse the check item.
                 */
                slen = map_afrom_substr(t, &new_map, NULL, &sbuff, check_cmp_op_table, check_cmp_op_table_len,
                                       &lhs_rules, &rhs_rules, &rhs_term);
                if (!new_map) {
                        ERROR_MARKER_ADJ(&sbuff, slen, fr_strerror());
                fail_entry:
                        talloc_free(t);
                        goto fail;
                }
 
                fr_assert(new_map->lhs != NULL);
                fr_assert(new_map->rhs != NULL);
 
                /*
                 *      The default rule says that the check
                 *      items look at the control list, but
                 *      protocol attributes should be compared in the request.
                 */
                if (!tmpl_attr_tail_da(new_map->lhs)->flags.internal) {
                        tmpl_attr_set_list(new_map->lhs, request_attr_request);
                }
 
                if (tmpl_contains_regex(new_map->rhs)) {
                        if (tmpl_is_regex_uncompiled(new_map->rhs) &&
                            (tmpl_regex_compile(new_map->rhs, false) < 0)) {
                                ERROR("%s[%d]: Failed compiling regular expression /%s/ - %s",
                                      file, lineno, new_map->rhs->name, fr_strerror());
                                goto fail_entry;
                        }
 
                        goto do_insert;
                }
 
        do_insert:
                fr_assert(!new_map->parent);
                map_list_insert_tail(&t->check, new_map);
 
                /*
                 *      There can be spaces before any comma.
                 */
                (void) fr_sbuff_adv_past_blank(&sbuff, SIZE_MAX, NULL);
 
                /*
                 *      Allow a comma after this item.  But remember
                 *      if we had a comma.
                 */
                if (fr_sbuff_next_if_char(&sbuff, ',')) {
                        comma = true;
                        goto check_item;
                }
                comma = false;
 
        check_item_comment:
                /*
                 *      There wasn't a comma after the item, so the
                 *      next thing MUST be a comment, LF, EOF.
                 *
                 *      If there IS stuff before the LF, then it's
                 *      unknown text.
                 */
                if (fr_sbuff_next_if_char(&sbuff, '#')) {
                        (void) fr_sbuff_adv_to_chr(&sbuff, SIZE_MAX, '\n');
                }
        check_item_end:
                if (fr_sbuff_next_if_char(&sbuff, '\n')) {
                        /*
                         *      The check item list ended with a comma.
                         *      That's bad.
                         */
                        if (comma) {
                                ERROR_MARKER(&sbuff, "Invalid comma ending the check item list");
                                goto fail_entry;
                        }
 
                        lineno++;
                        goto setup_reply;
                }
 
                /*
                 *      We didn't see SPACE LF or SPACE COMMENT LF.
                 *      There's something else going on.
                 */
                if (fr_sbuff_adv_to_chr(&sbuff, SIZE_MAX, '\n') != NULL) {
                        ERROR_MARKER(&sbuff, "Unexpected text after check item");
                        goto fail_entry;
                }
 
                /*
                 *      The next character is not LF, but we
                 *      skipped to LF above.  So, by process
                 *      of elimination, we must be at EOF.
                 */
                if (!fr_sbuff_is_char(&sbuff, '\n')) {
                add_entry:
                        fr_dlist_insert_tail(&list->head, t);
                        break;
                }
 
setup_reply:
                /*
                 *      Setup the reply items.
                 */
                lhs_rules.attr.list_def = request_attr_reply;
 
                comma = false;
 
                rhs_rules.attr.list_def = request_attr_request;
 
                relative_map = NULL;
 
reply_item:
                /*
                 *      Reply items start with spaces.  If there's no
                 *      spaces, then the current entry is done.  Add
                 *      it to the list, and go back to reading the
                 *      user name or $INCLUDE.
                 */
                if (fr_sbuff_adv_past_blank(&sbuff, SIZE_MAX, NULL) == 0) {
                        if (comma) {
                                ERROR("%s[%d]: Unexpected trailing comma in previous line", file, lineno);
                                goto fail_entry;
                        }
 
                        /*
                         *      The line doesn't begin with spaces.
                         *      The list of reply items MUST be
                         *      finished.  Go look for an entry name.
                         *
                         *      Note that we don't allow comments in
                         *      the middle of the reply item list.  Oh
                         *      well.
                         */
                        fr_dlist_insert_tail(&list->head, t);
                        continue;
 
                } else if (lineno == (t->lineno + 1)) {
                        fr_assert(comma == false);
 
                } else if (!comma) {
                        ERROR("%s[%d]: Missing comma in previous line", file, lineno);
                        goto fail_entry;
                }
 
                /*
                 *      SPACES COMMENT or SPACES LF means "end of
                 *      reply item list"
                 */
                if (fr_sbuff_is_char(&sbuff, '#')) {
                        (void) fr_sbuff_adv_to_chr(&sbuff, SIZE_MAX, '\n');
                }
                if (fr_sbuff_next_if_char(&sbuff, '\n')) {
                        lineno++;
                        goto add_entry;
                }
 
next_reply_item:
                /*
                 *      Unlike check items, we don't skip spaces or
                 *      comments here.  All of the code paths which
                 *      lead to here have already checked for those
                 *      cases.
                 */
                slen = map_afrom_substr(t, &new_map, &relative_map, &sbuff, map_assignment_op_table, map_assignment_op_table_len,
                                       &lhs_rules, &rhs_rules, &rhs_term);
                if (!new_map) {
                        ERROR_MARKER_ADJ(&sbuff, slen, fr_strerror());
                        goto fail_entry;
                }
 
                fr_assert(new_map->lhs != NULL);
 
                if (!tmpl_is_attr(new_map->lhs)) {
                        ERROR("%s[%d]: Unknown attribute '%s'",
                              file, lineno, new_map->lhs->name);
                        goto fail_entry;
                }
 
                /*
                 *      We no longer really care what the RHS is, or what the list is on the LHS.  The caller
                 *      takes care of checking that for us.
                 */
 
                if (!new_map->parent) map_list_insert_tail(&t->reply, new_map);
 
                (void) fr_sbuff_adv_past_blank(&sbuff, SIZE_MAX, NULL);
 
                /*
                 *      Commas separate entries on the same line.  And
                 *      we allow spaces after commas, too.
                 */
                if (fr_sbuff_next_if_char(&sbuff, ',')) {
                        comma = true;
                        (void) fr_sbuff_adv_past_blank(&sbuff, SIZE_MAX, NULL);
                } else {
                        comma = false;
                }
 
                /*
                 *      Comments or LF will end this particular line.
                 *
                 *      Reading the next line will cause a complaint
                 *      if this line ended with a comma.
                 */
                if (fr_sbuff_next_if_char(&sbuff, '#')) {
                        (void) fr_sbuff_adv_to_chr(&sbuff, SIZE_MAX, '\n');
                }
 
                if (fr_sbuff_next_if_char(&sbuff, '\n')) {
                        lineno++;
                        goto reply_item;
                }
 
                /*
                 *      Not comment or LF, the content MUST be another
                 *      pair.
                 */
                if (comma) goto next_reply_item;
 
                ERROR_MARKER(&sbuff, "Unexpected text after reply");
                goto fail_entry;
        }
 
        /*
         *      Else we were looking for an entry.  We didn't get one
         *      because we were at EOF, so that's OK.
         */
 
        fclose(fp);
 
        return 0;
}