proto_radius_tcp.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: a11ae376da1bba7fb065af4280c032ef84eab1a7 $
 * @file proto_radius_tcp.c
 * @brief RADIUS handler for TCP.
 *
 * @copyright 2016 The FreeRADIUS server project.
 * @copyright 2016 Alan DeKok (aland@deployingradius.com)
 */
#include <netdb.h>
#include <freeradius-devel/server/protocol.h>
#include <freeradius-devel/radius/tcp.h>
#include <freeradius-devel/util/trie.h>
#include <freeradius-devel/radius/radius.h>
#include <freeradius-devel/io/application.h>
#include <freeradius-devel/io/listen.h>
#include <freeradius-devel/io/schedule.h>
#include "proto_radius.h"
 
extern fr_app_io_t proto_radius_tcp;
 
typedef struct {
        char const                      *name;                  //!< socket name
        int                             sockfd;
 
        fr_io_address_t                 *connection;            //!< for connected sockets.
 
        fr_stats_t                      stats;                  //!< statistics for this socket
} proto_radius_tcp_thread_t;
 
typedef struct {
        CONF_SECTION                    *cs;                    //!< our configuration
 
        fr_ipaddr_t                     ipaddr;                 //!< IP address to listen on.
 
        char const                      *interface;             //!< Interface to bind to.
        char const                      *port_name;             //!< Name of the port for getservent().
 
        uint32_t                        recv_buff;              //!< How big the kernel's receive buffer should be.
 
        uint32_t                        max_packet_size;        //!< for message ring buffer.
        uint32_t                        max_attributes;         //!< Limit maximum decodable attributes.
 
        uint16_t                        port;                   //!< Port to listen on.
 
        bool                            recv_buff_is_set;       //!< Whether we were provided with a recv_buff
        bool                            dynamic_clients;        //!< whether we have dynamic clients
 
        fr_client_list_t                *clients;               //!< local clients
 
        fr_trie_t                       *trie;                  //!< for parsed networks
        fr_ipaddr_t                     *allow;                 //!< allowed networks for dynamic clients
        fr_ipaddr_t                     *deny;                  //!< denied networks for dynamic clients
 
        bool                            read_hexdump;           //!< Do we debug hexdump read packets.
        bool                            write_hexdump;          //!< Do we debug hexdump write packets.
} proto_radius_tcp_t;
 
 
static const conf_parser_t networks_config[] = {
        { FR_CONF_OFFSET_TYPE_FLAGS("allow", FR_TYPE_COMBO_IP_PREFIX , CONF_FLAG_MULTI, proto_radius_tcp_t, allow) },
        { FR_CONF_OFFSET_TYPE_FLAGS("deny", FR_TYPE_COMBO_IP_PREFIX , CONF_FLAG_MULTI, proto_radius_tcp_t, deny) },
 
        CONF_PARSER_TERMINATOR
};
 
 
static const conf_parser_t tcp_listen_config[] = {
        { FR_CONF_OFFSET_TYPE_FLAGS("ipaddr", FR_TYPE_COMBO_IP_ADDR, 0, proto_radius_tcp_t, ipaddr) },
        { FR_CONF_OFFSET_TYPE_FLAGS("ipv4addr", FR_TYPE_IPV4_ADDR, 0, proto_radius_tcp_t, ipaddr) },
        { FR_CONF_OFFSET_TYPE_FLAGS("ipv6addr", FR_TYPE_IPV6_ADDR, 0, proto_radius_tcp_t, ipaddr) },
 
        { FR_CONF_OFFSET("interface", proto_radius_tcp_t, interface) },
        { FR_CONF_OFFSET("port_name", proto_radius_tcp_t, port_name) },
 
        { FR_CONF_OFFSET("port", proto_radius_tcp_t, port) },
        { FR_CONF_OFFSET_IS_SET("recv_buff", FR_TYPE_UINT32, 0, proto_radius_tcp_t, recv_buff) },
 
        { FR_CONF_OFFSET("dynamic_clients", proto_radius_tcp_t, dynamic_clients) } ,
        { FR_CONF_POINTER("networks", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) networks_config },
 
        { FR_CONF_OFFSET("max_packet_size", proto_radius_tcp_t, max_packet_size), .dflt = "4096" } ,
        { FR_CONF_OFFSET("max_attributes", proto_radius_tcp_t, max_attributes), .dflt = STRINGIFY(RADIUS_MAX_ATTRIBUTES) } ,
 
        { FR_CONF_OFFSET("read_hexdump", proto_radius_tcp_t, read_hexdump) },
        { FR_CONF_OFFSET("write_hexdump", proto_radius_tcp_t, write_hexdump) },
 
        CONF_PARSER_TERMINATOR
};
 
 
static ssize_t mod_read(fr_listen_t *li, UNUSED void **packet_ctx, fr_time_t *recv_time_p, uint8_t *buffer, size_t buffer_len, size_t *leftover)
{
        proto_radius_tcp_t const        *inst = talloc_get_type_abort_const(li->app_io_instance, proto_radius_tcp_t);
        proto_radius_tcp_thread_t       *thread = talloc_get_type_abort(li->thread_instance, proto_radius_tcp_thread_t);
        ssize_t                         data_size;
        size_t                          packet_len, in_buffer;
        fr_radius_decode_fail_t         reason;
 
        /*
         *      We may have read multiple packets in the previous read.  In which case the buffer may already
         *      have packets remaining.  In that case, we can return packets directly from the buffer, and
         *      skip the read().
         */
        if (*leftover >= RADIUS_HEADER_LENGTH) {
                packet_len = fr_nbo_to_uint16(buffer + 2);
 
                if (packet_len <= *leftover) {
                        data_size = 0;
                        goto have_packet;
                }
 
                /*
                 *      Else we don't have a full packet, try to read more data from the network.
                 */
        }
 
        /*
         *      Read data into the buffer.
         */
        data_size = read(thread->sockfd, buffer + *leftover, buffer_len - *leftover);
        if (data_size < 0) {
                switch (errno) {
#if defined(EWOULDBLOCK) && (EWOULDBLOCK != EAGAIN)
                case EWOULDBLOCK:
#endif
                case EAGAIN:
                        /*
                         *      We didn't read any data; leave the buffers alone.
                         *
                         *      i.e. if we had a partial packet in the buffer and we didn't read any data,
                         *      then the partial packet is still left in the buffer.
                         */
                        return 0;
 
                default:
                        break;
                }
 
                PDEBUG2("proto_radius_tcp got read error (%zd) - %s", data_size, fr_syserror(errno));
                return data_size;
        }
 
        /*
         *      Note that we return ERROR for all bad packets, as
         *      there's no point in reading RADIUS packets from a TCP
         *      connection which isn't sending us RADIUS packets.
         */
 
        /*
         *      TCP read of zero means the socket is dead.
         */
        if (!data_size) {
                DEBUG2("proto_radius_tcp - other side closed the socket.");
                return -1;
        }
 
have_packet:
        /*
         *      We MUST always start with a known RADIUS packet.
         */
        if ((buffer[0] == 0) || (buffer[0] >= FR_RADIUS_CODE_MAX)) {
                DEBUG("proto_radius_tcp got invalid packet code %d", buffer[0]);
                thread->stats.total_unknown_types++;
                return -1;
        }
 
        in_buffer = data_size + *leftover;
 
        /*
         *      Not enough for one packet.  Tell the caller that we need to read more.
         */
        if (in_buffer < RADIUS_HEADER_LENGTH) {
                *leftover = in_buffer;
                return 0;
        }
 
        /*
         *      Figure out how large the RADIUS packet is.
         */
        packet_len = fr_nbo_to_uint16(buffer + 2);
 
        /*
         *      We don't have a complete RADIUS packet.  Tell the
         *      caller that we need to read more.
         */
        if (in_buffer < packet_len) {
                *leftover = in_buffer;
                return 0;
        }
 
        /*
         *      We've read at least one packet.  Tell the caller that
         *      there's more data available, and return only one packet.
         */
        *leftover = in_buffer - packet_len;
 
        /*
         *      If it's not a RADIUS packet, ignore it.
         */
        if (!fr_radius_ok(buffer, &packet_len, inst->max_attributes, false, &reason)) {
                /*
                 *      @todo - check for F5 load balancer packets.  <sigh>
                 */
                DEBUG2("proto_radius_tcp got a packet which isn't RADIUS");
                thread->stats.total_malformed_requests++;
                return -1;
        }
 
        *recv_time_p = fr_time();
        thread->stats.total_requests++;
 
        /*
         *      proto_radius sets the priority
         */
 
        /*
         *      Print out what we received.
         */
        DEBUG2("proto_radius_tcp - Received %s ID %d length %d %s",
               fr_radius_packet_name[buffer[0]], buffer[1],
               (int) packet_len, thread->name);
 
        return packet_len;
}
 
 
static ssize_t mod_write(fr_listen_t *li, void *packet_ctx, UNUSED fr_time_t request_time,
                         uint8_t *buffer, size_t buffer_len, size_t written)
{
        proto_radius_tcp_thread_t       *thread = talloc_get_type_abort(li->thread_instance, proto_radius_tcp_thread_t);
        fr_io_track_t                   *track = talloc_get_type_abort(packet_ctx, fr_io_track_t);
        ssize_t                         data_size;
 
        /*
         *      @todo - share a stats interface with the parent?  or
         *      put the stats in the listener, so that proto_radius
         *      can update them, too.. <sigh>
         */
        if (!written) thread->stats.total_responses++;
 
        /*
         *      This handles the race condition where we get a DUP,
         *      but the original packet replies before we're run.
         *      i.e. this packet isn't marked DUP, so we have to
         *      discover it's a dup later...
         *
         *      As such, if there's already a reply, then we ignore
         *      the encoded reply (which is probably going to be a
         *      NAK), and instead just ignore the DUP and don't reply.
         */
        if (track->reply_len) {
                return buffer_len;
        }
 
        /*
         *      We only write RADIUS packets.
         */
        fr_assert(buffer_len >= 20);
        fr_assert(written < buffer_len);
 
        /*
         *      Only write replies if they're RADIUS packets.
         *      sometimes we want to NOT send a reply...
         */
        data_size = write(thread->sockfd, buffer + written, buffer_len - written);
 
        /*
         *      This socket is dead.  That's an error...
         */
        if (data_size <= 0) return data_size;
 
#if 0
        /*
         *      If we're not tracking duplicates, then track->packet is NULL.
         *
         *      There's no reason to fix this now, as all of this will
         *      be rewritten when the bio stuff works.  Since this
         *      code doesn't do anything anyways, it's best to just
         *      comment it out.
         */
 
        /*
         *      Root through the reply to determine any
         *      connection-level negotiation data, but only the first
         *      time the packet is being written.
         */
        if ((written == 0) && (track->packet[0] == FR_RADIUS_CODE_STATUS_SERVER)) {
//              status_check_reply(inst, buffer, buffer_len);
        }
#endif
 
        /*
         *      Add in previously written data to the response.
         */
        return data_size + written;
}
 
 
static int mod_connection_set(fr_listen_t *li, fr_io_address_t *connection)
{
        proto_radius_tcp_thread_t       *thread = talloc_get_type_abort(li->thread_instance, proto_radius_tcp_thread_t);
 
        thread->connection = connection;
        return 0;
}
 
 
static void mod_network_get(int *ipproto, bool *dynamic_clients, fr_trie_t const **trie, void *instance)
{
        proto_radius_tcp_t *inst = talloc_get_type_abort(instance, proto_radius_tcp_t);
 
        *ipproto = IPPROTO_TCP;
        *dynamic_clients = inst->dynamic_clients;
        *trie = inst->trie;
}
 
 
/** Open a TCP listener for RADIUS
 *
 */
static int mod_open(fr_listen_t *li)
{
        proto_radius_tcp_t const        *inst = talloc_get_type_abort_const(li->app_io_instance, proto_radius_tcp_t);
        proto_radius_tcp_thread_t       *thread = talloc_get_type_abort(li->thread_instance, proto_radius_tcp_thread_t);
 
        int                             sockfd;
        fr_ipaddr_t                     ipaddr = inst->ipaddr;
        uint16_t                        port = inst->port;
 
        fr_assert(!thread->connection);
 
        li->fd = sockfd = fr_socket_server_tcp(&inst->ipaddr, &port, inst->port_name, true);
        if (sockfd < 0) {
                PERROR("Failed opening TCP socket");
        error:
                return -1;
        }
 
        (void) fr_nonblock(sockfd);
 
        if (fr_socket_bind(sockfd, inst->interface, &ipaddr, &port) < 0) {
                close(sockfd);
                PERROR("Failed binding socket");
                goto error;
        }
 
        if (listen(sockfd, 8) < 0) {
                close(sockfd);
                PERROR("Failed listening on socket");
                goto error;
        }
 
        thread->sockfd = sockfd;
 
        fr_assert((cf_parent(inst->cs) != NULL) && (cf_parent(cf_parent(inst->cs)) != NULL));   /* listen { ... } */
 
        thread->name = fr_app_io_socket_name(thread, &proto_radius_tcp,
                                             NULL, 0,
                                             &inst->ipaddr, inst->port,
                                             inst->interface);
 
        return 0;
}
 
 
/** Set the file descriptor for this socket.
 */
static int mod_fd_set(fr_listen_t *li, int fd)
{
        proto_radius_tcp_t const  *inst = talloc_get_type_abort_const(li->app_io_instance, proto_radius_tcp_t);
        proto_radius_tcp_thread_t *thread = talloc_get_type_abort(li->thread_instance, proto_radius_tcp_thread_t);
 
        thread->sockfd = fd;
 
        thread->name = fr_app_io_socket_name(thread, &proto_radius_tcp,
                                             &thread->connection->socket.inet.src_ipaddr, thread->connection->socket.inet.src_port,
                                             &inst->ipaddr, inst->port,
                                             inst->interface);
 
        return 0;
}
 
static int mod_track_compare(UNUSED void const *instance, UNUSED void *thread_instance, UNUSED fr_client_t *client,
                             void const *one, void const *two)
{
        int ret;
        uint8_t const *a = one;
        uint8_t const *b = two;
 
        /*
         *      The tree is ordered by IDs, which are (hopefully)
         *      pseudo-randomly distributed.
         */
        ret = (a[1] < b[1]) - (a[1] > b[1]);
        if (ret != 0) return ret;
 
        /*
         *      Then ordered by code, which is usually the same.
         */
        return (a[0] < b[0]) - (a[0] > b[0]);
}
 
 
static char const *mod_name(fr_listen_t *li)
{
        proto_radius_tcp_thread_t       *thread = talloc_get_type_abort(li->thread_instance, proto_radius_tcp_thread_t);
 
        return thread->name;
}
 
static void mod_hexdump_set(fr_listen_t *li, void *data)
{
        proto_radius_tcp_t      *inst = talloc_get_type_abort(data, proto_radius_tcp_t);
        li->read_hexdump = inst->read_hexdump;
        li->write_hexdump = inst->write_hexdump;
}
 
static int mod_instantiate(module_inst_ctx_t const *mctx)
{
        proto_radius_tcp_t      *inst = talloc_get_type_abort(mctx->mi->data, proto_radius_tcp_t);
        CONF_SECTION            *conf = mctx->mi->conf;
        size_t                  i, num;
        CONF_ITEM               *ci;
        CONF_SECTION            *server_cs;
 
        inst->cs = conf;
 
        /*
         *      Complain if no "ipaddr" is set.
         */
        if (inst->ipaddr.af == AF_UNSPEC) {
                cf_log_err(conf, "No 'ipaddr' was specified in the 'tcp' section");
                return -1;
        }
 
        if (inst->recv_buff_is_set) {
                FR_INTEGER_BOUND_CHECK("recv_buff", inst->recv_buff, >=, 32);
                FR_INTEGER_BOUND_CHECK("recv_buff", inst->recv_buff, <=, INT_MAX);
        }
 
        FR_INTEGER_BOUND_CHECK("max_packet_size", inst->max_packet_size, >=, 20);
        FR_INTEGER_BOUND_CHECK("max_packet_size", inst->max_packet_size, <=, 65536);
 
        if (!inst->port) {
                struct servent *s;
 
                if (!inst->port_name) {
                        cf_log_err(conf, "No 'port' was specified in the 'tcp' section");
                        return -1;
                }
 
                s = getservbyname(inst->port_name, "tcp");
                if (!s) {
                        cf_log_err(conf, "Unknown value for 'port_name = %s", inst->port_name);
                        return -1;
                }
 
                inst->port = ntohl(s->s_port);
        }
 
        /*
         *      Parse and create the trie for dynamic clients, even if
         *      there's no dynamic clients.
         *
         *      @todo - we could use this for source IP filtering?
         *      e.g. allow clients from a /16, but not from a /24
         *      within that /16.
         */
        num = talloc_array_length(inst->allow);
        if (!num) {
                if (inst->dynamic_clients) {
                        cf_log_err(conf, "The 'allow' subsection MUST contain at least one 'network' entry when 'dynamic_clients = true'.");
                        return -1;
                }
        } else {
                MEM(inst->trie = fr_trie_alloc(inst, NULL, NULL));
 
                for (i = 0; i < num; i++) {
                        fr_ipaddr_t *network;
 
                        /*
                         *      Can't add v4 networks to a v6 socket, or vice versa.
                         */
                        if (inst->allow[i].af != inst->ipaddr.af) {
                                cf_log_err(conf, "Address family in entry %zd - 'allow = %pV' does not match 'ipaddr'",
                                           i + 1, fr_box_ipaddr(inst->allow[i]));
                                return -1;
                        }
 
                        /*
                         *      Duplicates are bad.
                         */
                        network = fr_trie_match_by_key(inst->trie,
                                                &inst->allow[i].addr, inst->allow[i].prefix);
                        if (network) {
                                cf_log_err(conf, "Cannot add duplicate entry 'allow = %pV'",
                                           fr_box_ipaddr(inst->allow[i]));
                                return -1;
                        }
 
                        /*
                         *      Look for overlapping entries.
                         *      i.e. the networks MUST be disjoint.
                         *
                         *      Note that this catches 192.168.1/24
                         *      followed by 192.168/16, but NOT the
                         *      other way around.  The best fix is
                         *      likely to add a flag to
                         *      fr_trie_alloc() saying "we can only
                         *      have terminal fr_trie_user_t nodes"
                         */
                        network = fr_trie_lookup_by_key(inst->trie,
                                                 &inst->allow[i].addr, inst->allow[i].prefix);
                        if (network && (network->prefix <= inst->allow[i].prefix)) {
                                cf_log_err(conf, "Cannot add overlapping entry 'allow = %pV'",
                                           fr_box_ipaddr(inst->allow[i]));
                                cf_log_err(conf, "Entry is completely enclosed inside of a previously defined network");
                                return -1;
                        }
 
                        /*
                         *      Insert the network into the trie.
                         *      Lookups will return the fr_ipaddr_t of
                         *      the network.
                         */
                        if (fr_trie_insert_by_key(inst->trie,
                                           &inst->allow[i].addr, inst->allow[i].prefix,
                                           &inst->allow[i]) < 0) {
                                cf_log_err(conf, "Failed adding 'allow = %pV' to tracking table",
                                           fr_box_ipaddr(inst->allow[i]));
                                return -1;
                        }
                }
 
                /*
                 *      And now check denied networks.
                 */
                num = talloc_array_length(inst->deny);
                if (!num) return 0;
 
                /*
                 *      Since the default is to deny, you can only add
                 *      a "deny" inside of a previous "allow".
                 */
                for (i = 0; i < num; i++) {
                        fr_ipaddr_t     *network;
 
                        /*
                         *      Can't add v4 networks to a v6 socket, or vice versa.
                         */
                        if (inst->deny[i].af != inst->ipaddr.af) {
                                cf_log_err(conf, "Address family in entry %zd - 'deny = %pV' does not match 'ipaddr'",
                                           i + 1, fr_box_ipaddr(inst->deny[i]));
                                return -1;
                        }
 
                        /*
                         *      Duplicates are bad.
                         */
                        network = fr_trie_match_by_key(inst->trie,
                                                &inst->deny[i].addr, inst->deny[i].prefix);
                        if (network) {
                                cf_log_err(conf, "Cannot add duplicate entry 'deny = %pV'", fr_box_ipaddr(inst->deny[i]));
                                return -1;
                        }
 
                        /*
                         *      A "deny" can only be within a previous "allow".
                         */
                        network = fr_trie_lookup_by_key(inst->trie,
                                                &inst->deny[i].addr, inst->deny[i].prefix);
                        if (!network) {
                                cf_log_err(conf, "The network in entry %zd - 'deny = %pV' is not contained "
                                           "within a previous 'allow'", i + 1, fr_box_ipaddr(inst->deny[i]));
                                return -1;
                        }
 
                        /*
                         *      We hack the AF in "deny" rules.  If
                         *      the lookup gets AF_UNSPEC, then we're
                         *      adding a "deny" inside of a "deny".
                         */
                        if (network->af != inst->ipaddr.af) {
                                cf_log_err(conf, "The network in entry %zd - 'deny = %pV' overlaps with "
                                           "another 'deny' rule", i + 1, fr_box_ipaddr(inst->deny[i]));
                                return -1;
                        }
 
                        /*
                         *      Insert the network into the trie.
                         *      Lookups will return the fr_ipaddr_t of
                         *      the network.
                         */
                        if (fr_trie_insert_by_key(inst->trie,
                                           &inst->deny[i].addr, inst->deny[i].prefix,
                                           &inst->deny[i]) < 0) {
                                cf_log_err(conf, "Failed adding 'deny = %pV' to tracking table",
                                           fr_box_ipaddr(inst->deny[i]));
                                return -1;
                        }
 
                        /*
                         *      Hack it to make it a deny rule.
                         */
                        inst->deny[i].af = AF_UNSPEC;
                }
        }
 
        ci = cf_section_to_item(mctx->mi->parent->conf); /* listen { ... } */
        fr_assert(ci != NULL);
        ci = cf_parent(ci);
        fr_assert(ci != NULL);
 
        server_cs = cf_item_to_section(ci);
 
        /*
         *      Look up local clients, if they exist.
         */
        if (cf_section_find_next(server_cs, NULL, "client", CF_IDENT_ANY)) {
                inst->clients = client_list_parse_section(server_cs, IPPROTO_TCP, false);
                if (!inst->clients) {
                        cf_log_err(conf, "Failed creating local clients");
                        return -1;
                }
        }
 
        return 0;
}
 
static fr_client_t *mod_client_find(fr_listen_t *li, fr_ipaddr_t const *ipaddr, int ipproto)
{
        proto_radius_tcp_t const        *inst = talloc_get_type_abort_const(li->app_io_instance, proto_radius_tcp_t);
 
        /*
         *      Prefer local clients.
         */
        if (inst->clients) {
                fr_client_t *client;
 
                client = client_find(inst->clients, ipaddr, ipproto);
                if (client) return client;
        }
 
        return client_find(NULL, ipaddr, ipproto);
}
 
fr_app_io_t proto_radius_tcp = {
        .common = {
                .magic                  = MODULE_MAGIC_INIT,
                .name                   = "radius_tcp",
                .config                 = tcp_listen_config,
                .inst_size              = sizeof(proto_radius_tcp_t),
                .thread_inst_size       = sizeof(proto_radius_tcp_thread_t),
                .instantiate            = mod_instantiate,
        },
        .default_message_size   = 4096,
 
        .open                   = mod_open,
        .read                   = mod_read,
        .write                  = mod_write,
        .fd_set                 = mod_fd_set,
        .track_compare          = mod_track_compare,
        .connection_set         = mod_connection_set,
        .network_get            = mod_network_get,
        .client_find            = mod_client_find,
        .get_name               = mod_name,
        .hexdump_set            = mod_hexdump_set,
};