protocol.h

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
 */
#ifndef FR_PROTOCOL_H
#define FR_PROTOCOL_H
/**
 * $Id: b0d31a8b4bf5f53462736f0d83e7c234558caf7b $
 *
 * @file include/protocol.h
 * @brief Protocol module API.
 *
 * @copyright 2013 Alan DeKok
 */
RCSIDH(protocol_h, "$Id: b0d31a8b4bf5f53462736f0d83e7c234558caf7b $")

#ifdef __cplusplus
extern "C" {
#endif

/*
 *      We'll use this below.
 */
typedef int (*rad_listen_parse_t)(CONF_SECTION *, rad_listen_t *);
typedef void (*rad_listen_free_t)(rad_listen_t *);
typedef ssize_t (*rad_listen_size_t)(uint8_t const *data, size_t data_len);

typedef struct fr_protocol_t {
        uint64_t                magic;  //!< Used to validate loaded library
        char const              *name;  //!< The name of the protocol
        size_t                  inst_size;
        CONF_PARSER             *proto_config;

        uint32_t                transports;
        bool                    tls;

        rad_listen_size_t       size;

        rad_listen_parse_t      parse;
        rad_listen_parse_t      open;
        rad_listen_free_t       free;
        rad_listen_recv_t       recv;
        rad_listen_send_t       send;
        rad_listen_print_t      print;
        rad_listen_debug_t      debug;
        rad_listen_encode_t     encode;
        rad_listen_decode_t     decode;
} fr_protocol_t;

#define TRANSPORT_TCP (1 << IPPROTO_TCP)
#define TRANSPORT_UDP (1 << IPPROTO_UDP)
#define TRANSPORT_DUAL (TRANSPORT_UDP | TRANSPORT_TCP)

/*
 *      @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 *request, RADIUS_PACKET *packet, bool received);

#ifdef __cplusplus
}
#endif

#endif /* FR_PROTOCOL_H */