#ifndef PACKETPP_IGMP_LAYER

#define PACKETPP_IGMP_LAYER

#include "Layer.h"

#include "IpAddress.h"

#include <vector>

/// @file

/**

 * \namespace pcpp

 * \brief The main namespace for the PcapPlusPlus lib

 */

namespace pcpp

{

/**

 * @struct igmp_header

 * IGMPv1 and IGMPv2 basic protocol header

 */

struct igmp_header

{

  /** Indicates the message type. The enum for message type is pcpp::IgmpType */

  uint8_t type;

  /** Specifies the time limit for the corresponding report. The field has a resolution of 100 milliseconds */

  uint8_t maxResponseTime;

  /** This is the 16-bit one's complement of the one's complement sum of the entire IGMP message */

  uint16_t checksum;

  /** This is the multicast address being queried when sending a Group-Specific or Group-and-Source-Specific Query */

  uint32_t groupAddress;

};

/**

 * @struct igmpv3_query_header

 * IGMPv3 membership query basic header

 */

struct igmpv3_query_header

{

  /** IGMP message type. Should always have value of membership query (::IgmpType_MembershipQuery)  */

  uint8_t type;

  /** This field specifies the maximum time (in 1/10 second) allowed before sending a responding report */

  uint8_t maxResponseTime;

  /** This is the 16-bit one's complement of the one's complement sum of the entire IGMP message */

  uint16_t checksum;

  /** This is the multicast address being queried when sending a Group-Specific or Group-and-Source-Specific Query */

  uint32_t groupAddress;

  /** Suppress Router-side Processing Flag + Querier's Robustness Variable */

  uint8_t s_qrv;

  /** Querier's Query Interval Code */

  uint8_t qqic;

  /** This field specifies the number of source addresses present in the Query */

  uint16_t numOfSources;

};

/**

 * @struct igmpv3_report_header

 * IGMPv3 membership report basic header

 */

struct igmpv3_report_header

{

  /** IGMP message type. Should always have value of IGMPv3 membership report (::IgmpType_MembershipReportV3)  */

  uint8_t type;

  /** Unused byte */

  uint8_t reserved1;

  /** This is the 16-bit one's complement of the one's complement sum of the entire IGMP message */

  uint16_t checksum;

  /** Unused bytes */

  uint16_t reserved2;

  /** This field specifies the number of group records present in the Report */

  uint16_t numOfGroupRecords;

};

/**

 * @struct igmpv3_group_record

 * A block of fields containing information pertaining to the sender's membership in a single multicast group on the interface

 * from which the Report is sent. Relevant only for IGMPv3 membership report messages

 */

struct igmpv3_group_record

{

  /** Group record type */

  uint8_t recordType;

  /** Contains the length of the Auxiliary Data field in this Group Record. A value other than 0 isn't supported */

  uint8_t auxDataLen;

  /** Specifies how many source addresses are present in this Group Record */

  uint16_t numOfSources;

  /** Contains the IP multicast address to which this Group Record pertains */

  uint32_t multicastAddress;

  /** A vector of n IP unicast addresses, where n is the value in this record's Number of Sources field */

  uint8_t sourceAddresses[];

  /**

   * @return The multicast address in igmpv3_group_record#multicastAddress as IPv4Address instance

   */

  IPv4Address getMulticastAddress() const { return multicastAddress; }

  /**

   * @return The number of source addresses in this group record

   */

  uint16_t getSourceAddressCount() const;

  /**

   * Get the source address at a certain index

   * @param[in] index The index of the source address in the group record

   * @return The source address in the requested index. If index is negative or higher than the number of source addresses in this

   * group record the value if IPv4Address#Zero is returned

   */

  IPv4Address getSourceAddressAtIndex(int index) const;

  /**

   * @return The total size in bytes of the group record

   */

  size_t getRecordLen() const;

};

/**

 * IGMP message types

 */

enum IgmpType

{

  /** Unknown message type */

  IgmpType_Unknown = 0,

  /** IGMP Membership Query */

  IgmpType_MembershipQuery = 0x11,

  /** IGMPv1 Membership Report */

  IgmpType_MembershipReportV1 = 0x12,

  /** DVMRP */

  IgmpType_DVMRP = 0x13,

  /** PIM version 1 */

  IgmpType_P1Mv1 = 0x14,

  /** Cisco Trace Messages */

  IgmpType_CiscoTrace = 0x15,

  /** IGMPv2 Membership Report */

  IgmpType_MembershipReportV2 = 0x16,

  /** IGMPv2 Leave Group */

  IgmpType_LeaveGroup = 0x17,

  /** Multicast Traceroute Response */

  IgmpType_MulticastTracerouteResponse = 0x1e,

  /** Multicast Traceroute */

  IgmpType_MulticastTraceroute = 0x1f,

  /** IGMPv3 Membership Report */

  IgmpType_MembershipReportV3 = 0x22,

  /** MRD, Multicast Router Advertisement */

  IgmpType_MulticastRouterAdvertisement = 0x30,

  /** MRD, Multicast Router Solicitation */

  IgmpType_MulticastRouterSolicitation = 0x31,

  /** MRD, Multicast Router Termination */

  IgmpType_MulticastRouterTermination = 0x32,

};

/**

 * @class IgmpLayer

 * A base class for all IGMP (Internet Group Management Protocol) protocol classes. This is an abstract class and cannot be instantiated,

 * only its child classes can be instantiated. The inherited classes represent the different versions of the protocol:

 * IGMPv1, IGMPv2 and IGMPv3

 */

class IgmpLayer : public Layer

{

protected:

  IgmpLayer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet, ProtocolType igmpVer) : Layer(data, dataLen, prevLayer, packet) { m_Protocol = igmpVer; }

  IgmpLayer(IgmpType type, const IPv4Address& groupAddr, uint8_t maxResponseTime, ProtocolType igmpVer);

  uint16_t calculateChecksum();

  size_t getHeaderSizeByVerAndType(ProtocolType igmpVer, IgmpType igmpType) const;

public:

  virtual ~IgmpLayer() {}

  /**

   * Get a pointer to the raw IGMPv1/IGMPv2 header. Notice this points directly to the data, so every change will change the actual packet data

   * @return A pointer to the @ref igmp_header

   */

  igmp_header* getIgmpHeader() const { return (igmp_header*)m_Data; }

  /**

   * @return The IPv4 multicast address stored igmp_header#groupAddress

   */

  IPv4Address getGroupAddress() const { return getIgmpHeader()->groupAddress; }

  /**

   * Set the IPv4 multicast address

   * @param[in] groupAddr The IPv4 address to set

   */

  void setGroupAddress(const IPv4Address& groupAddr);

  /**

   * @return IGMP type set in igmp_header#type as ::IgmpType enum. Notice that if igmp_header#type contains a value

   * that doesn't appear in the ::IgmpType enum, ::IgmpType_Unknown will be returned

   */

  IgmpType getType() const;

  /**

   * Set IGMP type (will be written to igmp_header#type field)

   * @param[in] type The type to set

   */

  void setType(IgmpType type);

  /**

   * A static method that gets raw IGMP data (byte stream) and returns the IGMP version of this IGMP message

   * @param[in] data The IGMP raw data (byte stream)

   * @param[in] dataLen Raw data length

   * @param[out] isQuery Return true if IGMP message type is ::IgmpType_MembershipQuery and false otherwise

   * @return One of the values ::IGMPv1, ::IGMPv2, ::IGMPv3 according to detected IGMP version or ::UnknownProtocol if couldn't detect

   * IGMP version

   */

  static ProtocolType getIGMPVerFromData(uint8_t* data, size_t dataLen, bool& isQuery);

  // implement abstract methods

  /**

   * Does nothing for this layer (IGMP layer is always last)

   */

  void parseNextLayer() {}

  /**

   * @return Size of IGMP header = 8B

   */

  size_t getHeaderLen() const { return sizeof(igmp_header); }

  std::string toString() const;

  OsiModelLayer getOsiModelLayer() const { return OsiModelNetworkLayer; }

};

/**

 * @class IgmpV1Layer

 * Represents IGMPv1 (Internet Group Management Protocol ver 1) layer. This class represents all the different messages of IGMPv1

 */

class IgmpV1Layer : public IgmpLayer

{

public:

   /** A constructor that creates the layer from an existing packet raw data

   * @param[in] data A pointer to the raw data

   * @param[in] dataLen Size of the data in bytes

   * @param[in] prevLayer A pointer to the previous layer

   * @param[in] packet A pointer to the Packet instance where layer will be stored in

   */

  IgmpV1Layer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)

    : IgmpLayer(data, dataLen, prevLayer, packet, IGMPv1) {}

  /**

   * A constructor that allocates a new IGMPv1 header

   * @param[in] type The message type to set

   * @param[in] groupAddr The multicast address to set. This is an optional parameter and has a default value of IPv4Address#Zero

   * if not provided

   */

  explicit IgmpV1Layer(IgmpType type, const IPv4Address& groupAddr = IPv4Address())

    : IgmpLayer(type, groupAddr, 0, IGMPv1) {}

  /**

   * A destructor for this layer (does nothing)

   */

  ~IgmpV1Layer() {}

  // implement abstract methods

  /**

   * Calculate the IGMP checksum and set igmp_header#maxResponseTime to 0 (this field is unused in IGMPv1)

   */

  void computeCalculateFields();

};

/**

 * @class IgmpV2Layer

 * Represents IGMPv2 (Internet Group Management Protocol ver 2) layer. This class represents all the different messages of IGMPv2

 */

class IgmpV2Layer : public IgmpLayer

{

public:

   /** A constructor that creates the layer from an existing packet raw data

   * @param[in] data A pointer to the raw data

   * @param[in] dataLen Size of the data in bytes

   * @param[in] prevLayer A pointer to the previous layer

   * @param[in] packet A pointer to the Packet instance where layer will be stored in

   */

  IgmpV2Layer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)

    : IgmpLayer(data, dataLen, prevLayer, packet, IGMPv2) {}

  /**

   * A constructor that allocates a new IGMPv2 header

   * @param[in] type The message type to set

   * @param[in] groupAddr The multicast address to set. This is an optional parameter and has a default value of unspecified/zero IPv4 address

   * @param[in] maxResponseTime The max response time to set. This is an optional parameter and has a default value of 0 if not provided

   */

  explicit IgmpV2Layer(IgmpType type, const IPv4Address& groupAddr = IPv4Address(), uint8_t maxResponseTime = 0)

    : IgmpLayer(type, groupAddr, maxResponseTime, IGMPv2) {}

  /**

   * A destructor for this layer (does nothing)

   */

  ~IgmpV2Layer() {}

  // implement abstract methods

  /**

   * Calculate the IGMP checksum

   */

  void computeCalculateFields();

};

/**

 * @class IgmpV3QueryLayer

 * Represents an IGMPv3 (Internet Group Management Protocol ver 3) membership query message

 */

class IgmpV3QueryLayer : public IgmpLayer

{

public:

   /** A constructor that creates the layer from an existing packet raw data

   * @param[in] data A pointer to the raw data

   * @param[in] dataLen Size of the data in bytes

   * @param[in] prevLayer A pointer to the previous layer

   * @param[in] packet A pointer to the Packet instance where layer will be stored in

   */

  IgmpV3QueryLayer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet);

  /**

   * A constructor that allocates a new IGMPv3 membership query

   * @param[in] multicastAddr The multicast address to set. This is an optional parameter and has a default value of unspecified/zero IPv4 address

   * if not provided

   * @param[in] maxResponseTime The max response time to set. This is an optional parameter and has a default value of 0 if not provided

   * @param[in] s_qrv A 1-byte value representing the value in Suppress Router-side Processing Flag + Querier's Robustness Variable

   * (igmpv3_query_header#s_qrv field). This is an optional parameter and has a default value of 0 if not provided

   */

  IgmpV3QueryLayer(const IPv4Address& multicastAddr = IPv4Address(), uint8_t maxResponseTime = 0, uint8_t s_qrv = 0);

  /**

   * Get a pointer to the raw IGMPv3 membership query header. Notice this points directly to the data, so every change will change the

   * actual packet data

   * @return A pointer to the @ref igmpv3_query_header

   */

  igmpv3_query_header* getIgmpV3QueryHeader() const { return (igmpv3_query_header*)m_Data; }

  /**

   * @return The number of source addresses in this message (as extracted from the igmpv3_query_header#numOfSources field)

   */

  uint16_t getSourceAddressCount() const;

  /**

   * Get the IPV4 source address in a certain index

   * @param[in] index The requested index of the source address

   * @return The IPv4 source address, or IPv4Address#Zero if index is out of bounds (of the message or of the layer)

   */

  IPv4Address getSourceAddressAtIndex(int index) const;

  /**

   * Add a new source address at the end of the source address list. The igmpv3_query_header#numOfSources field will be incremented accordingly

   * @param[in] addr The IPv4 source address to add

   * @return True if source address was added successfully or false otherwise. If false is returned an appropriate error message

   * will be printed to log

   */

  bool addSourceAddress(const IPv4Address& addr);

  /**

   * Add a new source address at a certain index of the source address list. The igmpv3_query_header#numOfSources field will be incremented accordingly

   * @param[in] addr The IPv4 source address to add

   * @param[in] index The index to add the new source address at

   * @return True if source address was added successfully or false otherwise. If false is returned an appropriate error message

   * will be printed to log

   */

  bool addSourceAddressAtIndex(const IPv4Address& addr, int index);

  /**

   * Remove a source address at a certain index. The igmpv3_query_header#numOfSources field will be decremented accordingly

   * @param[in] index The index of the source address to be removed

   * @return True if source address was removed successfully or false otherwise. If false is returned an appropriate error message

   * will be printed to log

   */

  bool removeSourceAddressAtIndex(int index);

  /**

   * Remove all source addresses in the message. The igmpv3_query_header#numOfSources field will be set to 0

   * @return True if all source addresses were cleared successfully or false otherwise. If false is returned an appropriate error message

   * will be printed to log

   */

  bool removeAllSourceAddresses();

  // implement abstract methods

  /**

   * Calculate the IGMP checksum

   */

  void computeCalculateFields();

  /**

   * @return The message size in bytes which include the size of the basic header + the size of the source address list

   */

  size_t getHeaderLen() const;

};

/**

 * @class IgmpV3ReportLayer

 * Represents an IGMPv3 (Internet Group Management Protocol ver 3) membership report message

 */

class IgmpV3ReportLayer : public IgmpLayer

{

private:

  igmpv3_group_record* addGroupRecordAt(uint8_t recordType, const IPv4Address& multicastAddress, const std::vector<IPv4Address>& sourceAddresses, int offset);

public:

   /** A constructor that creates the layer from an existing packet raw data

   * @param[in] data A pointer to the raw data

   * @param[in] dataLen Size of the data in bytes

   * @param[in] prevLayer A pointer to the previous layer

   * @param[in] packet A pointer to the Packet instance where layer will be stored in

   */

  IgmpV3ReportLayer(uint8_t* data, size_t dataLen, Layer* prevLayer, Packet* packet)

    : IgmpLayer(data, dataLen, prevLayer, packet, IGMPv3) {}

  /**

   * A constructor that allocates a new IGMPv3 membership report with 0 group addresses

   */

  IgmpV3ReportLayer() : IgmpLayer(IgmpType_MembershipReportV3, IPv4Address(), 0, IGMPv3) {}

  /**

   * Get a pointer to the raw IGMPv3 membership report header. Notice this points directly to the data, so every change will change the

   * actual packet data

   * @return A pointer to the @ref igmpv3_report_header

   */

  igmpv3_report_header* getReportHeader() const { return (igmpv3_report_header*)m_Data; }

  /**

   * @return The number of group records in this message (as extracted from the igmpv3_report_header#numOfGroupRecords field)

   */

  uint16_t getGroupRecordCount() const;

  /**

   * @return A pointer to the first group record or NULL if no group records exist. Notice the return value is a pointer to the real data,

   * so changes in the return value will affect the packet data

   */

  igmpv3_group_record* getFirstGroupRecord() const;

  /**

   * Get the group record that comes next to a given group record. If "groupRecord" is NULL then NULL will be returned.

   * If "groupRecord" is the last group record or if it is out of layer bounds NULL will be returned also. Notice the return value is a

   * pointer to the real data casted to igmpv3_group_record type (as opposed to a copy of the option data). So changes in the return

   * value will affect the packet data

   * @param[in] groupRecord The group record to start searching from

   * @return The next group record or NULL if "groupRecord" is NULL, last or out of layer bounds

   */

  igmpv3_group_record* getNextGroupRecord(igmpv3_group_record* groupRecord) const;

  /**

   * Add a new group record at a the end of the group record list. The igmpv3_report_header#numOfGroupRecords field will be

   * incremented accordingly

   * @param[in] recordType The type of the new group record

   * @param[in] multicastAddress The multicast address of the new group record

   * @param[in] sourceAddresses A vector containing all the source addresses of the new group record

   * @return The method constructs a new group record, adds it to the end of the group record list of IGMPv3 report message and

   * returns a pointer to the new message. If something went wrong in creating or adding the new group record a NULL value is returned

   * and an appropriate error message is printed to log

   */

  igmpv3_group_record* addGroupRecord(uint8_t recordType, const IPv4Address& multicastAddress, const std::vector<IPv4Address>& sourceAddresses);

  /**

   * Add a new group record at a certain index of the group record list. The igmpv3_report_header#numOfGroupRecords field will be

   * incremented accordingly

   * @param[in] recordType The type of the new group record

   * @param[in] multicastAddress The multicast address of the new group record

   * @param[in] sourceAddresses A vector containing all the source addresses of the new group record

   * @param[in] index The index to add the new group address at

   * @return The method constructs a new group record, adds it to the IGMPv3 report message and returns a pointer to the new message.

   * If something went wrong in creating or adding the new group record a NULL value is returned and an appropriate error message is

   * printed to log

   */

  igmpv3_group_record* addGroupRecordAtIndex(uint8_t recordType, const IPv4Address& multicastAddress, const std::vector<IPv4Address>& sourceAddresses, int index);

  /**

   * Remove a group record at a certain index. The igmpv3_report_header#numOfGroupRecords field will be decremented accordingly

   * @param[in] index The index of the group record to be removed

   * @return True if group record was removed successfully or false otherwise. If false is returned an appropriate error message

   * will be printed to log

   */

  bool removeGroupRecordAtIndex(int index);

  /**

   * Remove all group records in the message. The igmpv3_report_header#numOfGroupRecords field will be set to 0

   * @return True if all group records were cleared successfully or false otherwise. If false is returned an appropriate error message

   * will be printed to log

   */

  bool removeAllGroupRecords();

  // implement abstract methods

  /**

   * Calculate the IGMP checksum

   */

  void computeCalculateFields();

  /**

   * @return The message size in bytes which include the size of the basic header + the size of the group record list

   */

  size_t getHeaderLen() const { return m_DataLen; }

};

}

#endif // PACKETPP_IGMP_LAYER