dhcp4_srv.cc 105 KB
Newer Older
1
// Copyright (C) 2011-2016 Internet Systems Consortium, Inc. ("ISC")
2
//
3 4 5
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6

7
#include <config.h>
8
#include <asiolink/io_address.h>
9
#include <dhcp/dhcp4.h>
10 11
#include <dhcp/duid.h>
#include <dhcp/hwaddr.h>
12
#include <dhcp/iface_mgr.h>
13
#include <dhcp/option4_addrlst.h>
14
#include <dhcp/option_int.h>
15
#include <dhcp/option_int_array.h>
16
#include <dhcp/option_vendor.h>
17
#include <dhcp/option_string.h>
18
#include <dhcp/pkt4.h>
19 20
#include <dhcp/pkt4o6.h>
#include <dhcp/pkt6.h>
21
#include <dhcp/docsis3_option_defs.h>
22
#include <dhcp4/dhcp4to6_ipc.h>
23 24
#include <dhcp4/dhcp4_log.h>
#include <dhcp4/dhcp4_srv.h>
25 26
#include <dhcpsrv/addr_utilities.h>
#include <dhcpsrv/callout_handle_store.h>
27
#include <dhcpsrv/cfgmgr.h>
28
#include <dhcpsrv/cfg_host_operations.h>
29
#include <dhcpsrv/cfg_subnets4.h>
30 31
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
32
#include <dhcpsrv/ncr_generator.h>
33
#include <dhcpsrv/subnet.h>
34
#include <dhcpsrv/subnet_selector.h>
35
#include <dhcpsrv/utils.h>
36
#include <dhcpsrv/utils.h>
37 38
#include <eval/evaluate.h>
#include <eval/eval_messages.h>
39
#include <hooks/callout_handle.h>
40
#include <hooks/hooks_log.h>
41
#include <hooks/hooks_manager.h>
42
#include <stats/stats_mgr.h>
43
#include <util/strutil.h>
44
#include <stats/stats_mgr.h>
45 46
#include <log/logger.h>
#include <cryptolink/cryptolink.h>
47
#include <cfgrpt/config_report.h>
48

49 50 51 52 53 54 55 56
#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>

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

#include <iomanip>

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

73 74 75
namespace isc {
namespace dhcp {

76
Dhcpv4Exchange::Dhcpv4Exchange(const AllocEnginePtr& alloc_engine,
77 78
                               const Pkt4Ptr& query,
                               const Subnet4Ptr& subnet)
79 80
    : alloc_engine_(alloc_engine), query_(query), resp_(),
      context_(new AllocEngine::ClientContext4()) {
81

82 83 84 85 86 87 88 89
    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");
90 91
    }

92 93 94
    // Create response message.
    initResponse();
    // Select subnet for the query message.
95
    context_->subnet_ = subnet;
96
    // Hardware address.
97
    context_->hwaddr_ = query->getHWAddr();
98 99
    // Pointer to client's query.
    context_->query_ = query;
100

101
    // Set client identifier if the match-client-id flag is enabled (default).
102 103 104
    // 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) {
105
        if (subnet->getMatchClientId()) {
106 107 108 109 110 111 112 113 114 115
            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());
        }
116

117 118 119 120 121
        // Find static reservations if not disabled for our subnet.
        if (subnet->getHostReservationMode() != Subnet::HR_DISABLED) {
            // Before we can check for static reservations, we need to prepare a set
            // of identifiers to be used for this.
            setHostIdentifiers();
122

123 124
            // Check for static reservations.
            alloc_engine->findReservation(*context_);
125 126
        }
    }
127 128
};

129
void
130
Dhcpv4Exchange::initResponse() {
131 132 133 134 135 136 137 138 139 140 141 142
    uint8_t resp_type = 0;
    switch (getQuery()->getType()) {
    case DHCPDISCOVER:
        resp_type = DHCPOFFER;
        break;
    case DHCPREQUEST:
    case DHCPINFORM:
        resp_type = DHCPACK;
        break;
    default:
        ;
    }
143
    // Only create a response if one is required.
144 145
    if (resp_type > 0) {
        resp_.reset(new Pkt4(resp_type, getQuery()->getTransid()));
146
        copyDefaultFields();
Francis Dupont's avatar
Francis Dupont committed
147
        copyDefaultOptions();
148 149 150 151

        if (getQuery()->isDhcp4o6()) {
            initResponse4o6();
        }
152 153 154
    }
}

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
void
Dhcpv4Exchange::initResponse4o6() {
    Pkt4o6Ptr query = boost::dynamic_pointer_cast<Pkt4o6>(getQuery());
    if (!query) {
        return;
    }
    const Pkt6Ptr& query6 = query->getPkt6();
    Pkt6Ptr resp6(new Pkt6(DHCPV6_DHCPV4_RESPONSE, query6->getTransid()));
    // Don't add client-id or server-id
    // But copy relay info
    if (!query6->relay_info_.empty()) {
        resp6->copyRelayInfo(query6);
    }
    // Copy interface and remote address
    resp6->setIface(query6->getIface());
    resp6->setIndex(query6->getIndex());
    resp6->setRemoteAddr(query6->getRemoteAddr());
    resp_.reset(new Pkt4o6(resp_, resp6));
}

175 176 177 178 179
void
Dhcpv4Exchange::copyDefaultFields() {
    resp_->setIface(query_->getIface());
    resp_->setIndex(query_->getIndex());

180 181
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
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
    // 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());

    // 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);
    }
208

209
    // Copy flags from the request to the response per RFC 2131
210
    resp_->setFlags(query_->getFlags());
211
}
212

213 214
void
Dhcpv4Exchange::copyDefaultOptions() {
215 216 217 218 219 220 221
    // 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);
    }
222 223 224 225 226

    // 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);
227
    }
228 229 230 231 232 233 234 235 236 237 238 239 240

    // RFC 3011 states about the Subnet Selection Option

    // "Servers configured to support this option MUST return an
    //  identical copy of the option to any client that sends it,
    //  regardless of whether or not the client requests the option in
    //  a parameter request list. Clients using this option MUST
    //  discard DHCPOFFER or DHCPACK packets that do not contain this
    //  option."
    OptionPtr subnet_sel = query_->getOption(DHO_SUBNET_SELECTION);
    if (subnet_sel) {
        resp_->addOption(subnet_sel);
    }
241 242
}

243 244 245 246
void
Dhcpv4Exchange::setHostIdentifiers() {
    const ConstCfgHostOperationsPtr cfg =
        CfgMgr::instance().getCurrentCfg()->getCfgHostOperations4();
247 248
    // Collect host identifiers. The identifiers are stored in order of preference.
    // The server will use them in that order to search for host reservations.
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
    BOOST_FOREACH(const Host::IdentifierType& id_type,
                  cfg->getIdentifierTypes()) {
        switch (id_type) {
        case Host::IDENT_HWADDR:
            if (context_->hwaddr_ && !context_->hwaddr_->hwaddr_.empty()) {
                context_->addHostIdentifier(id_type, context_->hwaddr_->hwaddr_);
            }
            break;

        case Host::IDENT_DUID:
            if (context_->clientid_) {
                const std::vector<uint8_t>& vec = context_->clientid_->getDuid();
                if (!vec.empty()) {
                    // Client identifier type = DUID? Client identifier holding a DUID
                    // comprises Type (1 byte), IAID (4 bytes), followed by the actual
                    // DUID. Thus, the minimal length is 6.
                    if ((vec[0] == CLIENT_ID_OPTION_TYPE_DUID) && (vec.size() > 5)) {
                        // Extract DUID, skip IAID.
                        context_->addHostIdentifier(id_type,
                                                    std::vector<uint8_t>(vec.begin() + 5,
                                                                         vec.end()));
                    }
                }
            }
            break;

        case Host::IDENT_CIRCUIT_ID:
            {
                OptionPtr rai = query_->getOption(DHO_DHCP_AGENT_OPTIONS);
                if (rai) {
                    OptionPtr circuit_id_opt = rai->getOption(RAI_OPTION_AGENT_CIRCUIT_ID);
                    if (circuit_id_opt) {
                        const OptionBuffer& circuit_id_vec = circuit_id_opt->getData();
                        if (!circuit_id_vec.empty()) {
                            context_->addHostIdentifier(id_type, circuit_id_vec);
                        }
                    }
                }
            }
            break;

290 291 292 293 294 295 296 297 298
        case Host::IDENT_CLIENT_ID:
            if (context_->clientid_) {
                const std::vector<uint8_t>& vec = context_->clientid_->getDuid();
                if (!vec.empty()) {
                    context_->addHostIdentifier(id_type, vec);
                }
            }
            break;

299 300 301 302 303 304
        default:
            ;
        }
    }
}

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
// Static values so instantiated when the module is loaded.
// As a result, the hook indexes will be defined before any method in this
// module is called.

int Dhcpv4Srv::hook_index_buffer4_receive_=
    HooksManager::registerHook("buffer4_receive");
int Dhcpv4Srv::hook_index_pkt4_receive_ =
    HooksManager::registerHook("pkt4_receive");
int Dhcpv4Srv::hook_index_subnet4_select_ =
    HooksManager::registerHook("subnet4_select");
int Dhcpv4Srv::hook_index_pkt4_send_ =
    HooksManager::registerHook("pkt4_send");
int Dhcpv4Srv::hook_index_lease4_release_ =
    HooksManager::registerHook("lease4_release");
int Dhcpv4Srv::hook_index_buffer4_send_ =
    HooksManager::registerHook("buffer4_send");
int Dhcpv4Srv::hook_index_lease4_decline_ =
    HooksManager::registerHook("lease4_decline");

324 325
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

326
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
327
                     const bool direct_response_desired)
328
    : shutdown_(true), alloc_engine_(), port_(port), use_bcast_(use_bcast) {
329

330
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
331
    try {
332 333 334
        // 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.
335
        if (port) {
336 337 338 339 340 341 342 343
            // 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);
344
        }
345

346 347 348 349
        // 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,
350
                                            false /* false = IPv4 */));
351

352 353
        /// @todo call loadLibraries() when handling configuration changes

354
    } catch (const std::exception &e) {
355
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
356 357 358
        shutdown_ = true;
        return;
    }
359

Tomek Mrugalski's avatar
Tomek Mrugalski committed
360
    shutdown_ = false;
361 362 363
}

Dhcpv4Srv::~Dhcpv4Srv() {
364 365 366 367 368 369
    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());
    }
370

371 372 373 374 375 376 377
    try {
        Dhcp4to6Ipc::instance().close();
    } catch(const std::exception& ex) {
        // Highly unlikely, but lets Report it but go on
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_DHCP4O6_ERROR).arg(ex.what());
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
378
    IfaceMgr::instance().closeSockets();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
379

380 381
    // The lease manager was instantiated during DHCPv4Srv configuration,
    // so we should clean up after ourselves.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
382
    LeaseMgrFactory::destroy();
383 384 385

    // Explicitly unload hooks
    HooksManager::getHooksManager().unloadLibraries();
386 387
}

388 389
void
Dhcpv4Srv::shutdown() {
390
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
391 392 393
    shutdown_ = true;
}

394
isc::dhcp::Subnet4Ptr
395
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query) const {
396

397 398 399 400 401
    // DHCPv4-over-DHCPv6 is a special (and complex) case
    if (query->isDhcp4o6()) {
        return (selectSubnet4o6(query));
    }

402 403 404 405 406 407 408 409 410 411
    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();

412 413 414 415 416 417
    // If the link-selection sub-option is present, extract its value.
    // "The link-selection sub-option is used by any DHCP relay agent
    // that desires to specify a subnet/link for a DHCP client request
    // that it is relaying but needs the subnet/link specification to
    // be different from the IP address the DHCP server should use
    // when communicating with the relay agent." (RFC 3257)
418
    //
419
    // Try first Relay Agent Link Selection sub-option
420 421
    OptionPtr rai = query->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
422 423 424 425 426 427 428 429
        OptionCustomPtr rai_custom =
            boost::dynamic_pointer_cast<OptionCustom>(rai);
        if (rai_custom) {
            OptionPtr link_select =
                rai_custom->getOption(RAI_OPTION_LINK_SELECTION);
            if (link_select) {
                OptionBuffer link_select_buf = link_select->getData();
                if (link_select_buf.size() == sizeof(uint32_t)) {
430
                    selector.option_select_ =
431
                        IOAddress::fromBytes(AF_INET, &link_select_buf[0]);
432 433 434
                }
            }
        }
435 436 437 438 439 440 441 442 443 444
    } else {
        // Or Subnet Selection option
        OptionPtr sbnsel = query->getOption(DHO_SUBNET_SELECTION);
        if (sbnsel) {
            OptionCustomPtr oc =
                boost::dynamic_pointer_cast<OptionCustom>(sbnsel);
            if (oc) {
                selector.option_select_ = oc->readAddress();
            }
        }
445 446
    }

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

    // Let's execute all callouts registered for subnet4_select
451
    if (HooksManager::calloutsPresent(hook_index_subnet4_select_)) {
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
        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)
471
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
472
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
473 474
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
475 476 477
            return (Subnet4Ptr());
        }

478 479
        /// @todo: Add support for DROP status

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

484 485
    if (subnet) {
        // Log at higher debug level that subnet has been found.
486
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
487 488 489 490
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
491
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
492 493 494 495
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
496
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
497 498 499 500
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

501
    return (subnet);
502 503
}

504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
isc::dhcp::Subnet4Ptr
Dhcpv4Srv::selectSubnet4o6(const Pkt4Ptr& query) const {
    // Here begin by the same thing than selectSubnet, i.e., the DHCPv4 part

    Subnet4Ptr subnet;

    SubnetSelector selector;
    selector.ciaddr_ = query->getCiaddr();
    selector.giaddr_ = query->getGiaddr();
    selector.local_address_ = query->getLocalAddr();
    selector.client_classes_ = query->classes_;
    // moved selector.remote_address_ as it is IPv6
    selector.iface_name_ = query->getIface();

    // If the link-selection sub-option is present, extract its value.
    // "The link-selection sub-option is used by any DHCP relay agent
    // that desires to specify a subnet/link for a DHCP client request
    // that it is relaying but needs the subnet/link specification to
    // be different from the IP address the DHCP server should use
    // when communicating with the relay agent." (RFC 3257)
    //
    // Try first Relay Agent Link Selection sub-option
    OptionPtr rai = query->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
        OptionCustomPtr rai_custom =
            boost::dynamic_pointer_cast<OptionCustom>(rai);
        if (rai_custom) {
            OptionPtr link_select =
                rai_custom->getOption(RAI_OPTION_LINK_SELECTION);
            if (link_select) {
                OptionBuffer link_select_buf = link_select->getData();
                if (link_select_buf.size() == sizeof(uint32_t)) {
                    selector.option_select_ =
                        IOAddress::fromBytes(AF_INET, &link_select_buf[0]);
                }
            }
        }
    } else {
        // Or Subnet Selection option
        OptionPtr sbnsel = query->getOption(DHO_SUBNET_SELECTION);
        if (sbnsel) {
            OptionCustomPtr oc =
                boost::dynamic_pointer_cast<OptionCustom>(sbnsel);
            if (oc) {
                selector.option_select_ = oc->readAddress();
            }
        }
    }

    // Mark it as DHCPv4-over-DHCPv6
    selector.dhcp4o6_ = true;

    // Now the DHCPv6 part
    selector.remote_address_ = query->getRemoteAddr();
    selector.first_relay_linkaddr_ = IOAddress("::");

    // Handle a DHCPv6 relayed query
    Pkt4o6Ptr query4o6 = boost::dynamic_pointer_cast<Pkt4o6>(query);
    if (!query4o6) {
563
        isc_throw(Unexpected, "Can't get DHCP4o6 message");
564 565 566 567 568 569 570 571 572 573 574 575 576 577
    }
    const Pkt6Ptr& query6 = query4o6->getPkt6();

    // Initialize fields specific to relayed messages.
    if (query6 && !query6->relay_info_.empty()) {
        BOOST_REVERSE_FOREACH(Pkt6::RelayInfo relay, query6->relay_info_) {
            if (!relay.linkaddr_.isV6Zero() &&
                !relay.linkaddr_.isV6LinkLocal()) {
                selector.first_relay_linkaddr_ = relay.linkaddr_;
                break;
            }
        }
        selector.interface_id_ =
            query6->getAnyRelayOption(D6O_INTERFACE_ID,
578
                                      Pkt6::RELAY_GET_FIRST);
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
    }

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

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

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

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

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

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

        /// @todo: Add support for DROP status

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

    if (subnet) {
        // Log at higher debug level that subnet has been found.
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
            .arg(query->getLabel())
            .arg(subnet->toText());

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

    return (subnet);
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
638 639
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
640 641 642
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
643 644
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
645 646 647
    IfaceMgr::instance().send(packet);
}

648 649
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
650
    while (!shutdown_) {
651
        try {
Francis Dupont's avatar
Francis Dupont committed
652
            run_one();
653
        } catch (const std::exception& e) {
654 655
            // General catch-all exception that are not caught by more specific
            // catches. This one is for exceptions derived from std::exception.
656
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_STD_EXCEPTION)
657
                .arg(e.what());
658 659 660 661
        } catch (...) {
            // General catch-all exception that are not caught by more specific
            // catches. This one is for other exceptions, not derived from
            // std::exception.
662
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_EXCEPTION);
663
        }
664 665 666 667
    }

    return (true);
}
668

Francis Dupont's avatar
Francis Dupont committed
669 670 671 672 673
void
Dhcpv4Srv::run_one() {
    // client's message and server's response
    Pkt4Ptr query;
    Pkt4Ptr rsp;
674

Francis Dupont's avatar
Francis Dupont committed
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
    try {
        uint32_t timeout = 1000;
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT).arg(timeout);
        query = receivePacket(timeout);

        // 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(packet4_logger, DBG_DHCP4_BASIC, DHCP4_BUFFER_RECEIVED)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getRemotePort())
                .arg(query->getLocalAddr().toText())
                .arg(query->getLocalPort())
                .arg(query->getIface());
693

Francis Dupont's avatar
Francis Dupont committed
694 695 696
        } else {
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_INTERRUPTED)
                .arg(timeout);
697 698
        }

Francis Dupont's avatar
Francis Dupont committed
699 700 701 702 703 704 705 706 707 708 709 710
    } 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, SIGHUP or SIGCHILD which are handled by the server. For
        // signals that are not handled by the server we rely on the default
        // behavior of the system.
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_SIGNAL)
            .arg(signal_set_->getNext());
    } catch (const std::exception& e) {
        // Log all other errors.
        LOG_ERROR(packet4_logger, DHCP4_BUFFER_RECEIVE_FAIL).arg(e.what());
    }
711

Francis Dupont's avatar
Francis Dupont committed
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
    // 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
    // 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.
    try {
        handleSignal();
    } catch (const std::exception& e) {
        // Standard exception occurred. Let's be on the safe side to
        // catch std::exception.
        LOG_ERROR(dhcp4_logger, DHCP4_HANDLE_SIGNAL_EXCEPTION)
            .arg(e.what());
    }
730

Francis Dupont's avatar
Francis Dupont committed
731 732 733 734 735 736
    // Timeout may be reached or signal received, which breaks select()
    // with no reception occurred. No need to log anything here because
    // we have logged right after the call to receivePacket().
    if (!query) {
        return;
    }
737

738
    processPacket(query, rsp);
739

740 741 742
    if (!rsp) {
        return;
    }
743

744 745 746 747 748
    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.
        // Let's execute all callouts registered for buffer4_send
749
        if (HooksManager::calloutsPresent(hook_index_buffer4_send_)) {
750 751 752 753 754 755
            CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

            // Pass incoming packet as argument
756
            callout_handle->setArgument("response4", rsp);
757 758

            // Call callouts
759
            HooksManager::callCallouts(hook_index_buffer4_send_,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
760
                                       *callout_handle);
761 762 763

            // Callouts decided to skip the next processing step. The next
            // processing step would to parse the packet, so skip at this
764
            // stage means drop.
765
            if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
766 767 768 769
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                          DHCP4_HOOK_BUFFER_SEND_SKIP)
                    .arg(rsp->getLabel());
                return;
770 771
            }

772
            /// @todo: Add support for DROP status.
773

774
            callout_handle->getArgument("response4", rsp);
775 776
        }

777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_PACKET_SEND)
            .arg(rsp->getLabel())
            .arg(rsp->getName())
            .arg(static_cast<int>(rsp->getType()))
            .arg(rsp->getLocalAddr())
            .arg(rsp->getLocalPort())
            .arg(rsp->getRemoteAddr())
            .arg(rsp->getRemotePort())
            .arg(rsp->getIface());

        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA,
                  DHCP4_RESPONSE_DATA)
            .arg(rsp->getLabel())
            .arg(rsp->getName())
            .arg(static_cast<int>(rsp->getType()))
            .arg(rsp->toText());
        sendPacket(rsp);

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

    } catch (const std::exception& e) {
        LOG_ERROR(packet4_logger, DHCP4_PACKET_SEND_FAIL)
            .arg(rsp->getLabel())
            .arg(e.what());
    }
803
}
804

805
void
806
Dhcpv4Srv::processPacket(Pkt4Ptr& query, Pkt4Ptr& rsp) {
807 808
    // Log reception of the packet. We need to increase it early, as any
    // failures in unpacking will cause the packet to be dropped. We
809
    // will increase type specific statistic further down the road.
810 811 812 813 814 815 816 817
    // See processStatsReceived().
    isc::stats::StatsMgr::instance().addValue("pkt4-received",
                                              static_cast<int64_t>(1));

    bool skip_unpack = false;

    // The packet has just been received so contains the uninterpreted wire
    // data; execute callouts registered for buffer4_receive.
818
    if (HooksManager::calloutsPresent(hook_index_buffer4_receive_)) {
819
        CalloutHandlePtr callout_handle = getCalloutHandle(query);
820

821 822
        // Delete previously set arguments
        callout_handle->deleteAllArguments();
823

824 825
        // Pass incoming packet as argument
        callout_handle->setArgument("query4", query);
826

827
        // Call callouts
828
        HooksManager::callCallouts(hook_index_buffer4_receive_,
829
                                   *callout_handle);
830

831 832 833 834 835 836 837 838 839 840 841 842
        // 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->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
            LOG_DEBUG(hooks_logger, DBG_DHCP4_DETAIL,
                      DHCP4_HOOK_BUFFER_RCVD_SKIP)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getLocalAddr().toText())
                .arg(query->getIface());
            skip_unpack = true;
        }
843

844
        callout_handle->getArgument("query4", query);
845

846 847
        /// @todo: add support for DROP status
    }
848

849 850 851
    // Unpack the packet information unless the buffer4_receive callouts
    // indicated they did it
    if (!skip_unpack) {
852
        try {
853 854 855 856 857
            LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_UNPACK)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getLocalAddr().toText())
                .arg(query->getIface());
            query->unpack();
858
        } catch (const std::exception& e) {
859 860 861 862 863 864
            // Failed to parse the packet.
            LOG_DEBUG(bad_packet4_logger, DBG_DHCP4_DETAIL,
                      DHCP4_PACKET_DROP_0001)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getLocalAddr().toText())
                .arg(query->getIface())
865
                .arg(e.what());
866

867 868 869
            // Increase the statistics of parse failues and dropped packets.
            isc::stats::StatsMgr::instance().addValue("pkt4-parse-failed",
                                                      static_cast<int64_t>(1));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
870
            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
871
                                                      static_cast<int64_t>(1));
872
            return;
873
        }
874
    }
875

876 877
    // Update statistics accordingly for received packet.
    processStatsReceived(query);
878

879 880 881 882
    // 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.
    classifyPacket(query);
883

884 885 886 887 888 889 890 891
    // 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)) {
        // Increase the statistic of dropped packets.
        isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
                                                  static_cast<int64_t>(1));
        return;
    }
892

893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
    // We have sanity checked (in accept() that the Message Type option
    // exists, so we can safely get it here.
    int type = query->getType();
    LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_PACKET_RECEIVED)
        .arg(query->getLabel())
        .arg(query->getName())
        .arg(type)
        .arg(query->getRemoteAddr())
        .arg(query->getLocalAddr())
        .arg(query->getIface());
    LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
        .arg(query->getLabel())
        .arg(query->toText());

    // Let's execute all callouts registered for pkt4_receive
    if (HooksManager::calloutsPresent(hook_index_pkt4_receive_)) {
        CalloutHandlePtr callout_handle = getCalloutHandle(query);
910

911 912
        // Delete previously set arguments
        callout_handle->deleteAllArguments();
913

914 915
        // Pass incoming packet as argument
        callout_handle->setArgument("query4", query);
916

917 918 919
        // Call callouts
        HooksManager::callCallouts(hook_index_pkt4_receive_,
                                   *callout_handle);
920

921 922 923 924 925 926 927
        // 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->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_PACKET_RCVD_SKIP)
                .arg(query->getLabel());
928
            return;
929
        }
930

931
        /// @todo: Add support for DROP status
932

933 934
        callout_handle->getArgument("query4", query);
    }
935

936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
    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:
            rsp = processInform(query);
            break;

        default:
            // Only action is to output a message if debug is enabled,
            // and that is covered by the debug statement before the
            // "switch" statement.
            ;
966
        }
967 968 969 970 971 972 973 974 975 976 977 978 979
    } catch (const std::exception& e) {

        // 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.
        // (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.)
        LOG_DEBUG(bad_packet4_logger, DBG_DHCP4_BASIC,
                  DHCP4_PACKET_DROP_0007)
            .arg(query->getLabel())
            .arg(e.what());
980

981 982 983 984
        // Increase the statistic of dropped packets.
        isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
                                                  static_cast<int64_t>(1));
    }
985

986 987 988
    if (!rsp) {
        return;
    }
989

990 991
    // Specifies if server should do the packing
    bool skip_pack = false;
992

993 994 995
    // Execute all callouts registered for pkt4_send
    if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
        CalloutHandlePtr callout_handle = getCalloutHandle(query);
996

997 998
        // Delete all previous arguments
        callout_handle->deleteAllArguments();
999

1000 1001
        // Clear skip flag if it was set in previous callouts
        callout_handle->setStatus(CalloutHandle::NEXT_STEP_CONTINUE);
1002

1003 1004
        // Set our response
        callout_handle->setArgument("response4", rsp);
1005

1006 1007 1008
        // Also pass the corresponding query packet as argument
        callout_handle->setArgument("query4", query);

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
        // Call all installed callouts
        HooksManager::callCallouts(hook_index_pkt4_send_,
                                   *callout_handle);

        // 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->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_PACKET_SEND_SKIP)
                .arg(query->getLabel());
            skip_pack = true;
1021
        }
1022

1023 1024
        /// @todo: Add support for DROP status
    }
1025

1026 1027 1028 1029 1030
    if (!skip_pack) {
        try {
            LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_PACK)
                .arg(rsp->getLabel());
            rsp->pack();
1031
        } catch (const std::exception& e) {
1032 1033
            LOG_ERROR(options4_logger, DHCP4_PACKET_PACK_FAIL)
                .arg(rsp->getLabel())
1034 1035
                .arg(e.what());
        }
1036 1037 1038
    }
}

1039
string
1040
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
    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());
1057 1058
}

1059
void
1060
Dhcpv4Srv::appendServerID(Dhcpv4Exchange& ex) {
1061 1062 1063
    // 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.
1064 1065
    /// @todo: perhaps we should consider some more sophisticated server id
    /// generation, but for the current use cases, it should be ok.
1066 1067 1068
    OptionPtr opt_srvid(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                           ex.getResponse()->getLocalAddr()));
    ex.getResponse()->addOption(opt_srvid);
1069 1070
}

1071 1072 1073 1074
void
Dhcpv4Srv::buildCfgOptionList(Dhcpv4Exchange& ex) {
    CfgOptionList& co_list = ex.getCfgOptionList();

1075
    // Retrieve subnet.
1076
    Subnet4Ptr subnet = ex.getContext()->subnet_;
1077 1078 1079 1080