|
|
@@ -0,0 +1,240 @@
|
|
|
+// Copyright (C) 2014 Internet Systems Consortium, Inc. ("ISC")
|
|
|
+//
|
|
|
+// Permission to use, copy, modify, and/or distribute this software for any
|
|
|
+// purpose with or without fee is hereby granted, provided that the above
|
|
|
+// copyright notice and this permission notice appear in all copies.
|
|
|
+//
|
|
|
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
|
|
|
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
|
+// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|
|
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
|
|
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
|
|
|
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
|
+// PERFORMANCE OF THIS SOFTWARE.
|
|
|
+
|
|
|
+#ifndef PKT_H
|
|
|
+#define PKT_H
|
|
|
+
|
|
|
+#include <asiolink/io_address.h>
|
|
|
+#include <util/buffer.h>
|
|
|
+#include <dhcp/option.h>
|
|
|
+#include <dhcp/classify.h>
|
|
|
+
|
|
|
+#include <boost/date_time/posix_time/posix_time.hpp>
|
|
|
+
|
|
|
+namespace isc {
|
|
|
+
|
|
|
+namespace dhcp {
|
|
|
+
|
|
|
+/// @brief Base class for DHCPv4 (Pkt4) and DHCPv6 (Pkt6) classes
|
|
|
+///
|
|
|
+/// This is a base class that holds all common information (e.g. source and
|
|
|
+/// destination ports) and operations (e.g. add, get, delete options).
|
|
|
+/// This class is purely virtual. Please instantiate Pkt4, Pkt6 or any
|
|
|
+/// other derived classes.
|
|
|
+class Pkt {
|
|
|
+protected:
|
|
|
+Pkt(uint32_t transid, const isc::asiolink::IOAddress& local_addr,
|
|
|
+ const isc::asiolink::IOAddress& remote_addr, uint16_t local_port,
|
|
|
+ uint16_t remote_port)
|
|
|
+ :transid_(transid),
|
|
|
+ iface_(""),
|
|
|
+ ifindex_(-1),
|
|
|
+ local_addr_(local_addr),
|
|
|
+ remote_addr_(remote_addr),
|
|
|
+ local_port_(local_port),
|
|
|
+ remote_port_(remote_port),
|
|
|
+ buffer_out_(0)
|
|
|
+ {
|
|
|
+ }
|
|
|
+
|
|
|
+ Pkt(const uint8_t* buf, uint32_t len, const isc::asiolink::IOAddress& local_addr,
|
|
|
+ const isc::asiolink::IOAddress& remote_addr, uint16_t local_port,
|
|
|
+ uint16_t remote_port)
|
|
|
+ :transid_(0),
|
|
|
+ iface_(""),
|
|
|
+ ifindex_(-1),
|
|
|
+ local_addr_(local_addr),
|
|
|
+ remote_addr_(remote_addr),
|
|
|
+ local_port_(local_port),
|
|
|
+ remote_port_(remote_port),
|
|
|
+ buffer_out_(0)
|
|
|
+ {
|
|
|
+ data_.resize(len);
|
|
|
+ memcpy(&data_[0], buf, len);
|
|
|
+ }
|
|
|
+
|
|
|
+public:
|
|
|
+
|
|
|
+ virtual void pack() = 0;
|
|
|
+ //virtual bool unpack() = 0;
|
|
|
+
|
|
|
+ /// @brief Returns reference to output buffer.
|
|
|
+ ///
|
|
|
+ /// Returned buffer will contain reasonable data only for
|
|
|
+ /// output (TX) packet and after pack() was called. This buffer
|
|
|
+ /// is only valid till Pkt{4,6} object is valid.
|
|
|
+ ///
|
|
|
+ /// RX packet or TX packet before pack() will return buffer with
|
|
|
+ /// zero length. This buffer is returned as non-const, so hooks
|
|
|
+ /// framework (and user's callouts) can modify them if needed
|
|
|
+ ///
|
|
|
+ /// @return reference to output buffer
|
|
|
+ isc::util::OutputBuffer& getBuffer() { return (buffer_out_); };
|
|
|
+
|
|
|
+ /// Adds an option to this packet.
|
|
|
+ ///
|
|
|
+ /// Sadly, we need to have 2 versions of that method. One that
|
|
|
+ /// accepts duplicates (DHCPv6) and one that does not (DHCPv4)
|
|
|
+ ///
|
|
|
+ /// @param opt option to be added.
|
|
|
+ virtual void addOption(const OptionPtr& opt);
|
|
|
+
|
|
|
+ /// Attempts to delete first suboption of requested type
|
|
|
+ ///
|
|
|
+ /// @param type Type of option to be deleted.
|
|
|
+ ///
|
|
|
+ /// @return true if option was deleted, false if no such option existed
|
|
|
+ bool delOption(uint16_t type);
|
|
|
+
|
|
|
+ virtual std::string toText() = 0;
|
|
|
+
|
|
|
+ /// Returns packet type
|
|
|
+ ///
|
|
|
+ /// For DHCPv6, this is a straightforward operation (read packet field), but
|
|
|
+ /// for DHCPv4 it requires finding appropriate option (that may or may not
|
|
|
+ /// be present).
|
|
|
+ virtual size_t len() = 0;
|
|
|
+
|
|
|
+ /// Returns message type (e.g. 1 = SOLICIT)
|
|
|
+ ///
|
|
|
+ /// @return message type
|
|
|
+ virtual uint8_t getType() const = 0;
|
|
|
+
|
|
|
+ /// Sets message type (e.g. 1 = SOLICIT)
|
|
|
+ ///
|
|
|
+ /// @param type message type to be set
|
|
|
+ virtual void setType(uint8_t type) = 0;
|
|
|
+
|
|
|
+ /// @brief Sets transaction-id value
|
|
|
+ ///
|
|
|
+ /// @param transid transaction-id to be set.
|
|
|
+ void setTransid(uint32_t transid) { transid_ = transid; }
|
|
|
+
|
|
|
+ /// Returns value of transaction-id field
|
|
|
+ ///
|
|
|
+ /// @return transaction-id
|
|
|
+ uint32_t getTransid() const { return (transid_); };
|
|
|
+
|
|
|
+ /// @brief Classes this packet belongs to.
|
|
|
+ ///
|
|
|
+ /// This field is public, so the code outside of Pkt4 or Pkt6 class can
|
|
|
+ /// iterate over existing classes. Having it public also solves the problem
|
|
|
+ /// of returned reference lifetime. It is preferred to use @ref inClass and
|
|
|
+ /// @ref addClass should be used to operate on this field.
|
|
|
+ ClientClasses classes_;
|
|
|
+
|
|
|
+ /// @brief Checks whether a client belongs to a given class
|
|
|
+ ///
|
|
|
+ /// @param client_class name of the class
|
|
|
+ /// @return true if belongs
|
|
|
+ bool inClass(const isc::dhcp::ClientClass& client_class);
|
|
|
+
|
|
|
+ /// @brief Adds packet to a specified class
|
|
|
+ ///
|
|
|
+ /// A packet can be added to the same class repeatedly. Any additional
|
|
|
+ /// attempts to add to a class the packet already belongs to, will be
|
|
|
+ /// ignored silently.
|
|
|
+ ///
|
|
|
+ /// @note It is a matter of naming convention. Conceptually, the server
|
|
|
+ /// processes a stream of packets, with some packets belonging to given
|
|
|
+ /// classes. From that perspective, this method adds a packet to specifed
|
|
|
+ /// class. Implementation wise, it looks the opposite - the class name
|
|
|
+ /// is added to the packet. Perhaps the most appropriate name for this
|
|
|
+ /// method would be associateWithClass()? But that seems overly long,
|
|
|
+ /// so I decided to stick with addClass().
|
|
|
+ ///
|
|
|
+ /// @param client_class name of the class to be added
|
|
|
+ void addClass(const isc::dhcp::ClientClass& client_class);
|
|
|
+
|
|
|
+ /// unparsed data (in received packets)
|
|
|
+ ///
|
|
|
+ /// @warning This public member is accessed by derived
|
|
|
+ /// classes directly. One of such derived classes is
|
|
|
+ /// @ref perfdhcp::PerfPkt6. The impact on derived clasess'
|
|
|
+ /// behavior must be taken into consideration before making
|
|
|
+ /// changes to this member such as access scope restriction or
|
|
|
+ /// data format change etc.
|
|
|
+ OptionBuffer data_;
|
|
|
+
|
|
|
+ virtual ~Pkt() { }
|
|
|
+
|
|
|
+protected:
|
|
|
+
|
|
|
+ /// transaction-id (32 bits for v4, 24 bits for v6)
|
|
|
+ uint32_t transid_;
|
|
|
+
|
|
|
+ /// name of the network interface the packet was received/to be sent over
|
|
|
+ std::string iface_;
|
|
|
+ /// @brief interface index
|
|
|
+ ///
|
|
|
+ /// interface index (each network interface has assigned unique ifindex
|
|
|
+ /// it is functional equivalent of name, but sometimes more useful, e.g.
|
|
|
+ /// when using crazy systems that allow spaces in interface names
|
|
|
+ /// e.g. windows
|
|
|
+ int ifindex_;
|
|
|
+
|
|
|
+ /// local address (dst if receiving packet, src if sending packet)
|
|
|
+ isc::asiolink::IOAddress local_addr_;
|
|
|
+
|
|
|
+ /// remote address (src if receiving packet, dst if sending packet)
|
|
|
+ isc::asiolink::IOAddress remote_addr_;
|
|
|
+
|
|
|
+ /// local TDP or UDP port
|
|
|
+ uint16_t local_port_;
|
|
|
+
|
|
|
+ /// remote TCP or UDP port
|
|
|
+ uint16_t remote_port_;
|
|
|
+
|
|
|
+ /// collection of options present in this message
|
|
|
+ ///
|
|
|
+ /// @warning This public member is accessed by derived
|
|
|
+ /// classes directly. One of such derived classes is
|
|
|
+ /// @ref perfdhcp::PerfPkt6. The impact on derived clasess'
|
|
|
+ /// behavior must be taken into consideration before making
|
|
|
+ /// changes to this member such as access scope restriction or
|
|
|
+ /// data format change etc.
|
|
|
+ isc::dhcp::OptionCollection options_;
|
|
|
+
|
|
|
+ /// Output buffer (used during message transmission)
|
|
|
+ ///
|
|
|
+ /// @warning This protected member is accessed by derived
|
|
|
+ /// classes directly. One of such derived classes is
|
|
|
+ /// @ref perfdhcp::PerfPkt6. The impact on derived clasess'
|
|
|
+ /// behavior must be taken into consideration before making
|
|
|
+ /// changes to this member such as access scope restriction or
|
|
|
+ /// data format change etc.
|
|
|
+ ///
|
|
|
+ /// @warning This public member is accessed by derived
|
|
|
+ /// classes directly. One of such derived classes is
|
|
|
+ /// @ref perfdhcp::PerfPkt4. The impact on derived clasess'
|
|
|
+ /// behavior must be taken into consideration before making
|
|
|
+ /// changes to this member such as access scope restriction or
|
|
|
+ /// data format change etc. This field is also public, because
|
|
|
+ /// it may be modified by callouts (which are written in C++ now,
|
|
|
+ /// but we expect to also have them in Python, so any accesibility
|
|
|
+ /// methods would overly complicate things here and degrade
|
|
|
+ /// performance).
|
|
|
+ isc::util::OutputBuffer buffer_out_;
|
|
|
+
|
|
|
+ /// packet timestamp
|
|
|
+ boost::posix_time::ptime timestamp_;
|
|
|
+
|
|
|
+ /// A callback to be called to unpack options from the packet.
|
|
|
+ UnpackOptionsCallback callback_;
|
|
|
+};
|
|
|
+
|
|
|
+}; // namespace isc::dhcp
|
|
|
+}; // namespace isc
|
|
|
+
|
|
|
+#endif
|
Tomek Mrugalski