mirror of
https://github.com/mfontanini/libtins
synced 2026-01-22 18:25:57 +01:00
329 lines
10 KiB
C++
329 lines
10 KiB
C++
/*
|
|
* Copyright (c) 2012, 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_H
|
|
#define TINS_ICMP_H
|
|
|
|
#include "macros.h"
|
|
#include "pdu.h"
|
|
#include "endianness.h"
|
|
|
|
namespace Tins {
|
|
|
|
/** \brief Class that represents an ICMP PDU.
|
|
*
|
|
* ICMP is the representation of the ICMP PDU. Instances of this class
|
|
* must be sent over a level 3 PDU, this will otherwise fail.
|
|
*/
|
|
class ICMP : public PDU {
|
|
public:
|
|
/**
|
|
* \brief This PDU's flag.
|
|
*/
|
|
static const PDU::PDUType pdu_flag = PDU::ICMP;
|
|
|
|
/** \brief ICMP flags
|
|
*/
|
|
enum Flags {
|
|
ECHO_REPLY = 0,
|
|
DEST_UNREACHABLE = 3,
|
|
SOURCE_QUENCH = 4,
|
|
REDIRECT = 5,
|
|
ECHO_REQUEST = 8,
|
|
TIME_EXCEEDED = 11,
|
|
PARAM_PROBLEM = 12,
|
|
INFO_REQUEST = 15,
|
|
INFO_REPLY = 16
|
|
};
|
|
|
|
/**
|
|
* \brief Creates an instance of ICMP.
|
|
*
|
|
* If no flag is specified, then ECHO_REQUEST will be used.
|
|
* \param flag The type flag which will be set.
|
|
*/
|
|
ICMP(Flags flag = ECHO_REQUEST);
|
|
|
|
/**
|
|
* \brief Constructs an ICMP object from a buffer.
|
|
*
|
|
* If there is not enough size for an ICMP header, a
|
|
* malformed_packet exception is thrown.
|
|
*
|
|
* Any extra data in the buffer will be stored in a RawPDU.
|
|
*
|
|
* \param buffer The buffer from which this PDU will be constructed.
|
|
* \param total_sz The total size of the buffer.
|
|
*/
|
|
ICMP(const uint8_t *buffer, uint32_t total_sz);
|
|
|
|
/**
|
|
* \brief Sets the code field.
|
|
*
|
|
* \param new_code The code which will be stored in the ICMP struct.
|
|
*/
|
|
void code(uint8_t new_code);
|
|
|
|
/** \brief Sets the type field.
|
|
*
|
|
* \param type The type which will be stored in the ICMP struct.
|
|
*/
|
|
void type(Flags type);
|
|
|
|
/**
|
|
* \brief Setter for checksum field.
|
|
*
|
|
* \param new_check uint16_t with the new checksum.
|
|
*/
|
|
void check(uint16_t new_check);
|
|
|
|
/**
|
|
* \brief Setter for the id field.
|
|
*
|
|
* \param new_id uint16_t with the new id.
|
|
*/
|
|
void id(uint16_t new_id);
|
|
|
|
/**
|
|
* \brief Setter for the sequence field.
|
|
*
|
|
* \param new_seq uint16_t with the new sequence.
|
|
*/
|
|
void sequence(uint16_t new_seq);
|
|
|
|
/**
|
|
* \brief Setter for the gateway field.
|
|
*
|
|
* \param new_gw uint32_t with the new gateway.
|
|
*/
|
|
void gateway(uint32_t new_gw);
|
|
|
|
/**
|
|
* \brief Setter for the mtu field.
|
|
*
|
|
* \param new_mtu uint16_t with the new sequence.
|
|
*/
|
|
void mtu(uint16_t new_mtu);
|
|
|
|
/**
|
|
* \brief Setter for the pointer field.
|
|
*
|
|
* \param new_pointer uint8_t with the new pointer.
|
|
*/
|
|
void pointer(uint8_t new_pointer);
|
|
|
|
/**
|
|
* \brief Sets echo request flag for this PDU.
|
|
*
|
|
* \param id The identifier for this request.
|
|
* \param seq The sequence number for this request.
|
|
*/
|
|
void set_echo_request(uint16_t id, uint16_t seq);
|
|
|
|
/**
|
|
* \brief Sets echo reply flag for this PDU.
|
|
*
|
|
* \param id The identifier for this request.
|
|
* \param seq The sequence number for this request.
|
|
*/
|
|
void set_echo_reply(uint16_t id, uint16_t seq);
|
|
|
|
/**
|
|
* \brief Sets information request flag for this PDU.
|
|
*
|
|
* \param id The identifier for this request.
|
|
* \param seq The sequence number for this request.
|
|
*/
|
|
void set_info_request(uint16_t id, uint16_t seq);
|
|
|
|
/**
|
|
* \brief Sets information reply flag for this PDU.
|
|
*
|
|
* \param id The identifier for this request.
|
|
* \param seq The sequence number for this request.
|
|
*/
|
|
void set_info_reply(uint16_t id, uint16_t seq);
|
|
|
|
/**
|
|
* \brief Sets destination unreachable for this PDU.
|
|
*/
|
|
void set_dest_unreachable();
|
|
|
|
/**
|
|
* \brief Sets time exceeded flag for this PDU.
|
|
*
|
|
* \param ttl_exceeded If true this PDU will represent a ICMP ttl
|
|
* exceeded, otherwise it will represent a fragment reassembly
|
|
* time exceeded.
|
|
*/
|
|
void set_time_exceeded(bool ttl_exceeded = true);
|
|
|
|
/**
|
|
* \brief Sets parameter problem flag for this PDU.
|
|
*
|
|
* \param set_pointer Indicates wether a pointer to the bad octet
|
|
* is provided.
|
|
* \param bad_octet Identifies the octet in which the error was
|
|
* detected. If set_pointer == false, it is ignored.
|
|
*/
|
|
void set_param_problem(bool set_pointer = false, uint8_t bad_octet = 0);
|
|
|
|
/**
|
|
* \brief Sets source quench flag for this PDU.
|
|
*/
|
|
void set_source_quench();
|
|
|
|
/**
|
|
* \brief Sets redirect flag for this PDU.
|
|
*
|
|
* \param icode The code to be set.
|
|
* \param address Address of the gateway to which traffic should
|
|
* be sent.
|
|
*/
|
|
void set_redirect(uint8_t icode, uint32_t address);
|
|
|
|
/**
|
|
* \brief Getter for the ICMP type flag.
|
|
*
|
|
* \return The type flag for this ICMP PDU.
|
|
*/
|
|
Flags type() const { return (Flags)_icmp.type; }
|
|
|
|
/**
|
|
* \brief Getter for the ICMP code flag.
|
|
*
|
|
* \return The code flag for this ICMP PDU.
|
|
*/
|
|
uint8_t code() const { return _icmp.code; }
|
|
|
|
/**
|
|
* \brief Getter for the checksum field.
|
|
*
|
|
* \return Returns the checksum as an unit16_t.
|
|
*/
|
|
uint16_t check() const { return Endian::be_to_host(this->_icmp.check); }
|
|
|
|
/**
|
|
* \brief Getter for the echo id.
|
|
*
|
|
* \return Returns the echo id.
|
|
*/
|
|
uint16_t id() const { return Endian::be_to_host(_icmp.un.echo.id); }
|
|
|
|
/**
|
|
* \brief Getter for the echo sequence number.
|
|
*
|
|
* \return Returns the echo sequence number.
|
|
*/
|
|
uint16_t sequence() const { return Endian::be_to_host(_icmp.un.echo.sequence); }
|
|
|
|
/**
|
|
* \brief Getter for the gateway field.
|
|
*
|
|
* \return Returns the gateways in an unit32_t.
|
|
*/
|
|
uint32_t gateway() const { return Endian::be_to_host(this->_icmp.un.gateway); }
|
|
|
|
/**
|
|
* \brief Getter for the pointer field.
|
|
*
|
|
* \return Returns the pointer value.
|
|
*/
|
|
uint8_t pointer() const { return this->_icmp.un.pointer; }
|
|
|
|
/**
|
|
* \brief Getter for the mtu field.
|
|
*
|
|
* \return Returns the mtu value in an uint16_t.
|
|
*/
|
|
uint16_t mtu() const { return Endian::be_to_host(this->_icmp.un.frag.mtu); }
|
|
|
|
/**
|
|
* \brief Returns the header size.
|
|
*
|
|
* This metod overrides PDU::header_size. This size includes the
|
|
* payload and options size. \sa PDU::header_size
|
|
*/
|
|
uint32_t header_size() const;
|
|
|
|
/**
|
|
* \brief Check wether ptr points to a valid response for this PDU.
|
|
*
|
|
* \sa PDU::matches_response
|
|
* \param ptr The pointer to the buffer.
|
|
* \param total_sz The size of the buffer.
|
|
*/
|
|
bool matches_response(const uint8_t *ptr, uint32_t total_sz) const;
|
|
|
|
/**
|
|
* \brief Getter for the PDU's type.
|
|
*
|
|
* \sa PDU::pdu_type
|
|
*/
|
|
PDUType pdu_type() const { return PDU::ICMP; }
|
|
|
|
/**
|
|
* \sa PDU::clone
|
|
*/
|
|
ICMP *clone() const {
|
|
return new ICMP(*this);
|
|
}
|
|
private:
|
|
TINS_BEGIN_PACK
|
|
struct icmphdr {
|
|
uint8_t type;
|
|
uint8_t code;
|
|
uint16_t check;
|
|
union {
|
|
struct {
|
|
uint16_t id;
|
|
uint16_t sequence;
|
|
} echo;
|
|
uint32_t gateway;
|
|
struct {
|
|
uint16_t unused;
|
|
uint16_t mtu;
|
|
} frag;
|
|
uint8_t pointer;
|
|
} un;
|
|
} TINS_END_PACK;
|
|
|
|
/** \brief Serialices this ICMP PDU.
|
|
* \param buffer The buffer in which the PDU will be serialized.
|
|
* \param total_sz The size available in the buffer.
|
|
* \param parent The PDU that's one level below this one on the stack.
|
|
*/
|
|
void write_serialization(uint8_t *buffer, uint32_t total_sz, const PDU *parent);
|
|
|
|
icmphdr _icmp;
|
|
};
|
|
}
|
|
|
|
#endif // TINS_ICMP_H
|