base.c

Go to the documentation of this file.

/*
 *   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
 */
 
/**
 * $Id: e4704d77bb518c7ef65ca2c4083a14960d3c1207 $
 * @file src/process/bfd/base.c
 * @brief BFD processing.
 *
 * @copyright 2023 Network RADIUS SAS (legal@networkradius.com)
 */
#include <freeradius-devel/server/protocol.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/bfd/bfd.h>
#include "bfd/session.h"
 
static fr_dict_t const *dict_bfd;
 
extern fr_dict_autoload_t process_bfd_dict[];
fr_dict_autoload_t process_bfd_dict[] = {
        { .out = &dict_bfd, .proto = "bfd" },
        { NULL }
};
 
static fr_dict_attr_t const *attr_packet_type;
static fr_dict_attr_t const *attr_bfd_packet;
static fr_dict_attr_t const *attr_bfd_state;
 
extern fr_dict_attr_autoload_t process_bfd_dict_attr[];
fr_dict_attr_autoload_t process_bfd_dict_attr[] = {
        { .out = &attr_packet_type, .name = "Packet-Type", .type = FR_TYPE_UINT32, .dict = &dict_bfd},
 
        { .out = &attr_bfd_packet, .name = "Packet", .type = FR_TYPE_STRUCT, .dict = &dict_bfd},
        { .out = &attr_bfd_state, .name = "Packet.state", .type = FR_TYPE_UINT8, .dict = &dict_bfd},
 
        { NULL }
};
 
#define SECTION(_x) \
        CONF_SECTION *recv_ ## _x; \
        CONF_SECTION *send_ ## _x
 
typedef struct {
        uint64_t        nothing;                // so that the next field isn't at offset 0
 
        SECTION(admin_down);
        SECTION(down);
        SECTION(init);
        SECTION(up);
} process_bfd_sections_t;
 
typedef struct {
        process_bfd_sections_t  sections;
} process_bfd_t;
 
#define PROCESS_PACKET_TYPE             fr_bfd_packet_code_t
#define PROCESS_CODE_MAX                FR_BFD_CODE_MAX
#define PROCESS_PACKET_CODE_VALID       FR_BFD_PACKET_CODE_VALID
#define PROCESS_INST                    process_bfd_t
 
#define PROCESS_SEND_RECV               (1)
 
#include <freeradius-devel/server/process.h>
 
/*
 *      Debug the packet if requested.
 */
static void bfd_packet_debug(request_t *request, fr_packet_t *packet, fr_pair_list_t *list, bool received)
{
#ifdef WITH_IFINDEX_NAME_RESOLUTION
        char if_name[IFNAMSIZ];
#endif
 
        if (!packet) return;
        if (!RDEBUG_ENABLED) return;
 
        log_request(L_DBG, L_DBG_LVL_1, request, __FILE__, __LINE__, "%s %s ID %d from %s%pV%s:%i to %s%pV%s:%i "
#ifdef WITH_IFINDEX_NAME_RESOLUTION
                       "%s%s%s"
#endif
                       "",
                       received ? "Received" : "Sending",
                       fr_bfd_packet_names[packet->code],
                       packet->id,
                       packet->socket.inet.src_ipaddr.af == AF_INET6 ? "[" : "",
                       fr_box_ipaddr(packet->socket.inet.src_ipaddr),
                       packet->socket.inet.src_ipaddr.af == AF_INET6 ? "]" : "",
                       packet->socket.inet.src_port,
                       packet->socket.inet.dst_ipaddr.af == AF_INET6 ? "[" : "",
                       fr_box_ipaddr(packet->socket.inet.dst_ipaddr),
                       packet->socket.inet.dst_ipaddr.af == AF_INET6 ? "]" : "",
                       packet->socket.inet.dst_port
#ifdef WITH_IFINDEX_NAME_RESOLUTION
                       , packet->socket.inet.ifindex ? "via " : "",
                       packet->socket.inet.ifindex ? fr_ifname_from_ifindex(if_name, packet->socket.inet.ifindex) : "",
                       packet->socket.inet.ifindex ? " " : ""
#endif
                       );
 
        if (received || request->parent) {
                log_request_pair_list(L_DBG_LVL_1, request, NULL, list, NULL);
        } else {
                log_request_proto_pair_list(L_DBG_LVL_1, request, NULL, list, NULL);
        }
}
 
RESUME_FLAG(recv_bfd, UNUSED,)
{
        rlm_rcode_t                     rcode = RESULT_RCODE;
        fr_pair_t                       *vp;
        uint32_t                        state = 0;
 
        PROCESS_TRACE;
 
        fr_assert(rcode < RLM_MODULE_NUMCODES);
 
        if (rcode == RLM_MODULE_FAIL) {
                state = FR_BFD_ADMIN_DOWN;
        } else {
                /*
                 *      Check for a state / reply code.
                 */
                vp = fr_pair_find_by_da(&request->reply_pairs, NULL, attr_packet_type);
                if (vp) {
                        state = vp->vp_uint32;
                } else {
                        vp = fr_pair_find_by_da(&request->reply_pairs, NULL, attr_bfd_packet);
                        if (vp) vp = fr_pair_find_by_da_nested(&vp->vp_group, NULL, attr_bfd_state);
                        if (vp) state = vp->vp_uint8;
                }
        }
 
        fr_assert(PROCESS_PACKET_CODE_VALID(state));
 
        request->reply->code = state;
 
        request->reply->timestamp = fr_time();
 
        return UNLANG_ACTION_CALCULATE_RESULT;
}
 
 
/*
 *      recv FOO
 */
static fr_process_state_t const process_state_packet[] = {
        [ FR_BFD_ADMIN_DOWN ] = {
                .default_reply = FR_BFD_DOWN,
                .default_rcode = RLM_MODULE_NOOP,
                .recv = recv_generic,
                .resume = resume_recv_bfd,
                .section_offset = offsetof(process_bfd_sections_t, recv_admin_down),
        },
 
        [ FR_BFD_DOWN ] = {
                .default_reply = FR_BFD_DOWN,
                .default_rcode = RLM_MODULE_NOOP,
                .recv = recv_generic,
                .resume = resume_recv_bfd,
                .section_offset = offsetof(process_bfd_sections_t, recv_down),
        },
 
        [ FR_BFD_INIT ] = {
                .default_reply = FR_BFD_UP,
                .default_rcode = RLM_MODULE_NOOP,
                .recv = recv_generic,
                .resume = resume_recv_bfd,
                .section_offset = offsetof(process_bfd_sections_t, recv_init),
        },
 
        [ FR_BFD_UP ] = {
                .default_reply = FR_BFD_UP,
                .default_rcode = RLM_MODULE_NOOP,
                .recv = recv_generic,
                .resume = resume_recv_bfd,
                .section_offset = offsetof(process_bfd_sections_t, recv_up),
        },
};
 
/*
 *      send FOO
 */
static fr_process_state_t const process_state_reply[] = {
        [ FR_BFD_ADMIN_DOWN ] = {
                .default_rcode = RLM_MODULE_NOOP,
                .send = send_generic,
                .resume = resume_send_generic,
                .section_offset = offsetof(process_bfd_sections_t, send_admin_down),
        },
 
        [ FR_BFD_DOWN ] = {
                .default_rcode = RLM_MODULE_NOOP,
                .send = send_generic,
                .resume = resume_send_generic,
                .section_offset = offsetof(process_bfd_sections_t, send_down),
        },
 
        [ FR_BFD_INIT ] = {
                .default_rcode = RLM_MODULE_NOOP,
                .send = send_generic,
                .resume = resume_send_generic,
                .section_offset = offsetof(process_bfd_sections_t, send_init),
        },
 
        [ FR_BFD_UP ] = {
                .default_rcode = RLM_MODULE_NOOP,
                .send = send_generic,
                .resume = resume_send_generic,
                .section_offset = offsetof(process_bfd_sections_t, send_up),
        },
};
 
static unlang_action_t mod_process(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
{
        fr_process_state_t const *state;
        bfd_wrapper_t const *wrapper;
 
        PROCESS_TRACE;
 
        (void)talloc_get_type_abort_const(mctx->mi->data, process_bfd_t);
        fr_assert(PROCESS_PACKET_CODE_VALID(request->packet->code));
 
        request->component = "bfd";
        request->module = NULL;
 
        fr_assert(request->proto_dict == dict_bfd);
 
        wrapper = (bfd_wrapper_t const *) request->packet->data;
 
        /*
         *      If there's no packet, we must be calling the "send" routine
         */
        if (wrapper->type == BFD_WRAPPER_SEND_PACKET) {
                fr_assert(wrapper->type == BFD_WRAPPER_SEND_PACKET);
 
                UPDATE_STATE(reply);
 
                bfd_packet_debug(request, request->reply, &request->reply_pairs, false);
                return state->send(p_result, mctx, request);
        }
 
        fr_assert(wrapper->type == BFD_WRAPPER_RECV_PACKET);
 
        UPDATE_STATE(packet);
 
        if (!state->recv) {
                REDEBUG("Invalid packet type (%u)", request->packet->code);
                RETURN_UNLANG_FAIL;
        }
 
        bfd_packet_debug(request, request->packet, &request->request_pairs, true);
 
        return state->recv(p_result, mctx, request);
}
 
/*
 *      We send and receive the same packet types.
 */
#define SEND_RECV(_x, _y) \
        { \
                .section = SECTION_NAME("recv", _x), \
                .actions = &mod_actions_postauth, \
                .offset = PROCESS_CONF_OFFSET(recv_ ## _y), \
        }, \
        { \
                .section = SECTION_NAME("send", _x), \
                .actions = &mod_actions_postauth, \
                .offset = PROCESS_CONF_OFFSET(send_ ## _y), \
        }
 
static const virtual_server_compile_t compile_list[] = {
        SEND_RECV("Admin-Down", admin_down),
        SEND_RECV("Down", down),
        SEND_RECV("Init", init),
        SEND_RECV("Up", up),
 
        COMPILE_TERMINATOR
};
 
 
extern fr_process_module_t process_bfd;
fr_process_module_t process_bfd = {
        .common = {
                .magic          = MODULE_MAGIC_INIT,
                .name           = "bfd",
                MODULE_INST(process_bfd_t),
                MODULE_RCTX(process_rctx_t)
        },
        .process        = mod_process,
        .compile_list   = compile_list,
        .dict           = &dict_bfd,
        .packet_type    = &attr_packet_type
};