dhcp4_srv.cc 92.9 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_log.h>
42
#include <hooks/hooks_manager.h>
43
#include <stats/stats_mgr.h>
44
#include <util/strutil.h>
45
#include <stats/stats_mgr.h>
46 47
#include <log/logger.h>
#include <cryptolink/cryptolink.h>
48
#include <cfgrpt/config_report.h>
49

50 51 52 53 54 55 56 57
#ifdef HAVE_MYSQL
#include <dhcpsrv/mysql_lease_mgr.h>
#endif
#ifdef HAVE_PGSQL
#include <dhcpsrv/pgsql_lease_mgr.h>
#endif
#include <dhcpsrv/memfile_lease_mgr.h>

58
#include <asio.hpp>
59
#include <boost/bind.hpp>
60
#include <boost/foreach.hpp>
61
#include <boost/shared_ptr.hpp>
62 63 64

#include <iomanip>

65 66
using namespace isc;
using namespace isc::asiolink;
67
using namespace isc::cryptolink;
68
using namespace isc::dhcp;
69
using namespace isc::dhcp_ddns;
70
using namespace isc::hooks;
71
using namespace isc::log;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
72
using namespace isc::stats;
73
using namespace std;
74

75
/// Structure that holds registered hook indexes
76 77
struct Dhcp4Hooks {
    int hook_index_buffer4_receive_;///< index for "buffer4_receive" hook point
78 79
    int hook_index_pkt4_receive_;   ///< index for "pkt4_receive" hook point
    int hook_index_subnet4_select_; ///< index for "subnet4_select" hook point
80
    int hook_index_lease4_release_; ///< index for "lease4_release" hook point
81
    int hook_index_pkt4_send_;      ///< index for "pkt4_send" hook point
82
    int hook_index_buffer4_send_;   ///< index for "buffer4_send" hook point
83

84 85 86
    /// Constructor that registers hook points for DHCPv4 engine
    Dhcp4Hooks() {
        hook_index_buffer4_receive_= HooksManager::registerHook("buffer4_receive");
87 88 89
        hook_index_pkt4_receive_   = HooksManager::registerHook("pkt4_receive");
        hook_index_subnet4_select_ = HooksManager::registerHook("subnet4_select");
        hook_index_pkt4_send_      = HooksManager::registerHook("pkt4_send");
90 91
        hook_index_lease4_release_ = HooksManager::registerHook("lease4_release");
        hook_index_buffer4_send_   = HooksManager::registerHook("buffer4_send");
92 93 94 95 96 97 98
    }
};

// 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.
99
Dhcp4Hooks Hooks;
100

101 102 103
namespace isc {
namespace dhcp {

104
Dhcpv4Exchange::Dhcpv4Exchange(const AllocEnginePtr& alloc_engine,
105 106
                               const Pkt4Ptr& query,
                               const Subnet4Ptr& subnet)
107 108
    : alloc_engine_(alloc_engine), query_(query), resp_(),
      context_(new AllocEngine::ClientContext4()) {
109

110 111 112 113 114 115 116 117
    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");
118 119
    }

120 121 122
    // Create response message.
    initResponse();
    // Select subnet for the query message.
123
    context_->subnet_ = subnet;
124
    // Hardware address.
125
    context_->hwaddr_ = query->getHWAddr();
126 127
    // Pointer to client's query.
    context_->query_ = query;
128

129
    // Set client identifier if the match-client-id flag is enabled (default).
130 131 132
    // If the subnet wasn't found it doesn't matter because we will not be
    // able to allocate a lease anyway so this context will not be used.
    if (subnet) {
133
        if (subnet->getMatchClientId()) {
134 135 136 137 138 139 140 141 142 143
            OptionPtr opt_clientid = query->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
            if (opt_clientid) {
                context_->clientid_.reset(new ClientId(opt_clientid->getData()));
            }
        } else {
            /// @todo When merging with #3806 use different logger.
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_CLIENTID_IGNORED_FOR_LEASES)
                .arg(query->getLabel())
                .arg(subnet->getID());
        }
144 145
    }
    // Check for static reservations.
146
    alloc_engine->findReservation(*context_);
147 148
};

149
void
150
Dhcpv4Exchange::initResponse() {
151 152 153 154 155 156 157 158 159 160 161 162
    uint8_t resp_type = 0;
    switch (getQuery()->getType()) {
    case DHCPDISCOVER:
        resp_type = DHCPOFFER;
        break;
    case DHCPREQUEST:
    case DHCPINFORM:
        resp_type = DHCPACK;
        break;
    default:
        ;
    }
163
    // Only create a response if one is required.
164 165
    if (resp_type > 0) {
        resp_.reset(new Pkt4(resp_type, getQuery()->getTransid()));
166 167 168 169 170 171 172 173 174
        copyDefaultFields();
    }
}

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

175 176
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
    // 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);
216 217 218
    }
}

219 220
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

221
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
222
                     const bool direct_response_desired)
223 224 225
    : 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) {
226

227
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
228
    try {
229 230 231
        // 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.
232
        if (port) {
233 234 235 236 237 238 239 240
            // 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);
241
        }
242

243 244 245 246
        // Instantiate allocation engine. The number of allocation attempts equal
        // to zero indicates that the allocation engine will use the number of
        // attempts depending on the pool size.
        alloc_engine_.reset(new AllocEngine(AllocEngine::ALLOC_ITERATIVE, 0,
247
                                            false /* false = IPv4 */));
248

249 250 251 252 253 254 255
        // 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

256
    } catch (const std::exception &e) {
257
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
258 259 260
        shutdown_ = true;
        return;
    }
261

Tomek Mrugalski's avatar
Tomek Mrugalski committed
262
    shutdown_ = false;
263 264 265
}

Dhcpv4Srv::~Dhcpv4Srv() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
266
    IfaceMgr::instance().closeSockets();
267 268
}

269 270
void
Dhcpv4Srv::shutdown() {
271
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
272 273 274
    shutdown_ = true;
}

275
isc::dhcp::Subnet4Ptr
276
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query) const {
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291

    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
292
    if (HooksManager::calloutsPresent(hook_index_subnet4_select_)) {
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
        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()) {
313
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
314 315
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
316 317 318 319 320 321 322
            return (Subnet4Ptr());
        }

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

323 324
    if (subnet) {
        // Log at higher debug level that subnet has been found.
325
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
326 327 328 329
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
330
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
331 332 333 334
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
335
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
336 337 338 339
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

340
    return (subnet);
341 342
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
343 344
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
345 346 347
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
348 349
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
350 351 352
    IfaceMgr::instance().send(packet);
}

353 354
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
355
    while (!shutdown_) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
356
        // client's message and server's response
357
        Pkt4Ptr query;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
358
        Pkt4Ptr rsp;
359

360
        try {
361 362 363 364 365 366 367 368 369 370
            // 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;
            }
371
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT).arg(timeout);
372
            query = receivePacket(timeout);
373

374 375 376 377 378 379 380
            // 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) {
381
                LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_BUFFER_RECEIVED)
382 383 384 385 386 387 388
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getRemotePort())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getLocalPort())
                    .arg(query->getIface());

            } else {
389
                LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_INTERRUPTED)
390 391 392
                    .arg(timeout);
            }

393 394 395 396 397
        } 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
398
            // behavior of the system.
399
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_SIGNAL)
400
                .arg(signal_set_->getNext());
401
        } catch (const std::exception& e) {
402
            // Log all other errors.
403
            LOG_ERROR(packet4_logger, DHCP4_BUFFER_RECEIVE_FAIL).arg(e.what());
404 405
        }

406 407 408
        // 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
409 410 411 412 413 414 415
        // 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.
416 417
        handleSignal();

418 419
        // Execute ready timers for the lease database, e.g. Lease File Cleanup.
        try {
420
            LeaseMgrFactory::instance().getIOService()->poll();
421 422 423 424 425 426

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

427
        // Timeout may be reached or signal received, which breaks select()
428 429
        // with no reception occurred. No need to log anything here because
        // we have logged right after the call to receivePacket().
430 431 432 433
        if (!query) {
            continue;
        }

434 435 436 437
        // Log reception of the packet. We need to increase it early, as any
        // failures in unpacking will cause the packet to be dropped. We
        // will increase type specific packets further down the road.
        // See processStatsReceived().
Tomek Mrugalski's avatar
Tomek Mrugalski committed
438
        isc::stats::StatsMgr::instance().addValue("pkt4-received",
439
                                                  static_cast<int64_t>(1));
440

441 442 443 444 445 446 447 448 449
        // 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));

450 451 452
        bool skip_unpack = false;

        // The packet has just been received so contains the uninterpreted wire
453
        // data; execute callouts registered for buffer4_receive.
454
        if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
455 456 457 458 459 460 461 462 463
            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
464 465
            HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                       *callout_handle);
466 467 468 469 470 471

            // 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()) {
472
                LOG_DEBUG(hooks_logger, DBG_DHCP4_DETAIL, DHCP4_HOOK_BUFFER_RCVD_SKIP)
473 474 475
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface());
476 477 478 479 480 481 482 483 484
                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
485
            try {
486
                LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_UNPACK)
487 488 489
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface());
Tomek Mrugalski's avatar
Tomek Mrugalski committed
490 491
                query->unpack();
            } catch (const std::exception& e) {
492
                // Failed to parse the packet.
493
                LOG_DEBUG(bad_packet4_logger, DBG_DHCP4_DETAIL,
494
                          DHCP4_PACKET_DROP_0001)
495 496 497
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface())
498
                    .arg(e.what());
499 500

                // Increase the statistics of parse failues and dropped packets.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
501
                isc::stats::StatsMgr::instance().addValue("pkt4-parse-failed",
502
                                                          static_cast<int64_t>(1));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
503
                isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
504
                                                          static_cast<int64_t>(1));
505 506
                continue;
            }
507
        }
508

509 510 511
        // Update statistics accordingly for received packet.
        processStatsReceived(query);

Tomek Mrugalski's avatar
Tomek Mrugalski committed
512 513 514
        // 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.
515 516
        classifyPacket(query);

517 518 519
        // 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)) {
520
            // Increase the statistic of dropped packets.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
521
            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
522
                                                      static_cast<int64_t>(1));
523
            continue;
524
        }
525

526
        // We have sanity checked (in accept() that the Message Type option
527 528
        // exists, so we can safely get it here.
        int type = query->getType();
529
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_PACKET_RECEIVED)
530
            .arg(query->getLabel())
531
            .arg(query->getName())
532
            .arg(type)
533 534
            .arg(query->getRemoteAddr())
            .arg(query->getLocalAddr())
535
            .arg(query->getIface());
536
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
537
            .arg(query->getLabel())
538 539
            .arg(query->toText());

Tomek Mrugalski's avatar
Tomek Mrugalski committed
540
        // Let's execute all callouts registered for pkt4_receive
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
        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()) {
558
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_RCVD_SKIP)
559
                    .arg(query->getLabel());
560 561
                continue;
            }
562

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

566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
        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:
588
                rsp = processInform(query);
589 590 591 592 593 594 595
                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.
                ;
596
            }
597 598
        } catch (const isc::Exception& e) {

599 600 601 602 603 604
            // 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.)
605
            LOG_DEBUG(bad_packet4_logger, DBG_DHCP4_BASIC,
606 607 608
                      DHCP4_PACKET_DROP_0007)
                .arg(query->getLabel())
                .arg(e.what());
609 610

            // Increase the statistic of dropped packets.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
611
            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
612
                                                      static_cast<int64_t>(1));
613
        }
614

615 616 617
        if (!rsp) {
            continue;
        }
618

619

620 621
        // Specifies if server should do the packing
        bool skip_pack = false;
622

Tomek Mrugalski's avatar
Tomek Mrugalski committed
623
        // Execute all callouts registered for pkt4_send
624 625
        if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
            CalloutHandlePtr callout_handle = getCalloutHandle(query);
626

627 628
            // Delete all previous arguments
            callout_handle->deleteAllArguments();
629

630 631
            // Clear skip flag if it was set in previous callouts
            callout_handle->setSkip(false);
632

633 634
            // Set our response
            callout_handle->setArgument("response4", rsp);
635

636 637 638
            // Call all installed callouts
            HooksManager::callCallouts(hook_index_pkt4_send_,
                                       *callout_handle);
639

640 641 642 643
            // 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()) {
644
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_SEND_SKIP)
645
                    .arg(query->getLabel());
646 647 648 649 650 651
                skip_pack = true;
            }
        }

        if (!skip_pack) {
            try {
652
                LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_PACK)
653
                    .arg(rsp->getLabel());
654 655
                rsp->pack();
            } catch (const std::exception& e) {
656
                LOG_ERROR(options4_logger, DHCP4_PACKET_PACK_FAIL)
657
                    .arg(rsp->getLabel())
658 659 660 661 662 663 664 665
                    .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
666
            // Let's execute all callouts registered for buffer4_send
667
            if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_send_)) {
668
                CalloutHandlePtr callout_handle = getCalloutHandle(query);
669

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

673 674
                // Pass incoming packet as argument
                callout_handle->setArgument("response4", rsp);
675

676
                // Call callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
677 678
                HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
                                           *callout_handle);
679

680 681 682 683
                // 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()) {
684
                    LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
685 686
                              DHCP4_HOOK_BUFFER_SEND_SKIP)
                        .arg(rsp->getLabel());
687
                    continue;
688
                }
689 690

                callout_handle->getArgument("response4", rsp);
691
            }
692

693
            LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_PACKET_SEND)
694
                .arg(rsp->getLabel())
695
                .arg(rsp->getName())
696 697 698 699 700 701
                .arg(static_cast<int>(rsp->getType()))
                .arg(rsp->getLocalAddr())
                .arg(rsp->getLocalPort())
                .arg(rsp->getRemoteAddr())
                .arg(rsp->getRemotePort())
                .arg(rsp->getIface());
702

703
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA,
704
                      DHCP4_RESPONSE_DATA)
705 706 707 708
                .arg(rsp->getLabel())
                .arg(rsp->getName())
                .arg(static_cast<int>(rsp->getType()))
                .arg(rsp->toText());
709
            sendPacket(rsp);
710 711 712 713

            // Update statistics accordingly for sent packet.
            processStatsSent(rsp);

714
        } catch (const std::exception& e) {
715
            LOG_ERROR(packet4_logger, DHCP4_PACKET_SEND_FAIL)
716
                .arg(rsp->getLabel())
717
                .arg(e.what());
718
        }
719 720 721 722 723
    }

    return (true);
}

724
string
725
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
    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());
742 743
}

744
isc::dhcp_ddns::D2Dhcid
745 746 747 748 749 750 751 752 753
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");

754 755
    }

756 757 758 759 760 761 762 763 764
    // 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);
765

766 767 768
    } catch (const Exception& ex) {
        isc_throw(DhcidComputeError, "unable to compute DHCID because the"
                  " hostname: " << lease->hostname_ << " is invalid");
769 770

    }
771 772 773

    // Prefer client id to HW address to compute DHCID. If Client Id is
    // NULL, use HW address.
774
    try {
775 776 777 778
        if (lease->client_id_) {
            return (D2Dhcid(lease->client_id_->getClientId(), fqdn_wire));

        } else {
779
            return (D2Dhcid(lease->hwaddr_, fqdn_wire));
780
        }
781
    } catch (const Exception& ex) {
782 783
        isc_throw(DhcidComputeError, "unable to compute DHCID: "
                  << ex.what());
784

785
    }
786 787 788

}

789
void
790
Dhcpv4Srv::appendServerID(Dhcpv4Exchange& ex) {
791 792 793
    // 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.
794 795
    /// @todo: perhaps we should consider some more sophisticated server id
    /// generation, but for the current use cases, it should be ok.
796 797 798
    OptionPtr opt_srvid(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                           ex.getResponse()->getLocalAddr()));
    ex.getResponse()->addOption(opt_srvid);
799 800
}

801
void
802
Dhcpv4Srv::appendRequestedOptions(Dhcpv4Exchange& ex) {
803 804
    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
805
    Subnet4Ptr subnet = ex.getContext()->subnet_;
806 807 808 809 810 811 812
    // 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;
    }
813

814 815
    Pkt4Ptr query = ex.getQuery();

816 817 818
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
819
        OptionUint8Array>(query->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
820 821 822 823 824
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
825

826 827
    Pkt4Ptr resp = ex.getResponse();

828 829 830 831 832 833
    // 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) {
834
        if (!resp->getOption(*opt)) {
835
            OptionDescriptor desc = subnet->getCfgOption()->get("dhcp4", *opt);
836
            if (desc.option_) {
837
                resp->addOption(desc.option_);
838
            }
839 840
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
841
}
842

843
void
844
Dhcpv4Srv::appendRequestedVendorOptions(Dhcpv4Exchange& ex) {
845
    // Get the configured subnet suitable for the incoming packet.
846
    Subnet4Ptr subnet = ex.getContext()->subnet_;
847 848 849 850 851 852 853 854 855 856
    // 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
857 858
    boost::shared_ptr<OptionVendor> vendor_req = boost::dynamic_pointer_cast<
        OptionVendor>(ex.getQuery()->getOption(DHO_VIVSO_SUBOPTIONS));
859 860 861 862 863 864 865
    if (!vendor_req) {
        return;
    }

    uint32_t vendor_id = vendor_req->getVendorId();

    // Let's try to get ORO within that vendor-option
866 867
    /// @todo This is very specific to vendor-id=4491 (Cable Labs). Other
    /// vendors may have different policies.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
868 869
    OptionUint8ArrayPtr oro =
        boost::dynamic_pointer_cast<OptionUint8Array>(vendor_req->getOption(DOCSIS3_V4_ORO));
870 871 872 873 874 875 876 877 878 879

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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
882
    for (std::vector<uint8_t>::const_iterator code = requested_opts.begin();
883
         code != requested_opts.end(); ++code) {
884
        if  (!vendor_rsp->getOption(*code)) {
885 886
            OptionDescriptor desc = subnet->getCfgOption()->get(vendor_id,
                                                                *code);
887 888
            if (desc.option_) {
                vendor_rsp->addOption(desc.option_);
889 890
                added = true;
            }
891 892
        }

893
        if (added) {
894
            ex.getResponse()->addOption(vendor_rsp);
895 896
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
897
}
898

899

900
void
901
Dhcpv4Srv::appendBasicOptions(Dhcpv4Exchange& ex) {
902 903 904 905 906 907
    // 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 };
908

909 910 911 912
    static size_t required_options_size =
        sizeof(required_options) / sizeof(required_options[0]);

    // Get the subnet.
913
    Subnet4Ptr subnet = ex.getContext()->subnet_;
914 915 916 917
    if (!subnet) {
        return;
    }

918 919
    Pkt4Ptr resp = ex.getResponse();

920 921 922
    // 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) {
923
        OptionPtr opt = resp->getOption(required_options[i]);
924 925
        if (!opt) {
            // Check whether option has been configured.
926 927
            OptionDescriptor desc = subnet->getCfgOption()->
                get("dhcp4", required_options[i]);
928
            if (desc.option_) {
929
                resp->addOption(desc.option_);
930 931 932
            }
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
933
}
934

935
void
936
Dhcpv4Srv::processClientName(Dhcpv4Exchange& ex) {
937 938 939
    // 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.
940
    try {
941
        Pkt4Ptr resp = ex.getResponse();
942
        Option4ClientFqdnPtr fqdn = boost::dynamic_pointer_cast<Option4ClientFqdn>
943
            (ex.getQuery()->getOption(DHO_FQDN));
944
        if (fqdn) {
945
            LOG_DEBUG(ddns4_logger, DBG_DHCP4_DETAIL, DHCP4_CLIENT_FQDN_PROCESS)
946
                .arg(ex.getQuery()->getLabel());
947
            processClientFqdnOption(</