dhcp4_srv.cc 139 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 9
#include <kea_version.h>

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

54 55 56 57 58 59
#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
60 61
#ifdef HAVE_CQL
#include <dhcpsrv/cql_lease_mgr.h>
62
#endif
63 64
#include <dhcpsrv/memfile_lease_mgr.h>

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

#include <iomanip>

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

83 84
namespace {

85
/// Structure that holds registered hook indexes
86
struct Dhcp4Hooks {
87 88 89 90 91 92 93 94 95
    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
96

97 98
    /// Constructor that registers hook points for DHCPv4 engine
    Dhcp4Hooks() {
99 100 101 102 103 104 105 106 107
        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");
108 109 110
    }
};

111 112
} // end of anonymous namespace

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

119

120 121 122
namespace isc {
namespace dhcp {

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

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

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

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

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

163 164
            // Check for static reservations.
            alloc_engine->findReservation(*context_);
165 166
        }
    }
167

168 169 170
    // Set KNOWN builtin class if something was found, UNKNOWN if not.
    if (!context_->hosts_.empty()) {
        query->addClass("KNOWN");
Francis Dupont's avatar
Francis Dupont committed
171 172 173
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_CLASS_ASSIGNED)
            .arg(query->getLabel())
            .arg("KNOWN");
174 175
    } else {
        query->addClass("UNKNOWN");
Francis Dupont's avatar
Francis Dupont committed
176 177 178
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_CLASS_ASSIGNED)
            .arg(query->getLabel())
            .arg("UNKNOWN");
179
    }
180

181 182 183
    // Perform second pass of classification.
    Dhcpv4Srv::evaluateClasses(query, true);

184 185 186 187
    const ClientClasses& classes = query_->getClasses();
    if (!classes.empty()) {
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_CLASS_ASSIGNED)
            .arg(query_->getLabel())
188
            .arg(classes.toText());
189
    }
190 191
};

192
void
193
Dhcpv4Exchange::initResponse() {
194 195 196 197 198 199 200 201 202 203 204 205
    uint8_t resp_type = 0;
    switch (getQuery()->getType()) {
    case DHCPDISCOVER:
        resp_type = DHCPOFFER;
        break;
    case DHCPREQUEST:
    case DHCPINFORM:
        resp_type = DHCPACK;
        break;
    default:
        ;
    }
206
    // Only create a response if one is required.
207 208
    if (resp_type > 0) {
        resp_.reset(new Pkt4(resp_type, getQuery()->getTransid()));
209
        copyDefaultFields();
Francis Dupont's avatar
Francis Dupont committed
210
        copyDefaultOptions();
211 212 213 214

        if (getQuery()->isDhcp4o6()) {
            initResponse4o6();
        }
215 216 217
    }
}

218 219 220 221 222
void
Dhcpv4Exchange::initResponse4o6() {
    Pkt4o6Ptr query = boost::dynamic_pointer_cast<Pkt4o6>(getQuery());
    if (!query) {
        return;
223
    }
224 225 226 227 228 229 230
    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);
    }
Francis Dupont's avatar
Francis Dupont committed
231
    // Copy interface, and remote address and port
232 233 234
    resp6->setIface(query6->getIface());
    resp6->setIndex(query6->getIndex());
    resp6->setRemoteAddr(query6->getRemoteAddr());
Francis Dupont's avatar
Francis Dupont committed
235
    resp6->setRemotePort(query6->getRemotePort());
236
    resp_.reset(new Pkt4o6(resp_, resp6));
237 238 239 240 241 242 243
}

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

244 245
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
    // 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);
    }
272

273
    // Copy flags from the request to the response per RFC 2131
274
    resp_->setFlags(query_->getFlags());
275
}
276

277 278
void
Dhcpv4Exchange::copyDefaultOptions() {
279 280
    // Let's copy client-id to response. See RFC6842.
    // It is possible to disable RFC6842 to keep backward compatibility
281
    bool echo = CfgMgr::instance().getCurrentCfg()->getEchoClientId();
282 283 284 285
    OptionPtr client_id = query_->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (client_id && echo) {
        resp_->addOption(client_id);
    }
286 287 288 289 290

    // 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);
291
    }
292 293 294 295 296 297 298 299 300 301 302 303 304

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

307 308 309 310
void
Dhcpv4Exchange::setHostIdentifiers() {
    const ConstCfgHostOperationsPtr cfg =
        CfgMgr::instance().getCurrentCfg()->getCfgHostOperations4();
311

312 313
    // Collect host identifiers. The identifiers are stored in order of preference.
    // The server will use them in that order to search for host reservations.
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
    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;

355 356 357 358 359 360 361 362
        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;
363
        case Host::IDENT_FLEX:
364 365 366 367 368
            {
                if (!HooksManager::calloutsPresent(Hooks.hook_index_host4_identifier_)) {
                    break;
                }

369
                CalloutHandlePtr callout_handle = getCalloutHandle(context_->query_);
370

371 372 373
                Host::IdentifierType type = Host::IDENT_FLEX;
                std::vector<uint8_t> id;

374 375 376 377 378
                // Use the RAII wrapper to make sure that the callout handle state is
                // reset when this object goes out of scope. All hook points must do
                // it to prevent possible circular dependency between the callout
                // handle and its arguments.
                ScopedCalloutHandleState callout_handle_state(callout_handle);
379 380 381 382 383 384

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

385 386 387
                // Call callouts
                HooksManager::callCallouts(Hooks.hook_index_host4_identifier_,
                                           *callout_handle);
388

389 390
                callout_handle->getArgument("id_type", type);
                callout_handle->getArgument("id_value", id);
391

392 393
                if ((callout_handle->getStatus() == CalloutHandle::NEXT_STEP_CONTINUE) &&
                    !id.empty()) {
394

395 396
                    LOG_DEBUG(packet4_logger, DBGLVL_TRACE_BASIC, DHCP4_FLEX_ID)
                        .arg(Host::getIdentifierAsText(type, &id[0], id.size()));
397

398
                    context_->addHostIdentifier(type, id);
399 400
                }
                break;
401
            }
402 403 404 405 406 407
        default:
            ;
        }
    }
}

408 409
void
Dhcpv4Exchange::setReservedClientClasses() {
410
    if (context_->currentHost() && query_) {
411 412 413 414
        const ClientClasses& classes = context_->currentHost()->getClientClasses4();
        for (ClientClasses::const_iterator cclass = classes.cbegin();
             cclass != classes.cend(); ++cclass) {
            query_->addClass(*cclass);
415 416 417 418
        }
    }
}

419 420
void
Dhcpv4Exchange::setReservedMessageFields() {
421
    ConstHostPtr host = context_->currentHost();
422 423 424 425 426 427
    // Nothing to do if host reservations not specified for this client.
    if (host) {
        if (!host->getNextServer().isV4Zero()) {
            resp_->setSiaddr(host->getNextServer());
        }

428 429 430 431
        std::string sname = host->getServerHostname();
        if (!sname.empty()) {
            resp_->setSname(reinterpret_cast<const uint8_t*>(sname.c_str()),
                            sname.size());
432 433
        }

434 435 436 437
        std::string bootfile = host->getBootFileName();
        if (!bootfile.empty()) {
            resp_->setFile(reinterpret_cast<const uint8_t*>(bootfile.c_str()),
                           bootfile.size());
438 439 440 441
        }
    }
}

442 443
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

444
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
445
                     const bool direct_response_desired)
446
    : io_service_(new IOService()), shutdown_(true), alloc_engine_(), port_(port),
447
      use_bcast_(use_bcast), network_state_(new NetworkState(NetworkState::DHCPv4)) {
448

449
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
450
    try {
451 452 453
        // 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.
454
        if (port) {
455 456 457 458 459 460 461 462
            // 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);
463
        }
464

465 466 467 468
        // 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,
469
                                            false /* false = IPv4 */));
470

471 472
        /// @todo call loadLibraries() when handling configuration changes

473
    } catch (const std::exception &e) {
474
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
475 476 477
        shutdown_ = true;
        return;
    }
478

Tomek Mrugalski's avatar
Tomek Mrugalski committed
479
    shutdown_ = false;
480 481 482
}

Dhcpv4Srv::~Dhcpv4Srv() {
483
    // Discard any cached packets or parked packets
Tomek Mrugalski's avatar
Tomek Mrugalski committed
484
    discardPackets();
485

486 487 488 489 490 491
    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());
    }
492

493 494 495 496 497 498 499
    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
500
    IfaceMgr::instance().closeSockets();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
501

502 503
    // The lease manager was instantiated during DHCPv4Srv configuration,
    // so we should clean up after ourselves.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
504
    LeaseMgrFactory::destroy();
505 506 507

    // Explicitly unload hooks
    HooksManager::getHooksManager().unloadLibraries();
508 509
}

510 511
void
Dhcpv4Srv::shutdown() {
512
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
513 514 515
    shutdown_ = true;
}

516
isc::dhcp::Subnet4Ptr
517 518
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query, bool& drop,
                        bool sanity_only) const {
519

520 521
    // DHCPv4-over-DHCPv6 is a special (and complex) case
    if (query->isDhcp4o6()) {
522
        return (selectSubnet4o6(query, drop, sanity_only));
523 524
    }

525 526
    Subnet4Ptr subnet;

527
    const SubnetSelector& selector = CfgSubnets4::initSelector(query);
528

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

    // Let's execute all callouts registered for subnet4_select
533
    // (skip callouts if the selectSubnet was called to do sanity checks only)
534 535
    if (!sanity_only &&
        HooksManager::calloutsPresent(Hooks.hook_index_subnet4_select_)) {
536 537
        CalloutHandlePtr callout_handle = getCalloutHandle(query);

538 539 540 541 542
        // Use the RAII wrapper to make sure that the callout handle state is
        // reset when this object goes out of scope. All hook points must do
        // it to prevent possible circular dependency between the callout
        // handle and its arguments.
        ScopedCalloutHandleState callout_handle_state(callout_handle);
543

544 545 546
        // Enable copying options from the packet within hook library.
        ScopedEnableOptionsCopy<Pkt4> query4_options_copy(query);

547 548 549 550 551 552 553 554
        // 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
555
        HooksManager::callCallouts(Hooks.hook_index_subnet4_select_,
556 557 558 559 560
                                   *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)
561
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
562
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
563 564
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
565 566 567
            return (Subnet4Ptr());
        }

568
        // Callouts decided to drop the packet. It is a superset of the
569
        // skip case so no subnet will be selected.
570 571 572 573
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_DROP) {
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_SUBNET4_SELECT_DROP)
                .arg(query->getLabel());
574
            drop = true;
575 576
            return (Subnet4Ptr());
        }
577

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

582 583
    if (subnet) {
        // Log at higher debug level that subnet has been found.
584
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
585 586 587 588
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
589
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
590 591 592 593
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
594
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
595 596 597 598
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

599
    return (subnet);
600 601
}

602
isc::dhcp::Subnet4Ptr
603 604
Dhcpv4Srv::selectSubnet4o6(const Pkt4Ptr& query, bool& drop,
                           bool sanity_only) const {
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622

    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) {
623
        isc_throw(Unexpected, "Can't get DHCP4o6 message");
624 625 626 627 628 629 630 631 632 633 634 635 636 637
    }
    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,
638
                                      Pkt6::RELAY_GET_FIRST);
639 640
    }

Francis Dupont's avatar
Francis Dupont committed
641 642 643 644 645 646 647 648 649
    // 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();
        }
    }

650
    CfgMgr& cfgmgr = CfgMgr::instance();
Francis Dupont's avatar
Francis Dupont committed
651
    subnet = cfgmgr.getCurrentCfg()->getCfgSubnets4()->selectSubnet4o6(selector);
652

653 654
    // Let's execute all callouts registered for subnet4_select.
    // (skip callouts if the selectSubnet was called to do sanity checks only)
655 656
    if (!sanity_only &&
        HooksManager::calloutsPresent(Hooks.hook_index_subnet4_select_)) {
657 658
        CalloutHandlePtr callout_handle = getCalloutHandle(query);

659 660 661 662 663
        // Use the RAII wrapper to make sure that the callout handle state is
        // reset when this object goes out of scope. All hook points must do
        // it to prevent possible circular dependency between the callout
        // handle and its arguments.
        ScopedCalloutHandleState callout_handle_state(callout_handle);
664 665 666 667 668 669 670 671 672

        // 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
673
        HooksManager::callCallouts(Hooks.hook_index_subnet4_select_,
674 675 676 677 678
                                   *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)
679
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
680
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
681 682
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
683 684 685
            return (Subnet4Ptr());
        }

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

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

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

    } else {
712
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
713 714 715 716
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

717
    return (subnet);
718 719
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
720 721
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
722 723 724
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
725 726
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
727 728 729
    IfaceMgr::instance().send(packet);
}

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

    return (true);
}
751

Francis Dupont's avatar
Francis Dupont committed
752 753 754 755 756
void
Dhcpv4Srv::run_one() {
    // client's message and server's response
    Pkt4Ptr query;
    Pkt4Ptr rsp;
757

Francis Dupont's avatar
Francis Dupont committed
758
    try {
759 760 761 762
        // 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
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
        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());
778

779
        }
780 781 782 783 784
        // 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.
785

Francis Dupont's avatar
Francis Dupont committed
786
    } catch (const SignalInterruptOnSelect&) {
Francis Dupont's avatar
Francis Dupont committed
787 788
        // 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
789
        // SIGINT, SIGHUP or SIGCHLD which are handled by the server. For
Francis Dupont's avatar
Francis Dupont committed
790 791 792 793 794 795 796 797
        // 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());
    }
798

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

Francis Dupont's avatar
Francis Dupont committed
818 819 820 821 822 823
    // 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;
    }
824

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

835 836 837
    if (!rsp) {
        return;
    }
838

839 840
    CalloutHandlePtr callout_handle = getCalloutHandle(query);
    processPacketBufferSend(callout_handle, rsp);
841
}
842

843
void
844
Dhcpv4Srv::processPacket(Pkt4Ptr& query, Pkt4Ptr& rsp, bool allow_packet_park) {
845 846
    // Log reception of the packet. We need to increase it early, as any
    // failures in unpacking will cause the packet to be dropped. We
847
    // will increase type specific statistic further down the road.
848 849 850 851 852 853 854 855 856 857
    // 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);
858

859 860 861 862 863
        // Use the RAII wrapper to make sure that the callout handle state is
        // reset when this object goes out of scope. All hook points must do
        // it to prevent possible circular dependency between the callout
        // handle and its arguments.
        ScopedCalloutHandleState callout_handle_state(callout_handle);
864

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

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

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

875 876 877 878 879 880 881 882 883 884 885 886
        // 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;
        }

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

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

903 904 905
    // Unpack the packet information unless the buffer4_receive callouts
    // indicated they did it
    if (!skip_unpack) {
906
        try {
907 908 909 910 911
            LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_UNPACK)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getLocalAddr().toText())
                .arg(query->getIface());
            query->unpack();
912 913 914 915 916 917
        } 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());
918
        } catch (const std::exception& e) {
919 920 921 922 923 924
            // 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())
925
                .arg(e.what());
926

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

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

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

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

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

956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
    // 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
Francis Dupont's avatar
Francis Dupont committed
971
    if (HooksManager::calloutsPresent(Hooks.hook_index_pkt4_receive_)) {
972
        CalloutHandlePtr callout_handle = getCalloutHandle(query);
973