dhcp4_srv.cc 85 KB
Newer Older
1
// Copyright (C) 2011-2015 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/option_string.h>
25
#include <dhcp/pkt4.h>
26
#include <dhcp/docsis3_option_defs.h>
27 28
#include <dhcp4/dhcp4_log.h>
#include <dhcp4/dhcp4_srv.h>
29 30
#include <dhcpsrv/addr_utilities.h>
#include <dhcpsrv/callout_handle_store.h>
31
#include <dhcpsrv/cfgmgr.h>
32
#include <dhcpsrv/cfg_subnets4.h>
33 34 35
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
#include <dhcpsrv/subnet.h>
36
#include <dhcpsrv/subnet_selector.h>
37
#include <dhcpsrv/utils.h>
38
#include <dhcpsrv/utils.h>
39
#include <hooks/callout_handle.h>
40
#include <hooks/hooks_manager.h>
41
#include <util/strutil.h>
42

43
#include <asio.hpp>
44
#include <boost/bind.hpp>
45
#include <boost/foreach.hpp>
46
#include <boost/shared_ptr.hpp>
47 48 49

#include <iomanip>

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

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

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

// 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.
82
Dhcp4Hooks Hooks;
83

84 85
namespace isc {
namespace dhcp {
86

87
Dhcpv4Exchange::Dhcpv4Exchange(const AllocEnginePtr& alloc_engine,
88 89
                               const Pkt4Ptr& query,
                               const Subnet4Ptr& subnet)
90 91
    : alloc_engine_(alloc_engine), query_(query), resp_(),
      context_(new AllocEngine::ClientContext4()) {
92

93 94 95 96 97 98 99 100
    if (!alloc_engine_) {
        isc_throw(BadValue, "alloc_engine value must not be NULL"
                  " when creating an instance of the Dhcpv4Exchange");
    }

    if (!query_) {
        isc_throw(BadValue, "query value must not be NULL when"
                  " creating an instance of the Dhcpv4Exchange");
101 102
    }

103 104 105
    // Create response message.
    initResponse();
    // Select subnet for the query message.
106
    context_->subnet_ = subnet;
107
    // Hardware address.
108
    context_->hwaddr_ = query->getHWAddr();
109 110 111
    // Client Identifier
    OptionPtr opt_clientid = query->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (opt_clientid) {
112
        context_->clientid_.reset(new ClientId(opt_clientid->getData()));
113 114
    }
    // Check for static reservations.
115
    alloc_engine->findReservation(*context_);
116 117
};

118
void
119
Dhcpv4Exchange::initResponse() {
120 121 122 123 124 125 126 127 128 129 130 131
    uint8_t resp_type = 0;
    switch (getQuery()->getType()) {
    case DHCPDISCOVER:
        resp_type = DHCPOFFER;
        break;
    case DHCPREQUEST:
    case DHCPINFORM:
        resp_type = DHCPACK;
        break;
    default:
        ;
    }
132
    // Only create a response if one is required.
133 134
    if (resp_type > 0) {
        resp_.reset(new Pkt4(resp_type, getQuery()->getTransid()));
135 136 137 138 139 140 141 142 143
        copyDefaultFields();
    }
}

void
Dhcpv4Exchange::copyDefaultFields() {
    resp_->setIface(query_->getIface());
    resp_->setIndex(query_->getIndex());

144 145
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
    // ciaddr is always 0, except for the Renew/Rebind state when it may
    // be set to the ciaddr sent by the client.
    resp_->setCiaddr(IOAddress::IPV4_ZERO_ADDRESS());
    resp_->setHops(query_->getHops());

    // copy MAC address
    resp_->setHWAddr(query_->getHWAddr());

    // relay address
    resp_->setGiaddr(query_->getGiaddr());

    // Let's copy client-id to response. See RFC6842.
    // It is possible to disable RFC6842 to keep backward compatibility
    bool echo = CfgMgr::instance().echoClientId();
    OptionPtr client_id = query_->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (client_id && echo) {
        resp_->addOption(client_id);
    }

    // If src/dest HW addresses are used by the packet filtering class
    // 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.
    HWAddrPtr src_hw_addr = query_->getLocalHWAddr();
    if (src_hw_addr) {
        resp_->setLocalHWAddr(src_hw_addr);
    }
    HWAddrPtr dst_hw_addr = query_->getRemoteHWAddr();
    if (dst_hw_addr) {
        resp_->setRemoteHWAddr(dst_hw_addr);
    }

    // If this packet is relayed, we want to copy Relay Agent Info option
    OptionPtr rai = query_->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
        resp_->addOption(rai);
185 186 187
    }
}

188 189
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

190
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
191
                     const bool direct_response_desired)
192 193 194
    : shutdown_(true), alloc_engine_(), port_(port),
      use_bcast_(use_bcast), hook_index_pkt4_receive_(-1),
      hook_index_subnet4_select_(-1), hook_index_pkt4_send_(-1) {
195

196
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
197
    try {
198 199 200
        // Port 0 is used for testing purposes where we don't open broadcast
        // capable sockets. So, set the packet filter handling direct traffic
        // only if we are in non-test mode.
201
        if (port) {
202 203 204 205 206 207 208 209
            // 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);
210
        }
211

212
        // Instantiate allocation engine
213 214
        alloc_engine_.reset(new AllocEngine(AllocEngine::ALLOC_ITERATIVE, 100,
                                            false /* false = IPv4 */));
215

216 217 218 219 220 221 222
        // 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

223
    } catch (const std::exception &e) {
224
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
225 226 227
        shutdown_ = true;
        return;
    }
228

Tomek Mrugalski's avatar
Tomek Mrugalski committed
229
    shutdown_ = false;
230 231 232
}

Dhcpv4Srv::~Dhcpv4Srv() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
233
    IfaceMgr::instance().closeSockets();
234 235
}

236 237
void
Dhcpv4Srv::shutdown() {
238
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
239 240 241
    shutdown_ = true;
}

242
isc::dhcp::Subnet4Ptr
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query, const bool run_hooks) const {

    Subnet4Ptr subnet;

    SubnetSelector selector;
    selector.ciaddr_ = query->getCiaddr();
    selector.giaddr_ = query->getGiaddr();
    selector.local_address_ = query->getLocalAddr();
    selector.remote_address_ = query->getRemoteAddr();
    selector.client_classes_ = query->classes_;
    selector.iface_name_ = query->getIface();

    CfgMgr& cfgmgr = CfgMgr::instance();
    subnet = cfgmgr.getCurrentCfg()->getCfgSubnets4()->selectSubnet(selector);

    // Let's execute all callouts registered for subnet4_select
    if (run_hooks && HooksManager::calloutsPresent(hook_index_subnet4_select_)) {
        CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

        // Set new arguments
        callout_handle->setArgument("query4", query);
        callout_handle->setArgument("subnet4", subnet);
        callout_handle->setArgument("subnet4collection",
                                    cfgmgr.getCurrentCfg()->
                                    getCfgSubnets4()->getAll());

        // Call user (and server-side) callouts
        HooksManager::callCallouts(hook_index_subnet4_select_,
                                   *callout_handle);

        // Callouts decided to skip this step. This means that no subnet
        // will be selected. Packet processing will continue, but it will
        // be severely limited (i.e. only global options will be assigned)
        if (callout_handle->getSkip()) {
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP);
            return (Subnet4Ptr());
        }

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

    return (subnet);
290 291
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
292 293
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
294 295 296
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
297 298
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
299 300 301
    IfaceMgr::instance().send(packet);
}

302 303
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
304
    while (!shutdown_) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
305
        // client's message and server's response
306
        Pkt4Ptr query;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
307
        Pkt4Ptr rsp;
308

309
        try {
310 311 312 313 314 315 316 317 318 319
            // The lease database backend may install some timers for which
            // the handlers need to be executed periodically. Retrieve the
            // maximum interval at which the handlers must be executed from
            // the lease manager.
            uint32_t timeout = LeaseMgrFactory::instance().getIOServiceExecInterval();
            // If the returned value is zero it means that there are no
            // timers installed, so use a default value.
            if (timeout == 0) {
                timeout = 1000;
            }
320
            query = receivePacket(timeout);
321 322 323 324 325 326 327

        } catch (const SignalInterruptOnSelect) {
            // Packet reception interrupted because a signal has been received.
            // This is not an error because we might have received a SIGTERM,
            // SIGINT or SIGHUP which are handled by the server. For signals
            // that are not handled by the server we rely on the default
            // behavior of the system, but there is nothing we should log here.
328
        } catch (const std::exception& e) {
329
            // Log all other errors.
330 331 332
            LOG_ERROR(dhcp4_logger, DHCP4_PACKET_RECEIVE_FAIL).arg(e.what());
        }

333 334 335
        // Handle next signal received by the process. It must be called after
        // an attempt to receive a packet to properly handle server shut down.
        // The SIGTERM or SIGINT will be received prior to, or during execution
Francis Dupont's avatar
Francis Dupont committed
336 337 338 339 340 341 342
        // of select() (select is invoked by receivePacket()). When that
        // happens, select will be interrupted. The signal handler will be
        // invoked immediately after select(). The handler will set the
        // shutdown flag and cause the process to terminate before the next
        // select() function is called. If the function was called before
        // receivePacket the process could wait up to the duration of timeout
        // of select() to terminate.
343 344
        handleSignal();

345 346
        // Execute ready timers for the lease database, e.g. Lease File Cleanup.
        try {
347
            LeaseMgrFactory::instance().getIOService()->poll();
348 349 350 351 352 353

        } catch (const std::exception& ex) {
            LOG_WARN(dhcp4_logger, DHCP4_LEASE_DATABASE_TIMERS_EXEC_FAIL)
                .arg(ex.what());
        }

354
        // Timeout may be reached or signal received, which breaks select()
Francis Dupont's avatar
Francis Dupont committed
355
        // with no reception occurred
356 357 358 359
        if (!query) {
            continue;
        }

360 361 362 363 364 365 366 367 368
        // 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));

369 370 371
        bool skip_unpack = false;

        // The packet has just been received so contains the uninterpreted wire
372
        // data; execute callouts registered for buffer4_receive.
373
        if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
374 375 376 377 378 379 380 381 382
            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
383 384
            HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                       *callout_handle);
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400

            // 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
401 402 403
            try {
                query->unpack();
            } catch (const std::exception& e) {
404 405 406
                // Failed to parse the packet.
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL,
                          DHCP4_PACKET_PARSE_FAIL).arg(e.what());
407 408
                continue;
            }
409
        }
410

Tomek Mrugalski's avatar
Tomek Mrugalski committed
411 412 413
        // Assign this packet to one or more classes if needed. We need to do
        // this before calling accept(), because getSubnet4() may need client
        // class information.
414 415
        classifyPacket(query);

416 417 418
        // Check whether the message should be further processed or discarded.
        // There is no need to log anything here. This function logs by itself.
        if (!accept(query)) {
419
            continue;
420
        }
421

422
        // We have sanity checked (in accept() that the Message Type option
423 424
        // exists, so we can safely get it here.
        int type = query->getType();
425
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_RECEIVED)
426
            .arg(serverReceivedPacketName(type))
427
            .arg(type)
428 429
            .arg(query->getIface());
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
430
            .arg(type)
431 432
            .arg(query->toText());

Tomek Mrugalski's avatar
Tomek Mrugalski committed
433
        // Let's execute all callouts registered for pkt4_receive
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
        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;
            }
454

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

458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
        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:
480
                rsp = processInform(query);
481 482 483 484 485 486 487
                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.
                ;
488
            }
489 490
        } catch (const isc::Exception& e) {

491 492 493 494 495 496
            // 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 Kea 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.)
497 498 499 500 501
            if (dhcp4_logger.isDebugEnabled(DBG_DHCP4_BASIC)) {
                std::string source = "unknown";
                HWAddrPtr hwptr = query->getHWAddr();
                if (hwptr) {
                    source = hwptr->toText();
502
                }
503 504 505
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC,
                          DHCP4_PACKET_PROCESS_FAIL)
                    .arg(source).arg(e.what());
506
            }
507
        }
508

509 510 511
        if (!rsp) {
            continue;
        }
512

513

514 515
        // Specifies if server should do the packing
        bool skip_pack = false;
516

Tomek Mrugalski's avatar
Tomek Mrugalski committed
517
        // Execute all callouts registered for pkt4_send
518 519
        if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
            CalloutHandlePtr callout_handle = getCalloutHandle(query);
520

521 522
            // Delete all previous arguments
            callout_handle->deleteAllArguments();
523

524 525
            // Clear skip flag if it was set in previous callouts
            callout_handle->setSkip(false);
526

527 528
            // Set our response
            callout_handle->setArgument("response4", rsp);
529

530 531 532
            // Call all installed callouts
            HooksManager::callCallouts(hook_index_pkt4_send_,
                                       *callout_handle);
533

534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
            // 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
556
            // Let's execute all callouts registered for buffer4_send
557
            if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_send_)) {
558
                CalloutHandlePtr callout_handle = getCalloutHandle(query);
559

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

563 564
                // Pass incoming packet as argument
                callout_handle->setArgument("response4", rsp);
565

566
                // Call callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
567 568
                HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
                                           *callout_handle);
569

570 571 572 573
                // 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
574 575
                    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS,
                              DHCP4_HOOK_BUFFER_SEND_SKIP);
576
                    continue;
577
                }
578 579

                callout_handle->getArgument("response4", rsp);
580
            }
581 582 583 584 585 586 587 588 589

            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());
590
        }
591 592 593 594 595
    }

    return (true);
}

596
string
597
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
    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());
614 615
}

616
isc::dhcp_ddns::D2Dhcid
617 618 619 620 621 622 623 624 625
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");

626 627
    }

628 629 630 631 632 633 634 635 636
    // 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);
637

638 639 640
    } catch (const Exception& ex) {
        isc_throw(DhcidComputeError, "unable to compute DHCID because the"
                  " hostname: " << lease->hostname_ << " is invalid");
641 642

    }
643 644 645

    // Prefer client id to HW address to compute DHCID. If Client Id is
    // NULL, use HW address.
646
    try {
647 648 649 650
        if (lease->client_id_) {
            return (D2Dhcid(lease->client_id_->getClientId(), fqdn_wire));

        } else {
651
            return (D2Dhcid(lease->hwaddr_, fqdn_wire));
652
        }
653
    } catch (const Exception& ex) {
654 655
        isc_throw(DhcidComputeError, "unable to compute DHCID: "
                  << ex.what());
656

657
    }
658 659 660

}

661
void
662
Dhcpv4Srv::appendServerID(Dhcpv4Exchange& ex) {
663 664 665
    // 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.
666 667
    /// @todo: perhaps we should consider some more sophisticated server id
    /// generation, but for the current use cases, it should be ok.
668 669 670
    OptionPtr opt_srvid(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                           ex.getResponse()->getLocalAddr()));
    ex.getResponse()->addOption(opt_srvid);
671 672
}

673
void
674
Dhcpv4Srv::appendRequestedOptions(Dhcpv4Exchange& ex) {
675 676
    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
677
    Subnet4Ptr subnet = ex.getContext()->subnet_;
678 679 680 681 682 683 684
    // 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;
    }
685

686 687
    Pkt4Ptr query = ex.getQuery();

688 689 690
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
691
        OptionUint8Array>(query->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
692 693 694 695 696
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
697

698 699
    Pkt4Ptr resp = ex.getResponse();

700 701 702 703 704 705
    // 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) {
706
        if (!resp->getOption(*opt)) {
707
            OptionDescriptor desc = subnet->getCfgOption()->get("dhcp4", *opt);
708
            if (desc.option_) {
709
                resp->addOption(desc.option_);
710
            }
711 712
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
713
}
714

715
void
716
Dhcpv4Srv::appendRequestedVendorOptions(Dhcpv4Exchange& ex) {
717
    // Get the configured subnet suitable for the incoming packet.
718
    Subnet4Ptr subnet = ex.getContext()->subnet_;
719 720 721 722 723 724 725 726 727 728
    // 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
729 730
    boost::shared_ptr<OptionVendor> vendor_req = boost::dynamic_pointer_cast<
        OptionVendor>(ex.getQuery()->getOption(DHO_VIVSO_SUBOPTIONS));
731 732 733 734 735 736 737
    if (!vendor_req) {
        return;
    }

    uint32_t vendor_id = vendor_req->getVendorId();

    // Let's try to get ORO within that vendor-option
738 739
    /// @todo This is very specific to vendor-id=4491 (Cable Labs). Other
    /// vendors may have different policies.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
740 741
    OptionUint8ArrayPtr oro =
        boost::dynamic_pointer_cast<OptionUint8Array>(vendor_req->getOption(DOCSIS3_V4_ORO));
742 743 744 745 746 747 748 749 750 751

    // 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;
752
    const std::vector<uint8_t>& requested_opts = oro->getValues();
753

Tomek Mrugalski's avatar
Tomek Mrugalski committed
754
    for (std::vector<uint8_t>::const_iterator code = requested_opts.begin();
755
         code != requested_opts.end(); ++code) {
756
        if  (!vendor_rsp->getOption(*code)) {
757 758
            OptionDescriptor desc = subnet->getCfgOption()->get(vendor_id,
                                                                *code);
759 760
            if (desc.option_) {
                vendor_rsp->addOption(desc.option_);
761 762
                added = true;
            }
763 764
        }

765
        if (added) {
766
            ex.getResponse()->addOption(vendor_rsp);
767 768
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
769
}
770

771

772
void
773
Dhcpv4Srv::appendBasicOptions(Dhcpv4Exchange& ex) {
774 775 776 777 778 779
    // 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 };
780

781 782 783 784
    static size_t required_options_size =
        sizeof(required_options) / sizeof(required_options[0]);

    // Get the subnet.
785
    Subnet4Ptr subnet = ex.getContext()->subnet_;
786 787 788 789
    if (!subnet) {
        return;
    }

790 791
    Pkt4Ptr resp = ex.getResponse();

792 793 794
    // 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) {
795
        OptionPtr opt = resp->getOption(required_options[i]);
796 797
        if (!opt) {
            // Check whether option has been configured.
798 799
            OptionDescriptor desc = subnet->getCfgOption()->
                get("dhcp4", required_options[i]);
800
            if (desc.option_) {
801
                resp->addOption(desc.option_);
802 803 804
            }
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
805
}
806

807
void
808
Dhcpv4Srv::processClientName(Dhcpv4Exchange& ex) {
809 810 811
    // 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.
812
    try {
813
        Pkt4Ptr resp = ex.getResponse();
814
        Option4ClientFqdnPtr fqdn = boost::dynamic_pointer_cast<Option4ClientFqdn>
815
            (ex.getQuery()->getOption(DHO_FQDN));
816
        if (fqdn) {
817
            processClientFqdnOption(ex);
818 819

        } else {
820
            OptionStringPtr hostname = boost::dynamic_pointer_cast<OptionString>
821
                (ex.getQuery()->getOption(DHO_HOST_NAME));
822
            if (hostname) {
823
                processHostnameOption(ex);
824 825 826 827 828 829 830 831 832 833 834 835 836
            }
        }
    } 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());
837 838 839 840
    }
}

void
841
Dhcpv4Srv::processClientFqdnOption(Dhcpv4Exchange& ex) {
842 843 844 845
    // Obtain the FQDN option from the client's message.
    Option4ClientFqdnPtr fqdn = boost::dynamic_pointer_cast<
        Option4ClientFqdn>(ex.getQuery()->getOption(DHO_FQDN));

846 847 848 849
    // Create the DHCPv4 Client FQDN Option to be included in the server's
    // response to a client.
    Option4ClientFqdnPtr fqdn_resp(new Option4ClientFqdn(*fqdn));

850 851 852 853
    // Set the server S, N, and O flags based on client's flags and
    // current configuration.
    D2ClientMgr& d2_mgr = CfgMgr::instance().getD2ClientMgr();
    d2_mgr.adjustFqdnFlags<Option4ClientFqdn>(*fqdn, *fqdn_resp);
854

855 856 857
    // Carry over the client's E flag.
    fqdn_resp->setFlag(Option4ClientFqdn::FLAG_E,
                       fqdn->getFlag(Option4ClientFqdn::FLAG_E));
858

859
    if (ex.getContext()->host_ && !ex.getContext()->host_->getHostname().empty()) {
860 861 862
        D2ClientMgr& d2_mgr = CfgMgr::instance().getD2ClientMgr();
        fqdn_resp->setDomainName(d2_mgr.qualifyName(ex.getContext()->host_->getHostname(),
                                                    true), Option4ClientFqdn::FULL);
863

864 865 866 867 868
    } else {
        // Adjust the domain name based on domain name value and type sent by the
        // client and current configuration.
        d2_mgr.adjustDomainName<Option4ClientFqdn>(*fqdn, *fqdn_resp);
    }
869 870 871 872 873 874 875 876 877 878

    // 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.
Francis Dupont's avatar
Francis Dupont committed
879
    // If we don't store the option in the response message, we will have to
880 881
    // propagate it in the different way to the functions which acquire the
    // lease. This would require modifications to the API of this class.
882
    ex.getResponse()->addOption(fqdn_resp);
883 884 885
}

void
886
Dhcpv4Srv::processHostnameOption(Dhcpv4Exchange& ex) {
887 888 889 890
    // Obtain the Hostname option from the client's message.
    OptionStringPtr opt_hostname = boost::dynamic_pointer_cast<OptionString>
        (ex.getQuery()->getOption(DHO_HOST_NAME));

891 892 893
    // Fetch D2 configuration.
    D2ClientMgr& d2_mgr = CfgMgr::instance().getD2ClientMgr();

894
    // Do nothing if the DNS updates are disabled.
895
    if (!d2_mgr.ddnsEnabled()) {
896 897 898
        return;
    }

899
    std::string hostname = isc::util::str::trim(opt_hostname->getValue());
900
    unsigned int label_count = OptionDataTypeUtil::getLabelCount(hostname);
901
    // The hostname option sent by the client should be at least 1 octet long.
902 903 904
    // If it isn't we ignore this option. (Per RFC 2131, section 3.14)
    /// @todo It would be more liberal to accept this and let it fall into
    /// the case  of replace or less than two below.
905 906 907 908
    if (label_count == 0) {
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_EMPTY_HOSTNAME);
        return;
    }
909 910 911 912
    // 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.
913
    OptionStringPtr opt_hostname_resp(new OptionString(*opt_hostname));
914 915 916 917 918 919 920 921

    // 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.

922
    // If there is a hostname reservation for this client, use it.
923
    if (ex.getContext()->host_ && !ex.getContext()->host_->getHostname().empty()) {
924 925
        opt_hostname_resp->setValue(d2_mgr.qualifyName(ex.getContext()->host_->getHostname(),
                                                       false));
926 927 928

    } else if ((d2_mgr.getD2ClientConfig()->getReplaceClientName()) ||
               (label_count < 2)) {
929 930
        // Set to root domain to signal later on that we should replace it.
        // DHO_HOST_NAME is a string option which cannot be empty.
931 932 933 934 935 936
        /// @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.
937
        opt_hostname_resp->setValue(".");
938

939
    } else if (label_count == 2) {
940
        // If there are two labels, it means that the client has specified
Francis Dupont's avatar
Francis Dupont committed
941
        // the unqualified name. We have to concatenate the unqualified name
942 943 944 945 946 947
        // with the domain name. The false value passed as a second argument
        // indicates that the trailing dot should not be appended to the
        // hostname. We don't want to append the trailing dot because
        // we don't know whether the hostname is partial or not and some
        // clients do not handle the hostnames with the trailing dot.
        opt_hostname_resp->setValue(d2_mgr.qualifyName(hostname, false));
948 949
    }

950
    ex.getResponse()->addOption(opt_hostname_resp);
951 952
}

953 954
void
Dhcpv4Srv::createNameChangeRequests(const Lease4Ptr& lease,
955
                                    const Lease4Ptr& old_lease) {
956 957 958 959 960
    if (!lease) {
        isc_throw(isc::Unexpected,
                  "NULL lease specified when creating NameChangeRequest");
    }

961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
    // 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) <