decode.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
 */
 
/** Protocol decoder support functions
 *
 * @file src/lib/util/decode.h
 *
 * @copyright 2022 Network RADIUS SAS (legal@networkradius.com)
 */
RCSIDH(decode_h, "$Id: 702cdf5a800c628fcb4ae46a781a3e027b9cdaa4 $")
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <freeradius-devel/util/pair.h>
#include <freeradius-devel/util/dns.h>
 
/** Decode a value from the network into an output #fr_pair_list_t
 *
 * @param[in] ctx               context to alloc new attributes in.
 * @param[out] out              Where to write the decoded options.
 * @param[in] parent            of sub TLVs.
 * @param[in] data              to parse.
 * @param[in] data_len          of the data to parse
 * @param[in] decode_ctx        ctx for decode function.
 * @return
 *      <= 0 on error
 *      bytes successfully decoded on success (<= data_len)
 */
typedef ssize_t (*fr_pair_decode_value_t)(TALLOC_CTX *ctx, fr_pair_list_t *out,
                                           fr_dict_attr_t const *parent,
                                           uint8_t const *data, size_t const data_len, void *decode_ctx);
 
typedef bool (*fr_pair_tlvs_verify_t)(uint8_t const *data, size_t const data_len);
 
#define PROTO_DECODE_FUNC(_name) static ssize_t decode_ ## _name(TALLOC_CTX *ctx, fr_pair_list_t *out, \
                                           fr_dict_attr_t const *parent, \
                                           uint8_t const *data, size_t const data_len, void *decode_ctx)
 
ssize_t fr_pair_array_from_network(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, fr_pair_decode_value_t decode_value) CC_HINT(nonnull(1,2,3,4,7));
 
ssize_t fr_pair_raw_from_network(TALLOC_CTX *ctx, fr_pair_list_t *out, fr_dict_attr_t const *parent,
                                 uint8_t const *data, size_t data_len) CC_HINT(nonnull);
 
ssize_t fr_pair_tlvs_from_network(TALLOC_CTX *ctx, fr_pair_list_t *out,
                                  fr_dict_attr_t const *parent,
                                  uint8_t const *data, size_t const data_len,
                                  void *decode_ctx, fr_pair_decode_value_t decode_tlv, fr_pair_tlvs_verify_t verify_tlvs,
                                  bool nested) CC_HINT(nonnull(1,2,3,4,7));
 
ssize_t fr_pair_dns_labels_from_network(TALLOC_CTX *ctx, fr_pair_list_t *out,
                                        fr_dict_attr_t const *parent, uint8_t const *start,
                                        uint8_t const *data, size_t const data_len, fr_dns_labels_t *lb, bool exact);
 
#ifdef __cplusplus
}
#endif