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 138 139
        // Instantiate LeaseMgr
        LeaseMgrFactory::create(dbconfig);
        LOG_INFO(dhcp4_logger, DHCP4_DB_BACKEND_STARTED)
            .arg(LeaseMgrFactory::instance().getType())
            .arg(LeaseMgrFactory::instance().getName());

        // Instantiate allocation engine
        alloc_engine_.reset(new AllocEngine(AllocEngine::ALLOC_ITERATIVE, 100));

140 141 142 143 144 145 146
        // 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

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

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

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

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

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

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

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

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

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

193 194 195 196 197 198 199 200 201
        // 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
202
        // data; execute callouts registered for buffer4_receive.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
203 204
        if (HooksManager::getHooksManager()
            .calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
205 206 207 208 209 210 211 212 213
            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
214 215
            HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                       *callout_handle);
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231

            // 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
232 233 234
            try {
                query->unpack();
            } catch (const std::exception& e) {
235 236 237
                // Failed to parse the packet.
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL,
                          DHCP4_PACKET_PARSE_FAIL).arg(e.what());
238 239
                continue;
            }
240
        }
241

242 243 244 245 246
        // 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();
247 248 249 250
        } catch (...) {
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_DROP_NO_TYPE)
                .arg(query->getIface());
            continue;
251
        }
252

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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
261
        // Let's execute all callouts registered for pkt4_receive
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
        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;
            }
282

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

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
        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.
                ;
316
            }
317 318 319 320 321 322 323 324 325 326 327 328 329 330
        } 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();
331
                }
332 333 334
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC,
                          DHCP4_PACKET_PROCESS_FAIL)
                    .arg(source).arg(e.what());
335
            }
336
        }
337

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

342
        adjustRemoteAddr(query, rsp);
343

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

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

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

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

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

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

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

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

375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
            // 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
397 398 399
            // Let's execute all callouts registered for buffer4_send
            if (HooksManager::getHooksManager()
                .calloutsPresent(Hooks.hook_index_buffer4_send_)) {
400
                CalloutHandlePtr callout_handle = getCalloutHandle(query);
401

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

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

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

412 413 414 415
                // 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
416 417
                    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS,
                              DHCP4_HOOK_BUFFER_SEND_SKIP);
418
                    continue;
419
                }
420 421

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

            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());
432
        }
433 434 435 436 437
    }

    return (true);
}

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

441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
    // 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
457
        if (!addr.isV4()) {
458 459 460 461 462 463 464 465 466 467
            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);
468 469 470 471 472
    }

    return (true);
}

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

    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;
        }

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

494
        for (Iface::AddressCollection::const_iterator addr = addrs.begin();
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
             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");
}

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

522
string
523
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
    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());
540 541
}

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

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

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

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

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

    // If src/dest HW addresses are used by the packet filtering class
564 565 566 567 568 569
    // 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.
570 571
    HWAddrPtr src_hw_addr = question->getLocalHWAddr();
    if (src_hw_addr) {
572
        answer->setLocalHWAddr(src_hw_addr);
573
    }
574
    HWAddrPtr dst_hw_addr = question->getRemoteHWAddr();
575
    if (dst_hw_addr) {
576
        answer->setRemoteHWAddr(dst_hw_addr);
577
    }
578 579
}

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

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

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

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

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

    // 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;
    }
606

607 608 609 610 611 612 613 614 615
    // 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;
    }
616

617 618 619 620 621 622 623 624 625 626 627 628
    // 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
629
}
630

631 632 633 634 635 636 637 638 639
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 };
640

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
    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
663
}
664

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

    // 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()));
684
        answer->setType(DHCPNAK);
685 686 687
        answer->setYiaddr(IOAddress("0.0.0.0"));
        return;
    }
688

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

692 693 694 695 696 697 698
    // 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
699

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

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

704 705 706 707 708 709
    // "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.
710
    bool fake_allocation = (question->getType() == DHCPDISCOVER);
711

712 713
    CalloutHandlePtr callout_handle = getCalloutHandle(question);

714 715 716 717
    // 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.
718 719
    // @todo pass the actual FQDN data.
    Lease4Ptr old_lease;
720
    Lease4Ptr lease = alloc_engine_->allocateAddress4(subnet, client_id, hwaddr,
721 722 723 724
                                                      hint, false, false, "",
                                                      fake_allocation,
                                                      callout_handle,
                                                      old_lease);
725 726

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

        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)
743 744 745 746 747
        Subnet::OptionDescriptor opt_routers =
            subnet->getOptionDescriptor("dhcp4", DHO_ROUTERS);
        if (opt_routers.option) {
            answer->addOption(opt_routers.option);
        }
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765

        // 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());

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

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
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.
796
    } else if (msg->getYiaddr() != zero_addr) {
797 798 799 800 801 802
        // 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.
803
        const bool bcast_flag = ((question->getFlags() & Pkt4::FLAG_BROADCAST_MASK) != 0);
804 805 806 807 808 809 810
        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 {
811
            msg->setRemoteAddr(msg->getYiaddr());
812 813 814 815 816 817 818 819 820 821 822 823 824

        }

    // 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());

    }
}


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

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

    return (opt);
}

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

    sanityCheck(discover, FORBIDDEN);

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

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

847
    assignLease(discover, offer);
848

849 850 851 852 853
    // 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);

854
    return (offer);
855 856
}

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

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

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

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

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

875 876 877 878 879
    // 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);

880
    return (ack);
881 882
}

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

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

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

896 897 898 899 900 901 902 903 904 905 906 907
    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;
        }
908

909 910 911 912 913 914 915 916 917 918
        // 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;
        }
919

920 921 922 923 924 925 926 927 928
        // 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;
        }
929

930
        bool skip = false;
931

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

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

940 941 942 943 944 945 946
            // 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
947 948
            HooksManager::callCallouts(Hooks.hook_index_lease4_release_,
                                       *callout_handle);
949 950 951 952 953 954

            // 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
955 956
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS,
                          DHCP4_HOOK_LEASE4_RELEASE_SKIP);
957 958
            }
        }
959

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

            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())
974
                .arg(client_id ? client_id->toText() : "(no client-id)")
975 976
                    .arg(release->getHWAddr()->toText());
            }
977 978 979 980 981 982
        }
    } 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());
983 984
    }

985
}
986

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

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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
995
    /// @todo Implement this for real. (also see ticket #3116)
996 997
    return (inform);
}
998 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

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);
}
1029

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

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

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

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

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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
1049
    // Let's execute all callouts registered for subnet4_select
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1050
    if (HooksManager::calloutsPresent(hook_index_subnet4_select_)) {
1051 1052 1053 1054 1055 1056 1057 1058
        CalloutHandlePtr callout_handle = getCalloutHandle(question);

        // We're reusing callout_handle from previous calls
        callout_handle->deleteAllArguments();

        // Set new arguments
        callout_handle->setArgument("query4", question);
        callout_handle->setArgument("subnet4", subnet);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1059 1060
        callout_handle->setArgument("subnet4collection",
                                    CfgMgr::instance().getSubnets4());
1061 1062

        // Call user (and server-side) callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1063 1064
        HooksManager::callCallouts(hook_index_subnet4_select_,
                                   *callout_handle);
1065 1066

        // Callouts decided to skip this step. This means that no subnet will be
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1067 1068
        // selected. Packet processing will continue, but it will be severly
        // limited (i.e. only global options will be assigned)
1069
        if (callout_handle->getSkip()) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1070 1071
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP);
1072 1073 1074 1075 1076
            return (Subnet4Ptr());
        }

        // Use whatever subnet was specified by the callout
        callout_handle->getArgument("subnet4", subnet);
1077
    }
1078 1079

    return (subnet);
1080 1081
}

1082 1083
void
Dhcpv4Srv::sanityCheck(const Pkt4Ptr& pkt, RequirementLevel serverid) {
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
    OptionPtr server_id = pkt->getOption(DHO_DHCP_SERVER_IDENTIFIER);
    switch (serverid) {
    case FORBIDDEN:
        if (server_id) {
            isc_throw(RFCViolation, "Server-id option was not expected, but "
                      << "received in " << serverReceivedPacketName(pkt->getType()));
        }
        break;

    case MANDATORY:
        if (!server_id) {
            isc_throw(RFCViolation, "Server-id option was expected, but not "
                      " received in message "
                      << serverReceivedPacketName(pkt->getType()));
        }
        break;

    case OPTIONAL:
        // do nothing here
        ;
    }
1105 1106

    // If there is HWAddress set and it is non-empty, then we're good
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1107
    if (pkt->getHWAddr()