dhcp4_srv.cc 132 KB
Newer Older
1
// Copyright (C) 2011-2018 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 <dhcp/dhcp4.h>
9 10
#include <dhcp/duid.h>
#include <dhcp/hwaddr.h>
11
#include <dhcp/iface_mgr.h>
12
#include <dhcp/libdhcp++.h>
13
#include <dhcp/option4_addrlst.h>
14
#include <dhcp/option_custom.h>
15
#include <dhcp/option_int.h>
16
#include <dhcp/option_int_array.h>
17
#include <dhcp/option_vendor.h>
18
#include <dhcp/option_string.h>
19
#include <dhcp/pkt4.h>
20 21
#include <dhcp/pkt4o6.h>
#include <dhcp/pkt6.h>
22
#include <dhcp/docsis3_option_defs.h>
23
#include <dhcp4/dhcp4to6_ipc.h>
24 25
#include <dhcp4/dhcp4_log.h>
#include <dhcp4/dhcp4_srv.h>
26
#include <dhcpsrv/addr_utilities.h>
27
#include <dhcpsrv/cfgmgr.h>
28
#include <dhcpsrv/cfg_host_operations.h>
29
#include <dhcpsrv/cfg_iface.h>
30
#include <dhcpsrv/cfg_shared_networks.h>
31
#include <dhcpsrv/cfg_subnets4.h>
32 33
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
34
#include <dhcpsrv/ncr_generator.h>
35
#include <dhcpsrv/shared_network.h>
36
#include <dhcpsrv/subnet.h>
37
#include <dhcpsrv/subnet_selector.h>
38
#include <dhcpsrv/utils.h>
39
#include <dhcpsrv/utils.h>
40 41
#include <eval/evaluate.h>
#include <eval/eval_messages.h>
42
#include <hooks/callout_handle.h>
43
#include <hooks/hooks_log.h>
44
#include <hooks/hooks_manager.h>
45
#include <stats/stats_mgr.h>
46
#include <util/strutil.h>
47
#include <stats/stats_mgr.h>
48 49
#include <log/logger.h>
#include <cryptolink/cryptolink.h>
50
#include <cfgrpt/config_report.h>
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
Tomek Mrugalski's avatar
Tomek Mrugalski committed
58 59
#ifdef HAVE_CQL
#include <dhcpsrv/cql_lease_mgr.h>
60
#endif
61 62
#include <dhcpsrv/memfile_lease_mgr.h>

63
#include <boost/algorithm/string/join.hpp>
64
#include <boost/bind.hpp>
65
#include <boost/foreach.hpp>
66
#include <boost/pointer_cast.hpp>
67
#include <boost/shared_ptr.hpp>
68 69 70

#include <iomanip>

71 72
using namespace isc;
using namespace isc::asiolink;
73
using namespace isc::cryptolink;
74
using namespace isc::dhcp;
75
using namespace isc::dhcp_ddns;
76
using namespace isc::hooks;
77
using namespace isc::log;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
78
using namespace isc::stats;
79
using namespace std;
80

81 82
namespace {

83
/// Structure that holds registered hook indexes
84
struct Dhcp4Hooks {
85 86 87 88 89 90 91 92 93
    int hook_index_buffer4_receive_;   ///< index for "buffer4_receive" hook point
    int hook_index_pkt4_receive_;      ///< index for "pkt4_receive" hook point
    int hook_index_subnet4_select_;    ///< index for "subnet4_select" hook point
    int hook_index_leases4_committed_; ///< index for "leases4_committed" hook point
    int hook_index_lease4_release_;    ///< index for "lease4_release" hook point
    int hook_index_pkt4_send_;         ///< index for "pkt4_send" hook point
    int hook_index_buffer4_send_;      ///< index for "buffer4_send" hook point
    int hook_index_lease4_decline_;    ///< index for "lease4_decline" hook point
    int hook_index_host4_identifier_;  ///< index for "host4_identifier" hook point
94

95 96
    /// Constructor that registers hook points for DHCPv4 engine
    Dhcp4Hooks() {
97 98 99 100 101 102 103 104 105
        hook_index_buffer4_receive_   = HooksManager::registerHook("buffer4_receive");
        hook_index_pkt4_receive_      = HooksManager::registerHook("pkt4_receive");
        hook_index_subnet4_select_    = HooksManager::registerHook("subnet4_select");
        hook_index_leases4_committed_ = HooksManager::registerHook("leases4_committed");
        hook_index_pkt4_send_         = HooksManager::registerHook("pkt4_send");
        hook_index_lease4_release_    = HooksManager::registerHook("lease4_release");
        hook_index_buffer4_send_      = HooksManager::registerHook("buffer4_send");
        hook_index_lease4_decline_    = HooksManager::registerHook("lease4_decline");
        hook_index_host4_identifier_  = HooksManager::registerHook("host4_identifier");
106 107 108
    }
};

109 110
} // end of anonymous namespace

111 112 113 114
// 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.
115
Dhcp4Hooks Hooks;
116

117

118 119 120
namespace isc {
namespace dhcp {

121
Dhcpv4Exchange::Dhcpv4Exchange(const AllocEnginePtr& alloc_engine,
122 123
                               const Pkt4Ptr& query,
                               const Subnet4Ptr& subnet)
124 125
    : alloc_engine_(alloc_engine), query_(query), resp_(),
      context_(new AllocEngine::ClientContext4()) {
126

127 128 129 130 131 132 133 134
    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");
135 136
    }

137 138 139
    // Create response message.
    initResponse();
    // Select subnet for the query message.
140
    context_->subnet_ = subnet;
141
    // Hardware address.
142
    context_->hwaddr_ = query->getHWAddr();
143 144
    // Pointer to client's query.
    context_->query_ = query;
145

146 147 148
    // If subnet found, retrieve client identifier which will be needed
    // for allocations and search for reservations associated with a
    // subnet/shared network.
149
    if (subnet) {
150 151 152
        OptionPtr opt_clientid = query->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
        if (opt_clientid) {
            context_->clientid_.reset(new ClientId(opt_clientid->getData()));
153
        }
154

155
        // Find static reservations if not disabled for our subnet.
156
        if (subnet->getHostReservationMode() != Network::HR_DISABLED) {
157 158 159
            // Before we can check for static reservations, we need to prepare a set
            // of identifiers to be used for this.
            setHostIdentifiers();
160

161 162
            // Check for static reservations.
            alloc_engine->findReservation(*context_);
163 164
        }
    }
165 166 167 168 169 170 171 172

    const ClientClasses& classes = query_->getClasses();
    if (!classes.empty()) {
        std::string joined_classes = boost::algorithm::join(classes, ", ");
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_CLASS_ASSIGNED)
            .arg(query_->getLabel())
            .arg(joined_classes);
    }
173 174
};

175
void
176
Dhcpv4Exchange::initResponse() {
177 178 179 180 181 182 183 184 185 186 187 188
    uint8_t resp_type = 0;
    switch (getQuery()->getType()) {
    case DHCPDISCOVER:
        resp_type = DHCPOFFER;
        break;
    case DHCPREQUEST:
    case DHCPINFORM:
        resp_type = DHCPACK;
        break;
    default:
        ;
    }
189
    // Only create a response if one is required.
190 191
    if (resp_type > 0) {
        resp_.reset(new Pkt4(resp_type, getQuery()->getTransid()));
192
        copyDefaultFields();
Francis Dupont's avatar
Francis Dupont committed
193
        copyDefaultOptions();
194 195 196 197

        if (getQuery()->isDhcp4o6()) {
            initResponse4o6();
        }
198 199 200
    }
}

201 202 203 204 205
void
Dhcpv4Exchange::initResponse4o6() {
    Pkt4o6Ptr query = boost::dynamic_pointer_cast<Pkt4o6>(getQuery());
    if (!query) {
        return;
206
    }
207 208 209 210 211 212 213 214 215 216 217 218
    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));
219 220 221 222 223 224 225
}

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

226 227
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
    // 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);
    }
254

255
    // Copy flags from the request to the response per RFC 2131
256
    resp_->setFlags(query_->getFlags());
257
}
258

259 260
void
Dhcpv4Exchange::copyDefaultOptions() {
261 262
    // Let's copy client-id to response. See RFC6842.
    // It is possible to disable RFC6842 to keep backward compatibility
263
    bool echo = CfgMgr::instance().getCurrentCfg()->getEchoClientId();
264 265 266 267
    OptionPtr client_id = query_->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (client_id && echo) {
        resp_->addOption(client_id);
    }
268 269 270 271 272

    // 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);
273
    }
274 275 276 277 278 279 280 281 282 283 284 285 286

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

289 290 291 292
void
Dhcpv4Exchange::setHostIdentifiers() {
    const ConstCfgHostOperationsPtr cfg =
        CfgMgr::instance().getCurrentCfg()->getCfgHostOperations4();
293

294 295
    // Collect host identifiers. The identifiers are stored in order of preference.
    // The server will use them in that order to search for host reservations.
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
    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;

337 338 339 340 341 342 343 344
        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;
345
        case Host::IDENT_FLEX:
346 347 348 349 350
            {
                if (!HooksManager::calloutsPresent(Hooks.hook_index_host4_identifier_)) {
                    break;
                }

351
                CalloutHandlePtr callout_handle = getCalloutHandle(context_->query_);
352

353 354 355 356 357 358 359 360 361 362 363
                Host::IdentifierType type = Host::IDENT_FLEX;
                std::vector<uint8_t> id;

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

                // Pass incoming packet as argument
                callout_handle->setArgument("query4", context_->query_);
                callout_handle->setArgument("id_type", type);
                callout_handle->setArgument("id_value", id);

364 365 366
                // Call callouts
                HooksManager::callCallouts(Hooks.hook_index_host4_identifier_,
                                           *callout_handle);
367

368 369
                callout_handle->getArgument("id_type", type);
                callout_handle->getArgument("id_value", id);
370

371 372
                if ((callout_handle->getStatus() == CalloutHandle::NEXT_STEP_CONTINUE) &&
                    !id.empty()) {
373

374 375
                    LOG_DEBUG(packet4_logger, DBGLVL_TRACE_BASIC, DHCP4_FLEX_ID)
                        .arg(Host::getIdentifierAsText(type, &id[0], id.size()));
376

377
                    context_->addHostIdentifier(type, id);
378 379
                }
                break;
380
            }
381 382 383 384 385 386
        default:
            ;
        }
    }
}

387 388
void
Dhcpv4Exchange::setReservedClientClasses() {
389
    if (context_->currentHost() && query_) {
390
        BOOST_FOREACH(const std::string& client_class,
391
                      context_->currentHost()->getClientClasses4()) {
392 393 394 395 396
            query_->addClass(client_class);
        }
    }
}

397 398
void
Dhcpv4Exchange::setReservedMessageFields() {
399
    ConstHostPtr host = context_->currentHost();
400 401 402 403 404 405
    // Nothing to do if host reservations not specified for this client.
    if (host) {
        if (!host->getNextServer().isV4Zero()) {
            resp_->setSiaddr(host->getNextServer());
        }

406 407 408 409
        std::string sname = host->getServerHostname();
        if (!sname.empty()) {
            resp_->setSname(reinterpret_cast<const uint8_t*>(sname.c_str()),
                            sname.size());
410 411
        }

412 413 414 415
        std::string bootfile = host->getBootFileName();
        if (!bootfile.empty()) {
            resp_->setFile(reinterpret_cast<const uint8_t*>(bootfile.c_str()),
                           bootfile.size());
416 417 418 419
        }
    }
}

420 421
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

422
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
423
                     const bool direct_response_desired)
424
    : io_service_(new IOService()), shutdown_(true), alloc_engine_(), port_(port),
425
      use_bcast_(use_bcast), network_state_(NetworkState::DHCPv4) {
426

427
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
428
    try {
429 430 431
        // 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.
432
        if (port) {
433 434 435 436 437 438 439 440
            // 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);
441
        }
442

443 444 445 446
        // 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,
447
                                            false /* false = IPv4 */));
448

449 450
        /// @todo call loadLibraries() when handling configuration changes

451
    } catch (const std::exception &e) {
452
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
453 454 455
        shutdown_ = true;
        return;
    }
456

Tomek Mrugalski's avatar
Tomek Mrugalski committed
457
    shutdown_ = false;
458 459 460
}

Dhcpv4Srv::~Dhcpv4Srv() {
461 462 463 464 465 466
    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());
    }
467

468 469 470 471 472 473 474
    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
475
    IfaceMgr::instance().closeSockets();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
476

477 478
    // The lease manager was instantiated during DHCPv4Srv configuration,
    // so we should clean up after ourselves.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
479
    LeaseMgrFactory::destroy();
480 481 482

    // Explicitly unload hooks
    HooksManager::getHooksManager().unloadLibraries();
483 484
}

485 486
void
Dhcpv4Srv::shutdown() {
487
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
488 489 490
    shutdown_ = true;
}

491
isc::dhcp::Subnet4Ptr
492
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query, bool& drop) const {
493

494 495
    // DHCPv4-over-DHCPv6 is a special (and complex) case
    if (query->isDhcp4o6()) {
496
        return (selectSubnet4o6(query, drop));
497 498
    }

499 500 501 502 503 504 505 506 507 508
    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();

509 510 511 512 513
    // 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
514
    // when communicating with the relay agent." (RFC 3527)
515
    //
516
    // Try first Relay Agent Link Selection sub-option
517 518
    OptionPtr rai = query->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
519 520 521 522 523 524 525 526
        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)) {
527
                    selector.option_select_ =
528
                        IOAddress::fromBytes(AF_INET, &link_select_buf[0]);
529 530 531
                }
            }
        }
532 533 534 535 536 537 538 539 540 541
    } 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();
            }
        }
542 543
    }

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

    // Let's execute all callouts registered for subnet4_select
548
    if (HooksManager::calloutsPresent(Hooks.hook_index_subnet4_select_)) {
549 550 551 552 553
        CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

554 555 556
        // Enable copying options from the packet within hook library.
        ScopedEnableOptionsCopy<Pkt4> query4_options_copy(query);

557 558 559 560 561 562 563 564
        // 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
565
        HooksManager::callCallouts(Hooks.hook_index_subnet4_select_,
566 567 568 569 570
                                   *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)
571
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
572
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
573 574
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
575 576 577
            return (Subnet4Ptr());
        }

578
        // Callouts decided to drop the packet. It is a superset of the
579
        // skip case so no subnet will be selected.
580 581 582 583
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_DROP) {
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_SUBNET4_SELECT_DROP)
                .arg(query->getLabel());
584
            drop = true;
585 586
            return (Subnet4Ptr());
        }
587

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

592 593
    if (subnet) {
        // Log at higher debug level that subnet has been found.
594
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
595 596 597 598
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
599
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
600 601 602 603
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
604
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
605 606 607 608
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

609
    return (subnet);
610 611
}

612
isc::dhcp::Subnet4Ptr
613
Dhcpv4Srv::selectSubnet4o6(const Pkt4Ptr& query, bool& drop) const {
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631

    Subnet4Ptr subnet;

    SubnetSelector selector;
    selector.ciaddr_ = query->getCiaddr();
    selector.giaddr_ = query->getGiaddr();
    selector.local_address_ = query->getLocalAddr();
    selector.client_classes_ = query->classes_;
    selector.iface_name_ = query->getIface();
    // 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) {
632
        isc_throw(Unexpected, "Can't get DHCP4o6 message");
633 634 635 636 637 638 639 640 641 642 643 644 645 646
    }
    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,
647
                                      Pkt6::RELAY_GET_FIRST);
648 649
    }

Francis Dupont's avatar
Francis Dupont committed
650 651 652 653 654 655 656 657 658
    // If the Subnet Selection option is present, extract its value.
    OptionPtr sbnsel = query->getOption(DHO_SUBNET_SELECTION);
    if (sbnsel) {
        OptionCustomPtr oc = boost::dynamic_pointer_cast<OptionCustom>(sbnsel);
        if (oc) {
            selector.option_select_ = oc->readAddress();
        }
    }

659
    CfgMgr& cfgmgr = CfgMgr::instance();
Francis Dupont's avatar
Francis Dupont committed
660
    subnet = cfgmgr.getCurrentCfg()->getCfgSubnets4()->selectSubnet4o6(selector);
661 662

    // Let's execute all callouts registered for subnet4_select
663
    if (HooksManager::calloutsPresent(Hooks.hook_index_subnet4_select_)) {
664 665 666 667 668 669 670 671 672 673 674 675 676
        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
677
        HooksManager::callCallouts(Hooks.hook_index_subnet4_select_,
678 679 680 681 682
                                   *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)
683
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
684
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
685 686
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
687 688 689
            return (Subnet4Ptr());
        }

690
        // Callouts decided to drop the packet. It is a superset of the
691
        // skip case so no subnet will be selected.
692 693 694 695
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_DROP) {
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_SUBNET4_SELECT_DROP)
                .arg(query->getLabel());
696
            drop = true;
697 698
            return (Subnet4Ptr());
        }
699

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

704 705
    if (subnet) {
        // Log at higher debug level that subnet has been found.
706
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
707 708 709 710
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
711
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
712 713 714 715
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
716
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
717 718 719 720
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

721
    return (subnet);
722 723
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
724 725
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
726 727 728
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
729 730
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
731 732 733
    IfaceMgr::instance().send(packet);
}

734 735
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
736
    while (!shutdown_) {
737
        try {
Francis Dupont's avatar
Francis Dupont committed
738
            run_one();
739
            getIOService()->poll();
740
        } catch (const std::exception& e) {
741 742
            // General catch-all exception that are not caught by more specific
            // catches. This one is for exceptions derived from std::exception.
743
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_STD_EXCEPTION)
744
                .arg(e.what());
745 746 747 748
        } catch (...) {
            // General catch-all exception that are not caught by more specific
            // catches. This one is for other exceptions, not derived from
            // std::exception.
749
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_EXCEPTION);
750
        }
751 752 753 754
    }

    return (true);
}
755

Francis Dupont's avatar
Francis Dupont committed
756 757 758 759 760
void
Dhcpv4Srv::run_one() {
    // client's message and server's response
    Pkt4Ptr query;
    Pkt4Ptr rsp;
761

Francis Dupont's avatar
Francis Dupont committed
762
    try {
763 764 765 766
        // Set select() timeout to 1s. This value should not be modified
        // because it is important that the select() returns control
        // frequently so as the IOService can be polled for ready handlers.
        uint32_t timeout = 1;
Francis Dupont's avatar
Francis Dupont committed
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
        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());
782

783
        }
784 785 786 787 788
        // We used to log that the wait was interrupted, but this is no longer
        // the case. Our wait time is 1s now, so the lack of query packet more
        // likely means that nothing new appeared within a second, rather than
        // we were interrupted. And we don't want to print a message every
        // second.
789

Francis Dupont's avatar
Francis Dupont committed
790 791 792
    } catch (const SignalInterruptOnSelect) {
        // Packet reception interrupted because a signal has been received.
        // This is not an error because we might have received a SIGTERM,
Josh Soref's avatar
Josh Soref committed
793
        // SIGINT, SIGHUP or SIGCHLD which are handled by the server. For
Francis Dupont's avatar
Francis Dupont committed
794 795 796 797 798 799 800 801
        // 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());
    }
802

Francis Dupont's avatar
Francis Dupont committed
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
    // 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());
    }
821

Francis Dupont's avatar
Francis Dupont committed
822 823 824 825 826 827
    // 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;
    }
828

829
    // If the DHCP service has been globally disabled, drop the packet.
830
    if (!network_state_.isServiceEnabled()) {
831 832 833
        LOG_DEBUG(bad_packet4_logger, DBG_DHCP4_BASIC,
                  DHCP4_PACKET_DROP_0008)
            .arg(query->getLabel());
834
        return;
835
    } else {
836 837
        processPacket(query, rsp);
    }
838

839 840 841
    if (!rsp) {
        return;
    }
842

843 844
    CalloutHandlePtr callout_handle = getCalloutHandle(query);
    processPacketBufferSend(callout_handle, rsp);
845
}
846

847
void
848
Dhcpv4Srv::processPacket(Pkt4Ptr& query, Pkt4Ptr& rsp, bool allow_packet_park) {
849 850
    // Log reception of the packet. We need to increase it early, as any
    // failures in unpacking will cause the packet to be dropped. We
851
    // will increase type specific statistic further down the road.
852 853 854 855 856 857 858 859 860 861
    // 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.
    if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
        CalloutHandlePtr callout_handle = getCalloutHandle(query);
862

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

866 867 868
        // Enable copying options from the packet within hook library.
        ScopedEnableOptionsCopy<Pkt4> query4_options_copy(query);

869 870
        // Pass incoming packet as argument
        callout_handle->setArgument("query4", query);
871

872 873 874
        // Call callouts
        HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                   *callout_handle);
875

876 877 878 879 880 881 882 883 884 885 886 887
        // Callouts decided to drop the received packet.
        // The response (rsp) is null so the caller (run_one) will
        // immediately return too.
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_DROP) {
            LOG_DEBUG(hooks_logger, DBG_DHCP4_DETAIL,
                      DHCP4_HOOK_BUFFER_RCVD_DROP)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getLocalAddr().toText())
                .arg(query->getIface());
            return;
        }

888 889 890 891 892 893 894 895 896 897 898 899
        // 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;
        }
900

901 902
        callout_handle->getArgument("query4", query);
    }
903

904 905 906
    // Unpack the packet information unless the buffer4_receive callouts
    // indicated they did it
    if (!skip_unpack) {
907
        try {
908 909 910 911 912
            LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_UNPACK)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getLocalAddr().toText())
                .arg(query->getIface());
            query->unpack();
913 914 915 916 917 918
        } catch (const SkipRemainingOptionsError& e) {
            // An option failed to unpack but we are to attempt to process it
            // anyway.  Log it and let's hope for the best.
            LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL,
                      DHCP4_PACKET_OPTIONS_SKIPPED)
                .arg(e.what());
919
        } catch (const std::exception& e) {
920 921 922 923 924 925
            // 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())
926
                .arg(e.what());
927

Francis Dupont's avatar
Francis Dupont committed
928
            // Increase the statistics of parse failures and dropped packets.
929 930
            isc::stats::StatsMgr::instance().addValue("pkt4-parse-failed",
                                                      static_cast<int64_t>(1));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
931
            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
932
                                                      static_cast<int64_t>(1));
933
            return;
934
        }
935
    }
936

937 938
    // Update statistics accordingly for received packet.
    processStatsReceived(query);
939

940 941 942 943
    // 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);
944

945 946 947
    // Now it is classified the deferred unpacking can be done.
    deferredUnpack(query);

948 949 950 951 952 953 954 955
    // 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;
    }
956