icmp_extension.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_ICMP_EXTENSION_H
#define TINS_ICMP_EXTENSION_H

#include <vector>
#include <stdint.h>
#include <tins/macros.h>
#include <tins/small_uint.h>
#include <tins/endianness.h>

namespace Tins {

class MPLS;

class TINS_API ICMPExtension {
public:
    typedef std::vector<uint8_t> payload_type;

    typedef std::vector<uint8_t> serialization_type;

    ICMPExtension();

    ICMPExtension(uint8_t ext_class, uint8_t ext_type);

    ICMPExtension(const uint8_t* buffer, uint32_t total_sz);

    void extension_class(uint8_t value);

    void extension_type(uint8_t value);

    void payload(const payload_type& value);

    uint8_t extension_class() const {
        return extension_class_;
    }

    uint8_t extension_type() const {
        return extension_type_;
    }

    const payload_type& payload() const {
        return payload_;
    }

    uint32_t size() const;

    void serialize(uint8_t* buffer, uint32_t buffer_size) const;

    serialization_type serialize() const;
private:
    static const uint32_t BASE_HEADER_SIZE;

    payload_type payload_;
    uint8_t extension_class_, extension_type_;
};

class TINS_API ICMPExtensionsStructure {
public:
    static const uint32_t MINIMUM_ICMP_PAYLOAD;

    typedef ICMPExtension::serialization_type serialization_type;

    typedef std::vector<ICMPExtension> extensions_type;

    ICMPExtensionsStructure();

    ICMPExtensionsStructure(const uint8_t* buffer, uint32_t total_sz);

    void version(small_uint<4> value);

    void reserved(small_uint<12> value);

    small_uint<4> version() const {
        uint16_t value = Endian::be_to_host(version_and_reserved_);
        return (value >> 12) & 0xf;
    }

    small_uint<12> reserved() const {
        uint16_t value = Endian::be_to_host(version_and_reserved_);
        return value & 0xfff;
    }

    uint16_t checksum() const {
        return Endian::be_to_host(checksum_);
    }

    const extensions_type& extensions() const {
        return extensions_;
    }

    void add_extension(const ICMPExtension& extension);

    void add_extension(MPLS& mpls);

    uint32_t size() const;

    void serialize(uint8_t* buffer, uint32_t buffer_size);

    serialization_type serialize();

    static bool validate_extensions(const uint8_t* buffer, uint32_t total_sz);
private:
    static const uint32_t BASE_HEADER_SIZE;

    uint16_t version_and_reserved_;
    uint16_t checksum_;
    extensions_type extensions_;
};

} // Tins

#endif // TINS_ICMP_EXTENSION_H