packet.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
 */
 
/** Structures and functions for packet manipulation
 *
 * @file src/lib/util/packet.h
 *
 * @copyright 2001, 2002, 2003, 2004, 2005, 2006 The FreeRADIUS server project
 */
RCSIDH(packet_h, "$Id: 99b4344a827e345c7660130ceaf5c83398c0f6bd $")
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <freeradius-devel/build.h>
#include <freeradius-devel/missing.h>
#include <freeradius-devel/util/inet.h>
#include <freeradius-devel/util/pair.h>
#include <freeradius-devel/util/rb.h>
#include <freeradius-devel/util/socket.h>
#include <freeradius-devel/util/talloc.h>
#include <freeradius-devel/util/time.h>
 
#ifdef WITH_VERIFY_PTR
#  define PACKET_VERIFY(_x)     (void) talloc_get_type_abort_const(_x, fr_packet_t)
#else
#  define PACKET_VERIFY(_x)     fr_cond_assert(_x)
#endif
 
#define RADIUS_AUTH_VECTOR_LENGTH               16
 
/*
 *      vector:         Request authenticator from access-request packet
 *                      Put in there by rad_decode, and must be put in the
 *                      response fr_packet_t as well before calling fr_packet_send
 *
 *      verified:       Filled in by rad_decode for accounting-request packets
 *
 *      data,data_len:  Used between fr_radius_recv and fr_radius_decode.
 */
typedef struct {
        fr_socket_t             socket;                 //!< This packet was received on.
        fr_time_t               timestamp;              //!< When we received the packet.
 
        int                     id;                     //!< Packet ID (used to link requests/responses).
        unsigned int            code;                   //!< Packet code (type).
 
        uint8_t                 *data;                  //!< Packet data (body).
        size_t                  data_len;               //!< Length of packet data.
 
        /*
         *      The vector should go away soon
         */
        uint8_t                 vector[RADIUS_AUTH_VECTOR_LENGTH];//!< RADIUS authentication vector.
 
        /*
         *      The following fields are deprecated, and only used by old code.
         */
        fr_rb_node_t            node;                   //!< Allows insertion into the list.c
                                                        ///< rbtree, may be removed in future.
 
        size_t                  partial;
 
        void                    *uctx;
} fr_packet_t;
 
fr_packet_t     *fr_packet_alloc(TALLOC_CTX *ctx, bool new_vector);
fr_packet_t     *fr_packet_alloc_reply(TALLOC_CTX *ctx, fr_packet_t *);
void            fr_packet_free(fr_packet_t **);
 
#ifdef __cplusplus
}
#endif