protocol.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: 6550c11a88b99d138689f1461e1b28bd7864779e $
 *
 * @file lib/server/protocol.h
 * @brief Protocol module API.
 *
 * @copyright 2013 Alan DeKok
 */
RCSIDH(protocol_h, "$Id: 6550c11a88b99d138689f1461e1b28bd7864779e $")
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <freeradius-devel/io/base.h>
 
#include <freeradius-devel/server/dl_module.h>
#include <freeradius-devel/server/listen.h>
 
/*
 *      We'll use this below.
 */
typedef int (*rad_listen_parse_t)(CONF_SECTION *, rad_listen_t *);
typedef int (*rad_listen_unlang_t)(CONF_SECTION *, CONF_SECTION *);
typedef void (*rad_listen_free_t)(rad_listen_t *);
 
/*
 *      @todo: fix for later
 */
int common_socket_parse(CONF_SECTION *cs, rad_listen_t *this);
int common_socket_open(CONF_SECTION *cs, rad_listen_t *this);
int common_socket_print(rad_listen_t const *this, char *buffer, size_t bufsize);
void common_packet_debug(request_t *request, fr_packet_t *packet, fr_pair_list_t *pairs, bool received);
 
/** Struct exported by a proto_* module
 *
 * Used to pass information common to proto_* modules to the server core,
 * and to register callbacks that get executed when processing packets of this
 * protocol type.
 */
typedef struct rad_protocol_s {
        DL_MODULE_COMMON;                               //!< Common fields to all loadable modules.
 
        uint32_t                        transports;     //!< What can transport this protocol.
        bool                            tls;            //!< Whether protocol can be wrapped in TLS.
 
        rad_listen_unlang_t             bootstrap;      //!< Phase1 - Basic validation checks of virtual server.
        rad_listen_unlang_t             compile;        //!< Phase2 - Compile unlang sections in the virtual
                                                        //!< server that map to packet types used by the protocol.
 
        rad_listen_parse_t              parse;          //!< Perform extra processing of the configuration data
                                                        //!< specified by config.
 
        rad_listen_parse_t              open;           //!< Open a descriptor.
 
        rad_listen_recv_t               recv;           //!< Read an incoming packet from the descriptor.
        rad_listen_send_t               send;           //!< Write an outgoing packet to the descriptor.
        rad_listen_error_t              error;          //!< Handle error/eol on the descriptor.
 
        rad_listen_print_t              print;          //!< Print a line describing the packet being sent or the
                                                        //!< packet that was received.
        rad_listen_debug_t              debug;          //!< Print an attribute list for debugging.
 
        rad_listen_encode_t             encode;         //!< Encode an outgoing packet.
        rad_listen_decode_t             decode;         //!< Decode an incoming packet.
} rad_protocol_t;
 
#define TRANSPORT_NONE 0
#define TRANSPORT_TCP (1 << IPPROTO_TCP)
#define TRANSPORT_UDP (1 << IPPROTO_UDP)
#define TRANSPORT_DUAL (TRANSPORT_UDP | TRANSPORT_TCP)
 
#ifdef __cplusplus
}
#endif