client_priv.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
 */
 
/**
 * $Id: f216f36d57335667083f68ec36cdf67c8ebc4878 $
 *
 * @file protocols/radius/client_priv.h
 * @brief RADIUS bio handlers for outgoing RADIUS private client sockets
 *
 * @copyright 2024 Network RADIUS SAS (legal@networkradius.com)
 */
RCSIDH(radius_client_priv_h, "$Id: f216f36d57335667083f68ec36cdf67c8ebc4878 $")
 
#include <freeradius-devel/radius/client.h>
#include <freeradius-devel/radius/id.h>
 
/*
 *      Client connected data structure
 */
typedef struct {
        fr_bio_packet_t         common;
 
        fr_radius_client_config_t cfg;
 
        fr_radius_code_id_t     codes;
 
        fr_socket_t             reply_socket;
 
        fr_radius_ctx_t         proto_ctx;
 
        fr_bio_t                *retry;
        fr_bio_t                *mem;
        fr_bio_t                *fd;
 
        /*
         *      @todo - this blocks on _any_ ID space being full.  So if we send auth+acct and auth blocks,
         *      then acct is also blocked.  Perhaps we want to track these individually, which means having
         *      the RADIUS client code deal with _multiple_ outgoing BIOs, each of which are equivalent.
         *
         *      However, that doesn't play well with the design that each BIO has its own FD associated with it,
         */
        bool                    all_ids_used;           //!< All IDs are used.
 
        fr_radius_client_bio_info_t info;
 
        /*
         *      @todo - perhaps we want to have the read() routine allocate memory for the packet?  Or the
         *      verify routine can do that?
         */
        uint8_t                 buffer[4096];   //!< temporary read buffer
} fr_radius_client_fd_bio_t;
 
fr_radius_client_fd_bio_t *fr_radius_client_fd_bio_alloc(TALLOC_CTX *ctx, size_t read_size, fr_radius_client_config_t *cfg, fr_bio_fd_config_t const *fd_cfg) CC_HINT(nonnull);
 
int     fr_radius_client_fd_bio_write(fr_radius_client_fd_bio_t *my, void *request_ctx, fr_packet_t *packet, fr_pair_list_t *list);
 
int     fr_radius_client_fd_bio_read(fr_bio_packet_t *bio, void **request_ctx_p, fr_packet_t **packet_p, TALLOC_CTX *out_ctx, fr_pair_list_t *out);