dhcp4_srv.cc 41.1 KB
Newer Older
1
// Copyright (C) 2011-2013 Internet Systems Consortium, Inc. ("ISC")
2 3 4 5 6 7 8 9 10 11 12 13 14
//
// 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.

15
#include <asiolink/io_address.h>
16
#include <dhcp/dhcp4.h>
17 18
#include <dhcp/duid.h>
#include <dhcp/hwaddr.h>
19
#include <dhcp/iface_mgr.h>
20
#include <dhcp/option4_addrlst.h>
21
#include <dhcp/option_int.h>
22
#include <dhcp/option_int_array.h>
23 24 25
#include <dhcp/pkt4.h>
#include <dhcp4/dhcp4_log.h>
#include <dhcp4/dhcp4_srv.h>
26 27
#include <dhcpsrv/addr_utilities.h>
#include <dhcpsrv/callout_handle_store.h>
28 29 30 31 32
#include <dhcpsrv/cfgmgr.h>
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
#include <dhcpsrv/subnet.h>
#include <dhcpsrv/utils.h>
33
#include <dhcpsrv/utils.h>
34
#include <hooks/callout_handle.h>
35
#include <hooks/hooks_manager.h>
36

37 38 39 40 41
#include <boost/algorithm/string/erase.hpp>

#include <iomanip>
#include <fstream>

42 43
using namespace isc;
using namespace isc::asiolink;
44
using namespace isc::dhcp;
45
using namespace isc::hooks;
46 47
using namespace isc::log;
using namespace std;
48

49
/// Structure that holds registered hook indexes
50 51
struct Dhcp4Hooks {
    int hook_index_buffer4_receive_;///< index for "buffer4_receive" hook point
52 53
    int hook_index_pkt4_receive_;   ///< index for "pkt4_receive" hook point
    int hook_index_subnet4_select_; ///< index for "subnet4_select" hook point
54
    int hook_index_lease4_release_; ///< index for "lease4_release" hook point
55
    int hook_index_pkt4_send_;      ///< index for "pkt4_send" hook point
56
    int hook_index_buffer4_send_;   ///< index for "buffer4_send" hook point
57

58 59 60
    /// Constructor that registers hook points for DHCPv4 engine
    Dhcp4Hooks() {
        hook_index_buffer4_receive_= HooksManager::registerHook("buffer4_receive");
61 62 63
        hook_index_pkt4_receive_   = HooksManager::registerHook("pkt4_receive");
        hook_index_subnet4_select_ = HooksManager::registerHook("subnet4_select");
        hook_index_pkt4_send_      = HooksManager::registerHook("pkt4_send");
64 65
        hook_index_lease4_release_ = HooksManager::registerHook("lease4_release");
        hook_index_buffer4_send_   = HooksManager::registerHook("buffer4_send");
66 67 68 69 70 71 72
    }
};

// Declare a Hooks object. As this is outside any function or method, it
// will be instantiated (and the constructor run) when the module is loaded.
// As a result, the hook indexes will be defined before any method in this
// module is called.
73
Dhcp4Hooks Hooks;
74

75 76 77 78 79 80 81 82 83 84 85 86
namespace isc {
namespace dhcp {

/// @brief file name of a server-id file
///
/// Server must store its server identifier in persistent storage that must not
/// change between restarts. This is name of the file that is created in dataDir
/// (see isc::dhcp::CfgMgr::getDataDir()). It is a text file that uses
/// regular IPv4 address, e.g. 192.0.2.1. Server will create it during
/// first run and then use it afterwards.
static const char* SERVER_ID_FILE = "b10-dhcp4-serverid";

87 88 89
// These are hardcoded parameters. Currently this is a skeleton server that only
// grants those options and a single, fixed, hardcoded lease.

90
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const char* dbconfig, const bool use_bcast,
91
                     const bool direct_response_desired)
92 93
: serverid_(), shutdown_(true), alloc_engine_(), port_(port),
    use_bcast_(use_bcast), hook_index_pkt4_receive_(-1),
94 95
    hook_index_subnet4_select_(-1), hook_index_pkt4_send_(-1) {

96
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
97
    try {
98
        // First call to instance() will create IfaceMgr (it's a singleton)
99
        // it may throw something if things go wrong.
100
        // The 'true' value of the call to setMatchingPacketFilter imposes
101 102 103 104
        // that IfaceMgr will try to use the mechanism to respond directly
        // to the client which doesn't have address assigned. This capability
        // may be lacking on some OSes, so there is no guarantee that server
        // will be able to respond directly.
105
        IfaceMgr::instance().setMatchingPacketFilter(direct_response_desired);
106

107 108 109
        if (port) {
            // open sockets only if port is non-zero. Port 0 is used
            // for non-socket related testing.
110
            IfaceMgr::instance().openSockets4(port_, use_bcast_);
111
        }
112

113 114 115
        string srvid_file = CfgMgr::instance().getDataDir() + "/" + string(SERVER_ID_FILE);
        if (loadServerID(srvid_file)) {
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_SERVERID_LOADED)
116
                .arg(srvidToString(getServerID()))
117 118 119 120 121 122 123 124 125 126 127 128 129
                .arg(srvid_file);
        } else {
            generateServerID();
            LOG_INFO(dhcp4_logger, DHCP4_SERVERID_GENERATED)
                .arg(srvidToString(getServerID()))
                .arg(srvid_file);

            if (!writeServerID(srvid_file)) {
                LOG_WARN(dhcp4_logger, DHCP4_SERVERID_WRITE_FAIL)
                    .arg(srvid_file);
            }

        }
130

131 132 133 134 135 136 137
        // Instantiate LeaseMgr
        LeaseMgrFactory::create(dbconfig);
        LOG_INFO(dhcp4_logger, DHCP4_DB_BACKEND_STARTED)
            .arg(LeaseMgrFactory::instance().getType())
            .arg(LeaseMgrFactory::instance().getName());

        // Instantiate allocation engine
138 139
        alloc_engine_.reset(new AllocEngine(AllocEngine::ALLOC_ITERATIVE, 100,
                                            false /* false = IPv4 */));
140

141 142 143 144 145 146 147
        // Register hook points
        hook_index_pkt4_receive_   = Hooks.hook_index_pkt4_receive_;
        hook_index_subnet4_select_ = Hooks.hook_index_subnet4_select_;
        hook_index_pkt4_send_      = Hooks.hook_index_pkt4_send_;

        /// @todo call loadLibraries() when handling configuration changes

148
    } catch (const std::exception &e) {
149
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
150 151 152
        shutdown_ = true;
        return;
    }
153

Tomek Mrugalski's avatar
Tomek Mrugalski committed
154
    shutdown_ = false;
155 156 157
}

Dhcpv4Srv::~Dhcpv4Srv() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
158
    IfaceMgr::instance().closeSockets();
159 160
}

161 162
void
Dhcpv4Srv::shutdown() {
163
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
164 165 166
    shutdown_ = true;
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
167 168
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
169 170 171
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
172 173
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
174 175 176
    IfaceMgr::instance().send(packet);
}

177 178
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
179
    while (!shutdown_) {
180
        /// @todo: calculate actual timeout once we have lease database
181 182
        //cppcheck-suppress variableScope This is temporary anyway
        const int timeout = 1000;
183

Tomek Mrugalski's avatar
Tomek Mrugalski committed
184
        // client's message and server's response
185
        Pkt4Ptr query;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
186
        Pkt4Ptr rsp;
187

188
        try {
189
            query = receivePacket(timeout);
190 191 192 193
        } catch (const std::exception& e) {
            LOG_ERROR(dhcp4_logger, DHCP4_PACKET_RECEIVE_FAIL).arg(e.what());
        }

194 195 196 197 198 199 200 201 202
        // Timeout may be reached or signal received, which breaks select()
        // with no reception ocurred
        if (!query) {
            continue;
        }

        bool skip_unpack = false;

        // The packet has just been received so contains the uninterpreted wire
203
        // data; execute callouts registered for buffer4_receive.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
204 205
        if (HooksManager::getHooksManager()
            .calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
206 207 208 209 210 211 212 213 214
            CalloutHandlePtr callout_handle = getCalloutHandle(query);

            // Delete previously set arguments
            callout_handle->deleteAllArguments();

            // Pass incoming packet as argument
            callout_handle->setArgument("query4", query);

            // Call callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
215 216
            HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                       *callout_handle);
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232

            // Callouts decided to skip the next processing step. The next
            // processing step would to parse the packet, so skip at this
            // stage means that callouts did the parsing already, so server
            // should skip parsing.
            if (callout_handle->getSkip()) {
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_BUFFER_RCVD_SKIP);
                skip_unpack = true;
            }

            callout_handle->getArgument("query4", query);
        }

        // Unpack the packet information unless the buffer4_receive callouts
        // indicated they did it
        if (!skip_unpack) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
233 234 235
            try {
                query->unpack();
            } catch (const std::exception& e) {
236 237 238
                // Failed to parse the packet.
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL,
                          DHCP4_PACKET_PARSE_FAIL).arg(e.what());
239 240
                continue;
            }
241
        }
242

243 244 245 246 247
        // When receiving a packet without message type option, getType() will
        // throw. Let's set type to -1 as default error indicator.
        int type = -1;
        try {
            type = query->getType();
248 249 250 251
        } catch (...) {
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_DROP_NO_TYPE)
                .arg(query->getIface());
            continue;
252
        }
253

254
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_RECEIVED)
255
            .arg(serverReceivedPacketName(type))
256
            .arg(type)
257 258
            .arg(query->getIface());
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
259
            .arg(type)
260 261
            .arg(query->toText());

Tomek Mrugalski's avatar
Tomek Mrugalski committed
262
        // Let's execute all callouts registered for pkt4_receive
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
        if (HooksManager::calloutsPresent(hook_index_pkt4_receive_)) {
            CalloutHandlePtr callout_handle = getCalloutHandle(query);

            // Delete previously set arguments
            callout_handle->deleteAllArguments();

            // Pass incoming packet as argument
            callout_handle->setArgument("query4", query);

            // Call callouts
            HooksManager::callCallouts(hook_index_pkt4_receive_,
                                       *callout_handle);

            // Callouts decided to skip the next processing step. The next
            // processing step would to process the packet, so skip at this
            // stage means drop.
            if (callout_handle->getSkip()) {
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_RCVD_SKIP);
                continue;
            }
283

284 285
            callout_handle->getArgument("query4", query);
        }
286

287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
        try {
            switch (query->getType()) {
            case DHCPDISCOVER:
                rsp = processDiscover(query);
                break;

            case DHCPREQUEST:
                // Note that REQUEST is used for many things in DHCPv4: for
                // requesting new leases, renewing existing ones and even
                // for rebinding.
                rsp = processRequest(query);
                break;

            case DHCPRELEASE:
                processRelease(query);
                break;

            case DHCPDECLINE:
                processDecline(query);
                break;

            case DHCPINFORM:
                processInform(query);
                break;

            default:
                // Only action is to output a message if debug is enabled,
                // and that is covered by the debug statement before the
                // "switch" statement.
                ;
317
            }
318 319 320 321 322 323 324 325 326 327 328 329 330 331
        } catch (const isc::Exception& e) {

            // Catch-all exception (at least for ones based on the isc
            // Exception class, which covers more or less all that
            // are explicitly raised in the BIND 10 code).  Just log
            // the problem and ignore the packet. (The problem is logged
            // as a debug message because debug is disabled by default -
            // it prevents a DDOS attack based on the sending of problem
            // packets.)
            if (dhcp4_logger.isDebugEnabled(DBG_DHCP4_BASIC)) {
                std::string source = "unknown";
                HWAddrPtr hwptr = query->getHWAddr();
                if (hwptr) {
                    source = hwptr->toText();
332
                }
333 334 335
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC,
                          DHCP4_PACKET_PROCESS_FAIL)
                    .arg(source).arg(e.what());
336
            }
337
        }
338

339 340 341
        if (!rsp) {
            continue;
        }
342

343
        adjustRemoteAddr(query, rsp);
344

345 346 347 348 349
        if (!rsp->getHops()) {
            rsp->setRemotePort(DHCP4_CLIENT_PORT);
        } else {
            rsp->setRemotePort(DHCP4_SERVER_PORT);
        }
350

351 352 353 354
        rsp->setLocalAddr(query->getLocalAddr());
        rsp->setLocalPort(DHCP4_SERVER_PORT);
        rsp->setIface(query->getIface());
        rsp->setIndex(query->getIndex());
355

356 357
        // Specifies if server should do the packing
        bool skip_pack = false;
358

Tomek Mrugalski's avatar
Tomek Mrugalski committed
359
        // Execute all callouts registered for pkt4_send
360 361
        if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
            CalloutHandlePtr callout_handle = getCalloutHandle(query);
362

363 364
            // Delete all previous arguments
            callout_handle->deleteAllArguments();
365

366 367
            // Clear skip flag if it was set in previous callouts
            callout_handle->setSkip(false);
368

369 370
            // Set our response
            callout_handle->setArgument("response4", rsp);
371

372 373 374
            // Call all installed callouts
            HooksManager::callCallouts(hook_index_pkt4_send_,
                                       *callout_handle);
375

376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
            // Callouts decided to skip the next processing step. The next
            // processing step would to send the packet, so skip at this
            // stage means "drop response".
            if (callout_handle->getSkip()) {
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_SEND_SKIP);
                skip_pack = true;
            }
        }

        if (!skip_pack) {
            try {
                rsp->pack();
            } catch (const std::exception& e) {
                LOG_ERROR(dhcp4_logger, DHCP4_PACKET_SEND_FAIL)
                    .arg(e.what());
            }
        }

        try {
            // Now all fields and options are constructed into output wire buffer.
            // Option objects modification does not make sense anymore. Hooks
            // can only manipulate wire buffer at this stage.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
398 399 400
            // Let's execute all callouts registered for buffer4_send
            if (HooksManager::getHooksManager()
                .calloutsPresent(Hooks.hook_index_buffer4_send_)) {
401
                CalloutHandlePtr callout_handle = getCalloutHandle(query);
402

403 404
                // Delete previously set arguments
                callout_handle->deleteAllArguments();
405

406 407
                // Pass incoming packet as argument
                callout_handle->setArgument("response4", rsp);
408

409
                // Call callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
410 411
                HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
                                           *callout_handle);
412

413 414 415 416
                // Callouts decided to skip the next processing step. The next
                // processing step would to parse the packet, so skip at this
                // stage means drop.
                if (callout_handle->getSkip()) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
417 418
                    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS,
                              DHCP4_HOOK_BUFFER_SEND_SKIP);
419
                    continue;
420
                }
421 422

                callout_handle->getArgument("response4", rsp);
423
            }
424 425 426 427 428 429 430 431 432

            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA,
                      DHCP4_RESPONSE_DATA)
                .arg(static_cast<int>(rsp->getType())).arg(rsp->toText());

            sendPacket(rsp);
        } catch (const std::exception& e) {
            LOG_ERROR(dhcp4_logger, DHCP4_PACKET_SEND_FAIL)
                .arg(e.what());
433
        }
434 435 436 437 438
    }

    return (true);
}

439 440
bool
Dhcpv4Srv::loadServerID(const std::string& file_name) {
441

442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
    // load content of the file into a string
    fstream f(file_name.c_str(), ios::in);
    if (!f.is_open()) {
        return (false);
    }

    string hex_string;
    f >> hex_string;
    f.close();

    // remove any spaces
    boost::algorithm::erase_all(hex_string, " ");

    try {
        IOAddress addr(hex_string);

Tomek Mrugalski's avatar
Tomek Mrugalski committed
458
        if (!addr.isV4()) {
459 460 461 462 463 464 465 466 467 468
            return (false);
        }

        // Now create server-id option
        serverid_.reset(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER, addr));

    } catch(...) {
        // any kind of malformed input (empty string, IPv6 address, complete
        // garbate etc.)
        return (false);
469 470 471 472 473
    }

    return (true);
}

474 475
void
Dhcpv4Srv::generateServerID() {
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492

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

    // Let's find suitable interface.
    for (IfaceMgr::IfaceCollection::const_iterator iface = ifaces.begin();
         iface != ifaces.end(); ++iface) {

        // Let's don't use loopback.
        if (iface->flag_loopback_) {
            continue;
        }

        // Let's skip downed interfaces. It is better to use working ones.
        if (!iface->flag_up_) {
            continue;
        }

493
        const Iface::AddressCollection addrs = iface->getAddresses();
494

495
        for (Iface::AddressCollection::const_iterator addr = addrs.begin();
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
             addr != addrs.end(); ++addr) {
            if (addr->getFamily() != AF_INET) {
                continue;
            }

            serverid_ = OptionPtr(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                                     *addr));
            return;
        }


    }

    isc_throw(BadValue, "No suitable interfaces for server-identifier found");
}

512 513
bool
Dhcpv4Srv::writeServerID(const std::string& file_name) {
514 515 516 517 518 519
    fstream f(file_name.c_str(), ios::out | ios::trunc);
    if (!f.good()) {
        return (false);
    }
    f << srvidToString(getServerID());
    f.close();
520
    return (true);
521 522
}

523
string
524
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
    if (!srvid) {
        isc_throw(BadValue, "NULL pointer passed to srvidToString()");
    }
    boost::shared_ptr<Option4AddrLst> generated =
        boost::dynamic_pointer_cast<Option4AddrLst>(srvid);
    if (!srvid) {
        isc_throw(BadValue, "Pointer to invalid option passed to srvidToString()");
    }

    Option4AddrLst::AddressContainer addrs = generated->getAddresses();
    if (addrs.size() != 1) {
        isc_throw(BadValue, "Malformed option passed to srvidToString(). "
                  << "Expected to contain a single IPv4 address.");
    }

    return (addrs[0].toText());
541 542
}

543 544
void
Dhcpv4Srv::copyDefaultFields(const Pkt4Ptr& question, Pkt4Ptr& answer) {
545 546 547
    answer->setIface(question->getIface());
    answer->setIndex(question->getIndex());
    answer->setCiaddr(question->getCiaddr());
548

549
    answer->setSiaddr(IOAddress("0.0.0.0")); // explicitly set this to 0
550
    answer->setHops(question->getHops());
551 552

    // copy MAC address
553
    answer->setHWAddr(question->getHWAddr());
554 555

    // relay address
556 557
    answer->setGiaddr(question->getGiaddr());

558
    // Let's copy client-id to response. See RFC6842.
559 560 561 562
    OptionPtr client_id = question->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (client_id) {
        answer->addOption(client_id);
    }
563 564

    // If src/dest HW addresses are used by the packet filtering class
565 566 567 568 569 570
    // we need to copy them as well. There is a need to check that the
    // address being set is not-NULL because an attempt to set the NULL
    // HW would result in exception. If these values are not set, the
    // the default HW addresses (zeroed) should be generated by the
    // packet filtering class when creating Ethernet header for
    // outgoing packet.
571 572
    HWAddrPtr src_hw_addr = question->getLocalHWAddr();
    if (src_hw_addr) {
573
        answer->setLocalHWAddr(src_hw_addr);
574
    }
575
    HWAddrPtr dst_hw_addr = question->getRemoteHWAddr();
576
    if (dst_hw_addr) {
577
        answer->setRemoteHWAddr(dst_hw_addr);
578
    }
579 580
}

581 582
void
Dhcpv4Srv::appendDefaultOptions(Pkt4Ptr& msg, uint8_t msg_type) {
583
    OptionPtr opt;
584 585

    // add Message Type Option (type 53)
586
    msg->setType(msg_type);
587

Tomek Mrugalski's avatar
Tomek Mrugalski committed
588
    // DHCP Server Identifier (type 54)
589
    msg->addOption(getServerID());
Tomek Mrugalski's avatar
Tomek Mrugalski committed
590

591 592 593
    // more options will be added here later
}

594 595
void
Dhcpv4Srv::appendRequestedOptions(const Pkt4Ptr& question, Pkt4Ptr& msg) {
596 597 598 599 600 601 602 603 604 605 606

    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
    Subnet4Ptr subnet = selectSubnet(question);
    // If we can't find the subnet for the client there is no way
    // to get the options to be sent to a client. We don't log an
    // error because it will be logged by the assignLease method
    // anyway.
    if (!subnet) {
        return;
    }
607

608 609 610 611 612 613 614 615 616
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
        OptionUint8Array>(question->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
617

618 619 620 621 622 623 624 625 626 627 628 629
    // Get the codes of requested options.
    const std::vector<uint8_t>& requested_opts = option_prl->getValues();
    // For each requested option code get the instance of the option
    // to be returned to the client.
    for (std::vector<uint8_t>::const_iterator opt = requested_opts.begin();
         opt != requested_opts.end(); ++opt) {
        Subnet::OptionDescriptor desc =
            subnet->getOptionDescriptor("dhcp4", *opt);
        if (desc.option) {
            msg->addOption(desc.option);
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
630
}
631

632 633 634 635 636 637 638 639 640
void
Dhcpv4Srv::appendBasicOptions(const Pkt4Ptr& question, Pkt4Ptr& msg) {
    // Identify options that we always want to send to the
    // client (if they are configured).
    static const uint16_t required_options[] = {
        DHO_SUBNET_MASK,
        DHO_ROUTERS,
        DHO_DOMAIN_NAME_SERVERS,
        DHO_DOMAIN_NAME };
641

642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
    static size_t required_options_size =
        sizeof(required_options) / sizeof(required_options[0]);

    // Get the subnet.
    Subnet4Ptr subnet = selectSubnet(question);
    if (!subnet) {
        return;
    }

    // Try to find all 'required' options in the outgoing
    // message. Those that are not present will be added.
    for (int i = 0; i < required_options_size; ++i) {
        OptionPtr opt = msg->getOption(required_options[i]);
        if (!opt) {
            // Check whether option has been configured.
            Subnet::OptionDescriptor desc =
                subnet->getOptionDescriptor("dhcp4", required_options[i]);
            if (desc.option) {
                msg->addOption(desc.option);
            }
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
664
}
665

666 667
void
Dhcpv4Srv::assignLease(const Pkt4Ptr& question, Pkt4Ptr& answer) {
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684

    // We need to select a subnet the client is connected in.
    Subnet4Ptr subnet = selectSubnet(question);
    if (!subnet) {
        // This particular client is out of luck today. We do not have
        // information about the subnet he is connected to. This likely means
        // misconfiguration of the server (or some relays). We will continue to
        // process this message, but our response will be almost useless: no
        // addresses or prefixes, no subnet specific configuration etc. The only
        // thing this client can get is some global information (like DNS
        // servers).

        // perhaps this should be logged on some higher level? This is most likely
        // configuration bug.
        LOG_ERROR(dhcp4_logger, DHCP4_SUBNET_SELECTION_FAILED)
            .arg(question->getRemoteAddr().toText())
            .arg(serverReceivedPacketName(question->getType()));
685
        answer->setType(DHCPNAK);
686 687 688
        answer->setYiaddr(IOAddress("0.0.0.0"));
        return;
    }
689

690 691 692
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_SELECTED)
        .arg(subnet->toText());

693 694 695 696 697 698 699
    // Get client-id option
    ClientIdPtr client_id;
    OptionPtr opt = question->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (opt) {
        client_id = ClientIdPtr(new ClientId(opt->getData()));
    }
    // client-id is not mandatory in DHCPv4
700

701
    IOAddress hint = question->getYiaddr();
702

703
    HWAddrPtr hwaddr = question->getHWAddr();
704

705 706 707 708 709 710
    // "Fake" allocation is processing of DISCOVER message. We pretend to do an
    // allocation, but we do not put the lease in the database. That is ok,
    // because we do not guarantee that the user will get that exact lease. If
    // the user selects this server to do actual allocation (i.e. sends REQUEST)
    // it should include this hint. That will help us during the actual lease
    // allocation.
711
    bool fake_allocation = (question->getType() == DHCPDISCOVER);
712

713 714
    CalloutHandlePtr callout_handle = getCalloutHandle(question);

715 716 717 718
    // Use allocation engine to pick a lease for this client. Allocation engine
    // will try to honour the hint, but it is just a hint - some other address
    // may be used instead. If fake_allocation is set to false, the lease will
    // be inserted into the LeaseMgr as well.
719 720
    // @todo pass the actual FQDN data.
    Lease4Ptr old_lease;
721
    Lease4Ptr lease = alloc_engine_->allocateAddress4(subnet, client_id, hwaddr,
722 723 724 725
                                                      hint, false, false, "",
                                                      fake_allocation,
                                                      callout_handle,
                                                      old_lease);
726 727

    if (lease) {
728 729
        // We have a lease! Let's set it in the packet and send it back to
        // the client.
730 731
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, fake_allocation?
                  DHCP4_LEASE_ADVERT:DHCP4_LEASE_ALLOC)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
732
            .arg(lease->addr_.toText())
733
            .arg(client_id?client_id->toText():"(no client-id)")
Tomek Mrugalski's avatar
Tomek Mrugalski committed
734
            .arg(hwaddr?hwaddr->toText():"(no hwaddr info)");
735 736 737 738 739 740 741 742 743

        answer->setYiaddr(lease->addr_);

        // IP Address Lease time (type 51)
        opt = OptionPtr(new Option(Option::V4, DHO_DHCP_LEASE_TIME));
        opt->setUint32(lease->valid_lft_);
        answer->addOption(opt);

        // Router (type 3)
744 745 746 747 748
        Subnet::OptionDescriptor opt_routers =
            subnet->getOptionDescriptor("dhcp4", DHO_ROUTERS);
        if (opt_routers.option) {
            answer->addOption(opt_routers.option);
        }
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766

        // Subnet mask (type 1)
        answer->addOption(getNetmaskOption(subnet));

        // @todo: send renew timer option (T1, option 58)
        // @todo: send rebind timer option (T2, option 59)

    } else {
        // Allocation engine did not allocate a lease. The engine logged
        // cause of that failure. The only thing left is to insert
        // status code to pass the sad news to the client.

        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, fake_allocation?
                  DHCP4_LEASE_ADVERT_FAIL:DHCP4_LEASE_ALLOC_FAIL)
            .arg(client_id?client_id->toText():"(no client-id)")
            .arg(hwaddr?hwaddr->toText():"(no hwaddr info)")
            .arg(hint.toText());

767
        answer->setType(DHCPNAK);
768 769 770 771
        answer->setYiaddr(IOAddress("0.0.0.0"));
    }
}

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
void
Dhcpv4Srv::adjustRemoteAddr(const Pkt4Ptr& question, Pkt4Ptr& msg) {
    // Let's create static objects representing zeroed and broadcast
    // addresses. We will use them further in this function to test
    // other addresses against them. Since they are static, they will
    // be created only once.
    static const IOAddress zero_addr("0.0.0.0");
    static const IOAddress bcast_addr("255.255.255.255");

    // If received relayed message, server responds to the relay address.
    if (question->getGiaddr() != zero_addr) {
        msg->setRemoteAddr(question->getGiaddr());

    // If giaddr is 0 but client set ciaddr, server should unicast the
    // response to ciaddr.
    } else if (question->getCiaddr() != zero_addr) {
        msg->setRemoteAddr(question->getCiaddr());

    // We can't unicast the response to the client when sending NAK,
    // because we haven't allocated address for him. Therefore,
    // NAK is broadcast.
    } else if (msg->getType() == DHCPNAK) {
        msg->setRemoteAddr(bcast_addr);

    // If yiaddr is set it means that we have created a lease for a client.
797
    } else if (msg->getYiaddr() != zero_addr) {
798 799 800 801 802 803
        // If the broadcast bit is set in the flags field, we have to
        // send the response to broadcast address. Client may have requested it
        // because it doesn't support reception of messages on the interface
        // which doesn't have an address assigned. The other case when response
        // must be broadcasted is when our server does not support responding
        // directly to a client without address assigned.
804
        const bool bcast_flag = ((question->getFlags() & Pkt4::FLAG_BROADCAST_MASK) != 0);
805 806 807 808 809 810 811
        if (!IfaceMgr::instance().isDirectResponseSupported() || bcast_flag) {
            msg->setRemoteAddr(bcast_addr);

        // Client cleared the broadcast bit and we support direct responses
        // so we should unicast the response to a newly allocated address -
        // yiaddr.
        } else {
812
            msg->setRemoteAddr(msg->getYiaddr());
813 814 815 816 817 818 819 820 821 822 823 824 825

        }

    // In most cases, we should have the remote address found already. If we
    // found ourselves at this point, the rational thing to do is to respond
    // to the address we got the query from.
    } else {
        msg->setRemoteAddr(question->getRemoteAddr());

    }
}


826 827
OptionPtr
Dhcpv4Srv::getNetmaskOption(const Subnet4Ptr& subnet) {
828 829 830 831 832 833 834 835
    uint32_t netmask = getNetmask4(subnet->get().second);

    OptionPtr opt(new OptionInt<uint32_t>(Option::V4,
                  DHO_SUBNET_MASK, netmask));

    return (opt);
}

836 837
Pkt4Ptr
Dhcpv4Srv::processDiscover(Pkt4Ptr& discover) {
838 839 840

    sanityCheck(discover, FORBIDDEN);

841
    Pkt4Ptr offer = Pkt4Ptr
Tomek Mrugalski's avatar
Tomek Mrugalski committed
842
        (new Pkt4(DHCPOFFER, discover->getTransid()));
843

Tomek Mrugalski's avatar
Tomek Mrugalski committed
844 845
    copyDefaultFields(discover, offer);
    appendDefaultOptions(offer, DHCPOFFER);
846
    appendRequestedOptions(discover, offer);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
847

848
    assignLease(discover, offer);
849

850 851 852 853 854
    // There are a few basic options that we always want to
    // include in the response. If client did not request
    // them we append them for him.
    appendBasicOptions(discover, offer);

855
    return (offer);
856 857
}

858 859
Pkt4Ptr
Dhcpv4Srv::processRequest(Pkt4Ptr& request) {
860

Tomek Mrugalski's avatar
Tomek Mrugalski committed
861
    /// @todo Uncomment this (see ticket #3116)
862 863
    // sanityCheck(request, MANDATORY);

864
    Pkt4Ptr ack = Pkt4Ptr
865 866 867 868
        (new Pkt4(DHCPACK, request->getTransid()));

    copyDefaultFields(request, ack);
    appendDefaultOptions(ack, DHCPACK);
869
    appendRequestedOptions(request, ack);
870

871 872 873
    // Note that we treat REQUEST message uniformly, regardless if this is a
    // first request (requesting for new address), renewing existing address
    // or even rebinding.
874
    assignLease(request, ack);
875

876 877 878 879 880
    // There are a few basic options that we always want to
    // include in the response. If client did not request
    // them we append them for him.
    appendBasicOptions(request, ack);

881
    return (ack);
882 883
}

884 885
void
Dhcpv4Srv::processRelease(Pkt4Ptr& release) {
886

Tomek Mrugalski's avatar
Tomek Mrugalski committed
887
    /// @todo Uncomment this (see ticket #3116)
888 889
    // sanityCheck(release, MANDATORY);

890
    // Try to find client-id
891 892 893 894 895 896
    ClientIdPtr client_id;
    OptionPtr opt = release->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (opt) {
        client_id = ClientIdPtr(new ClientId(opt->getData()));
    }

897 898 899 900 901 902 903 904 905 906 907 908
    try {
        // Do we have a lease for that particular address?
        Lease4Ptr lease = LeaseMgrFactory::instance().getLease4(release->getYiaddr());

        if (!lease) {
            // No such lease - bogus release
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_RELEASE_FAIL_NO_LEASE)
                .arg(release->getYiaddr().toText())
                .arg(release->getHWAddr()->toText())
                .arg(client_id ? client_id->toText() : "(no client-id)");
            return;
        }
909

910 911 912 913 914 915 916 917 918 919
        // Does the hardware address match? We don't want one client releasing
        // second client's leases.
        if (lease->hwaddr_ != release->getHWAddr()->hwaddr_) {
            // @todo: Print hwaddr from lease as part of ticket #2589
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_RELEASE_FAIL_WRONG_HWADDR)
                .arg(release->getYiaddr().toText())
                .arg(client_id ? client_id->toText() : "(no client-id)")
                .arg(release->getHWAddr()->toText());
            return;
        }
920

921 922 923 924 925 926 927 928 929
        // Does the lease have client-id info? If it has, then check it with what
        // the client sent us.
        if (lease->client_id_ && client_id && *lease->client_id_ != *client_id) {
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_RELEASE_FAIL_WRONG_CLIENT_ID)
                .arg(release->getYiaddr().toText())
                .arg(client_id->toText())
                .arg(lease->client_id_->toText());
            return;
        }
930

931
        bool skip = false;
932

Tomek Mrugalski's avatar
Tomek Mrugalski committed
933 934 935
        // Execute all callouts registered for lease4_release
        if (HooksManager::getHooksManager()
            .calloutsPresent(Hooks.hook_index_lease4_release_)) {
936 937 938 939
            CalloutHandlePtr callout_handle = getCalloutHandle(release);

            // Delete all previous arguments
            callout_handle->deleteAllArguments();
940

941 942 943 944 945 946 947
            // Pass the original packet
            callout_handle->setArgument("query4", release);

            // Pass the lease to be updated
            callout_handle->setArgument("lease4", lease);

            // Call all installed callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
948 949
            HooksManager::callCallouts(Hooks.hook_index_lease4_release_,
                                       *callout_handle);
950 951 952 953 954 955

            // Callouts decided to skip the next processing step. The next
            // processing step would to send the packet, so skip at this
            // stage means "drop response".
            if (callout_handle->getSkip()) {
                skip = true;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
956 957
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS,
                          DHCP4_HOOK_LEASE4_RELEASE_SKIP);
958 959
            }
        }
960

961 962
        // Ok, hw and client-id match - let's release the lease.
        if (!skip) {
963
            bool success = LeaseMgrFactory::instance().deleteLease(lease->addr_);
964 965 966 967 968 969 970 971 972 973 974

            if (success) {
                // Release successful - we're done here
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_RELEASE)
                    .arg(lease->addr_.toText())
                    .arg(client_id ? client_id->toText() : "(no client-id)")
                    .arg(release->getHWAddr()->toText());
            } else {
                // Release failed -
                LOG_ERROR(dhcp4_logger, DHCP4_RELEASE_FAIL)
                    .arg(lease->addr_.toText())
975
                .arg(client_id ? client_id->toText() : "(no client-id)")
976 977
                    .arg(release->getHWAddr()->toText());
            }
978 979 980 981 982 983
        }
    } catch (const isc::Exception& ex) {
        // Rethrow the exception with a bit more data.
        LOG_ERROR(dhcp4_logger, DHCP4_RELEASE_EXCEPTION)
            .arg(ex.what())
            .arg(release->getYiaddr());
984 985
    }

986
}
987

988
void
989
Dhcpv4Srv::processDecline(Pkt4Ptr& /* decline */) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
990
    /// @todo Implement this (also see ticket #3116)
991 992
}

993 994
Pkt4Ptr
Dhcpv4Srv::processInform(Pkt4Ptr& inform) {
995

Tomek Mrugalski's avatar
Tomek Mrugalski committed
996
    /// @todo Implement this for real. (also see ticket #3116)
997 998
    return (inform);
}
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029

const char*
Dhcpv4Srv::serverReceivedPacketName(uint8_t type) {
    static const char* DISCOVER = "DISCOVER";
    static const char* REQUEST = "REQUEST";
    static const char* RELEASE = "RELEASE";
    static const char* DECLINE = "DECLINE";
    static const char* INFORM = "INFORM";
    static const char* UNKNOWN = "UNKNOWN";

    switch (type) {
    case DHCPDISCOVER:
        return (DISCOVER);

    case DHCPREQUEST:
        return (REQUEST);

    case DHCPRELEASE:
        return (RELEASE);

    case DHCPDECLINE:
        return (DECLINE);

    case DHCPINFORM:
        return (INFORM);

    default:
        ;
    }
    return (UNKNOWN);
}
1030

1031 1032
Subnet4Ptr
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& question) {
1033

1034
    Subnet4Ptr subnet;
1035 1036
    // Is this relayed message?
    IOAddress relay = question->getGiaddr();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1037
    static const IOAddress notset("0.0.0.0");
1038

Tomek Mrugalski's avatar
Tomek Mrugalski committed
1039
    if (relay != notset) {
1040
        // Yes: Use relay address to select subnet
1041
        subnet = CfgMgr::instance().getSubnet4(relay);
1042 1043 1044
    } else {

        // No: Use client's address to select subnet
1045
        subnet = CfgMgr::instance().getSubnet4(question->getRemoteAddr());
1046
    }
1047

1048 1049
    /// @todo Implement getSubnet4(interface-name)

Tomek Mrugalski's avatar
Tomek Mrugalski committed
1050
    // Let's execute all callouts registered for subnet4_select
Tomek Mrugalski's avatar
Tomek Mrugalski committed