libtins/include/dhcpv6.h

/*
 * Copyright (c) 2012, Nasel
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following disclaimer
 *   in the documentation and/or other materials provided with the
 *   distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef TINS_DHCPV6_H
#define TINS_DHCPV6_H

#include <list>
#include "pdu.h"
#include "endianness.h"
#include "small_uint.h"
#include "ipv6_address.h"
#include "pdu_option.h"

namespace Tins {    
/**
 * Represents a DHCPv6 PDU.
 */
class DHCPv6 : public PDU {
public:
    /**
     * Represents a DHCPv6 option. 
     */
    class dhcpv6_option {
    public:
        typedef std::vector<uint8_t> container_type;
        typedef container_type::value_type data_type;
        typedef uint16_t option_type;

        /**
         * \brief Constructs a PDUOption.
         * \param opt The option type.
         * \param length The option's data length.
         * \param data The option's data(if any).
         */
        dhcpv6_option(option_type opt = 0, size_t length = 0, const data_type *data = 0) 
        : option_(opt), option_size_(length) {
            if(data)
                value_.insert(value_.end(), data, data + length);
        }
        
        /**
         * \brief Constructs a PDUOption from iterators, which 
         * indicate the data to be stored in it.
         * 
         * \param opt The option type.
         * \param start The beginning of the option data.
         * \param end The end of the option data.
         */
        template<typename ForwardIterator>
        dhcpv6_option(option_type opt, ForwardIterator start, ForwardIterator end) 
        : option_(opt), option_size_(std::distance(start, end))
        {
            value_.insert(value_.end(), start, end);
        }
        
        /**
         * Retrieves this option's type.
         * \return uint8_t containing this option's size.
         */
        uint16_t option() const {
            return option_;
        }
        
        /**
         * Sets this option's type
         * \param opt The option type to be set.
         */
        void option(uint16_t opt) {
            option_ = opt;
        }
        
        /**
         * Retrieves this option's data.
         * 
         * If this method is called when data_size() == 0, 
         * dereferencing the returned pointer will result in undefined
         * behaviour.
         * 
         * \return const data_type& containing this option's value.
         */
        const data_type *data_ptr() const {
            return &*value_.begin();
        }
        
        /**
         * Retrieves the length of this option's data.
         */
        uint16_t data_size() const {
            return option_size_;
        }
    private:
        option_type option_;
        uint16_t option_size_;
        container_type value_;
    };

    /**
     * The message types.
     */
    enum MessageType {
        SOLICIT = 1,
        ADVERTISE,
        REQUEST,
        CONFIRM,
        RENEW,
        REBIND,
        REPLY,
        RELEASE,
        DECLINE,
        RECONFIGURE,
        INFO_REQUEST,
        RELAY_FORWARD,
        RELAY_REPLY,
        LEASE_QUERY,
        LEASE_QUERY_REPLY,
        LEASE_QUERY_DONE,
        LEASE_QUERY_DATA
    };
    
    /**
     * The DHCPv6 options.
     */
    enum Option {
        CLIENTID = 1, 
        SERVERID, 
        IA_NA, 
        IA_TA, 
        IA_ADDR, 
        OPTION_REQUEST, 
        PREFERENCE, 
        ELAPSED_TIME, 
        RELAY_MSG, 
        AUTH = 11, 
        UNICAST, 
        STATUS_CODE, 
        RAPID_COMMIT, 
        USER_CLASS, 
        VENDOR_CLASS, 
        VENDOR_OPTS, 
        INTERFACE_ID, 
        RECONF_MSG, 
        RECONF_ACCEPT, 
        SIP_SERVER_D, 
        SIP_SERVER_A, 
        DNS_SERVERS, 
        DOMAIN_LIST, 
        IA_PD, 
        IAPREFIX, 
        NIS_SERVERS, 
        NISP_SERVERS, 
        NIS_DOMAIN_NAME, 
        NISP_DOMAIN_NAME, 
        SNTP_SERVERS, 
        INFORMATION_REFRESH_TIME, 
        BCMCS_SERVER_D, 
        BCMCS_SERVER_A, 
        GEOCONF_CIVIC = 36, 
        REMOTE_ID, 
        SUBSCRIBER_ID, 
        CLIENT_FQDN, 
        PANA_AGENT, 
        NEW_POSIX_TIMEZONE, 
        NEW_TZDB_TIMEZONE, 
        ERO, 
        LQ_QUERY, 
        CLIENT_DATA, 
        CLT_TIME, 
        LQ_RELAY_DATA, 
        LQ_CLIENT_LINK, 
        MIP6_HNIDF, 
        MIP6_VDINF, 
        V6_LOST, 
        CAPWAP_AC_V6, 
        RELAY_ID, 
        NTP_SERVER, 
        V6_ACCESS_DOMAIN, 
        SIP_UA_CS_LIST, 
        BOOTFILE_URL, 
        BOOTFILE_PARAM, 
        CLIENT_ARCH_TYPE, 
        NII, 
        GEOLOCATION, 
        AFTR_NAME, 
        ERP_LOCAL_DOMAIN_NAME, 
        RSOO, 
        PD_EXCLUDE, 
        VSS, 
        MIP6_IDINF, 
        MIP6_UDINF, 
        MIP6_HNP, 
        MIP6_HAA, 
        MIP6_HAF, 
        RDNSS_SELECTION, 
        KRB_PRINCIPAL_NAME, 
        KRB_REALM_NAME, 
        KRB_DEFAULT_REALM_NAME, 
        KRB_KDC
    };

    /**
     * The type used to store the DHCPv6 options.
     */
    typedef std::list<dhcpv6_option> options_type;

    /**
     * The type used to store IP addresses.
     */
    typedef IPv6Address ipaddress_type;
    
    /**
     * This PDU's flag.
     */
    static const PDU::PDUType pdu_flag = PDU::DHCPv6;

    /**
     * The type used to store the Identity Association for Non-Temporary
     * Addresses option.
     */
    struct ia_na_type {
        typedef std::vector<uint8_t> options_type;
        
        uint32_t id, t1, t2;
        options_type options;
        
        ia_na_type(uint32_t id = 0, uint32_t t1 = 0, uint32_t t2 = 0,
          const options_type& options = options_type())
        : id(id), t1(t1), t2(t2), options(options) {}
    };
    
    /**
     * The type used to store the Identity Association for Temporary
     * Addresses option.
     */
    struct ia_ta_type {
        typedef std::vector<uint8_t> options_type;
        
        uint32_t id;
        options_type options;
        
        ia_ta_type(uint32_t id = 0,
          const options_type& options = options_type())
        : id(id), options(options) {}
    };

    /**
     * The type used to store the Identity Association Address option.
     */
    struct ia_address_type {
        typedef std::vector<uint8_t> options_type;
        
        ipaddress_type address;
        uint32_t preferred_lifetime, valid_lifetime;
        options_type options;
        
        ia_address_type(ipaddress_type address = ipaddress_type(), 
          uint32_t preferred_lifetime = 0, uint32_t valid_lifetime = 0, 
          const options_type& options = options_type())
        : address(address), preferred_lifetime(preferred_lifetime), 
          valid_lifetime(valid_lifetime), options(options) {}
    };
    
    /**
     * The type used to store the Authentication option.
     */
    struct authentication_type {
        typedef std::vector<uint8_t> auth_info_type;
        
        uint8_t protocol, algorithm, rdm;
        uint64_t replay_detection;
        auth_info_type auth_info;
        
        authentication_type(uint8_t protocol = 0, uint8_t algorithm = 0,
          uint8_t rdm = 0, uint64_t replay_detection = 0,
          const auth_info_type &auth_info = auth_info_type())
        : protocol(protocol), algorithm(algorithm), rdm(rdm),
        replay_detection(replay_detection), auth_info(auth_info) {}
    };
    
    /**
     * The type used to store the Status Code option.
     */
    struct status_code_type {
        uint16_t code;
        std::string message;
        
        status_code_type(uint16_t code = 0, const std::string &message = "")
        : code(code), message(message) { }
    };
    
    /**
     * The type used to store the Vendor-specific Information option.
     */
    struct vendor_info_type {
        typedef std::vector<uint8_t> data_type;
        
        uint32_t enterprise_number;
        data_type data;
        
        vendor_info_type(uint32_t enterprise_number = 0, 
          const data_type &data = data_type())
        : enterprise_number(enterprise_number), data(data) { }
    };
    
    
    /**
     * The type used to store the User Class option's user class data.
     */
    typedef std::vector<uint8_t> class_option_data_type;
    
    /**
     * The type used to store the User Class option.
     */
    typedef std::vector<class_option_data_type> user_class_type;
    
    /**
     * The type used to store the Vendor Class option.
     */
    struct vendor_class_type {
        typedef std::vector<class_option_data_type> class_data_type;
        
        uint32_t enterprise_number;
        class_data_type vendor_class_data;
        
        vendor_class_type(uint32_t enterprise_number = 0, 
          const class_data_type &vendor_class_data = class_data_type())
        : enterprise_number(enterprise_number), 
        vendor_class_data(vendor_class_data) { }
    };
        
    /**
     * The type used to store the Option Request option.
     */
    typedef std::vector<Option> option_request_type;
    
    /**
     * The type used to store the Relay Message option.
     */
    typedef std::vector<uint8_t> relay_msg_type;
    
    /**
     * The type used to store the Interface-ID option.
     */
    typedef std::vector<uint8_t> interface_id_type;

    /**
     * Default constructor.
     */
    DHCPv6();
    
    /**
     * \brief Constructor which constructs a DHCPv6 object from a buffer 
     * and adds all identifiable PDUs found in the buffer as children 
     * of this one.
     * \param buffer The buffer from which this PDU will be constructed.
     * \param total_sz The total size of the buffer.
     */
    DHCPv6(const uint8_t *buffer, uint32_t total_sz);

    // Getters
    
    /**
     * \brief Getter for the message type field.
     *
     * \return The stored message type field.
     */
    MessageType msg_type() const { 
        return static_cast<MessageType>(header_data[0]); 
    }
    
    /**
     * \brief Getter for the hop count field.
     *
     * \return The stored hop count field.
     */
    uint8_t hop_count() const { return header_data[1]; }
    
    /**
     * \brief Getter for the transaction id field.
     *
     * \return The stored transaction id field.
     */
    small_uint<24> transaction_id() const { 
        return (header_data[1] << 16) | (header_data[2] << 8) | header_data[3];
    }

    /**
     * \brief Getter for the peer address field.
     *
     * \return The stored peer address field.
     */
    const ipaddress_type &peer_address() const { return peer_addr; }
    
    /**
     * \brief Getter for the link address field.
     *
     * \return The stored link address field.
     */
    const ipaddress_type &link_address() const { return link_addr; }

    // Setters
    /**
     * \brief Setter for the message type field.
     *
     * \param type The new message type.
     */
    void msg_type(MessageType type);
    
    /**
     * \brief Setter for the hop count field.
     *
     * \param count The new hop count.
     */
    void hop_count(uint8_t count);
    
    /**
     * \brief Setter for the transaction id field.
     *
     * \param id The new transaction id.
     */
    void transaction_id(small_uint<24> id);
    
    /**
     * \brief Setter for the peer address field.
     *
     * \param count The new peer address.
     */
    void peer_address(const ipaddress_type &addr);
    
    /**
     * \brief Setter for the link address field.
     *
     * \param count The new link address.
     */
    void link_address(const ipaddress_type &addr);
    
    // Option getters
    
    /**
     * \brief Getter for the Identity Association for Non-Temporary
     * Addresses option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    ia_na_type ia_na() const;
    
    /**
     * \brief Getter for the Identity Association for Temporary
     * Addresses option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    ia_ta_type ia_ta() const;
    
    /**
     * \brief Getter for the Identity Association Address option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    ia_address_type ia_address() const;
    
    /**
     * \brief Getter for the Option Request option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    option_request_type option_request() const;
    
    /**
     * \brief Getter for the Preference option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    uint8_t preference() const;
    
    /**
     * \brief Getter for the Elapsed Time option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    uint16_t elapsed_time() const;
    
    /**
     * \brief Getter for the Relay Message option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    relay_msg_type relay_message() const;
    
    /**
     * \brief Getter for the Authentication option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    authentication_type authentication() const;
    
    /**
     * \brief Getter for the Server Unicast option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    ipaddress_type server_unicast() const;
    
    /**
     * \brief Getter for the Server Unicast option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    status_code_type status_code() const;
    
    /**
     * \brief Getter for the Rapid Commit option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    bool has_rapid_commit() const;
    
    /**
     * \brief Getter for the User Class option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    user_class_type user_class() const;
    
    /**
     * \brief Getter for the Vendor Class option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    vendor_class_type vendor_class() const;
    
    /**
     * \brief Getter for the Vendor-specific Information option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    vendor_info_type vendor_info() const;
    
    /**
     * \brief Getter for the Interface ID option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    interface_id_type interface_id() const;

    /**
     * \brief Getter for the Reconfigure Message option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    uint8_t reconfigure_msg() const;
    
    /**
     * \brief Getter for the Reconfigure Accept option.
     * 
     * This method will throw an option_not_found exception if the
     * option is not found.
     */
    bool has_reconfigure_accept() const;
    
    // Option setters
    
    /**
     * \brief Setter for the Identity Association for Non-Temporary
     * Addresses option.
     * 
     * \param value The new IA_NA option data.
     */
    void ia_na(const ia_na_type &value);
    
    /**
     * \brief Setter for the Identity Association for Temporary
     * Addresses option.
     * 
     * \param value The new IA_TA option data.
     */
    void ia_ta(const ia_ta_type &value);
    
    /**
     * \brief Setter for the Identity Association Address option.
     * 
     * \param value The new IA Address option data.
     */
    void ia_address(const ia_address_type &value);
    
    /**
     * \brief Setter for the Identity Association Address option.
     * 
     * \param value The new Option Request option data.
     */
    void option_request(const option_request_type &value);
    
    /**
     * \brief Setter for the Preference option.
     * 
     * \param value The new Preference option data.
     */
    void preference(uint8_t value);
    
    /**
     * \brief Setter for the Elapsed Time option.
     * 
     * \param value The new Elapsed Time option data.
     */
    void elapsed_time(uint16_t value);
    
    /**
     * \brief Setter for the Relay Message option.
     * 
     * \param value The new Relay Message option data.
     */
    void relay_message(const relay_msg_type &value);
    
    /**
     * \brief Setter for the Authentication option.
     * 
     * \param value The new Authentication option data.
     */
    void authentication(const authentication_type &value);
    
    /**
     * \brief Setter for the Server Unicast option.
     * 
     * \param value The new Server Unicast option data.
     */
    void server_unicast(const ipaddress_type &value);
    
    /**
     * \brief Setter for the Status Code option.
     * 
     * \param value The new Status Code option data.
     */
    void status_code(const status_code_type &value);
    
    /**
     * \brief Adds a Rapid Commit option.
     */
    void rapid_commit();
    
    /**
     * \brief Setter for the User Class option.
     * 
     * \param value The new User Class option data.
     */
    void user_class(const user_class_type &value);
    
    /**
     * \brief Setter for the Vendor Class option.
     * 
     * \param value The new Vendor Class option data.
     */
    void vendor_class(const vendor_class_type &value);
    
    /**
     * \brief Setter for the Vendor-specific Information option.
     * 
     * \param value The new Vendor-specific Information option data.
     */
    void vendor_info(const vendor_info_type &value);
    
    /**
     * \brief Setter for the Interface ID option.
     * 
     * \param value The new Interface ID option data.
     */
    void interface_id(const interface_id_type &value);
    
    /**
     * \brief Setter for the Reconfigure Message option.
     * 
     * \param value The new Reconfigure Message option data.
     */
    void reconfigure_msg(uint8_t value);
    
    /**
     * \brief Adds a Reconfigure Accept option.
     */
    void reconfigure_accept();
    
    // Other stuff
    
    /**
     * Indicates whether this is a relay agent/server message
     */
    bool is_relay_message() const;
    
    /**
     * \brief Adds a DHCPv6 option.
     * 
     * The option is added after the last option in the option 
     * fields.
     * 
     * \param option The option to be added
     */
    void add_option(const dhcpv6_option &option);
    
    /**
     * \brief Searchs for an option that matchs the given flag.
     * 
     * If the option is not found, a null pointer is returned. 
     * Deleting the returned pointer will result in <b>undefined 
     * behaviour</b>.
     * 
     * \param id The option identifier to be searched.
     */
    const dhcpv6_option *search_option(Option id) const;

    // PDU stuff
    
    /**
     * \brief Returns the header size.
     *
     * This metod overrides PDU::header_size. \sa PDU::header_size
     */
    uint32_t header_size() const;
    
    /**
     * \brief Getter for the PDU's type.
     * \sa PDU::pdu_type
     */
    PDUType pdu_type() const { return pdu_flag; }
    
    /**
     * \sa PDU::clone
     */
    DHCPv6 *clone() const {
        return new DHCPv6(*this);
    }
private:
    void write_serialization(uint8_t *buffer, uint32_t total_sz, const PDU *);
    uint8_t* write_option(const dhcpv6_option &option, uint8_t* buffer) const;
    
    template<template <typename> class Functor>
    const dhcpv6_option *safe_search_option(Option opt, uint32_t size) const {
        const dhcpv6_option *option = search_option(opt);
        if(!option || Functor<uint32_t>()(option->data_size(), size))
            throw option_not_found();
        return option;
    }
    
    template<typename InputIterator>
    void class_option_data2option(InputIterator start, InputIterator end, 
      std::vector<uint8_t>& buffer, size_t start_index = 0) 
    {
        size_t index = start_index;
        while(start != end) {
            buffer.resize(buffer.size() + sizeof(uint16_t) + start->size());
            *(uint16_t*)&buffer[index] = Endian::host_to_be<uint16_t>(start->size());
            index += sizeof(uint16_t);
            std::copy(start->begin(), start->end(), buffer.begin() + index);
            index += start->size();
            
            start++;
        }
    }
    
    template<typename OutputType>
    OutputType option2class_option_data(const uint8_t *ptr, uint32_t total_sz) const
    {
        typedef typename OutputType::value_type value_type;
        OutputType output;
        size_t index = 0;
        while(index + 2 < total_sz) {
            uint16_t size = Endian::be_to_host(
                *(const uint16_t*)(ptr + index)
            );
            index += sizeof(uint16_t);
            if(index + size > total_sz)
                throw option_not_found();
            output.push_back(
                value_type(ptr + index, ptr + index + size)
            );
            index += size;
        }
        if(index != total_sz)
            throw option_not_found();
        return output;
    }
    

    uint8_t header_data[4];
    uint32_t options_size;
    ipaddress_type link_addr, peer_addr;
    options_type options_;
};    
}

#endif // TINS_DHCPV6_H