dhcp4_srv_unittest.cc 113 KB
Newer Older
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1
// Copyright (C) 2011-2013  Internet Systems Consortium, Inc. ("ISC")
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
//
// 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.

#include <config.h>
#include <sstream>

18
#include <asiolink/io_address.h>
19
#include <config/ccsession.h>
20
#include <dhcp/dhcp4.h>
21
#include <dhcp/iface_mgr.h>
22
#include <dhcp/option.h>
23
#include <dhcp/option4_addrlst.h>
24
#include <dhcp/option_custom.h>
25
#include <dhcp/option_int.h>
26
#include <dhcp/option_int_array.h>
27 28
#include <dhcp/pkt_filter.h>
#include <dhcp/pkt_filter_inet.h>
29
#include <dhcp4/dhcp4_srv.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
30
#include <dhcp4/dhcp4_log.h>
31
#include <dhcp4/config_parser.h>
32
#include <hooks/server_hooks.h>
33 34 35 36
#include <dhcpsrv/cfgmgr.h>
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
#include <dhcpsrv/utils.h>
37
#include <gtest/gtest.h>
38 39
#include <hooks/server_hooks.h>
#include <hooks/hooks_manager.h>
40

41 42
#include <boost/scoped_ptr.hpp>

43 44 45 46
#include <fstream>
#include <iostream>

#include <arpa/inet.h>
47 48 49 50

using namespace std;
using namespace isc;
using namespace isc::dhcp;
51
using namespace isc::data;
52
using namespace isc::asiolink;
53
using namespace isc::hooks;
54 55 56 57

namespace {

class NakedDhcpv4Srv: public Dhcpv4Srv {
58
    // "Naked" DHCPv4 server, exposes internal fields
59
public:
60 61 62

    /// @brief Constructor.
    ///
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
    /// This constructor disables default modes of operation used by the
    /// Dhcpv4Srv class:
    /// - Send/receive broadcast messages through sockets on interfaces
    /// which support broadcast traffic.
    /// - Direct DHCPv4 traffic - communication with clients which do not
    /// have IP address assigned yet.
    ///
    /// Enabling these modes requires root privilges so they must be
    /// disabled for unit testing.
    ///
    /// Note, that disabling broadcast options on sockets does not impact
    /// the operation of these tests because they use local loopback
    /// interface which doesn't have broadcast capability anyway. It rather
    /// prevents setting broadcast options on other (broadcast capable)
    /// sockets which are opened on other interfaces in Dhcpv4Srv constructor.
    ///
    /// The Direct DHCPv4 Traffic capability can be disabled here because
    /// it is tested with PktFilterLPFTest unittest. The tests which belong
    /// to PktFilterLPFTest can be enabled on demand when root privileges can
    /// be guaranteed.
83 84 85
    ///
    /// @param port port number to listen on; the default value 0 indicates
    /// that sockets should not be opened.
86
    NakedDhcpv4Srv(uint16_t port = 0)
87
        : Dhcpv4Srv(port, "type=memfile", false, false) {
88
    }
89

90 91 92
    /// @brief fakes packet reception
    /// @param timeout ignored
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
93 94
    /// The method receives all packets queued in receive queue, one after
    /// another. Once the queue is empty, it initiates the shutdown procedure.
95 96 97 98
    ///
    /// See fake_received_ field for description
    virtual Pkt4Ptr receivePacket(int /*timeout*/) {

Tomek Mrugalski's avatar
Tomek Mrugalski committed
99
        // If there is anything prepared as fake incoming traffic, use it
100 101 102 103 104 105
        if (!fake_received_.empty()) {
            Pkt4Ptr pkt = fake_received_.front();
            fake_received_.pop_front();
            return (pkt);
        }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
106
        // If not, just trigger shutdown and return immediately
107 108 109 110 111 112
        shutdown();
        return (Pkt4Ptr());
    }

    /// @brief fake packet sending
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
113 114
    /// Pretend to send a packet, but instead just store it in fake_send_ list
    /// where test can later inspect server's response.
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
    virtual void sendPacket(const Pkt4Ptr& pkt) {
        fake_sent_.push_back(pkt);
    }

    /// @brief adds a packet to fake receive queue
    ///
    /// See fake_received_ field for description
    void fakeReceive(const Pkt4Ptr& pkt) {
        fake_received_.push_back(pkt);
    }

    virtual ~NakedDhcpv4Srv() {
    }

    /// @brief packets we pretend to receive
    ///
    /// Instead of setting up sockets on interfaces that change between OSes, it
    /// is much easier to fake packet reception. This is a list of packets that
    /// we pretend to have received. You can schedule new packets to be received
    /// using fakeReceive() and NakedDhcpv4Srv::receivePacket() methods.
    list<Pkt4Ptr> fake_received_;

    list<Pkt4Ptr> fake_sent_;

139
    using Dhcpv4Srv::adjustRemoteAddr;
140 141 142 143 144 145
    using Dhcpv4Srv::processDiscover;
    using Dhcpv4Srv::processRequest;
    using Dhcpv4Srv::processRelease;
    using Dhcpv4Srv::processDecline;
    using Dhcpv4Srv::processInform;
    using Dhcpv4Srv::getServerID;
146 147 148
    using Dhcpv4Srv::loadServerID;
    using Dhcpv4Srv::generateServerID;
    using Dhcpv4Srv::writeServerID;
149
    using Dhcpv4Srv::sanityCheck;
150
    using Dhcpv4Srv::srvidToString;
151
    using Dhcpv4Srv::unpackOptions;
152 153
};

154 155
static const char* SRVID_FILE = "server-id-test.txt";

156 157
/// @brief Dummy Packet Filtering class.
///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
158 159
/// This class reports capability to respond directly to the client which
/// doesn't have address configured yet.
160
///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
161 162
/// All packet and socket handling functions do nothing because they are not
/// used in unit tests.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
class PktFilterTest : public PktFilter {
public:

    /// @brief Reports 'direct response' capability.
    ///
    /// @return always true.
    virtual bool isDirectResponseSupported() const {
        return (true);
    }

    /// Does nothing.
    virtual int openSocket(const Iface&, const IOAddress&, const uint16_t,
                           const bool, const bool) {
        return (0);
    }

    /// Does nothing.
    virtual Pkt4Ptr receive(const Iface&, const SocketInfo&) {
        return Pkt4Ptr();
    }

    /// Does nothing.
    virtual int send(const Iface&, uint16_t, const Pkt4Ptr&) {
        return (0);
    }

};

191 192
class Dhcpv4SrvTest : public ::testing::Test {
public:
193 194 195 196 197

    /// @brief Constructor
    ///
    /// Initializes common objects used in many tests.
    /// Also sets up initial configuration in CfgMgr.
198
    Dhcpv4SrvTest() :
199
        rcode_(-1)
200
    {
201 202 203 204 205 206 207
        subnet_ = Subnet4Ptr(new Subnet4(IOAddress("192.0.2.0"), 24, 1000,
                                         2000, 3000));
        pool_ = Pool4Ptr(new Pool4(IOAddress("192.0.2.100"), IOAddress("192.0.2.110")));
        subnet_->addPool(pool_);

        CfgMgr::instance().deleteSubnets4();
        CfgMgr::instance().addSubnet4(subnet_);
208

209 210 211 212
        // Add Router option.
        Option4AddrLstPtr opt_routers(new Option4AddrLst(DHO_ROUTERS));
        opt_routers->setAddress(IOAddress("192.0.2.2"));
        subnet_->addOption(opt_routers, false, "dhcp4");
213

214 215
        // it's ok if that fails. There should not be such a file anyway
        unlink(SRVID_FILE);
216 217 218 219 220 221 222 223 224 225

        const IfaceMgr::IfaceCollection& ifaces = IfaceMgr::instance().getIfaces();

        // There must be some interface detected
        if (ifaces.empty()) {
            // We can't use ASSERT in constructor
            ADD_FAILURE() << "No interfaces detected.";
        }

        valid_iface_ = ifaces.begin()->getName();
226
    }
227

228 229 230
    virtual ~Dhcpv4SrvTest() {
    }

231
    /// @brief Add 'Parameter Request List' option to the packet.
232
    ///
233
    /// This function PRL option comprising the following option codes:
234 235 236 237 238 239 240 241 242 243 244 245 246 247
    /// - 5 - Name Server
    /// - 15 - Domain Name
    /// - 7 - Log Server
    /// - 8 - Quotes Server
    /// - 9 - LPR Server
    ///
    /// @param pkt packet to add PRL option to.
    void addPrlOption(Pkt4Ptr& pkt) {

        OptionUint8ArrayPtr option_prl =
            OptionUint8ArrayPtr(new OptionUint8Array(Option::V4,
                                                     DHO_DHCP_PARAMETER_REQUEST_LIST));

        // Let's request options that have been configured for the subnet.
248 249 250 251
        option_prl->addValue(DHO_DOMAIN_NAME_SERVERS);
        option_prl->addValue(DHO_DOMAIN_NAME);
        option_prl->addValue(DHO_LOG_SERVERS);
        option_prl->addValue(DHO_COOKIE_SERVERS);
252 253
        // Let's also request the option that hasn't been configured. In such
        // case server should ignore request for this particular option.
254
        option_prl->addValue(DHO_LPR_SERVERS);
255 256 257 258 259 260
        // And add 'Parameter Request List' option into the DISCOVER packet.
        pkt->addOption(option_prl);
    }

    /// @brief Configures options being requested in the PRL option.
    ///
261
    /// The lpr-servers option is NOT configured here although it is
262 263
    /// added to the 'Parameter Request List' option in the
    /// \ref addPrlOption. When requested option is not configured
264
    /// the server should not return it in its response. The goal
265 266 267 268 269 270 271 272 273 274 275 276
    /// of not configuring the requested option is to verify that
    /// the server will not return it.
    void configureRequestedOptions() {
        // dns-servers
        Option4AddrLstPtr
            option_dns_servers(new Option4AddrLst(DHO_DOMAIN_NAME_SERVERS));
        option_dns_servers->addAddress(IOAddress("192.0.2.1"));
        option_dns_servers->addAddress(IOAddress("192.0.2.100"));
        ASSERT_NO_THROW(subnet_->addOption(option_dns_servers, false, "dhcp4"));

        // domain-name
        OptionDefinition def("domain-name", DHO_DOMAIN_NAME, OPT_FQDN_TYPE);
277
        OptionCustomPtr option_domain_name(new OptionCustom(def, Option::V4));
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
        option_domain_name->writeFqdn("example.com");
        subnet_->addOption(option_domain_name, false, "dhcp4");

        // log-servers
        Option4AddrLstPtr option_log_servers(new Option4AddrLst(DHO_LOG_SERVERS));
        option_log_servers->addAddress(IOAddress("192.0.2.2"));
        option_log_servers->addAddress(IOAddress("192.0.2.10"));
        ASSERT_NO_THROW(subnet_->addOption(option_log_servers, false, "dhcp4"));

        // cookie-servers
        Option4AddrLstPtr option_cookie_servers(new Option4AddrLst(DHO_COOKIE_SERVERS));
        option_cookie_servers->addAddress(IOAddress("192.0.2.1"));
        ASSERT_NO_THROW(subnet_->addOption(option_cookie_servers, false, "dhcp4"));
    }

293 294 295
    /// @brief checks that the response matches request
    /// @param q query (client's message)
    /// @param a answer (server's message)
296
    void messageCheck(const Pkt4Ptr& q, const Pkt4Ptr& a) {
297 298 299 300 301 302 303
        ASSERT_TRUE(q);
        ASSERT_TRUE(a);

        EXPECT_EQ(q->getHops(),   a->getHops());
        EXPECT_EQ(q->getIface(),  a->getIface());
        EXPECT_EQ(q->getIndex(),  a->getIndex());
        EXPECT_EQ(q->getGiaddr(), a->getGiaddr());
304 305 306
        // When processing an incoming packet the remote address
        // is copied as a src address, and the source address is
        // copied as a remote address to the response.
307 308
        EXPECT_TRUE(q->getLocalHWAddr() == a->getLocalHWAddr());
        EXPECT_TRUE(q->getRemoteHWAddr() == a->getRemoteHWAddr());
309

310 311 312
        // Check that bare minimum of required options are there.
        // We don't check options requested by a client. Those
        // are checked elsewhere.
313 314 315 316 317
        EXPECT_TRUE(a->getOption(DHO_SUBNET_MASK));
        EXPECT_TRUE(a->getOption(DHO_ROUTERS));
        EXPECT_TRUE(a->getOption(DHO_DHCP_SERVER_IDENTIFIER));
        EXPECT_TRUE(a->getOption(DHO_DHCP_LEASE_TIME));
        EXPECT_TRUE(a->getOption(DHO_SUBNET_MASK));
318 319
        EXPECT_TRUE(a->getOption(DHO_DOMAIN_NAME));
        EXPECT_TRUE(a->getOption(DHO_DOMAIN_NAME_SERVERS));
320

321
        // Check that something is offered
322 323 324
        EXPECT_TRUE(a->getYiaddr().toText() != "0.0.0.0");
    }

325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
    /// @brief Check that requested options are present.
    ///
    /// @param pkt packet to be checked.
    void optionsCheck(const Pkt4Ptr& pkt) {
        // Check that the requested and configured options are returned
        // in the ACK message.
        EXPECT_TRUE(pkt->getOption(DHO_DOMAIN_NAME))
            << "domain-name not present in the response";
        EXPECT_TRUE(pkt->getOption(DHO_DOMAIN_NAME_SERVERS))
            << "dns-servers not present in the response";
        EXPECT_TRUE(pkt->getOption(DHO_LOG_SERVERS))
            << "log-servers not present in the response";
        EXPECT_TRUE(pkt->getOption(DHO_COOKIE_SERVERS))
            << "cookie-servers not present in the response";
        // Check that the requested but not configured options are not
        // returned in the ACK message.
        EXPECT_FALSE(pkt->getOption(DHO_LPR_SERVERS))
            << "domain-name present in the response but it is"
            << " expected not to be present";
    }

346 347 348 349 350 351 352 353
    /// @brief generates client-id option
    ///
    /// Generate client-id option of specified length
    /// Ids with different lengths are sufficent to generate
    /// unique ids. If more fine grained control is required,
    /// tests generate client-ids on their own.
    /// Sets client_id_ field.
    /// @param size size of the client-id to be generated
354 355 356 357 358 359 360 361 362 363 364 365 366 367
    OptionPtr generateClientId(size_t size = 4) {

        OptionBuffer clnt_id(size);
        for (int i = 0; i < size; i++) {
            clnt_id[i] = 100 + i;
        }

        client_id_ = ClientIdPtr(new ClientId(clnt_id));

        return (OptionPtr(new Option(Option::V4, DHO_DHCP_CLIENT_IDENTIFIER,
                                     clnt_id.begin(),
                                     clnt_id.begin() + size)));
    }

368 369 370 371
    /// @brief generate hardware address
    ///
    /// @param size size of the generated MAC address
    /// @param pointer to Hardware Address object
Tomek Mrugalski's avatar
Tomek Mrugalski committed
372
    HWAddrPtr generateHWAddr(size_t size = 6) {
373
        const uint8_t hw_type = 123; // Just a fake number (typically 6=HTYPE_ETHER, see dhcp4.h)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
374 375 376 377 378 379 380
        OptionBuffer mac(size);
        for (int i = 0; i < size; ++i) {
            mac[i] = 50 + i;
        }
        return (HWAddrPtr(new HWAddr(mac, hw_type)));
    }

381 382 383
    /// Check that address was returned from proper range, that its lease
    /// lifetime is correct, that T1 and T2 are returned properly
    /// @param rsp response to be checked
384 385
    /// @param subnet subnet that should be used to verify assigned address
    ///        and options
386 387
    /// @param t1_mandatory is T1 mandatory?
    /// @param t2_mandatory is T2 mandatory?
388
    void checkAddressParams(const Pkt4Ptr& rsp, const SubnetPtr subnet,
389 390
                            bool t1_mandatory = false,
                            bool t2_mandatory = false) {
391 392 393 394

        // Technically inPool implies inRange, but let's be on the safe
        // side and check both.
        EXPECT_TRUE(subnet->inRange(rsp->getYiaddr()));
395
        EXPECT_TRUE(subnet->inPool(Lease::TYPE_V4, rsp->getYiaddr()));
396 397

        // Check lease time
398 399
        OptionPtr opt = rsp->getOption(DHO_DHCP_LEASE_TIME);
        if (!opt) {
400 401
            ADD_FAILURE() << "Lease time option missing in response";
        } else {
402
            EXPECT_EQ(opt->getUint32(), subnet->getValid());
403 404 405
        }

        // Check T1 timer
406 407 408
        opt = rsp->getOption(DHO_DHCP_RENEWAL_TIME);
        if (opt) {
            EXPECT_EQ(opt->getUint32(), subnet->getT1());
409 410 411 412 413 414 415
        } else {
            if (t1_mandatory) {
                ADD_FAILURE() << "Required T1 option missing";
            }
        }

        // Check T2 timer
416 417 418
        opt = rsp->getOption(DHO_DHCP_REBINDING_TIME);
        if (opt) {
            EXPECT_EQ(opt->getUint32(), subnet->getT2());
419
        } else {
420
            if (t2_mandatory) {
421 422 423 424 425
                ADD_FAILURE() << "Required T2 option missing";
            }
        }
    }

426 427 428 429 430
    /// @brief Basic checks for generated response (message type and trans-id).
    ///
    /// @param rsp response packet to be validated
    /// @param expected_message_type expected message type
    /// @param expected_transid expected transaction-id
431 432 433 434 435 436 437
    void checkResponse(const Pkt4Ptr& rsp, uint8_t expected_message_type,
                       uint32_t expected_transid) {
        ASSERT_TRUE(rsp);
        EXPECT_EQ(expected_message_type, rsp->getType());
        EXPECT_EQ(expected_transid, rsp->getTransid());
    }

438 439 440 441 442 443
    /// @brief Checks if the lease sent to client is present in the database
    ///
    /// @param rsp response packet to be validated
    /// @param client_id expected client-identifier (or NULL)
    /// @param HWAddr expected hardware address (not used now)
    /// @param expected_addr expected address
444
    Lease4Ptr checkLease(const Pkt4Ptr& rsp, const OptionPtr& client_id,
445
                         const HWAddrPtr&, const IOAddress& expected_addr) {
446 447 448 449 450 451 452 453 454 455 456 457 458 459

        ClientIdPtr id;
        if (client_id) {
            OptionBuffer data = client_id->getData();
            id.reset(new ClientId(data));
        }

        Lease4Ptr lease = LeaseMgrFactory::instance().getLease4(expected_addr);
        if (!lease) {
            cout << "Lease for " << expected_addr.toText()
                 << " not found in the database backend.";
            return (Lease4Ptr());
        }

460 461
        EXPECT_EQ(rsp->getYiaddr().toText(), expected_addr.toText());

462 463 464 465 466 467 468 469 470
        EXPECT_EQ(expected_addr.toText(), lease->addr_.toText());
        if (client_id) {
            EXPECT_TRUE(*lease->client_id_ == *id);
        }
        EXPECT_EQ(subnet_->getID(), lease->subnet_id_);

        return (lease);
    }

471 472 473
    /// @brief Checks if server response (OFFER, ACK, NAK) includes proper server-id
    /// @param rsp response packet to be validated
    /// @param expected_srvid expected value of server-id
474
    void checkServerId(const Pkt4Ptr& rsp, const OptionPtr& expected_srvid) {
475 476 477 478 479 480
        // Check that server included its server-id
        OptionPtr opt = rsp->getOption(DHO_DHCP_SERVER_IDENTIFIER);
        ASSERT_TRUE(opt);
        EXPECT_EQ(opt->getType(), expected_srvid->getType() );
        EXPECT_EQ(opt->len(), expected_srvid->len() );
        EXPECT_TRUE(opt->getData() == expected_srvid->getData());
481 482
    }

483 484 485
    /// @brief Checks if server response (OFFER, ACK, NAK) includes proper client-id
    /// @param rsp response packet to be validated
    /// @param expected_clientid expected value of client-id
486 487
    void checkClientId(const Pkt4Ptr& rsp, const OptionPtr& expected_clientid) {
        // check that server included our own client-id
488 489 490 491 492
        OptionPtr opt = rsp->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
        ASSERT_TRUE(opt);
        EXPECT_EQ(expected_clientid->getType(), opt->getType());
        EXPECT_EQ(expected_clientid->len(), opt->len());
        EXPECT_TRUE(expected_clientid->getData() == opt->getData());
493 494
    }

495 496 497
    /// @brief Tests if Discover or Request message is processed correctly
    ///
    /// @param msg_type DHCPDISCOVER or DHCPREQUEST
498
    void testDiscoverRequest(const uint8_t msg_type) {
499
        // Create an instance of the tested class.
500
        boost::scoped_ptr<NakedDhcpv4Srv> srv(new NakedDhcpv4Srv(0));
501 502

        // Initialize the source HW address.
503
        vector<uint8_t> mac(6);
504
        for (int i = 0; i < 6; ++i) {
505
            mac[i] = i * 10;
506
        }
507
        // Initialized the destination HW address.
508
        vector<uint8_t> dst_mac(6);
509
        for (int i = 0; i < 6; ++i) {
510 511
            dst_mac[i] = i * 20;
        }
512 513
        // Create a DHCP message. It will be used to simulate the
        // incoming message.
514
        boost::shared_ptr<Pkt4> req(new Pkt4(msg_type, 1234));
515 516
        // Create a response message. It will hold a reponse packet.
        // Initially, set it to NULL.
517
        boost::shared_ptr<Pkt4> rsp;
518
        // Set the name of the interface on which packet is received.
519
        req->setIface("eth0");
520
        // Set the interface index. It is just a dummy value and will
521
        // not be interpreted.
522
        req->setIndex(17);
523 524
        // Set the target HW address. This value is normally used to
        // construct the data link layer header.
525
        req->setRemoteHWAddr(1, 6, dst_mac);
526
        // Set the HW address. This value is set on DHCP level (in chaddr).
527
        req->setHWAddr(1, 6, mac);
528 529
        // Set local HW address. It is used to construct the data link layer
        // header.
530
        req->setLocalHWAddr(1, 6, mac);
531
        // Set target IP address.
532
        req->setRemoteAddr(IOAddress("192.0.2.55"));
533
        // Set relay address.
534
        req->setGiaddr(IOAddress("192.0.2.10"));
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569

        // We are going to test that certain options are returned
        // in the response message when requested using 'Parameter
        // Request List' option. Let's configure those options that
        // are returned when requested.
        configureRequestedOptions();

        if (msg_type == DHCPDISCOVER) {
            ASSERT_NO_THROW(
                rsp = srv->processDiscover(req);
            );

            // Should return OFFER
            ASSERT_TRUE(rsp);
            EXPECT_EQ(DHCPOFFER, rsp->getType());

        } else {
            ASSERT_NO_THROW(
                rsp = srv->processRequest(req);
            );

            // Should return ACK
            ASSERT_TRUE(rsp);
            EXPECT_EQ(DHCPACK, rsp->getType());

        }

        messageCheck(req, rsp);

        // We did not request any options so these should not be present
        // in the RSP.
        EXPECT_FALSE(rsp->getOption(DHO_LOG_SERVERS));
        EXPECT_FALSE(rsp->getOption(DHO_COOKIE_SERVERS));
        EXPECT_FALSE(rsp->getOption(DHO_LPR_SERVERS));

570
        // Repeat the test but request some options.
571 572 573
        // Add 'Parameter Request List' option.
        addPrlOption(req);

574 575 576 577
        if (msg_type == DHCPDISCOVER) {
            ASSERT_NO_THROW(
                rsp = srv->processDiscover(req);
            );
578

579 580 581
            // Should return non-NULL packet.
            ASSERT_TRUE(rsp);
            EXPECT_EQ(DHCPOFFER, rsp->getType());
582

583 584 585 586 587 588 589 590 591 592
        } else {
            ASSERT_NO_THROW(
                rsp = srv->processRequest(req);
            );

            // Should return non-NULL packet.
            ASSERT_TRUE(rsp);
            EXPECT_EQ(DHCPACK, rsp->getType());

        }
593 594 595

        // Check that the requested options are returned.
        optionsCheck(rsp);
596

597 598
    }

599 600 601
    /// @brief This function cleans up after the test.
    virtual void TearDown() {

602
        CfgMgr::instance().deleteSubnets4();
603 604 605

        // Let's clean up if there is such a file.
        unlink(SRVID_FILE);
606

607 608 609
        // Close all open sockets.
        IfaceMgr::instance().closeSockets();

610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
        // Some unit tests override the default packet filtering class, used
        // by the IfaceMgr. The dummy class, called PktFilterTest, reports the
        // capability to directly respond to the clients without IP address
        // assigned. This capability is not supported by the default packet
        // filtering class: PktFilterInet. Therefore setting the dummy class
        // allows to test scenarios, when server responds to the broadcast address
        // on client's request, despite having support for direct response.
        // The following call restores the use of original packet filtering class
        // after the test.
        try {
            IfaceMgr::instance().setPacketFilter(PktFilterPtr(new PktFilterInet()));

        } catch (const Exception& ex) {
            FAIL() << "Failed to restore the default (PktFilterInet) packet filtering"
                   << " class after the test. Exception has been caught: "
                   << ex.what();
        }
    }
628

629
    /// @brief A subnet used in most tests
630 631
    Subnet4Ptr subnet_;

632
    /// @brief A pool used in most tests
633 634
    Pool4Ptr pool_;

635
    /// @brief A client-id used in most tests
636
    ClientIdPtr client_id_;
637 638 639 640 641 642 643

    int rcode_;

    ConstElementPtr comment_;

    // Name of a valid network interface
    string valid_iface_;
644 645
};

Tomek Mrugalski's avatar
Tomek Mrugalski committed
646 647
// Sanity check. Verifies that both Dhcpv4Srv and its derived
// class NakedDhcpv4Srv can be instantiated and destroyed.
648 649
TEST_F(Dhcpv4SrvTest, basic) {

650
    // Check that the base class can be instantiated
651
    boost::scoped_ptr<Dhcpv4Srv> srv;
652 653
    ASSERT_NO_THROW(srv.reset(new Dhcpv4Srv(DHCP4_SERVER_PORT + 10000, "type=memfile",
                                            false, false)));
654
    srv.reset();
655 656 657 658 659
    // We have to close open sockets because further in this test we will
    // call the Dhcpv4Srv constructor again. This constructor will try to
    // set the appropriate packet filter class for IfaceMgr. This requires
    // that all sockets are closed.
    IfaceMgr::instance().closeSockets();
660

661
    // Check that the derived class can be instantiated
662 663
    boost::scoped_ptr<NakedDhcpv4Srv> naked_srv;
    ASSERT_NO_THROW(
664
        naked_srv.reset(new NakedDhcpv4Srv(DHCP4_SERVER_PORT + 10000)));
665
    EXPECT_TRUE(naked_srv->getServerID());
666 667
    // Close sockets again for the next test.
    IfaceMgr::instance().closeSockets();
668

669
    ASSERT_NO_THROW(naked_srv.reset(new NakedDhcpv4Srv(0)));
670
    EXPECT_TRUE(naked_srv->getServerID());
671 672
}

673 674 675
// This test verifies that the destination address of the response
// message is set to giaddr, when giaddr is set to non-zero address
// in the received message.
676 677 678
TEST_F(Dhcpv4SrvTest, adjustRemoteAddressRelay) {
    boost::scoped_ptr<NakedDhcpv4Srv> srv(new NakedDhcpv4Srv(0));

679
    // Create the instance of the incoming packet.
680
    boost::shared_ptr<Pkt4> req(new Pkt4(DHCPDISCOVER, 1234));
681
    // Set the giaddr to non-zero address as if it was relayed.
682
    req->setGiaddr(IOAddress("192.0.2.1"));
683 684
    // Set ciaddr to zero. This simulates the client which applies
    // for the new lease.
685
    req->setCiaddr(IOAddress("0.0.0.0"));
686 687 688 689 690 691 692
    // Clear broadcast flag.
    req->setFlags(0x0000);

    // Create a response packet. Assume that the new lease have
    // been created and new address allocated. This address is
    // stored in yiaddr field.
    boost::shared_ptr<Pkt4> resp(new Pkt4(DHCPOFFER, 1234));
693
    resp->setYiaddr(IOAddress("192.0.2.100"));
694 695
    // Clear the remote address.
    resp->setRemoteAddr(IOAddress("0.0.0.0"));
696

697
    // This function never throws.
698 699
    ASSERT_NO_THROW(srv->adjustRemoteAddr(req, resp));

700
    // Now the destination address should be relay's address.
701
    EXPECT_EQ("192.0.2.1", resp->getRemoteAddr().toText());
702 703 704 705 706 707

    // Let's do another test and set other fields: ciaddr and
    // flags. By doing it, we want to make sure that the relay
    // address will take precedence.
    req->setGiaddr(IOAddress("192.0.2.50"));
    req->setCiaddr(IOAddress("192.0.2.11"));
708
    req->setFlags(Pkt4::FLAG_BROADCAST_MASK);
709 710 711 712 713 714 715 716 717 718 719

    resp->setYiaddr(IOAddress("192.0.2.100"));
    // Clear remote address.
    resp->setRemoteAddr(IOAddress("0.0.0.0"));

    ASSERT_NO_THROW(srv->adjustRemoteAddr(req, resp));

    // Response should be sent back to the relay address.
    EXPECT_EQ("192.0.2.50", resp->getRemoteAddr().toText());
}

720 721 722 723
// This test verifies that the destination address of the response message
// is set to ciaddr when giaddr is set to zero and the ciaddr is set to
// non-zero address in the received message. This is the case when the
// client is in Renew or Rebind state.
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
TEST_F(Dhcpv4SrvTest, adjustRemoteAddressRenewRebind) {
    boost::scoped_ptr<NakedDhcpv4Srv> srv(new NakedDhcpv4Srv(0));

    // Create instance of the incoming packet.
    boost::shared_ptr<Pkt4> req(new Pkt4(DHCPDISCOVER, 1234));

    // Clear giaddr to simulate direct packet.
    req->setGiaddr(IOAddress("0.0.0.0"));
    // Set ciaddr to non-zero address. The response should be sent to this
    // address as the client is in renewing or rebinding state (it is fully
    // configured).
    req->setCiaddr(IOAddress("192.0.2.15"));
    // Let's configure broadcast flag. It should be ignored because
    // we are responding directly to the client having an address
    // and trying to extend his lease. Broadcast flag is only used
    // when new lease is acquired and server must make a decision
    // whether to unicast the response to the acquired address or
    // broadcast it.
742
    req->setFlags(Pkt4::FLAG_BROADCAST_MASK);
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759

    // Create a response.
    boost::shared_ptr<Pkt4> resp(new Pkt4(DHCPOFFER, 1234));
    // Let's extend the lease for the client in such a way that
    // it will actually get different address. The response
    // should not be sent to this address but rather to ciaddr
    // as client still have ciaddr configured.
    resp->setYiaddr(IOAddress("192.0.2.13"));
    // Clear the remote address.
    resp->setRemoteAddr(IOAddress("0.0.0.0"));

    ASSERT_NO_THROW(srv->adjustRemoteAddr(req, resp));

    // Check that server responds to ciaddr
    EXPECT_EQ("192.0.2.15", resp->getRemoteAddr().toText());
}

760 761 762 763 764 765 766
// This test verifies that the destination address of the response message
// is set correctly when giaddr and ciaddr is zeroed in the received message
// and the new lease is acquired. The lease address is carried in the
// response message in the yiaddr field. In this case destination address
// of the response should be set to yiaddr if server supports direct responses
// to the client which doesn't have an address yet or broadcast if the server
// doesn't support direct responses.
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
TEST_F(Dhcpv4SrvTest, adjustRemoteAddressSelect) {
    boost::scoped_ptr<NakedDhcpv4Srv> srv(new NakedDhcpv4Srv(0));

    // Create instance of the incoming packet.
    boost::shared_ptr<Pkt4> req(new Pkt4(DHCPDISCOVER, 1234));

    // Clear giaddr to simulate direct packet.
    req->setGiaddr(IOAddress("0.0.0.0"));
    // Clear client address as it hasn't got any address configured yet.
    req->setCiaddr(IOAddress("0.0.0.0"));

    // Let's clear the broadcast flag.
    req->setFlags(0);

    // Create a response.
    boost::shared_ptr<Pkt4> resp(new Pkt4(DHCPOFFER, 1234));
    // Assign some new address for this client.
    resp->setYiaddr(IOAddress("192.0.2.13"));

    // Clear the remote address.
    resp->setRemoteAddr(IOAddress("0.0.0.0"));

    // When running unit tests, the IfaceMgr is using the default Packet
    // Filtering class, PktFilterInet. This class does not support direct
    // responses to clients without address assigned. When giaddr and ciaddr
    // are zero and client has just got new lease, the assigned address is
    // carried in yiaddr. In order to send this address to the client,
    // server must broadcast its response.
    ASSERT_NO_THROW(srv->adjustRemoteAddr(req, resp));

    // Check that the response is sent to broadcast address as the
    // server doesn't have capability to respond directly.
    EXPECT_EQ("255.255.255.255", resp->getRemoteAddr().toText());

    // We also want to test the case when the server has capability to
    // respond directly to the client which is not configured. Server
    // makes decision whether it responds directly or broadcast its
    // response based on the capability reported by IfaceMgr. In order
    // to set this capability we have to provide a dummy Packet Filter
    // class which would report the support for direct responses.
    // This class is called PktFilterTest.
    IfaceMgr::instance().setPacketFilter(PktFilterPtr(new PktFilterTest()));

    // Now we expect that the server will send its response to the
    // address assigned for the client.
    ASSERT_NO_THROW(srv->adjustRemoteAddr(req, resp));

    EXPECT_EQ("192.0.2.13", resp->getRemoteAddr().toText());
}

817 818 819 820 821
// This test verifies that the destination address of the response message
// is set to broadcast address when client set broadcast flag in its
// query. Client sets this flag to indicate that it can't receive direct
// responses from the server when it doesn't have its interface configured.
// Server must respect broadcast flag.
822 823 824 825 826 827 828 829 830 831 832 833
TEST_F(Dhcpv4SrvTest, adjustRemoteAddressBroadcast) {
    boost::scoped_ptr<NakedDhcpv4Srv> srv(new NakedDhcpv4Srv(0));

    // Create instance of the incoming packet.
    boost::shared_ptr<Pkt4> req(new Pkt4(DHCPDISCOVER, 1234));

    // Clear giaddr to simulate direct packet.
    req->setGiaddr(IOAddress("0.0.0.0"));
    // Clear client address as it hasn't got any address configured yet.
    req->setCiaddr(IOAddress("0.0.0.0"));

    // Let's set the broadcast flag.
834
    req->setFlags(Pkt4::FLAG_BROADCAST_MASK);
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862

    // Create a response.
    boost::shared_ptr<Pkt4> resp(new Pkt4(DHCPOFFER, 1234));
    // Assign some new address for this client.
    resp->setYiaddr(IOAddress("192.0.2.13"));

    // Clear the remote address.
    resp->setRemoteAddr(IOAddress("0.0.0.0"));

    // When running unit tests, the IfaceMgr is using the default Packet
    // Filtering class, PktFilterInet. This class does not support direct
    // responses to the clients without address assigned. If giaddr and
    // ciaddr are zero and client has just got the new lease, the assigned
    // address is carried in yiaddr. In order to send this address to the
    // client, server must send the response to the broadcast address when
    // direct response is not supported. This conflicts with the purpose
    // of this test which is supposed to verify that responses are sent
    // to broadcast address only, when broadcast flag is set. Therefore,
    // in order to simulate that direct responses are supported we have
    // to replace the default packet filtering class with a dummy class
    // which reports direct response capability.
    IfaceMgr::instance().setPacketFilter(PktFilterPtr(new PktFilterTest()));

    ASSERT_NO_THROW(srv->adjustRemoteAddr(req, resp));

    // Server must repond to broadcast address when client desired that
    // by setting the broadcast flag in its request.
    EXPECT_EQ("255.255.255.255", resp->getRemoteAddr().toText());
863 864
}

865
// Verifies that DISCOVER message can be processed correctly,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
866 867 868 869 870 871 872
// that the OFFER message generated in response is valid and
// contains necessary options.
//
// Note: this test focuses on the packet correctness. There
// are other tests that verify correctness of the allocation
// engine. See DiscoverBasic, DiscoverHint, DiscoverNoClientId
// and DiscoverInvalidHint.
873 874
TEST_F(Dhcpv4SrvTest, processDiscover) {
    testDiscoverRequest(DHCPDISCOVER);
875
}
876

877
// Verifies that REQUEST message can be processed correctly,
878
// that the OFFER message generated in response is valid and
Tomek Mrugalski's avatar
Tomek Mrugalski committed
879 880 881 882
// contains necessary options.
//
// Note: this test focuses on the packet correctness. There
// are other tests that verify correctness of the allocation
883 884
// engine. See DiscoverBasic, DiscoverHint, DiscoverNoClientId
// and DiscoverInvalidHint.
885 886
TEST_F(Dhcpv4SrvTest, processRequest) {
    testDiscoverRequest(DHCPREQUEST);
887 888 889
}

TEST_F(Dhcpv4SrvTest, processRelease) {
890
    NakedDhcpv4Srv srv;
891
    Pkt4Ptr pkt(new Pkt4(DHCPRELEASE, 1234));
892

893
    // Should not throw
894
    EXPECT_NO_THROW(srv.processRelease(pkt));
895 896 897
}

TEST_F(Dhcpv4SrvTest, processDecline) {
898
    NakedDhcpv4Srv srv;
899
    Pkt4Ptr pkt(new Pkt4(DHCPDECLINE, 1234));
900

901
    // Should not throw
902
    EXPECT_NO_THROW(srv.processDecline(pkt));
903 904 905
}

TEST_F(Dhcpv4SrvTest, processInform) {
906
    NakedDhcpv4Srv srv;
907
    Pkt4Ptr pkt(new Pkt4(DHCPINFORM, 1234));
908

909
    // Should not throw
910
    EXPECT_NO_THROW(srv.processInform(pkt));
911

912
    // Should return something
913
    EXPECT_TRUE(srv.processInform(pkt));
914

915
    // @todo Implement more reasonable tests before starting
916
    // work on processSomething() method.
917 918
}

919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
TEST_F(Dhcpv4SrvTest, serverReceivedPacketName) {
    // Check all possible packet types
    for (int itype = 0; itype < 256; ++itype) {
        uint8_t type = itype;

        switch (type) {
        case DHCPDECLINE:
            EXPECT_STREQ("DECLINE", Dhcpv4Srv::serverReceivedPacketName(type));
            break;

        case DHCPDISCOVER:
            EXPECT_STREQ("DISCOVER", Dhcpv4Srv::serverReceivedPacketName(type));
            break;

        case DHCPINFORM:
            EXPECT_STREQ("INFORM", Dhcpv4Srv::serverReceivedPacketName(type));
            break;

        case DHCPRELEASE:
            EXPECT_STREQ("RELEASE", Dhcpv4Srv::serverReceivedPacketName(type));
            break;

        case DHCPREQUEST:
            EXPECT_STREQ("REQUEST", Dhcpv4Srv::serverReceivedPacketName(type));
            break;

        default:
            EXPECT_STREQ("UNKNOWN", Dhcpv4Srv::serverReceivedPacketName(type));
        }
    }
}

951 952 953 954 955 956 957 958 959 960 961 962 963
// This test verifies that incoming DISCOVER can be handled properly, that an
// OFFER is generated, that the response has an address and that address
// really belongs to the configured pool.
//
// constructed very simple DISCOVER message with:
// - client-id option
//
// expected returned OFFER message:
// - copy of client-id
// - server-id
// - offered address
TEST_F(Dhcpv4SrvTest, DiscoverBasic) {
    boost::scoped_ptr<NakedDhcpv4Srv> srv;
964
    ASSERT_NO_THROW(srv.reset(new NakedDhcpv4Srv(0)));
965 966 967 968 969 970

    Pkt4Ptr dis = Pkt4Ptr(new Pkt4(DHCPDISCOVER, 1234));
    dis->setRemoteAddr(IOAddress("192.0.2.1"));
    OptionPtr clientid = generateClientId();
    dis->addOption(clientid);

971
    // Pass it to the server and get an offer
972 973
    Pkt4Ptr offer = srv->processDiscover(dis);

974
    // Check if we get response at all
975 976
    checkResponse(offer, DHCPOFFER, 1234);

977
    // Check that address was returned from proper range, that its lease
978 979 980
    // lifetime is correct, that T1 and T2 are returned properly
    checkAddressParams(offer, subnet_);

981
    // Check identifiers
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
    checkServerId(offer, srv->getServerID());
    checkClientId(offer, clientid);
}


// This test verifies that incoming DISCOVER can be handled properly, that an
// OFFER is generated, that the response has an address and that address
// really belongs to the configured pool.
//
// constructed very simple DISCOVER message with:
// - client-id option
// - address set to specific value as hint
//
// expected returned OFFER message:
// - copy of client-id
// - server-id
// - offered address
TEST_F(Dhcpv4SrvTest, DiscoverHint) {
    boost::scoped_ptr<NakedDhcpv4Srv> srv;
1001
    ASSERT_NO_THROW(srv.reset(new NakedDhcpv4Srv(0)));
1002 1003 1004 1005 1006 1007 1008 1009
    IOAddress hint("192.0.2.107");

    Pkt4Ptr dis = Pkt4Ptr(new Pkt4(DHCPDISCOVER, 1234));
    dis->setRemoteAddr(IOAddress("192.0.2.1"));
    OptionPtr clientid = generateClientId();
    dis->addOption(clientid);
    dis->setYiaddr(hint);

1010
    // Pass it to the server and get an offer
1011 1012
    Pkt4Ptr offer = srv->processDiscover(dis);

1013
    // Check if we get response at all
1014 1015
    checkResponse(offer, DHCPOFFER, 1234);

1016
    // Check that address was returned from proper range, that its lease
1017 1018 1019 1020 1021
    // lifetime is correct, that T1 and T2 are returned properly
    checkAddressParams(offer, subnet_);

    EXPECT_EQ(offer->getYiaddr().toText(), hint.toText());

1022
    // Check identifiers
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
    checkServerId(offer, srv->getServerID());
    checkClientId(offer, clientid);
}


// This test verifies that incoming DISCOVER can be handled properly, that an
// OFFER is generated, that the response has an address and that address
// really belongs to the configured pool.
//
// constructed very simple DISCOVER message with:
// - address set to specific value as hint
//
// expected returned OFFER message:
// - copy of client-id
// - server-id
// - offered address
TEST_F(Dhcpv4SrvTest, DiscoverNoClientId) {
    boost::scoped_ptr<NakedDhcpv4Srv> srv;
1041
    ASSERT_NO_THROW(srv.reset(new NakedDhcpv4Srv(0)));
1042 1043 1044 1045 1046
    IOAddress hint("192.0.2.107");

    Pkt4Ptr dis = Pkt4Ptr(new Pkt4(DHCPDISCOVER, 1234));
    dis->setRemoteAddr(IOAddress("192.0.2.1"));
    dis->setYiaddr(hint);
1047
    dis->setHWAddr(generateHWAddr(6));
1048

1049
    // Pass it to the server and get an offer
1050 1051
    Pkt4Ptr offer = srv->processDiscover(dis);

1052
    // Check if we get response at all
1053 1054
    checkResponse(offer, DHCPOFFER, 1234);

1055
    // Check that address was returned from proper range, that its lease
1056 1057 1058 1059 1060
    // lifetime is correct, that T1 and T2 are returned properly
    checkAddressParams(offer, subnet_);

    EXPECT_EQ(offer->getYiaddr().toText(), hint.toText());

1061
    // Check identifiers
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
    checkServerId(offer, srv->getServerID());
}

// This test verifies that incoming DISCOVER can be handled properly, that an
// OFFER is generated, that the response has an address and that address
// really belongs to the configured pool.
//
// constructed very simple DISCOVER message with:
// - client-id option
// - address set to specific value as hint, but that hint is invalid
//
// expected returned OFFER message:
// - copy of client-id
// - server-id
// - offered address (!= hint)
TEST_F(Dhcpv4SrvTest, DiscoverInvalidHint) {
    boost::scoped_ptr<NakedDhcpv4Srv> srv;
1079
    ASSERT_NO_THROW(srv.reset(new NakedDhcpv4Srv(0)));
1080 1081 1082 1083 1084 1085 1086 1087
    IOAddress hint("10.1.2.3");

    Pkt4Ptr dis = Pkt4Ptr(new Pkt4(DHCPDISCOVER, 1234));
    dis->setRemoteAddr(IOAddress("192.0.2.107"));
    OptionPtr clientid = generateClientId();
    dis->addOption(clientid);
    dis->setYiaddr(hint);

1088
    // Pass it to the server and get an offer
1089 1090
    Pkt4Ptr offer = srv->processDiscover(dis);

1091
    // Check if we get response at all
1092 1093
    checkResponse(offer, DHCPOFFER, 1234);

1094
    // Check that address was returned from proper range, that its lease
1095 1096 1097 1098 1099
    // lifetime is correct, that T1 and T2 are returned properly
    checkAddressParams(offer, subnet_);

    EXPECT_NE(offer->getYiaddr().toText(), hint.toText());

1100
    // Check identifiers
1101 1102 1103 1104 1105 1106 1107 1108
    checkServerId(offer, srv->getServerID());
    checkClientId(offer, clientid);
}

/// @todo: Add a test that client sends hint that is in pool, but currently
/// being used by a different client.

// This test checks that the server is offering different addresses to different
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1109 1110
// clients in OFFERs. Please note that OFFER is not a guarantee that such
// an address will be assigned. Had the pool was very small and contained only