dhcp4_srv.cc 125 KB
Newer Older
Francis Dupont's avatar
Francis Dupont committed
1
// Copyright (C) 2011-2017 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 27
#include <dhcpsrv/addr_utilities.h>
#include <dhcpsrv/callout_handle_store.h>
28
#include <dhcpsrv/cfgmgr.h>
29
#include <dhcpsrv/cfg_host_operations.h>
30
#include <dhcpsrv/cfg_iface.h>
31
#include <dhcpsrv/cfg_shared_networks.h>
32
#include <dhcpsrv/cfg_subnets4.h>
33 34
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
35
#include <dhcpsrv/ncr_generator.h>
36
#include <dhcpsrv/shared_network.h>
37
#include <dhcpsrv/subnet.h>
38
#include <dhcpsrv/subnet_selector.h>
39
#include <dhcpsrv/utils.h>
40
#include <dhcpsrv/utils.h>
41 42
#include <eval/evaluate.h>
#include <eval/eval_messages.h>
43
#include <hooks/callout_handle.h>
44
#include <hooks/hooks_log.h>
45
#include <hooks/hooks_manager.h>
46
#include <stats/stats_mgr.h>
47
#include <util/strutil.h>
48
#include <stats/stats_mgr.h>
49 50
#include <log/logger.h>
#include <cryptolink/cryptolink.h>
51
#include <cfgrpt/config_report.h>
52

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

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

#include <iomanip>

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

82
/// Structure that holds registered hook indexes
83
struct Dhcp4Hooks {
84 85 86 87 88 89 90 91
    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_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
92

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

// 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.
110
Dhcp4Hooks Hooks;
111

112 113 114
namespace isc {
namespace dhcp {

115
Dhcpv4Exchange::Dhcpv4Exchange(const AllocEnginePtr& alloc_engine,
116 117
                               const Pkt4Ptr& query,
                               const Subnet4Ptr& subnet)
118 119
    : alloc_engine_(alloc_engine), query_(query), resp_(),
      context_(new AllocEngine::ClientContext4()) {
120

121 122 123 124 125 126 127 128
    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");
129 130
    }

131 132 133
    // Create response message.
    initResponse();
    // Select subnet for the query message.
134
    context_->subnet_ = subnet;
135
    // Hardware address.
136
    context_->hwaddr_ = query->getHWAddr();
137 138
    // Pointer to client's query.
    context_->query_ = query;
139

140 141 142
    // If subnet found, retrieve client identifier which will be needed
    // for allocations and search for reservations associated with a
    // subnet/shared network.
143
    if (subnet) {
144 145 146
        OptionPtr opt_clientid = query->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
        if (opt_clientid) {
            context_->clientid_.reset(new ClientId(opt_clientid->getData()));
147
        }
148

149
        // Find static reservations if not disabled for our subnet.
150
        if (subnet->getHostReservationMode() != Network::HR_DISABLED) {
151 152 153
            // Before we can check for static reservations, we need to prepare a set
            // of identifiers to be used for this.
            setHostIdentifiers();
154

155 156
            // Check for static reservations.
            alloc_engine->findReservation(*context_);
157 158
        }
    }
159 160 161 162 163 164 165 166

    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);
    }
167 168
};

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

        if (getQuery()->isDhcp4o6()) {
            initResponse4o6();
        }
192 193 194
    }
}

195 196 197 198 199
void
Dhcpv4Exchange::initResponse4o6() {
    Pkt4o6Ptr query = boost::dynamic_pointer_cast<Pkt4o6>(getQuery());
    if (!query) {
        return;
200
    }
201 202 203 204 205 206 207 208 209 210 211 212
    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));
213 214 215 216 217 218 219
}

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

220 221
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
    // 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);
    }
248

249
    // Copy flags from the request to the response per RFC 2131
250
    resp_->setFlags(query_->getFlags());
251
}
252

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

    // 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);
267
    }
268 269 270 271 272 273 274 275 276 277 278 279 280

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

283 284 285 286
void
Dhcpv4Exchange::setHostIdentifiers() {
    const ConstCfgHostOperationsPtr cfg =
        CfgMgr::instance().getCurrentCfg()->getCfgHostOperations4();
287

288 289
    // Collect host identifiers. The identifiers are stored in order of preference.
    // The server will use them in that order to search for host reservations.
290 291 292 293 294 295 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
    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;

331 332 333 334 335 336 337 338
        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;
339
        case Host::IDENT_FLEX:
340 341 342 343 344
            {
                if (!HooksManager::calloutsPresent(Hooks.hook_index_host4_identifier_)) {
                    break;
                }

345
                CalloutHandlePtr callout_handle = getCalloutHandle(context_->query_);
346

347 348 349 350 351 352 353 354 355 356 357
                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);

358 359 360
                // Call callouts
                HooksManager::callCallouts(Hooks.hook_index_host4_identifier_,
                                           *callout_handle);
361

362 363
                callout_handle->getArgument("id_type", type);
                callout_handle->getArgument("id_value", id);
364

365 366
                if ((callout_handle->getStatus() == CalloutHandle::NEXT_STEP_CONTINUE) &&
                    !id.empty()) {
367

368 369
                    LOG_DEBUG(packet4_logger, DBGLVL_TRACE_BASIC, DHCP4_FLEX_ID)
                        .arg(Host::getIdentifierAsText(type, &id[0], id.size()));
370

371
                    context_->addHostIdentifier(type, id);
372 373
                }
                break;
374
            }
375 376 377 378 379 380
        default:
            ;
        }
    }
}

381 382
void
Dhcpv4Exchange::setReservedClientClasses() {
383
    if (context_->currentHost() && query_) {
384
        BOOST_FOREACH(const std::string& client_class,
385
                      context_->currentHost()->getClientClasses4()) {
386 387 388 389 390
            query_->addClass(client_class);
        }
    }
}

391 392
void
Dhcpv4Exchange::setReservedMessageFields() {
393
    ConstHostPtr host = context_->currentHost();
394 395 396 397 398 399
    // Nothing to do if host reservations not specified for this client.
    if (host) {
        if (!host->getNextServer().isV4Zero()) {
            resp_->setSiaddr(host->getNextServer());
        }

400 401 402 403
        std::string sname = host->getServerHostname();
        if (!sname.empty()) {
            resp_->setSname(reinterpret_cast<const uint8_t*>(sname.c_str()),
                            sname.size());
404 405
        }

406 407 408 409
        std::string bootfile = host->getBootFileName();
        if (!bootfile.empty()) {
            resp_->setFile(reinterpret_cast<const uint8_t*>(bootfile.c_str()),
                           bootfile.size());
410 411 412 413
        }
    }
}

414 415
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

416
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
417
                     const bool direct_response_desired)
418
    : io_service_(new IOService()), shutdown_(true), alloc_engine_(), port_(port),
419
      use_bcast_(use_bcast), network_state_(NetworkState::DHCPv4) {
420

421
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
422
    try {
423 424 425
        // 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.
426
        if (port) {
427 428 429 430 431 432 433 434
            // 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);
435
        }
436

437 438 439 440
        // 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,
441
                                            false /* false = IPv4 */));
442

443 444
        /// @todo call loadLibraries() when handling configuration changes

445
    } catch (const std::exception &e) {
446
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
447 448 449
        shutdown_ = true;
        return;
    }
450

Tomek Mrugalski's avatar
Tomek Mrugalski committed
451
    shutdown_ = false;
452 453 454
}

Dhcpv4Srv::~Dhcpv4Srv() {
455 456 457 458 459 460
    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());
    }
461

462 463 464 465 466 467 468
    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
469
    IfaceMgr::instance().closeSockets();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
470

471 472
    // The lease manager was instantiated during DHCPv4Srv configuration,
    // so we should clean up after ourselves.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
473
    LeaseMgrFactory::destroy();
474 475 476

    // Explicitly unload hooks
    HooksManager::getHooksManager().unloadLibraries();
477 478
}

479 480
void
Dhcpv4Srv::shutdown() {
481
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
482 483 484
    shutdown_ = true;
}

485
isc::dhcp::Subnet4Ptr
486
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query, bool& drop) const {
487

488 489
    // DHCPv4-over-DHCPv6 is a special (and complex) case
    if (query->isDhcp4o6()) {
490
        return (selectSubnet4o6(query, drop));
491 492
    }

493 494 495 496 497 498 499 500 501 502
    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();

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

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

    // Let's execute all callouts registered for subnet4_select
542
    if (HooksManager::calloutsPresent(Hooks.hook_index_subnet4_select_)) {
543 544 545 546 547
        CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

548 549 550
        // Enable copying options from the packet within hook library.
        ScopedEnableOptionsCopy<Pkt4> query4_options_copy(query);

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

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

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

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

    } else {
598
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
599 600 601 602
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

603
    return (subnet);
604 605
}

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

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

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

653
    CfgMgr& cfgmgr = CfgMgr::instance();
Francis Dupont's avatar
Francis Dupont committed
654
    subnet = cfgmgr.getCurrentCfg()->getCfgSubnets4()->selectSubnet4o6(selector);
655 656

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

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

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

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

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

715
    return (subnet);
716 717
}

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

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

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

    return (true);
}
749

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

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

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

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

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

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

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

833 834 835
    if (!rsp) {
        return;
    }
836

837 838 839 840 841 842
    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
        if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_send_)) {
843 844 845 846 847
            CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

848 849 850
            // Enable copying options from the packet within hook library.
            ScopedEnableOptionsCopy<Pkt4> resp4_options_copy(rsp);

851
            // Pass incoming packet as argument
852
            callout_handle->setArgument("response4", rsp);
853 854

            // Call callouts
855
            HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
856
                                       *callout_handle);
857 858 859

            // Callouts decided to skip the next processing step. The next
            // processing step would to parse the packet, so skip at this
860
            // stage means drop.
861 862
            if ((callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) ||
                (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_DROP)) {
863 864 865 866
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                          DHCP4_HOOK_BUFFER_SEND_SKIP)
                    .arg(rsp->getLabel());
                return;
867 868
            }

869
            callout_handle->getArgument("response4", rsp);
870 871
        }

872 873 874 875
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_PACKET_SEND)
            .arg(rsp->getLabel())
            .arg(rsp->getName())
            .arg(static_cast<int>(rsp->getType()))
876
            .arg(rsp->getLocalAddr().isV4Zero() ? "*" : rsp->getLocalAddr().toText())
877 878 879
            .arg(rsp->getLocalPort())
            .arg(rsp->getRemoteAddr())
            .arg(rsp->getRemotePort())
880 881
            .arg(rsp->getIface().empty() ? "to be determined from routing" :
                 rsp->getIface());
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898

        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());
    }
899
}
900

901
void
902
Dhcpv4Srv::processPacket(Pkt4Ptr& query, Pkt4Ptr& rsp) {
903 904
    // Log reception of the packet. We need to increase it early, as any
    // failures in unpacking will cause the packet to be dropped. We
905
    // will increase type specific statistic further down the road.
906 907 908 909 910 911 912 913 914 915
    // 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);
916

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

920 921 922
        // Enable copying options from the packet within hook library.
        ScopedEnableOptionsCopy<Pkt4> query4_options_copy(query);

923 924
        // Pass incoming packet as argument
        callout_handle->setArgument("query4", query);
925

926 927 928
        // Call callouts
        HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                   *callout_handle);
929

930 931 932 933 934 935 936 937 938 939 940 941
        // 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;
        }

942 943 944 945 946 947 948 949 950 951 952 953
        // 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;
        }
954

955 956
        callout_handle->getArgument("query4", query);
    }
957

958 959 960
    // Unpack the packet information unless the buffer4_receive callouts
    // indicated they did it
    if (!skip_unpack) {
961
        try {
962 963 964 965 966
            LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_UNPACK)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getLocalAddr().toText())
                .arg(query->getIface());
            query->unpack();
967
        } catch (const std::exception& e) {