dhcp4_srv.cc 87.4 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 <config.h>
16
#include <asiolink/io_address.h>
17
#include <dhcp/dhcp4.h>
18 19
#include <dhcp/duid.h>
#include <dhcp/hwaddr.h>
20
#include <dhcp/iface_mgr.h>
21
#include <dhcp/option4_addrlst.h>
22
#include <dhcp/option_int.h>
23
#include <dhcp/option_int_array.h>
24
#include <dhcp/option_vendor.h>
25
#include <dhcp/option_string.h>
26
#include <dhcp/pkt4.h>
27
#include <dhcp/docsis3_option_defs.h>
28 29
#include <dhcp4/dhcp4_log.h>
#include <dhcp4/dhcp4_srv.h>
30 31
#include <dhcpsrv/addr_utilities.h>
#include <dhcpsrv/callout_handle_store.h>
32
#include <dhcpsrv/cfgmgr.h>
33
#include <dhcpsrv/cfg_subnets4.h>
34 35 36
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
#include <dhcpsrv/subnet.h>
37
#include <dhcpsrv/subnet_selector.h>
38
#include <dhcpsrv/utils.h>
39
#include <dhcpsrv/utils.h>
40
#include <hooks/callout_handle.h>
41
#include <hooks/hooks_manager.h>
42
#include <util/strutil.h>
43

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

#include <iomanip>

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

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

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

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

85 86 87
namespace isc {
namespace dhcp {

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

94 95 96 97 98 99 100 101
    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");
102 103
    }

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

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

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

145 146
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
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 185
    // 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);
186 187 188
    }
}

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

191
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
192
                     const bool direct_response_desired)
193 194 195
    : 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) {
196

197
    // fixme: either remove or change its name.
198
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
199
    try {
200 201 202
        // 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.
203
        if (port) {
204 205 206 207 208 209 210 211
            // 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);
212
        }
213

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

218 219 220 221 222 223 224
        // 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

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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
231
    shutdown_ = false;
232 233 234
}

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

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

244
isc::dhcp::Subnet4Ptr
245
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query) const {
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260

    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
261
    if (HooksManager::calloutsPresent(hook_index_subnet4_select_)) {
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
        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()) {
282 283 284
            LOG_DEBUG(srv_hooks_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
285 286 287 288 289 290 291
            return (Subnet4Ptr());
        }

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

292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
    if (subnet) {
        // Log at higher debug level that subnet has been found.
        LOG_DEBUG(packet_logger, DBG_DHCP4_DETAIL, DHCP4_SUBNET_SELECTED)
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
        LOG_DEBUG(packet_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
        LOG_DEBUG(packet_logger, DBG_DHCP4_DETAIL,
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

309
    return (subnet);
310 311
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
312 313
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
314 315 316
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
317 318
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
319 320 321
    IfaceMgr::instance().send(packet);
}

322 323
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
324
    while (!shutdown_) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
325
        // client's message and server's response
326
        Pkt4Ptr query;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
327
        Pkt4Ptr rsp;
328

329
        try {
330 331 332 333 334 335 336 337 338 339
            // 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;
            }
340
            LOG_DEBUG(packet_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT).arg(timeout);
341
            query = receivePacket(timeout);
342

343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
            // Log if packet has arrived. We can't log the detailed information
            // about the DHCP message because it hasn't been unpacked/parsed
            // yet, and it can't be parsed at this point because hooks will
            // have to process it first. The only information available at this
            // point are: the interface, source address and destination addresses
            // and ports.
            if (query) {
                LOG_DEBUG(packet_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_RECEIVED)
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getRemotePort())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getLocalPort())
                    .arg(query->getIface());

            } else {
                LOG_DEBUG(packet_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_TIMEOUT)
                    .arg(timeout);
            }

362 363 364 365 366 367
        } 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.
368 369
            LOG_DEBUG(packet_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_SIGNAL)
                .arg(signal_set_->getNext());
370
        } catch (const std::exception& e) {
371
            // Log all other errors.
372
            LOG_ERROR(packet_logger, DHCP4_BUFFER_RECEIVE_FAIL).arg(e.what());
373 374
        }

375 376 377
        // 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
378 379 380 381 382 383 384
        // 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.
385
        // fixme
386 387
        handleSignal();

388 389
        // Execute ready timers for the lease database, e.g. Lease File Cleanup.
        try {
390
            // fixme
391
            LeaseMgrFactory::instance().getIOService()->poll();
392 393 394 395 396 397

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

398
        // Timeout may be reached or signal received, which breaks select()
399 400
        // with no reception occurred. No need to log anything here because
        // we have logged right after the call to receivePacket().
401 402 403 404
        if (!query) {
            continue;
        }

405 406 407 408 409 410
        // 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.
411
        // fixme
412 413 414
        query->setCallback(boost::bind(&Dhcpv4Srv::unpackOptions, this,
                                       _1, _2, _3));

415 416 417
        bool skip_unpack = false;

        // The packet has just been received so contains the uninterpreted wire
418
        // data; execute callouts registered for buffer4_receive.
419
        if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
420 421 422 423 424 425 426 427 428
            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
429 430
            HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                       *callout_handle);
431 432 433 434 435 436

            // 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()) {
437 438 439 440
                LOG_DEBUG(srv_hooks_logger, DBG_DHCP4_DETAIL, DHCP4_HOOK_BUFFER_RCVD_SKIP)
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface());
441 442 443 444 445 446 447 448 449
                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
450
            try {
451 452 453 454
                LOG_DEBUG(options_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_UNPACK)
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface());
Tomek Mrugalski's avatar
Tomek Mrugalski committed
455 456
                query->unpack();
            } catch (const std::exception& e) {
457
                // Failed to parse the packet.
458 459
                LOG_DEBUG(bad_packet_logger, DBG_DHCP4_DETAIL,
                          DHCP4_PACKET_DROP_0001)
460 461 462
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface())
463
                    .arg(e.what());
464 465
                continue;
            }
466
        }
467

Tomek Mrugalski's avatar
Tomek Mrugalski committed
468 469 470
        // 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.
471
        //  fixme
472 473
        classifyPacket(query);

474 475
        // Check whether the message should be further processed or discarded.
        // There is no need to log anything here. This function logs by itself.
476
        // fixme
477
        if (!accept(query)) {
478
            continue;
479
        }
480

481
        // We have sanity checked (in accept() that the Message Type option
482 483
        // exists, so we can safely get it here.
        int type = query->getType();
484 485
        LOG_DEBUG(packet_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_RECEIVED)
            .arg(query->getLabel())
486
            .arg(query->getName())
487
            .arg(type)
488 489
            .arg(query->getRemoteAddr())
            .arg(query->getLocalAddr())
490
            .arg(query->getIface());
491 492
        LOG_DEBUG(packet_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
            .arg(query->getLabel())
493 494
            .arg(query->toText());

Tomek Mrugalski's avatar
Tomek Mrugalski committed
495
        // Let's execute all callouts registered for pkt4_receive
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
        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()) {
513 514
                LOG_DEBUG(srv_hooks_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_RCVD_SKIP)
                    .arg(query->getLabel());
515 516
                continue;
            }
517

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

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
        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:
543
                rsp = processInform(query);
544 545 546 547 548 549 550
                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.
                ;
551
            }
552 553
        } catch (const isc::Exception& e) {

554 555 556 557 558 559
            // 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.)
560 561 562 563
            LOG_DEBUG(bad_packet_logger, DBG_DHCP4_BASIC,
                      DHCP4_PACKET_DROP_0007)
                .arg(query->getLabel())
                .arg(e.what());
564
        }
565

566 567 568
        if (!rsp) {
            continue;
        }
569

570

571 572
        // Specifies if server should do the packing
        bool skip_pack = false;
573

Tomek Mrugalski's avatar
Tomek Mrugalski committed
574
        // Execute all callouts registered for pkt4_send
575 576
        if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
            CalloutHandlePtr callout_handle = getCalloutHandle(query);
577

578 579
            // Delete all previous arguments
            callout_handle->deleteAllArguments();
580

581 582
            // Clear skip flag if it was set in previous callouts
            callout_handle->setSkip(false);
583

584 585
            // Set our response
            callout_handle->setArgument("response4", rsp);
586

587 588 589
            // Call all installed callouts
            HooksManager::callCallouts(hook_index_pkt4_send_,
                                       *callout_handle);
590

591 592 593 594
            // 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()) {
595 596
                LOG_DEBUG(srv_hooks_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_SEND_SKIP)
                    .arg(query->getLabel());
597 598 599 600 601 602
                skip_pack = true;
            }
        }

        if (!skip_pack) {
            try {
603 604
                LOG_DEBUG(options_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_PACK)
                    .arg(rsp->getLabel());
605 606
                rsp->pack();
            } catch (const std::exception& e) {
607 608
                LOG_ERROR(options_logger, DHCP4_PACKET_PACK_FAIL)
                    .arg(rsp->getLabel())
609 610 611 612 613 614 615 616
                    .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
617
            // Let's execute all callouts registered for buffer4_send
618
            if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_send_)) {
619
                CalloutHandlePtr callout_handle = getCalloutHandle(query);
620

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

624 625
                // Pass incoming packet as argument
                callout_handle->setArgument("response4", rsp);
626

627
                // Call callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
628 629
                HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
                                           *callout_handle);
630

631 632 633 634
                // 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()) {
635 636 637
                    LOG_DEBUG(srv_hooks_logger, DBG_DHCP4_HOOKS,
                              DHCP4_HOOK_BUFFER_SEND_SKIP)
                        .arg(rsp->getLabel());
638
                    continue;
639
                }
640 641

                callout_handle->getArgument("response4", rsp);
642
            }
643

644
            LOG_DEBUG(options_logger, DBG_DHCP4_DETAIL_DATA,
645
                      DHCP4_RESPONSE_DATA)
646
                .arg(rsp->getLabel())
647
                .arg(rsp->getName())
648 649 650 651 652
                .arg(static_cast<int>(rsp->getType()))
                .arg(rsp->toText());

            LOG_DEBUG(packet_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_SEND)
                .arg(rsp->getLabel())
653
                .arg(rsp->getName())
654 655 656 657 658 659 660
                .arg(static_cast<int>(rsp->getType()))
                .arg(rsp->getLocalAddr())
                .arg(rsp->getLocalPort())
                .arg(rsp->getRemoteAddr())
                .arg(rsp->getRemotePort())
                .arg(rsp->getIface());
                
661 662
            sendPacket(rsp);
        } catch (const std::exception& e) {
663 664
            LOG_ERROR(packet_logger, DHCP4_PACKET_SEND_FAIL)
                .arg(rsp->getLabel())
665
                .arg(e.what());
666
        }
667 668 669 670 671
    }

    return (true);
}

672
string
673
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
    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());
690 691
}

692
isc::dhcp_ddns::D2Dhcid
693 694 695 696 697 698 699 700 701
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");

702 703
    }

704 705 706 707 708 709 710 711 712
    // 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);
713

714 715 716
    } catch (const Exception& ex) {
        isc_throw(DhcidComputeError, "unable to compute DHCID because the"
                  " hostname: " << lease->hostname_ << " is invalid");
717 718

    }
719 720 721

    // Prefer client id to HW address to compute DHCID. If Client Id is
    // NULL, use HW address.
722
    try {
723 724 725 726
        if (lease->client_id_) {
            return (D2Dhcid(lease->client_id_->getClientId(), fqdn_wire));

        } else {
727
            return (D2Dhcid(lease->hwaddr_, fqdn_wire));
728
        }
729
    } catch (const Exception& ex) {
730 731
        isc_throw(DhcidComputeError, "unable to compute DHCID: "
                  << ex.what());
732

733
    }
734 735 736

}

737
void
738
Dhcpv4Srv::appendServerID(Dhcpv4Exchange& ex) {
739 740 741
    // 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.
742 743
    /// @todo: perhaps we should consider some more sophisticated server id
    /// generation, but for the current use cases, it should be ok.
744 745 746
    OptionPtr opt_srvid(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                           ex.getResponse()->getLocalAddr()));
    ex.getResponse()->addOption(opt_srvid);
747 748
}

749
void
750
Dhcpv4Srv::appendRequestedOptions(Dhcpv4Exchange& ex) {
751 752
    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
753
    Subnet4Ptr subnet = ex.getContext()->subnet_;
754 755 756 757 758 759 760
    // 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;
    }
761

762 763
    Pkt4Ptr query = ex.getQuery();

764 765 766
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
767
        OptionUint8Array>(query->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
768 769 770 771 772
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
773

774 775
    Pkt4Ptr resp = ex.getResponse();

776 777 778 779 780 781
    // 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) {
782
        if (!resp->getOption(*opt)) {
783
            OptionDescriptor desc = subnet->getCfgOption()->get("dhcp4", *opt);
784
            if (desc.option_) {
785
                resp->addOption(desc.option_);
786
            }
787 788
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
789
}
790

791
void
792
Dhcpv4Srv::appendRequestedVendorOptions(Dhcpv4Exchange& ex) {
793
    // Get the configured subnet suitable for the incoming packet.
794
    Subnet4Ptr subnet = ex.getContext()->subnet_;
795 796 797 798 799 800 801 802 803 804
    // 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
805 806
    boost::shared_ptr<OptionVendor> vendor_req = boost::dynamic_pointer_cast<
        OptionVendor>(ex.getQuery()->getOption(DHO_VIVSO_SUBOPTIONS));
807 808 809 810 811 812 813
    if (!vendor_req) {
        return;
    }

    uint32_t vendor_id = vendor_req->getVendorId();

    // Let's try to get ORO within that vendor-option
814 815
    /// @todo This is very specific to vendor-id=4491 (Cable Labs). Other
    /// vendors may have different policies.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
816 817
    OptionUint8ArrayPtr oro =
        boost::dynamic_pointer_cast<OptionUint8Array>(vendor_req->getOption(DOCSIS3_V4_ORO));
818 819 820 821 822 823 824 825 826 827

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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
830
    for (std::vector<uint8_t>::const_iterator code = requested_opts.begin();
831
         code != requested_opts.end(); ++code) {
832
        if  (!vendor_rsp->getOption(*code)) {
833 834
            OptionDescriptor desc = subnet->getCfgOption()->get(vendor_id,
                                                                *code);
835 836
            if (desc.option_) {
                vendor_rsp->addOption(desc.option_);
837 838
                added = true;
            }
839 840
        }

841
        if (added) {
842
            ex.getResponse()->addOption(vendor_rsp);
843 844
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
845
}
846

847

848
void
849
Dhcpv4Srv::appendBasicOptions(Dhcpv4Exchange& ex) {
850 851 852 853 854 855
    // 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 };
856

857 858 859 860
    static size_t required_options_size =
        sizeof(required_options) / sizeof(required_options[0]);

    // Get the subnet.
861
    Subnet4Ptr subnet = ex.getContext()->subnet_;
862 863 864 865
    if (!subnet) {
        return;
    }

866 867
    Pkt4Ptr resp = ex.getResponse();

868 869 870
    // 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) {
871
        OptionPtr opt = resp->getOption(required_options[i]);
872 873
        if (!opt) {
            // Check whether option has been configured.
874 875
            OptionDescriptor desc = subnet->getCfgOption()->
                get("dhcp4", required_options[i]);
876
            if (desc.option_) {
877
                resp->addOption(desc.option_);
878 879 880
            }
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
881
}
882

883
void
884
Dhcpv4Srv::processClientName(Dhcpv4Exchange& ex) {
885 886 887
    // 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.
888
    try {
889
        Pkt4Ptr resp = ex.getResponse();
890
        Option4ClientFqdnPtr fqdn = boost::dynamic_pointer_cast<Option4ClientFqdn>
891
            (ex.getQuery()->getOption(DHO_FQDN));
892
        if (fqdn) {
893 894
            LOG_DEBUG(hostname_logger, DBG_DHCP4_BASIC, DHCP4_CLIENT_FQDN_PROCESS)
                .arg(ex.getQuery()->getLabel());
895
            processClientFqdnOption(ex);
896 897

        } else {
898
            OptionStringPtr hostname = boost::dynamic_pointer_cast<OptionString>
899
                (ex.getQuery()->getOption(DHO_HOST_NAME));
900
            if (hostname) {
901 902
                LOG_DEBUG(hostname_logger, DBG_DHCP4_BASIC, DHCP4_CLIENT_HOSTNAME_PROCESS)
                    .arg(ex.getQuery()->getLabel());
903
                processHostnameOption(ex);
904 905
            }
        }
906
    } catch (const Exception& e) {
907 908 909 910 911 912 913 914
        // 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.
915 916 917
        LOG_DEBUG(hostname_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_CLIENT_NAME_PROC_FAIL)
            .arg(ex.getQuery()->getLabel())
            .arg(e.what());
918 919 920 921
    }
}

void
922
Dhcpv4Srv::processClientFqdnOption(Dhcpv4Exchange& ex) {
923 924 925 926
    // Obtain the FQDN option from the client's message.
    Option4ClientFqdnPtr fqdn = boost::dynamic_pointer_cast<
        Option4ClientFqdn>(ex.getQuery()->getOption(DHO_FQDN));

927 928 929 930
    LOG_DEBUG(hostname_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_CLIENT_FQDN_DATA)
        .arg(ex.getQuery()->getLabel())
        .arg(fqdn->toText());

931 932 933 934
    // Create the DHCPv4 Client FQDN Option to be included in the server's
    // response to a client.
    Option4ClientFqdnPtr fqdn_resp(new Option4ClientFqdn(*fqdn));

935 936 937 938
    // 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);
939

940 941 942
    // Carry over the client's E flag.
    fqdn_resp->setFlag(Option4ClientFqdn::FLAG_E,
                       fqdn->getFlag(Option4ClientFqdn::FLAG_E));
943

944
    if (ex.getContext()->host_ && !ex.getContext()->host_->getHostname().empty()) {
945 946 947
        D2ClientMgr& d2_mgr = CfgMgr::instance().getD2ClientMgr();
        fqdn_resp->setDomainName(d2_mgr.qualifyName(ex.getContext()->host_->getHostname(),
                                                    true), Option4ClientFqdn::FULL);