uri.h

Go to the documentation of this file.

#pragma once
/*
 *  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
 */
 
/** Functions for dealing with URIs
 *
 * @file src/lib/util/uri.c
 *
 * @copyright 2021 The FreeRADIUS server project
 */
RCSIDH(uri_h, "$Id: ec9fc03acb9a451983a99f3c9873e5dc70ad3671 $")
 
#include <freeradius-devel/util/value.h>
#include <freeradius-devel/util/sbuff.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/** A function used to escape an argument passed to an xlat
 *
 * @param[in,out] vb            to escape
 * @param[in] uctx              a "context" for the escaping
 * @return
 *      - 0 on success.
 *      - -1 on failure.
 */
typedef int (*fr_uri_escape_func_t)(fr_value_box_t *vb, void *uctx);
 
/** Definition for a single part of a URI
 *
 */
typedef struct {
        char const                      *name;                          //!< Name of this part of the URI
        fr_sbuff_term_t const           *terminals;                     //!< Characters that mark the end of this part.
        uint8_t const                   part_adv[UINT8_MAX + 1];        //!< How many parts to advance for a specific terminal
        size_t                          extra_skip;                     //!< How many additional characters to skip after
                                                                        ///< the terminal
        fr_value_box_safe_for_t         safe_for;                       //!< What type of value is safe for this part
        fr_uri_escape_func_t            func;                           //!< Function to use to escape tainted values
} fr_uri_part_t;
 
/** uctx to pass to fr_uri_escape
 *
 * @note Should not be passed to fr_uri_escape_list. That takes the uctx to pass to the fr_uri_escape_func_t directly.
 */
typedef struct {
        fr_uri_part_t const     *uri_part;                      //!< Start of the uri parts array.  Will be updated
                                                                ///< as boxes are escaped.
        void                    *uctx;                          //!< to pass to fr_uri_escape_func_t.
} fr_uri_escape_ctx_t;
 
#define XLAT_URI_PART_TERMINATOR { .name = NULL, .terminals = NULL, .safe_for = 0, .func = NULL }
 
int fr_uri_escape_list(fr_value_box_list_t *uri, fr_uri_part_t const *uri_parts, void *uctx);
 
int fr_uri_escape(fr_value_box_t *uri_vb, void *uctx);
 
int fr_uri_has_scheme(fr_value_box_list_t *uri, fr_table_num_sorted_t const *schemes, size_t schemes_len, int def);
 
#ifdef __cplusplus
}
#endif