icmp_msg.h

Go to the documentation of this file.

// Copyright (C) 2023-2026 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef ICMP_MSG_H
#define ICMP_MSG_H
 
#include <asiolink/io_address.h>
 
#include <cstdint>
 
#include <boost/shared_ptr.hpp>
 
#include <arpa/inet.h>
#include <netinet/in.h>
#include <netinet/ip.h>
#include <netinet/ip_icmp.h>
#include <unistd.h>
 
namespace isc {
namespace ping_check {
 
// Forward class definition.
class ICMPMsg;

typedef boost::shared_ptr<ICMPMsg> ICMPMsgPtr;

typedef boost::shared_ptr<struct icmp> ICMPPtr;

class ICMPMsg {
public:
    enum ICMPMsgType : uint16_t {
        ECHO_REPLY = 0,
        TARGET_UNREACHABLE = 3,
        ECHO_REQUEST = 8
    };

    constexpr static size_t ICMP_HEADER_SIZE = 8;

    ICMPMsg();

    virtual ~ICMPMsg() = default;

    static ICMPMsgPtr unpack(const uint8_t* wire_data, size_t length);

    ICMPPtr pack() const;

    uint8_t getType() const {
        return (msg_type_);
    }

    void setType(uint8_t msg_type) {
        msg_type_ = msg_type;
    }

    uint8_t getCode() const {
        return (code_);
    }

    void setCode(uint8_t code) {
        code_ = code;
    }

    uint16_t getChecksum() const {
        return (check_sum_);
    }

    void setChecksum(uint16_t check_sum) {
        check_sum_ = check_sum;
    }

    uint16_t getId() const {
        return (id_);
    }

    void setId(const uint16_t id) {
        id_ = id;
    }

    uint16_t getSequence() const {
        return (sequence_);
    }

    void setSequence(uint16_t sequence) {
        sequence_ = sequence;
    }

    const isc::asiolink::IOAddress& getSource() const {
        return (source_);
    }

    void setSource(const isc::asiolink::IOAddress& source) {
        source_ = source;
    }

    const isc::asiolink::IOAddress& getDestination() const {
        return (destination_);
    }

    void setDestination(const isc::asiolink::IOAddress& destination) {
        destination_ = destination;
    }

    const std::vector<uint8_t>& getPayload() const {
        return (payload_);
    }

    void setPayload(const uint8_t* data, size_t length);

    static uint32_t calcChecksum(const uint8_t* data, size_t length);
 
private:
    isc::asiolink::IOAddress source_;

    isc::asiolink::IOAddress destination_;

    uint8_t msg_type_;

    uint8_t code_;

    uint16_t check_sum_;

    uint16_t id_;

    uint16_t sequence_;
 
    // data beyond the ICMP header
    std::vector<uint8_t> payload_;
};
 
 
} // end of namespace ping_check
} // end of namespace isc
 
#endif