dhcp4_srv.cc 69.6 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
#include <dhcp/option_vendor.h>
24
#include <dhcp/pkt4.h>
25
#include <dhcp/docsis3_option_defs.h>
26 27
#include <dhcp4/dhcp4_log.h>
#include <dhcp4/dhcp4_srv.h>
28 29
#include <dhcpsrv/addr_utilities.h>
#include <dhcpsrv/callout_handle_store.h>
30 31 32 33 34
#include <dhcpsrv/cfgmgr.h>
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
#include <dhcpsrv/subnet.h>
#include <dhcpsrv/utils.h>
35
#include <dhcpsrv/utils.h>
36
#include <hooks/callout_handle.h>
37
#include <hooks/hooks_manager.h>
38
#include <util/strutil.h>
39

40
#include <boost/algorithm/string/erase.hpp>
41
#include <boost/bind.hpp>
42
#include <boost/foreach.hpp>
43 44 45 46

#include <iomanip>
#include <fstream>

47 48
using namespace isc;
using namespace isc::asiolink;
49
using namespace isc::dhcp;
50
using namespace isc::dhcp_ddns;
51
using namespace isc::hooks;
52 53
using namespace isc::log;
using namespace std;
54

55
/// Structure that holds registered hook indexes
56 57
struct Dhcp4Hooks {
    int hook_index_buffer4_receive_;///< index for "buffer4_receive" hook point
58 59
    int hook_index_pkt4_receive_;   ///< index for "pkt4_receive" hook point
    int hook_index_subnet4_select_; ///< index for "subnet4_select" hook point
60
    int hook_index_lease4_release_; ///< index for "lease4_release" hook point
61
    int hook_index_pkt4_send_;      ///< index for "pkt4_send" hook point
62
    int hook_index_buffer4_send_;   ///< index for "buffer4_send" hook point
63

64 65 66
    /// Constructor that registers hook points for DHCPv4 engine
    Dhcp4Hooks() {
        hook_index_buffer4_receive_= HooksManager::registerHook("buffer4_receive");
67 68 69
        hook_index_pkt4_receive_   = HooksManager::registerHook("pkt4_receive");
        hook_index_subnet4_select_ = HooksManager::registerHook("subnet4_select");
        hook_index_pkt4_send_      = HooksManager::registerHook("pkt4_send");
70 71
        hook_index_lease4_release_ = HooksManager::registerHook("lease4_release");
        hook_index_buffer4_send_   = HooksManager::registerHook("buffer4_send");
72 73 74 75 76 77 78
    }
};

// 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.
79
Dhcp4Hooks Hooks;
80

81 82 83
namespace isc {
namespace dhcp {

84 85
namespace {

86
// @todo The following constants describe server's behavior with respect to the
87 88 89
// DHCPv4 Client FQDN Option sent by a client. They will be removed
// when DDNS parameters for DHCPv4 are implemented with the ticket #3033.

90 91 92 93 94
// @todo Additional configuration parameter which we may consider is the one
// that controls whether the DHCP server sends the removal NameChangeRequest
// if it discovers that the entry for the particular client exists or that
// it always updates the DNS.

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
// Should server always include the FQDN option in its response, regardless
// if it has been requested in Parameter Request List Option (Disabled).
const bool FQDN_ALWAYS_INCLUDE = false;
// Enable A RR update delegation to the client (Disabled).
const bool FQDN_ALLOW_CLIENT_UPDATE = false;
// Globally enable updates (Enabled).
const bool FQDN_ENABLE_UPDATE = true;
// Do update, even if client requested no updates with N flag (Disabled).
const bool FQDN_OVERRIDE_NO_UPDATE = false;
// Server performs an update when client requested delegation (Enabled).
const bool FQDN_OVERRIDE_CLIENT_UPDATE = true;
// The fully qualified domain-name suffix if partial name provided by
// a client.
const char* FQDN_PARTIAL_SUFFIX = "example.com";
// Should server replace the domain-name supplied by the client (Disabled).
const bool FQDN_REPLACE_CLIENT_NAME = false;

}

114 115 116 117 118 119 120 121 122
/// @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";

123 124 125
// These are hardcoded parameters. Currently this is a skeleton server that only
// grants those options and a single, fixed, hardcoded lease.

126
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const char* dbconfig, const bool use_bcast,
127
                     const bool direct_response_desired)
128 129
: serverid_(), shutdown_(true), alloc_engine_(), port_(port),
    use_bcast_(use_bcast), hook_index_pkt4_receive_(-1),
130 131
    hook_index_subnet4_select_(-1), hook_index_pkt4_send_(-1) {

132
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
133
    try {
134 135 136 137
        // Open sockets only if port is non-zero. Port 0 is used for testing
        // purposes in two cases:
        // - when non-socket related testing is performed
        // - when the particular test supplies its own packet filtering class.
138
        if (port) {
139 140 141 142 143 144 145 146 147
            // First call to instance() will create IfaceMgr (it's a singleton)
            // it may throw something if things go wrong.
            // The 'true' value of the call to setMatchingPacketFilter imposes
            // 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.
            IfaceMgr::instance().setMatchingPacketFilter(direct_response_desired);

148 149 150 151 152 153
            // Create error handler. This handler will be called every time
            // the socket opening operation fails. We use this handler to
            // log a warning.
            isc::dhcp::IfaceMgrErrorMsgCallback error_handler =
                boost::bind(&Dhcpv4Srv::ifaceMgrSocket4ErrorHandler, _1);
            IfaceMgr::instance().openSockets4(port_, use_bcast_, error_handler);
154
        }
155

156 157 158
        string srvid_file = CfgMgr::instance().getDataDir() + "/" + string(SERVER_ID_FILE);
        if (loadServerID(srvid_file)) {
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_SERVERID_LOADED)
159
                .arg(srvidToString(getServerID()))
160 161 162 163 164 165 166 167 168 169 170 171 172
                .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);
            }

        }
173

174 175 176 177 178 179 180
        // Instantiate LeaseMgr
        LeaseMgrFactory::create(dbconfig);
        LOG_INFO(dhcp4_logger, DHCP4_DB_BACKEND_STARTED)
            .arg(LeaseMgrFactory::instance().getType())
            .arg(LeaseMgrFactory::instance().getName());

        // Instantiate allocation engine
181 182
        alloc_engine_.reset(new AllocEngine(AllocEngine::ALLOC_ITERATIVE, 100,
                                            false /* false = IPv4 */));
183

184 185 186 187 188 189 190
        // 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

191
    } catch (const std::exception &e) {
192
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
193 194 195
        shutdown_ = true;
        return;
    }
196

Tomek Mrugalski's avatar
Tomek Mrugalski committed
197
    shutdown_ = false;
198 199 200
}

Dhcpv4Srv::~Dhcpv4Srv() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
201
    IfaceMgr::instance().closeSockets();
202 203
}

204 205
void
Dhcpv4Srv::shutdown() {
206
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
207 208 209
    shutdown_ = true;
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
210 211
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
212 213 214
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
215 216
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
217 218 219
    IfaceMgr::instance().send(packet);
}

220 221
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
222
    while (!shutdown_) {
223
        /// @todo: calculate actual timeout once we have lease database
224 225
        //cppcheck-suppress variableScope This is temporary anyway
        const int timeout = 1000;
226

Tomek Mrugalski's avatar
Tomek Mrugalski committed
227
        // client's message and server's response
228
        Pkt4Ptr query;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
229
        Pkt4Ptr rsp;
230

231
        try {
232
            query = receivePacket(timeout);
233 234 235 236
        } catch (const std::exception& e) {
            LOG_ERROR(dhcp4_logger, DHCP4_PACKET_RECEIVE_FAIL).arg(e.what());
        }

237 238 239 240 241 242
        // Timeout may be reached or signal received, which breaks select()
        // with no reception ocurred
        if (!query) {
            continue;
        }

243 244 245 246 247 248 249 250 251
        // In order to parse the DHCP options, the server needs to use some
        // configuration information such as: existing option spaces, option
        // definitions etc. This is the kind of information which is not
        // available in the libdhcp, so we need to supply our own implementation
        // of the option parsing function here, which would rely on the
        // configuration data.
        query->setCallback(boost::bind(&Dhcpv4Srv::unpackOptions, this,
                                       _1, _2, _3));

252 253 254
        bool skip_unpack = false;

        // The packet has just been received so contains the uninterpreted wire
255
        // data; execute callouts registered for buffer4_receive.
256
        if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
257 258 259 260 261 262 263 264 265
            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
266 267
            HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                       *callout_handle);
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283

            // 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
284 285 286
            try {
                query->unpack();
            } catch (const std::exception& e) {
287 288 289
                // Failed to parse the packet.
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL,
                          DHCP4_PACKET_PARSE_FAIL).arg(e.what());
290 291
                continue;
            }
292
        }
293

294 295 296 297 298
        // 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();
299 300 301 302
        } catch (...) {
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_DROP_NO_TYPE)
                .arg(query->getIface());
            continue;
303
        }
304

305
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_RECEIVED)
306
            .arg(serverReceivedPacketName(type))
307
            .arg(type)
308 309
            .arg(query->getIface());
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
310
            .arg(type)
311 312
            .arg(query->toText());

Tomek Mrugalski's avatar
Tomek Mrugalski committed
313
        // Let's execute all callouts registered for pkt4_receive
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
        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;
            }
334

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

338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
        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.
                ;
368
            }
369 370 371 372 373 374 375 376 377 378 379 380 381 382
        } 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();
383
                }
384 385 386
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC,
                          DHCP4_PACKET_PROCESS_FAIL)
                    .arg(source).arg(e.what());
387
            }
388
        }
389

390 391 392
        if (!rsp) {
            continue;
        }
393

394 395
        // Specifies if server should do the packing
        bool skip_pack = false;
396

Tomek Mrugalski's avatar
Tomek Mrugalski committed
397
        // Execute all callouts registered for pkt4_send
398 399
        if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
            CalloutHandlePtr callout_handle = getCalloutHandle(query);
400

401 402
            // Delete all previous arguments
            callout_handle->deleteAllArguments();
403

404 405
            // Clear skip flag if it was set in previous callouts
            callout_handle->setSkip(false);
406

407 408
            // Set our response
            callout_handle->setArgument("response4", rsp);
409

410 411 412
            // Call all installed callouts
            HooksManager::callCallouts(hook_index_pkt4_send_,
                                       *callout_handle);
413

414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
            // 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
436
            // Let's execute all callouts registered for buffer4_send
437
            if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_send_)) {
438
                CalloutHandlePtr callout_handle = getCalloutHandle(query);
439

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

443 444
                // Pass incoming packet as argument
                callout_handle->setArgument("response4", rsp);
445

446
                // Call callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
447 448
                HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
                                           *callout_handle);
449

450 451 452 453
                // 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
454 455
                    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS,
                              DHCP4_HOOK_BUFFER_SEND_SKIP);
456
                    continue;
457
                }
458 459

                callout_handle->getArgument("response4", rsp);
460
            }
461 462 463 464 465 466 467 468 469

            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());
470
        }
471 472 473

        // Send NameChangeRequests to the b10-dhcp_ddns module.
        sendNameChangeRequests();
474 475 476 477 478
    }

    return (true);
}

479 480
bool
Dhcpv4Srv::loadServerID(const std::string& file_name) {
481

482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
    // 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
498
        if (!addr.isV4()) {
499 500 501 502 503 504 505 506 507 508
            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);
509 510 511 512 513
    }

    return (true);
}

514 515
void
Dhcpv4Srv::generateServerID() {
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532

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

533
        const Iface::AddressCollection addrs = iface->getAddresses();
534

535
        for (Iface::AddressCollection::const_iterator addr = addrs.begin();
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
             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");
}

552 553
bool
Dhcpv4Srv::writeServerID(const std::string& file_name) {
554 555 556 557 558 559
    fstream f(file_name.c_str(), ios::out | ios::trunc);
    if (!f.good()) {
        return (false);
    }
    f << srvidToString(getServerID());
    f.close();
560
    return (true);
561 562
}

563
string
564
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
    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());
581 582
}

583
isc::dhcp_ddns::D2Dhcid
584 585 586 587 588 589 590 591 592
Dhcpv4Srv::computeDhcid(const Lease4Ptr& lease) {
    if (!lease) {
        isc_throw(DhcidComputeError, "a pointer to the lease must be not"
                  " NULL to compute DHCID");

    } else if (lease->hostname_.empty()) {
        isc_throw(DhcidComputeError, "unable to compute the DHCID for the"
                  " lease which has empty hostname set");

593 594
    }

595 596 597 598 599 600 601 602 603
    // In order to compute DHCID the client's hostname must be encoded in
    // canonical wire format. It is unlikely that the FQDN is malformed
    // because it is validated by the classes which encapsulate options
    // carrying client FQDN. However, if the client name was carried in the
    // Hostname option it is more likely as it carries the hostname as a
    // regular string.
    std::vector<uint8_t> fqdn_wire;
    try {
        OptionDataTypeUtil::writeFqdn(lease->hostname_, fqdn_wire, true);
604

605 606 607
    } catch (const Exception& ex) {
        isc_throw(DhcidComputeError, "unable to compute DHCID because the"
                  " hostname: " << lease->hostname_ << " is invalid");
608 609

    }
610 611 612

    // Prefer client id to HW address to compute DHCID. If Client Id is
    // NULL, use HW address.
613
    try {
614 615 616 617 618 619 620
        if (lease->client_id_) {
            return (D2Dhcid(lease->client_id_->getClientId(), fqdn_wire));

        } else {
            HWAddrPtr hwaddr(new HWAddr(lease->hwaddr_, HTYPE_ETHER));
            return (D2Dhcid(hwaddr, fqdn_wire));
        }
621
    } catch (const Exception& ex) {
622 623
        isc_throw(DhcidComputeError, "unable to compute DHCID: "
                  << ex.what());
624

625
    }
626 627 628

}

629 630
void
Dhcpv4Srv::copyDefaultFields(const Pkt4Ptr& question, Pkt4Ptr& answer) {
631 632 633
    answer->setIface(question->getIface());
    answer->setIndex(question->getIndex());
    answer->setCiaddr(question->getCiaddr());
634

635
    answer->setSiaddr(IOAddress("0.0.0.0")); // explicitly set this to 0
636
    answer->setHops(question->getHops());
637 638

    // copy MAC address
639
    answer->setHWAddr(question->getHWAddr());
640 641

    // relay address
642 643
    answer->setGiaddr(question->getGiaddr());

644
    // Let's copy client-id to response. See RFC6842.
645 646 647 648
    OptionPtr client_id = question->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (client_id) {
        answer->addOption(client_id);
    }
649 650

    // If src/dest HW addresses are used by the packet filtering class
651 652 653 654 655 656
    // 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.
657 658
    HWAddrPtr src_hw_addr = question->getLocalHWAddr();
    if (src_hw_addr) {
659
        answer->setLocalHWAddr(src_hw_addr);
660
    }
661
    HWAddrPtr dst_hw_addr = question->getRemoteHWAddr();
662
    if (dst_hw_addr) {
663
        answer->setRemoteHWAddr(dst_hw_addr);
664
    }
665 666 667 668 669 670

    // If this packet is relayed, we want to copy Relay Agent Info option
    OptionPtr rai = question->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
        answer->addOption(rai);
    }
671 672
}

673 674
void
Dhcpv4Srv::appendDefaultOptions(Pkt4Ptr& msg, uint8_t msg_type) {
675
    OptionPtr opt;
676 677

    // add Message Type Option (type 53)
678
    msg->setType(msg_type);
679 680 681 682

    // more options will be added here later
}

683 684 685 686 687 688 689 690 691 692 693 694
void
Dhcpv4Srv::appendServerID(const Pkt4Ptr& response) {
    // The source address for the outbound message should have been set already.
    // This is the address that to the best of the server's knowledge will be
    // available from the client.
    // @todo: perhaps we should consider some more sophisticated server id
    // generation, but for the current use cases, it should be ok.
    response->addOption(OptionPtr(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                                     response->getLocalAddr()))
                        );
}

695 696
void
Dhcpv4Srv::appendRequestedOptions(const Pkt4Ptr& question, Pkt4Ptr& msg) {
697 698 699 700 701 702 703 704 705 706 707

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

709 710 711 712 713 714 715 716 717
    // 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;
    }
718

719 720 721 722 723 724
    // 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) {
725 726 727 728 729 730
        if (!msg->getOption(*opt)) {
            Subnet::OptionDescriptor desc =
                subnet->getOptionDescriptor("dhcp4", *opt);
            if (desc.option && !msg->getOption(*opt)) {
                msg->addOption(desc.option);
            }
731 732
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
733
}
734

735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
void
Dhcpv4Srv::appendRequestedVendorOptions(const Pkt4Ptr& question, Pkt4Ptr& answer) {
    // Get the configured subnet suitable for the incoming packet.
    Subnet4Ptr subnet = selectSubnet(question);
    // Leave if there is no subnet matching the incoming packet.
    // There is no need to log the error message here because
    // it will be logged in the assignLease() when it fails to
    // pick the suitable subnet. We don't want to duplicate
    // error messages in such case.
    if (!subnet) {
        return;
    }

    // Try to get the vendor option
    boost::shared_ptr<OptionVendor> vendor_req =
        boost::dynamic_pointer_cast<OptionVendor>(question->getOption(DHO_VIVSO_SUBOPTIONS));
    if (!vendor_req) {
        return;
    }

    uint32_t vendor_id = vendor_req->getVendorId();

    // Let's try to get ORO within that vendor-option
    /// @todo This is very specific to vendor-id=4491 (Cable Labs). Other vendors
    /// may have different policies.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
760 761
    OptionUint8ArrayPtr oro =
        boost::dynamic_pointer_cast<OptionUint8Array>(vendor_req->getOption(DOCSIS3_V4_ORO));
762 763 764 765 766 767 768 769 770 771

    // Option ORO not found. Don't do anything then.
    if (!oro) {
        return;
    }

    boost::shared_ptr<OptionVendor> vendor_rsp(new OptionVendor(Option::V4, vendor_id));

    // Get the list of options that client requested.
    bool added = false;
772
    const std::vector<uint8_t>& requested_opts = oro->getValues();
773

Tomek Mrugalski's avatar
Tomek Mrugalski committed
774
    for (std::vector<uint8_t>::const_iterator code = requested_opts.begin();
775
         code != requested_opts.end(); ++code) {
776 777 778 779 780 781 782
        if  (!vendor_rsp->getOption(*code)) {
            Subnet::OptionDescriptor desc = subnet->getVendorOptionDescriptor(vendor_id,
                                                                              *code);
            if (desc.option) {
                vendor_rsp->addOption(desc.option);
                added = true;
            }
783 784
        }

785 786
        if (added) {
            answer->addOption(vendor_rsp);
787 788
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
789
}
790

791

792 793 794 795 796 797 798 799
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_ROUTERS,
        DHO_DOMAIN_NAME_SERVERS,
        DHO_DOMAIN_NAME };
800

801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
    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
823
}
824

825 826 827 828 829
void
Dhcpv4Srv::processClientName(const Pkt4Ptr& query, Pkt4Ptr& answer) {
    // It is possible that client has sent both Client FQDN and Hostname
    // option. In such case, server should prefer Client FQDN option and
    // ignore the Hostname option.
830 831 832 833 834 835 836 837 838 839 840 841
    try {
        Option4ClientFqdnPtr fqdn = boost::dynamic_pointer_cast<Option4ClientFqdn>
            (query->getOption(DHO_FQDN));
        if (fqdn) {
            processClientFqdnOption(fqdn, answer);

        } else {
            OptionCustomPtr hostname = boost::dynamic_pointer_cast<OptionCustom>
                (query->getOption(DHO_HOST_NAME));
            if (hostname) {
                processHostnameOption(hostname, answer);
            }
842

843 844 845 846 847 848 849 850 851 852 853 854
        }
    } catch (const Exception& ex) {
        // In some rare cases it is possible that the client's name processing
        // fails. For example, the Hostname option may be malformed, or there
        // may be an error in the server's logic which would cause multiple
        // attempts to add the same option to the response message. This
        // error message aggregates all these errors so they can be diagnosed
        // from the log. We don't want to throw an exception here because,
        // it will impact the processing of the whole packet. We rather want
        // the processing to continue, even if the client's name is wrong.
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_CLIENT_NAME_PROC_FAIL)
            .arg(ex.what());
855 856 857 858
    }
}

void
859 860 861 862 863 864 865 866 867 868 869
Dhcpv4Srv::processClientFqdnOption(const Option4ClientFqdnPtr& fqdn,
                                   Pkt4Ptr& answer) {
    // Create the DHCPv4 Client FQDN Option to be included in the server's
    // response to a client.
    Option4ClientFqdnPtr fqdn_resp(new Option4ClientFqdn(*fqdn));

    // RFC4702, section 4 - set 'NOS' flags to 0.
    fqdn_resp->setFlag(Option4ClientFqdn::FLAG_S, 0);
    fqdn_resp->setFlag(Option4ClientFqdn::FLAG_O, 0);
    fqdn_resp->setFlag(Option4ClientFqdn::FLAG_N, 0);

870 871 872 873
    // Conditions when N flag has to be set to indicate that server will not
    // perform DNS updates:
    // 1. Updates are globally disabled,
    // 2. Client requested no update and server respects it,
874 875 876 877
    // 3. Client requested that the forward DNS update is delegated to the
    //    client but server neither respects requests for forward update
    //    delegation nor it is configured to send update on its own when
    //    client requested delegation.
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
    if (!FQDN_ENABLE_UPDATE ||
        (fqdn->getFlag(Option4ClientFqdn::FLAG_N) &&
         !FQDN_OVERRIDE_NO_UPDATE) ||
        (!fqdn->getFlag(Option4ClientFqdn::FLAG_S) &&
         !FQDN_ALLOW_CLIENT_UPDATE && !FQDN_OVERRIDE_CLIENT_UPDATE)) {
        fqdn_resp->setFlag(Option4ClientFqdn::FLAG_N, true);

    // Conditions when S flag is set to indicate that server will perform DNS
    // update on its own:
    // 1. Client requested that server performs DNS update and DNS updates are
    //    globally enabled.
    // 2. Client requested that server delegates forward update to the client
    //    but server doesn't respect requests for delegation and it is
    // configured to perform an update on its own when client requested the
    // delegation.
    } else  if (fqdn->getFlag(Option4ClientFqdn::FLAG_S) ||
                (!fqdn->getFlag(Option4ClientFqdn::FLAG_S) &&
                 !FQDN_ALLOW_CLIENT_UPDATE && FQDN_OVERRIDE_CLIENT_UPDATE)) {
        fqdn_resp->setFlag(Option4ClientFqdn::FLAG_S, true);
    }

    // Server MUST set the O flag if it has overriden the client's setting
    // of S flag.
    if (fqdn->getFlag(Option4ClientFqdn::FLAG_S) !=
        fqdn_resp->getFlag(Option4ClientFqdn::FLAG_S)) {
        fqdn_resp->setFlag(Option4ClientFqdn::FLAG_O, true);
    }

    // If client suppled partial or empty domain-name, server should generate
    // one.
    if (fqdn->getDomainNameType() == Option4ClientFqdn::PARTIAL) {
        std::ostringstream name;
910
        if (fqdn->getDomainName().empty() || FQDN_REPLACE_CLIENT_NAME) {
911 912
            fqdn_resp->setDomainName("", Option4ClientFqdn::PARTIAL);

913 914
        } else {
            name << fqdn->getDomainName();
915 916 917
            name << "." << FQDN_PARTIAL_SUFFIX;
            fqdn_resp->setDomainName(name.str(), Option4ClientFqdn::FULL);

918 919 920
        }

    // Server may be configured to replace a name supplied by a client, even if
921 922 923
    // client supplied fully qualified domain-name. The empty domain-name is
    // is set to indicate that the name must be generated when the new lease
    // is acquired.
924
    } else if(FQDN_REPLACE_CLIENT_NAME) {
925
        fqdn_resp->setDomainName("", Option4ClientFqdn::PARTIAL);
926 927 928 929 930 931 932 933 934 935 936 937 938 939
    }

    // Add FQDN option to the response message. Note that, there may be some
    // cases when server may choose not to include the FQDN option in a
    // response to a client. In such cases, the FQDN should be removed from the
    // outgoing message. In theory we could cease to include the FQDN option
    // in this function until it is confirmed that it should be included.
    // However, we include it here for simplicity. Functions used to acquire
    // lease for a client will scan the response message for FQDN and if it
    // is found they will take necessary actions to store the FQDN information
    // in the lease database as well as to generate NameChangeRequests to DNS.
    // If we don't store the option in the reponse message, we will have to
    // propagate it in the different way to the functions which acquire the
    // lease. This would require modifications to the API of this class.
940
    answer->addOption(fqdn_resp);
941 942 943
}

void
944 945
Dhcpv4Srv::processHostnameOption(const OptionCustomPtr& opt_hostname,
                                 Pkt4Ptr& answer) {
946
    // Do nothing if the DNS updates are disabled.
947 948 949 950
    if (!FQDN_ENABLE_UPDATE) {
        return;
    }

951
    std::string hostname = isc::util::str::trim(opt_hostname->readString());
952
    unsigned int label_count = OptionDataTypeUtil::getLabelCount(hostname);
953 954 955 956 957 958
    // The hostname option sent by the client should be at least 1 octet long.
    // If it isn't we ignore this option.
    if (label_count == 0) {
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_EMPTY_HOSTNAME);
        return;
    }
959 960 961 962 963 964 965 966 967 968 969 970 971
    // Copy construct the hostname provided by the client. It is entirely
    // possible that we will use the hostname option provided by the client
    // to perform the DNS update and we will send the same option to him to
    // indicate that we accepted this hostname.
    OptionCustomPtr opt_hostname_resp(new OptionCustom(*opt_hostname));

    // The hostname option may be unqualified or fully qualified. The lab_count
    // holds the number of labels for the name. The number of 1 means that
    // there is only root label "." (even for unqualified names, as the
    // getLabelCount function treats each name as a fully qualified one).
    // By checking the number of labels present in the hostname we may infer
    // whether client has sent the fully qualified or unqualified hostname.

972 973 974 975 976 977
    // @todo We may want to reconsider whether it is appropriate for the
    // client to send a root domain name as a Hostname. There are
    // also extensions to the auto generation of the client's name,
    // e.g. conversion to the puny code which may be considered at some point.
    // For now, we just remain liberal and expect that the DNS will handle
    // conversion if needed and possible.
978
    if (FQDN_REPLACE_CLIENT_NAME || (label_count < 2)) {
979
        opt_hostname_resp->writeString("");
980 981 982 983 984 985 986 987 988 989
    // If there are two labels, it means that the client has specified
    // the unqualified name. We have to concatenate the unqalified name
    // with the domain name.
    } else if (label_count == 2) {
        std::ostringstream resp_hostname;
        resp_hostname << hostname << "." << FQDN_PARTIAL_SUFFIX << ".";
        opt_hostname_resp->writeString(resp_hostname.str());
    }

    answer->addOption(opt_hostname_resp);
990 991
}

992 993
void
Dhcpv4Srv::createNameChangeRequests(const Lease4Ptr& lease,
994
                                    const Lease4Ptr& old_lease) {
995 996 997 998 999
    if (!lease) {
        isc_throw(isc::Unexpected,
                  "NULL lease specified when creating NameChangeRequest");
    }

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
    // If old lease is not NULL, it is an indication that the lease has
    // just been renewed. In such case we may need to generate the
    // additional NameChangeRequest to remove an existing entry before
    // we create a NameChangeRequest to add the entry for an updated lease.
    // We may also decide not to generate any requests at all. This is when
    // we discover that nothing has changed in the client's FQDN data.
    if (old_lease) {
        if (!lease->matches(*old_lease)) {
            isc_throw(isc::Unexpected,
                      "there is no match between the current instance of the"
                      " lease: " << lease->toText() << ", and the previous"
                      " instance: " << lease->toText());
        } else {
            // There will be a NameChangeRequest generated to remove existing
            // DNS entries if the following conditions are met:
            // - The hostname is set for the existing lease, we can't generate
            //   removal request for non-existent hostname.
            // - A server has performed reverse, forward or both updates.
            // - FQDN data between the new and old lease do not match.
1019
            if  ((lease->hostname_ != old_lease->hostname_) ||
1020
                 (lease->fqdn_fwd_ != old_lease->fqdn_fwd_) ||
1021 1022 1023
                 (lease->fqdn_rev_ != old_lease->fqdn_rev_)) {
                queueNameChangeRequest(isc::dhcp_ddns::CHG_REMOVE,
                                       old_lease);
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034

            // If FQDN data from both leases match, there is no need to update.
            } else if ((lease->hostname_ == old_lease->hostname_) &&
                       (lease->fqdn_fwd_ == old_lease->fqdn_fwd_) &&
                       (lease->fqdn_rev_ == old_lease->fqdn_rev_)) {
                return;
            }

        }
    }

1035 1036 1037 1038
    // We may need to generate the NameChangeRequest for the new lease. It
    // will be generated only if hostname is set and if forward or reverse
    // update has been requested.
    queueNameChangeRequest(isc::dhcp_ddns::CHG_ADD, lease);
1039 1040
}

1041 1042
void
Dhcpv4Srv::
1043 1044 1045 1046 1047 1048 1049 1050
queueNameChangeRequest(const isc::dhcp_ddns::NameChangeType chg_type,
                       const Lease4Ptr& lease) {
    // The hostname must not be empty, and at least one type of update
    // should be requested.
    if (!lease || lease->hostname_.empty() ||
        (!lease->fqdn_rev_ && !lease->fqdn_fwd_)) {
        return;
    }
1051 1052

    // Create the DHCID for the NameChangeRequest.
1053 1054 1055 1056 1057 1058 1059 1060 1061
    D2Dhcid dhcid;
    try {
        dhcid  = computeDhcid(lease);
    } catch (const DhcidComputeError& ex) {
        LOG_ERROR(dhcp4_logger, DHCP4_DHCID_COMPUTE_ERROR)
            .arg(lease->toText())
            .arg(ex.what());
        return;
    }
1062
    // Create NameChangeRequest
1063 1064
    NameChangeRequest ncr(chg_type, lease->fqdn_fwd_, lease->fqdn_rev_,
                          lease->hostname_, lease->addr_.toText(),
1065 1066
                          dhcid, lease->cltt_ + lease->valid_lft_,
                          lease->valid_lft_);
1067 1068 1069 1070
    // And queue it.
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUEUE_NCR)
        .arg(chg_type == CHG_ADD ? "add" : "remove")
        .arg(ncr.toText());
1071 1072 1073
    name_change_reqs_.push(ncr);
}

1074 1075 1076 1077 1078 1079 1080 1081 1082
void
Dhcpv4Srv::sendNameChangeRequests() {
    while (!name_change_reqs_.empty()) {
        // @todo Once next NameChangeRequest is picked from the queue
        // we should send it to the b10-dhcp_ddns module. Currently we
        // just drop it.
        name_change_reqs_.pop();
    }
}
1083

1084 1085
void
Dhcpv4Srv::assignLease(const Pkt4Ptr& question, Pkt4Ptr& answer) {
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102

    // 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()));
1103
        answer->setType(DHCPNAK);
1104 1105 1106
        answer->setYiaddr(IOAddress("0.0.0.0"));
        return;
    }
1107

1108 1109 1110 1111 1112 1113 1114
    // Set up siaddr. Perhaps assignLease is not the best place to call this
    // as siaddr has nothing to do with a lease, but otherwise we would have
    // to select subnet twice (performance hit) or update too many functions
    // at once.
    // @todo: move subnet selection to a common code
    answer->setSiaddr(subnet->getSiaddr());

1115 1116 1117
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_SELECTED)
        .arg(subnet->toText());