arp.h

/*
 * Copyright (c) 2017, Matias Fontanini
 * 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_ARP_H
#define TINS_ARP_H

#include <tins/macros.h>
#include <tins/pdu.h>
#include <tins/endianness.h>
#include <tins/hw_address.h>
#include <tins/ip_address.h>

namespace Tins {

class NetworkInterface;
class EthernetII;

class TINS_API ARP : public PDU {
public:
    typedef HWAddress<6> hwaddress_type;
    
    typedef IPv4Address ipaddress_type;

    static const PDU::PDUType pdu_flag = PDU::ARP;

    enum Flags {
        REQUEST = 0x0001,
        REPLY   = 0x0002
    };

    static metadata extract_metadata(const uint8_t *buffer, uint32_t total_sz);

    ARP(ipaddress_type target_ip = ipaddress_type(), 
        ipaddress_type sender_ip = ipaddress_type(), 
        const hwaddress_type& target_hw = hwaddress_type(), 
        const hwaddress_type& sender_hw = hwaddress_type());

    ARP(const uint8_t* buffer, uint32_t total_sz);

    /* Getters */
    hwaddress_type sender_hw_addr() const {
        return header_.sender_hw_address;
    }

    ipaddress_type sender_ip_addr() const {
        return ipaddress_type(header_.sender_ip_address);
    }

    hwaddress_type target_hw_addr() const {
        return header_.target_hw_address;
    }

    ipaddress_type target_ip_addr() const {
        return ipaddress_type(header_.target_ip_address);
    }

    uint16_t hw_addr_format() const {
        return Endian::be_to_host(header_.hw_address_format);
    }

    uint16_t prot_addr_format() const {
        return Endian::be_to_host(header_.proto_address_format);
    }

    uint8_t hw_addr_length() const {
        return header_.hw_address_length;
    }

    uint8_t prot_addr_length() const {
        return header_.proto_address_length;
    }

    uint16_t opcode() const {
        return Endian::be_to_host(header_.opcode);
    }

    uint32_t header_size() const;

    /* Setters */

    void sender_hw_addr(const hwaddress_type& address);

    void sender_ip_addr(ipaddress_type address);

    void target_hw_addr(const hwaddress_type& address);

    void target_ip_addr(ipaddress_type address);

    void hw_addr_format(uint16_t format);

    void prot_addr_format(uint16_t format);

    void hw_addr_length(uint8_t length);

    void prot_addr_length(uint8_t length);

    void opcode(Flags code);

    PDUType pdu_type() const { return pdu_flag; }

    static EthernetII make_arp_request(ipaddress_type target, 
                                       ipaddress_type sender, 
                                       const hwaddress_type& hw_snd = hwaddress_type());

    static EthernetII make_arp_reply(ipaddress_type target, 
                                     ipaddress_type sender, 
                                     const hwaddress_type& hw_tgt = hwaddress_type(), 
                                     const hwaddress_type& hw_snd = hwaddress_type());

    bool matches_response(const uint8_t* ptr, uint32_t total_sz) const;
    
    ARP* clone() const {
        return new ARP(*this);
    }
private:
    TINS_BEGIN_PACK
    struct arp_header {
        uint16_t hw_address_format;
        uint16_t proto_address_format;
        uint8_t hw_address_length;
        uint8_t proto_address_length;
        uint16_t opcode;
        uint8_t sender_hw_address[hwaddress_type::address_size];    
        uint32_t sender_ip_address; 
        uint8_t target_hw_address[hwaddress_type::address_size];    
        uint32_t target_ip_address;
    } TINS_END_PACK;

    void write_serialization(uint8_t* buffer, uint32_t total_sz);

    arp_header header_;
};

} // Tins

#endif // TINS_ARP_H