dhcp4_srv.cc 98.1 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() {
266 267 268 269 270 271
    try {
        stopD2();
    } catch(const std::exception& ex) {
        // Highly unlikely, but lets Report it but go on
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_D2STOP_ERROR).arg(ex.what());
    }
272

Tomek Mrugalski's avatar
Tomek Mrugalski committed
273
    IfaceMgr::instance().closeSockets();
274 275
}

276 277
void
Dhcpv4Srv::shutdown() {
278
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
279 280 281
    shutdown_ = true;
}

282
isc::dhcp::Subnet4Ptr
283
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query) const {
284 285 286 287 288 289 290 291 292 293 294

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

295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
    OptionPtr rai = query->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
        OptionCustomPtr oc = boost::dynamic_pointer_cast<OptionCustom>(rai);
        if (oc) {
            OptionPtr ols = oc->getOption(RAI_OPTION_LINK_SELECTION);
            if (ols) {
                OptionBuffer lsb = ols->getData();
                if (lsb.size() == sizeof(uint32_t)) {
                    selector.option_select_ =
                        IOAddress::fromBytes(AF_INET, &lsb[0]);
                }
            }
        }
    }

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

    // Let's execute all callouts registered for subnet4_select
314
    if (HooksManager::calloutsPresent(hook_index_subnet4_select_)) {
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
        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()) {
335
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
336 337
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
338 339 340 341 342 343 344
            return (Subnet4Ptr());
        }

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

345 346
    if (subnet) {
        // Log at higher debug level that subnet has been found.
347
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
348 349 350 351
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
352
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
353 354 355 356
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
357
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
358 359 360 361
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

362
    return (subnet);
363 364
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
365 366
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
367 368 369
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
370 371
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
372 373 374
    IfaceMgr::instance().send(packet);
}

375 376
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
377
    while (!shutdown_) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
378
        // client's message and server's response
379
        Pkt4Ptr query;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
380
        Pkt4Ptr rsp;
381

382
        try {
383 384 385 386 387 388 389 390 391 392
            // 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;
            }
393
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT).arg(timeout);
394
            query = receivePacket(timeout);
395

396 397 398 399 400 401 402
            // 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) {
403
                LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_BUFFER_RECEIVED)
404 405 406 407 408 409 410
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getRemotePort())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getLocalPort())
                    .arg(query->getIface());

            } else {
411
                LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_INTERRUPTED)
412 413 414
                    .arg(timeout);
            }

415 416 417
        } catch (const SignalInterruptOnSelect) {
            // Packet reception interrupted because a signal has been received.
            // This is not an error because we might have received a SIGTERM,
418 419
            // SIGINT, SIGHUP or SIGCHILD which are handled by the server. For
            // signals that are not handled by the server we rely on the default
420
            // behavior of the system.
421
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_SIGNAL)
422
                .arg(signal_set_->getNext());
423
        } catch (const std::exception& e) {
424
            // Log all other errors.
425
            LOG_ERROR(packet4_logger, DHCP4_BUFFER_RECEIVE_FAIL).arg(e.what());
426 427
        }

428 429 430
        // 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
431 432 433 434 435 436 437
        // 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.
438 439 440
        try {
            handleSignal();
        } catch (const std::exception& e) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
441 442 443
            // Standard exception occurred. Let's be on the safe side to
            // catch std::exception.
            LOG_ERROR(dhcp4_logger, DHCP4_HANDLE_SIGNAL_EXCEPTION)
444 445
                .arg(e.what());
        }
446

447 448
        // Execute ready timers for the lease database, e.g. Lease File Cleanup.
        try {
449
            LeaseMgrFactory::instance().getIOService()->poll();
450 451 452 453 454 455

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

456
        // Timeout may be reached or signal received, which breaks select()
457 458
        // with no reception occurred. No need to log anything here because
        // we have logged right after the call to receivePacket().
459 460 461 462
        if (!query) {
            continue;
        }

463 464 465 466
        // 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
467
        isc::stats::StatsMgr::instance().addValue("pkt4-received",
468
                                                  static_cast<int64_t>(1));
469

470 471 472 473 474 475 476 477 478
        // 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));

479 480 481
        bool skip_unpack = false;

        // The packet has just been received so contains the uninterpreted wire
482
        // data; execute callouts registered for buffer4_receive.
483
        if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
484 485 486 487 488 489 490 491 492
            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
493 494
            HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                       *callout_handle);
495 496 497 498 499 500

            // 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()) {
501
                LOG_DEBUG(hooks_logger, DBG_DHCP4_DETAIL, DHCP4_HOOK_BUFFER_RCVD_SKIP)
502 503 504
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface());
505 506 507 508 509 510 511 512 513
                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
514
            try {
515
                LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_UNPACK)
516 517 518
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface());
Tomek Mrugalski's avatar
Tomek Mrugalski committed
519 520
                query->unpack();
            } catch (const std::exception& e) {
521
                // Failed to parse the packet.
522
                LOG_DEBUG(bad_packet4_logger, DBG_DHCP4_DETAIL,
523
                          DHCP4_PACKET_DROP_0001)
524 525 526
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface())
527
                    .arg(e.what());
528 529

                // Increase the statistics of parse failues and dropped packets.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
530
                isc::stats::StatsMgr::instance().addValue("pkt4-parse-failed",
531
                                                          static_cast<int64_t>(1));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
532
                isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
533
                                                          static_cast<int64_t>(1));
534 535
                continue;
            }
536
        }
537

538 539 540
        // Update statistics accordingly for received packet.
        processStatsReceived(query);

Tomek Mrugalski's avatar
Tomek Mrugalski committed
541 542 543
        // 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.
544 545
        classifyPacket(query);

546 547 548
        // 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)) {
549
            // Increase the statistic of dropped packets.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
550
            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
551
                                                      static_cast<int64_t>(1));
552
            continue;
553
        }
554

555
        // We have sanity checked (in accept() that the Message Type option
556 557
        // exists, so we can safely get it here.
        int type = query->getType();
558
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_PACKET_RECEIVED)
559
            .arg(query->getLabel())
560
            .arg(query->getName())
561
            .arg(type)
562 563
            .arg(query->getRemoteAddr())
            .arg(query->getLocalAddr())
564
            .arg(query->getIface());
565
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
566
            .arg(query->getLabel())
567 568
            .arg(query->toText());

Tomek Mrugalski's avatar
Tomek Mrugalski committed
569
        // Let's execute all callouts registered for pkt4_receive
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
        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()) {
587
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_RCVD_SKIP)
588
                    .arg(query->getLabel());
589 590
                continue;
            }
591

592 593
            callout_handle->getArgument("query4", query);
        }
594

595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
        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:
617
                rsp = processInform(query);
618 619 620 621 622 623 624
                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.
                ;
625
            }
626
        } catch (const std::exception& e) {
627

628 629 630 631
            // Catch-all exception (we used to call only isc::Exception, but
            // std::exception could potentially be raised and if we don't catch
            // it here, it would be caught in main() and the process would
            // terminate).  Just log the problem and ignore the packet.
632 633 634
            // (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.)
635
            LOG_DEBUG(bad_packet4_logger, DBG_DHCP4_BASIC,
636 637 638
                      DHCP4_PACKET_DROP_0007)
                .arg(query->getLabel())
                .arg(e.what());
639 640

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

645 646 647
        if (!rsp) {
            continue;
        }
648

649

650 651
        // Specifies if server should do the packing
        bool skip_pack = false;
652

Tomek Mrugalski's avatar
Tomek Mrugalski committed
653
        // Execute all callouts registered for pkt4_send
654 655
        if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
            CalloutHandlePtr callout_handle = getCalloutHandle(query);
656

657 658
            // Delete all previous arguments
            callout_handle->deleteAllArguments();
659

660 661
            // Clear skip flag if it was set in previous callouts
            callout_handle->setSkip(false);
662

663 664
            // Set our response
            callout_handle->setArgument("response4", rsp);
665

666 667 668
            // Call all installed callouts
            HooksManager::callCallouts(hook_index_pkt4_send_,
                                       *callout_handle);
669

670 671 672 673
            // 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()) {
674
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_SEND_SKIP)
675
                    .arg(query->getLabel());
676 677 678 679 680 681
                skip_pack = true;
            }
        }

        if (!skip_pack) {
            try {
682
                LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_PACK)
683
                    .arg(rsp->getLabel());
684 685
                rsp->pack();
            } catch (const std::exception& e) {
686
                LOG_ERROR(options4_logger, DHCP4_PACKET_PACK_FAIL)
687
                    .arg(rsp->getLabel())
688 689 690 691 692 693 694 695
                    .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
696
            // Let's execute all callouts registered for buffer4_send
697
            if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_send_)) {
698
                CalloutHandlePtr callout_handle = getCalloutHandle(query);
699

700 701
                // Delete previously set arguments
                callout_handle->deleteAllArguments();
702

703 704
                // Pass incoming packet as argument
                callout_handle->setArgument("response4", rsp);
705

706
                // Call callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
707 708
                HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
                                           *callout_handle);
709

710 711 712 713
                // 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()) {
714
                    LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
715 716
                              DHCP4_HOOK_BUFFER_SEND_SKIP)
                        .arg(rsp->getLabel());
717
                    continue;
718
                }
719 720

                callout_handle->getArgument("response4", rsp);
721
            }
722

723
            LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_PACKET_SEND)
724
                .arg(rsp->getLabel())
725
                .arg(rsp->getName())
726 727 728 729 730 731
                .arg(static_cast<int>(rsp->getType()))
                .arg(rsp->getLocalAddr())
                .arg(rsp->getLocalPort())
                .arg(rsp->getRemoteAddr())
                .arg(rsp->getRemotePort())
                .arg(rsp->getIface());
732

733
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA,
734
                      DHCP4_RESPONSE_DATA)
735 736 737 738
                .arg(rsp->getLabel())
                .arg(rsp->getName())
                .arg(static_cast<int>(rsp->getType()))
                .arg(rsp->toText());
739
            sendPacket(rsp);
740 741 742 743

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

744
        } catch (const std::exception& e) {
745
            LOG_ERROR(packet4_logger, DHCP4_PACKET_SEND_FAIL)
746
                .arg(rsp->getLabel())
747
                .arg(e.what());
748
        }
749 750 751 752 753
    }

    return (true);
}

754
string
755
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
    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());
772 773
}

774
isc::dhcp_ddns::D2Dhcid
775 776 777 778 779 780 781 782 783
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");

784 785
    }

786 787 788 789 790 791 792 793 794
    // 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);
795

796 797 798
    } catch (const Exception& ex) {
        isc_throw(DhcidComputeError, "unable to compute DHCID because the"
                  " hostname: " << lease->hostname_ << " is invalid");
799 800

    }
801 802 803

    // Prefer client id to HW address to compute DHCID. If Client Id is
    // NULL, use HW address.
804
    try {
805 806 807 808
        if (lease->client_id_) {
            return (D2Dhcid(lease->client_id_->getClientId(), fqdn_wire));

        } else {
809
            return (D2Dhcid(lease->hwaddr_, fqdn_wire));
810
        }
811
    } catch (const Exception& ex) {
812 813
        isc_throw(DhcidComputeError, "unable to compute DHCID: "
                  << ex.what());
814

815
    }
816 817 818

}

819
void
820
Dhcpv4Srv::appendServerID(Dhcpv4Exchange& ex) {
821 822 823
    // 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.
824 825
    /// @todo: perhaps we should consider some more sophisticated server id
    /// generation, but for the current use cases, it should be ok.
826 827 828
    OptionPtr opt_srvid(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                           ex.getResponse()->getLocalAddr()));
    ex.getResponse()->addOption(opt_srvid);
829 830
}

831
void
832
Dhcpv4Srv::appendRequestedOptions(Dhcpv4Exchange& ex) {
833 834
    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
835
    Subnet4Ptr subnet = ex.getContext()->subnet_;
836 837 838 839 840 841 842
    // 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;
    }
843

844 845
    Pkt4Ptr query = ex.getQuery();

846 847 848
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
849
        OptionUint8Array>(query->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
850 851 852 853 854
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
855

856 857
    Pkt4Ptr resp = ex.getResponse();

858 859 860 861 862 863
    // 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) {
864
        if (!resp->getOption(*opt)) {
865
            OptionDescriptor desc = subnet->getCfgOption()->get("dhcp4", *opt);
866
            if (desc.option_) {
867
                resp->addOption(desc.option_);
868
            }
869 870
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
871
}
872

873
void
874
Dhcpv4Srv::appendRequestedVendorOptions(Dhcpv4Exchange& ex) {
875
    // Get the configured subnet suitable for the incoming packet.
876
    Subnet4Ptr subnet = ex.getContext()->subnet_;
877 878 879 880 881 882 883 884 885 886
    // 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
887 888
    boost::shared_ptr<OptionVendor> vendor_req = boost::dynamic_pointer_cast<
        OptionVendor>(ex.getQuery()->getOption(DHO_VIVSO_SUBOPTIONS));
889 890 891 892 893 894 895
    if (!vendor_req) {
        return;
    }

    uint32_t vendor_id = vendor_req->getVendorId();

    // Let's try to get ORO within that vendor-option
896 897
    /// @todo This is very specific to vendor-id=4491 (Cable Labs). Other
    /// vendors may have different policies.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
898 899
    OptionUint8ArrayPtr oro =
        boost::dynamic_pointer_cast<OptionUint8Array>(vendor_req->getOption(DOCSIS3_V4_ORO));
900 901 902 903 904 905 906 907 908 909

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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
912
    for (std::vector<uint8_t>::const_iterator code = requested_opts.begin();
913
         code != requested_opts.end(); ++code) {
914
        if  (!vendor_rsp->getOption(*code)) {
915 916
            OptionDescriptor desc = subnet->getCfgOption()->get(vendor_id,
                                                                *code);
917 918
            if (desc.option_) {
                vendor_rsp->addOption(desc.option_);
919 920
                added = true;
            }
921 922
        }

923
        if (added) {