internal.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
 */
 
#include <freeradius-devel/util/pair.h>
#include <freeradius-devel/util/talloc.h>
 
/*
 *      Encoding byte 0
 */
#define FR_INTERNAL_MASK_TYPE           0xe0
#define FR_INTERNAL_MASK_LEN            0x1c
#define FR_INTERNAL_FLAG_EXTENDED       0x01
#define FR_INTERNAL_FLAG_TAINTED        0x02
 
/*
 *      Encoding byte 1
 */
#define FR_INTERNAL_FLAG_UNKNOWN        0x80
#define FR_INTERNAL_FLAG_INTERNAL       0x40
 
typedef struct {
        bool    allow_name_only;        //!< Allow name only pairs.  This should be set
                                        ///< to true when encoding data that's being
                                        ///< passed between threads in the same process.
                                        ///< It should be set to false when encoding
                                        ///< data that's stored in an external database
                                        ///< or in the cache module.
} fr_internal_encode_ctx_t;
 
/*
 * $Id: e4c6773163c6d77692149c0ff062ae8f69a11d8e $
 *
 * @file protocols/internal/internal.h
 * @brief Structures and prototypes for the internal encoder/decoder.
 *
 * @copyright 2020 The FreeRADIUS server project
 */
 
ssize_t fr_internal_encode_pair(fr_dbuff_t *dbuff, fr_dcursor_t *cursor, void *encode_ctx);
 
ssize_t fr_internal_encode_list(fr_dbuff_t *dbuff, fr_pair_list_t const *list, void *encode_ctx);
 
ssize_t fr_internal_decode_pair(TALLOC_CTX *ctx, fr_pair_list_t *out, fr_dict_attr_t const *parent,
                                uint8_t const *data, size_t data_len, void *decode_ctx);
 
ssize_t fr_internal_decode_pair_dbuff(TALLOC_CTX *ctx, fr_pair_list_t *out, fr_dict_attr_t const *parent,
                                fr_dbuff_t *dbuff, void *decode_ctx);
 
ssize_t fr_internal_decode_list_dbuff(TALLOC_CTX *ctx, fr_pair_list_t *out, fr_dict_attr_t const *parent,
                                fr_dbuff_t *dbuff, void *decode_ctx);