ace-radius/RadiusAttribute.h

/*
 * This source file is part of the ace-radius library.  This code was
 * written by Alex Agranov in 2004-2009, and is covered by the BSD open source
 * license. Refer to the accompanying documentation for details on usage and
 * license.
 */

#ifndef _RADIUSATTRIBUTE_H__
#define _RADIUSATTRIBUTE_H__

#include "Radius.h"

// definition of Attribute Types from RFC2865
#define D_ATTR_USER_NAME                1
#define D_ATTR_USER_PASSWORD            2
#define D_ATTR_CHAP_PASSWORD            3
#define D_ATTR_NAS_IP_ADDRESS           4
#define D_ATTR_NAS_PORT                 5
#define D_ATTR_SERVICE_TYPE             6
#define D_ATTR_FRAMED_PROTOCOL          7
#define D_ATTR_FRAMED_IP_ADDRESS        8
#define D_ATTR_FRAMED_IP_NETMASK        9
#define D_ATTR_FRAMED_ROUTING           10 
#define D_ATTR_FILTER_ID                11 
#define D_ATTR_FRAMED_MTU               12 
#define D_ATTR_FRAMED_COMPRESSION       13 
#define D_ATTR_LOGIN_IP_HOST            14 
#define D_ATTR_LOGIN_SERVICE            15 
#define D_ATTR_LOGIN_TCP_PORT           16 
#define D_ATTR_OLD_PASSWORD             17
#define D_ATTR_REPLY_MESSAGE            18 
#define D_ATTR_CALLBACK_NUMBER          19 
#define D_ATTR_CALLBACK_ID              20 
#define D_ATTR_FRAMED_ROUTE             22 
#define D_ATTR_FRAMED_IPX_NETWORK       23 
#define D_ATTR_STATE                    24 
#define D_ATTR_CLASS                    25 
#define D_ATTR_VENDOR_SPECIFIC          26 
#define D_ATTR_SESSION_TIMEOUT          27 
#define D_ATTR_IDLE_TIMEOUT             28 
#define D_ATTR_TERMINATION_ACTION       29 
#define D_ATTR_CALLED_STATION_ID        30 
#define D_ATTR_CALLING_STATION_ID       31 
#define D_ATTR_NAS_IDENTIFIER           32 
#define D_ATTR_PROXY_STATE              33 
#define D_ATTR_LOGIN_LAT_SERVICE        34 
#define D_ATTR_LOGIN_LAT_NODE           35 
#define D_ATTR_LOGIN_LAT_GROUP          36 
#define D_ATTR_FRAMED_APPLETALK_LINK    37 
#define D_ATTR_FRAMED_APPLETALK_NETWORK 38 
#define D_ATTR_FRAMED_APPLETALK_ZONE    39 
// types 40-59 are reserved for accounting - RFC2866
#define D_ATTR_CHAP_CHALLENGE           60 
#define D_ATTR_NAS_PORT_TYPE            61 
#define D_ATTR_PORT_LIMIT               62 
#define D_ATTR_LOGIN_LAT_PROMPT         63

// definition of Attribute Types from RFC2866
#define D_ATTR_ACCT_STATUS_TYPE         40 
#define D_ATTR_ACCT_DELAY_TIME          41 
#define D_ATTR_ACCT_INPUT_OCTETS        42 
#define D_ATTR_ACCT_OUTPUT_OCTETS       43 
#define D_ATTR_ACCT_SESSION_ID          44 
#define D_ATTR_ACCT_AUTHENTIC           45 
#define D_ATTR_ACCT_SESSION_TIME        46 
#define D_ATTR_ACCT_INPUT_PACKETS       47 
#define D_ATTR_ACCT_OUTPUT_PACKETS      48 
#define D_ATTR_ACCT_TERMINATE_CAUSE     49 
#define D_ATTR_ACCT_MULTI_SESSION_ID    50 
#define D_ATTR_ACCT_LINK_COUNT          51 

#define D_ATTR_MAX_KNOWN_TYPE           63



// definition of Acct-Status-Type attribute values from RFC2866
#define D_ACCT_STATUS_START             1
#define D_ACCT_STATUS_STOP              2
#define D_ACCT_STATUS_INTERIM_UPDATE    3
#define D_ACCT_STATUS_ON                7
#define D_ACCT_STATUS_OFF               8


// max length of User-Password attribute
#define D_USER_PASSWORD_MAX_LENGTH    128



class RadiusPacket;
class RadiusSecret;

class RadiusAttribute
{
public:

    RadiusAttribute();
    
    ~RadiusAttribute();

    
    void dump();

    

    void init(RadiusPacket * p_packet, uint16_t p_offset);

    
    RadiusPacket * getPacket(void);


    uint16_t getOffset(void);




    unsigned char getType(void);


    int setType(unsigned char p_type);

    
    const char * getTypeDescription(void);



    unsigned char getLength(void);


    int setLength(unsigned char p_length);

    

    int isValid(void);


    // ------------------------------------------------------------
    // get- and set- methods - access data stored in the attribute

    // ===========================
    // Regular attributes
    // ===========================


    uint32_t getNumber(void);
    

    int setNumber(uint32_t p_value);



    struct in_addr getIPAddress(void);


    int setIPAddress(struct in_addr p_value);



    int getString(const char * & p_data, uint16_t & p_length);
    

    int setString(const char * p_data, uint16_t p_length = 0);


    // ===========================
    // Vendor-Specific attribute
    // ===========================


    uint32_t getVendorId(void);
    

    int setVendorId(uint32_t p_vendorId);


    int getVendorRawString(const char * & p_data, uint16_t & p_length);
    

    int setVendorRawString(const char * p_data, uint16_t p_length = 0);



        unsigned char getVendorType();


        int setVendorType(unsigned char p_value);



        unsigned char getVendorLength();


        int setVendorLength(unsigned char p_length);



        uint32_t getVendorNumber();
    

        int setVendorNumber(uint32_t p_value);



        struct in_addr getVendorIPAddress();   


        int setVendorIPAddress(struct in_addr p_address);



        int getVendorString(const char * & p_data, uint16_t & p_length);
    

        int setVendorString(const char * p_data, uint16_t p_length = 0);


    // ===========================
    // User-Password attribute
    // ===========================
    

    int getUserPassword(char * p_data, uint16_t & p_length, 
                        RadiusSecret * p_secret = NULL);
    

    int setUserPassword(const char * p_data, uint16_t p_length = 0);

    // Encode raw data of User-Password attribute
    /*
     * We need this function in order to re-encode User-Password attribute with new secret key
     * when packet is retransmitted through new connection; application should not use this API.
     */
    int encodeUserPassword(const unsigned char * p_data, uint16_t p_length);


    // ===========================
    // Old-Password attribute
    // ===========================


    int getOldPassword(char * p_data, uint16_t & p_length, 
                        RadiusSecret * p_secret = NULL);


    int setOldPassword(const char * p_data, uint16_t p_length = 0);

    // Encode raw data of Old-Password attribute
    /*
     * We need this function in order to re-encode User-Password attribute with new secret key
     * when packet is retransmitted through new connection; application should not use this API.
     */
    int encodeOldPassword(const unsigned char * p_data, uint16_t p_length);


    // ===========================
    // CHAP-Password attribute
    // ===========================


    unsigned char getChapIdentifier(void);
    

    int setChapIdentifier(unsigned char p_chapId);


    int getChapString(const char * & p_data, uint16_t & p_length);
    

    int setChapString(const char * p_data, uint16_t p_length = 0);



private:

    // Get pointer to the attribute raw data
    unsigned char * getRawData(void);

    // Types of attribute data
    typedef enum AttributeFormat_e
    {
        E_ATTR_FORMAT_INTEGER,
        E_ATTR_FORMAT_IP_ADDRESS,
        E_ATTR_FORMAT_STRING,
        E_ATTR_FORMAT_VENDOR_SPECIFIC,
        E_ATTR_FORMAT_USER_PASSWORD,
        E_ATTR_FORMAT_CHAP_PASSWORD
    };

    // Dump attribute in readable text format to the STDOUT
    void dump(AttributeFormat_e p_format);


    // Pointer to the RADIUS packet that this attribute belongs to
    RadiusPacket * m_packet;

    // Offset of the attribute inside the RADIUS packet
    uint16_t m_offset;
};

#endif // _RADIUSATTRIBUTE_H__

---