123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392 |
- // 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 DHCP6_CLIENT_H
- #define DHCP6_CLIENT_H
- #include <asiolink/io_address.h>
- #include <dhcp/duid.h>
- #include <dhcp/option.h>
- #include <dhcp6/tests/dhcp6_test_utils.h>
- #include <boost/noncopyable.hpp>
- #include <boost/shared_ptr.hpp>
- namespace isc {
- namespace dhcp {
- namespace test {
- /// @brief DHCPv6 client used for unit testing.
- ///
- /// This class implements a DHCPv6 "client" which interoperates with the
- /// @c NakedDhcpv6Srv class. It calls @c NakedDhcpv6Srv::fakeRecive to
- /// deliver client messages to the server for processing. The server places
- /// the response in the @c NakedDhcpv6Srv::fake_sent_ container. The client
- /// pops messages from this container which simulates reception of the
- /// response from the server.
- ///
- /// The client maintains the leases it acquired from the server. If it has
- /// acquired the lease as a result of SARR exchange, it will use this lease
- /// when the Rebind process is triggered by the unit test.
- ///
- /// The client exposes a set of functions which simulate different exchange
- /// types between the client and the server. It also provides the access to
- /// the objects encapsulating responses from the server so as it is possible
- /// to verify from the unit test that the server's response is correct.
- ///
- /// @todo This class has been implemented to simplify the structure of the
- /// unit test and to make unit tests code self-explanatory. Currently,
- /// this class is mostly used by the unit tests which test Rebind processing
- /// logic. At some point we may want to use this class to test some other
- /// message types, e.g. Renew, in which case it may need to be extended.
- /// Also, once we implement the support for multiple IAAddr and IAPrefix
- /// options within single IA, the logic which maintains leases will have
- /// to be extended to support it.
- class Dhcp6Client : public boost::noncopyable {
- public:
- /// @brief Holds an information about single lease.
- struct LeaseInfo {
- /// @brief A structure describing the lease.
- Lease6 lease_;
- /// @brief Holds the last status code that server has sent for
- /// the particular lease.
- uint16_t status_code_;
- /// @brief Default constructor for the structure.
- LeaseInfo() :
- lease_(), status_code_(0) { }
- };
- /// @brief Holds the current client configuration obtained from the
- /// server over DHCP.
- ///
- /// Currently it simply contains the collection of leases acquired.
- struct Configuration {
- std::vector<LeaseInfo> leases_;
- };
- /// @brief Holds the DHCPv6 messages taking part in transaction between
- /// the client and the server.
- struct Context {
- /// @brief Holds the last sent message from the client to the server.
- Pkt6Ptr query_;
- /// @brief Holds the last sent message by the server to the client.
- Pkt6Ptr response_;
- };
- /// @brief Creates a new client.
- ///
- /// This constructor initializes the class members to default values:
- /// - relay link-addr = 3000:1::1
- /// - first transaction id = 0
- /// - dest-addr = All_DHCP_Relay_Agents_and_Servers
- /// - duid (LLT) = <random 4 bytes>00010203040506
- /// - link-local-addr = fe80::3a60:77ff:fed5:cdef
- /// - IA_NA not requested
- /// - IA_PD not requested
- /// - not relayed
- Dhcp6Client();
- /// @brief Creates a new client that communicates with a specified server.
- ///
- /// This constructor allows passing a pointer to the server object which
- /// should be used in a test. The server may be preconfigured before passed
- /// to the constructor. The default configuration used by the client is:
- /// - relay link-addr = 3000:1::1
- /// - first transaction id = 0
- /// - dest-addr = All_DHCP_Relay_Agents_and_Servers
- /// - duid (LLT) = <random 4 bytes>00010203040506
- /// - link-local-addr = fe80::3a60:77ff:fed5:cdef
- /// - IA_NA not requested
- /// - IA_PD not requested
- /// - not relayed
- ///
- /// @param srv Object representing server under test.
- Dhcp6Client(boost::shared_ptr<isc::test::NakedDhcpv6Srv>& srv);
- /// @brief Performs a 4-way echange between the client and the server.
- ///
- /// If the 4-way exchange is successful, the client should acquire leases
- /// according to the server's current configuration and the type of leases
- /// that have been requested (IA_NA, IA_PD).
- ///
- /// The leases acquired are accessible through the @c config_ member.
- ///
- /// @throw This function doesn't throw exceptions on its own, but it calls
- /// functions that are not exception safe, so it may throw exceptions if
- /// error occurs.
- ///
- /// @todo Perform sanity checks on returned messages.
- void doSARR();
- /// @brief Send Solicit and receive Advertise.
- ///
- /// This function simulates the first transaction of the 4-way exchange,
- /// i.e. sends a Solicit to the server and receives Advertise. It doesn't
- /// set the lease configuration in the @c config_.
- ///
- /// @throw This function doesn't throw exceptions on its own, but it calls
- /// functions that are not exception safe, so it may throw exceptions if
- /// error occurs.
- ///
- /// @todo Perform sanity checks on returned messages.
- void doSolicit();
- /// @brief Sends a Rebind to the server and receives the Reply.
- ///
- /// This function simulates sending the Rebind message to the server and
- /// receiving server's response (if any). The client uses existing leases
- /// (either address or prefixes) and places them in the Rebind message.
- /// If the server responds to the Rebind (and extends the lease lifetimes)
- /// the current lease configuration is updated.
- ///
- /// @throw This function doesn't throw exceptions on its own, but it calls
- /// functions that are not exception safe, so it may throw exceptions if
- /// error occurs.
- ///
- /// @todo Perform sanity checks on returned messages.
- void doRebind();
- /// @brief Sends Request to the server and receives Reply.
- ///
- /// This function simulates sending the Request message to the server and
- /// receiving server's response (if any). The client copies IA options
- /// from the current context (server's Advertise) to request acquisition
- /// of offered IAs. If the server responds to the Request (leases are
- /// acquired) the client's lease configuration is updated.
- ///
- /// @throw This function doesn't throw exceptions on its own, but it calls
- /// functions that are not exception safe, so it may throw exceptions if
- /// error occurs.
- ///
- /// @todo Perform sanity checks on returned messages.
- void doRequest();
- /// @brief Simulates aging of leases by the specified number of seconds.
- ///
- /// This function moves back the time of acquired leases by the specified
- /// number of seconds. It is useful for checking whether the particular
- /// lease has been later updated (e.g. as a result of Rebind) as it is
- /// expected that the fresh lease has cltt set to "now" (not to the time
- /// in the past).
- void fastFwdTime(const uint32_t secs);
- /// @brief Returns DUID option used by the client.
- OptionPtr getClientId() const;
- /// @brief Returns current context.
- const Context& getContext() const {
- return (context_);
- }
- /// @brief Returns lease at specified index.
- ///
- /// @warning This method doesn't check if the specified index is out of
- /// range. The caller is responsible for using a correct offset by
- /// invoking the @c getLeaseNum function.
- ///
- /// @param at Index of the lease held by the client.
- /// @return A lease at the specified index.
- Lease6 getLease(const size_t at) const {
- return (config_.leases_[at].lease_);
- }
- /// @brief Returns status code set by the server for the lease.
- ///
- /// @warning This method doesn't check if the specified index is out of
- /// range. The caller is responsible for using a correct offset by
- /// invoking the @c getLeaseNum function.
- ///
- /// @param at Index of the lease held by the client.
- /// @return A status code for the lease at the specified index.
- uint16_t getStatusCode(const size_t at) const {
- return (config_.leases_[at].status_code_);
- }
- /// @brief Returns number of acquired leases.
- size_t getLeaseNum() const {
- return (config_.leases_.size());
- }
- /// @brief Returns the server that the client is communicating with.
- boost::shared_ptr<isc::test::NakedDhcpv6Srv> getServer() const {
- return (srv_);
- }
- /// @brief Modifies the client's DUID (adds one to it).
- ///
- /// The DUID should be modified to test negative scenarios when the client
- /// acquires a lease and tries to renew it with a different DUID. The server
- /// should detect the DUID mismatch and react accordingly.
- ///
- /// The DUID modification affects the value returned by the
- /// @c Dhcp6Client::getClientId
- void modifyDUID();
- /// @brief Sets destination address for the messages being sent by the
- /// client.
- ///
- /// By default, the client uses All_DHCP_Relay_Agents_and_Servers
- /// multicast address to communicate with the server. In certain cases
- /// it ay be desired that different address is used (e.g. unicast in Renew).
- /// This function sets the new address for all future exchanges with the
- /// server.
- ///
- /// @param dest_addr New destination address.
- void setDestAddress(const asiolink::IOAddress& dest_addr) {
- dest_addr_ = dest_addr;
- }
- /// @brief Place IA_NA options to request address assignment.
- ///
- /// This function configures the client to place IA_NA options in its
- /// Solicit messages to request the IPv6 address assignment.
- ///
- /// @param use Parameter which 'true' value indicates that client should
- /// request address assignment.
- void useNA(const bool use = true) {
- use_na_ = use;
- }
- /// @brief Place IA_PD options to request prefix assignment.
- ///
- /// This function configures the client to place IA_PD options in its
- /// Solicit messages to request the IPv6 address assignment.
- ///
- /// @param use Parameter which 'true' value indicates that client should
- /// request prefix assignment.
- void usePD(const bool use = true) {
- use_pd_ = use;
- }
- /// @brief Simulate sending messages through a relay.
- ///
- /// @param use Parameter which 'true' value indicates that client should
- /// simulate sending messages via relay.
- /// @param link_addr Relay link-addr.
- void useRelay(const bool use = true,
- const asiolink::IOAddress& link_addr = asiolink::IOAddress("3000:1::1")) {
- use_relay_ = use;
- relay_link_addr_ = link_addr;
- }
- /// @brief Lease configuration obtained by the client.
- Configuration config_;
- /// @brief Link address of the relay to be used for relayed messages.
- asiolink::IOAddress relay_link_addr_;
- private:
- /// @brief Applies the new leases for the client.
- ///
- /// This method is called when the client obtains a new configuration
- /// from the server in the Reply message. This function adds new leases
- /// or replaces existing ones, on the client's side. Client uses these
- /// leases in any later communication with the server when doing Renew
- /// or Rebind.
- ///
- /// @param reply Server response.
- ///
- /// @todo Currently this function supports one IAAddr or IAPrefix option
- /// within IA. We will need to extend it to support multiple options
- /// within a single IA once server supports that.
- void applyRcvdConfiguration(const Pkt6Ptr& reply);
- /// @brief Applies configuration for the single lease.
- ///
- /// This method is called by the @c Dhcp6Client::applyRcvdConfiguration for
- /// each individual lease.
- ///
- /// @param lease_info Structure holding new lease information.
- void applyLease(const LeaseInfo& lease_info);
- /// @brief Copy IA options from one message to another.
- ///
- /// This method copies IA_NA and IA_PD options from one message to another.
- /// It is useful when the client needs to construct the Request message
- /// using addresses and prefixes returned by the client in Advertise.
- ///
- /// @param source Message from which IA options will be copied.
- /// @param dest Message to which IA options will be copied.
- ///
- /// @todo Add support for IA_TA.
- void copyIAs(const Pkt6Ptr& source, const Pkt6Ptr& dest);
- /// @brief Creates IA options from existing configuration.
- ///
- /// This method iterates over existing leases that client acquired and
- /// places corresponding IA_NA or IA_PD options into a specified message.
- /// This is useful to construct Renew or Rebind message from the existing
- /// configuration that client has obtained using 4-way exchange.
- ///
- /// @param dest Message to which the IA options will be added.
- void copyIAsFromLeases(const Pkt6Ptr& dest) const;
- /// @brief Creates client's side DHCP message.
- ///
- /// @param msg_type Type of the message to be created.
- /// @return An instance of the message created.
- Pkt6Ptr createMsg(const uint8_t msg_type);
- /// @brief Generates DUID for the client.
- ///
- /// @param duid_type Type of the DUID. Currently, only LLT is accepted.
- /// @return Object encapsulating a DUID.
- DuidPtr generateDUID(DUID::DUIDType duid_type) const;
- /// @brief Simulates reception of the message from the server.
- ///
- /// @return Received message.
- Pkt6Ptr receiveOneMsg();
- /// @brief Simulates sending a message to the server.
- ///
- /// This function instantly triggers processing of the message by the
- /// server. The server's response can be gathered by invoking the
- /// @c receiveOneMsg function.
- ///
- /// @param msg Message to be sent.
- void sendMsg(const Pkt6Ptr& msg);
- /// @brief Current context (sent and received message).
- Context context_;
- /// @biref Current transaction id (altered on each send).
- uint32_t curr_transid_;
- /// @brief Currently use destination address.
- asiolink::IOAddress dest_addr_;
- /// @brief Currently used DUID.
- DuidPtr duid_;
- /// @brief Currently used link local address.
- asiolink::IOAddress link_local_;
- /// @brief Pointer to the server that the client is communicating with.
- boost::shared_ptr<isc::test::NakedDhcpv6Srv> srv_;
- bool use_na_; ///< Enable address assignment.
- bool use_pd_; ///< Enable prefix delegation.
- bool use_relay_; ///< Enable relaying messages to the server.
- };
- } // end of namespace isc::dhcp::test
- } // end of namespace isc::dhcp
- } // end of namespace isc
- #endif // DHCP6_CLIENT
|