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

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

49 50 51 52 53 54
#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
55 56
#ifdef HAVE_CQL
#include <dhcpsrv/cql_lease_mgr.h>
57
#endif
58 59
#include <dhcpsrv/memfile_lease_mgr.h>

60
#include <boost/bind.hpp>
61
#include <boost/foreach.hpp>
62
#include <boost/shared_ptr.hpp>
63 64 65

#include <iomanip>

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

76
/// Structure that holds registered hook indexes
77 78
struct Dhcp4Hooks {
    int hook_index_buffer4_receive_;///< index for "buffer4_receive" hook point
79 80
    int hook_index_pkt4_receive_;   ///< index for "pkt4_receive" hook point
    int hook_index_subnet4_select_; ///< index for "subnet4_select" hook point
81
    int hook_index_lease4_release_; ///< index for "lease4_release" hook point
82
    int hook_index_pkt4_send_;      ///< index for "pkt4_send" hook point
83
    int hook_index_buffer4_send_;   ///< index for "buffer4_send" hook point
84
    int hook_index_lease4_decline_; ///< index for "lease4_decline" hook point
85

86 87 88
    /// Constructor that registers hook points for DHCPv4 engine
    Dhcp4Hooks() {
        hook_index_buffer4_receive_= HooksManager::registerHook("buffer4_receive");
89 90 91
        hook_index_pkt4_receive_   = HooksManager::registerHook("pkt4_receive");
        hook_index_subnet4_select_ = HooksManager::registerHook("subnet4_select");
        hook_index_pkt4_send_      = HooksManager::registerHook("pkt4_send");
92 93
        hook_index_lease4_release_ = HooksManager::registerHook("lease4_release");
        hook_index_buffer4_send_   = HooksManager::registerHook("buffer4_send");
94
        hook_index_lease4_decline_ = HooksManager::registerHook("lease4_decline");
95 96 97 98 99 100 101
    }
};

// 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.
102
Dhcp4Hooks Hooks;
103

104 105 106
namespace isc {
namespace dhcp {

107
Dhcpv4Exchange::Dhcpv4Exchange(const AllocEnginePtr& alloc_engine,
108 109
                               const Pkt4Ptr& query,
                               const Subnet4Ptr& subnet)
110 111
    : alloc_engine_(alloc_engine), query_(query), resp_(),
      context_(new AllocEngine::ClientContext4()) {
112

113 114 115 116 117 118 119 120
    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");
121 122
    }

123 124 125
    // Create response message.
    initResponse();
    // Select subnet for the query message.
126
    context_->subnet_ = subnet;
127
    // Hardware address.
128
    context_->hwaddr_ = query->getHWAddr();
129 130
    // Pointer to client's query.
    context_->query_ = query;
131

132
    // Set client identifier if the match-client-id flag is enabled (default).
133 134 135
    // If the subnet wasn't found it doesn't matter because we will not be
    // able to allocate a lease anyway so this context will not be used.
    if (subnet) {
136
        if (subnet->getMatchClientId()) {
137 138 139 140 141 142 143 144 145 146
            OptionPtr opt_clientid = query->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
            if (opt_clientid) {
                context_->clientid_.reset(new ClientId(opt_clientid->getData()));
            }
        } else {
            /// @todo When merging with #3806 use different logger.
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_CLIENTID_IGNORED_FOR_LEASES)
                .arg(query->getLabel())
                .arg(subnet->getID());
        }
147

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

154 155
            // Check for static reservations.
            alloc_engine->findReservation(*context_);
156 157
        }
    }
158 159
};

160
void
161
Dhcpv4Exchange::initResponse() {
162 163 164 165 166 167 168 169 170 171 172 173
    uint8_t resp_type = 0;
    switch (getQuery()->getType()) {
    case DHCPDISCOVER:
        resp_type = DHCPOFFER;
        break;
    case DHCPREQUEST:
    case DHCPINFORM:
        resp_type = DHCPACK;
        break;
    default:
        ;
    }
174
    // Only create a response if one is required.
175 176
    if (resp_type > 0) {
        resp_.reset(new Pkt4(resp_type, getQuery()->getTransid()));
177
        copyDefaultFields();
Francis Dupont's avatar
Francis Dupont committed
178
        copyDefaultOptions();
179 180 181 182

        if (getQuery()->isDhcp4o6()) {
            initResponse4o6();
        }
183 184 185
    }
}

186 187 188 189 190
void
Dhcpv4Exchange::initResponse4o6() {
    Pkt4o6Ptr query = boost::dynamic_pointer_cast<Pkt4o6>(getQuery());
    if (!query) {
        return;
191
    }
192 193 194 195 196 197 198 199 200 201 202 203
    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));
204 205 206 207 208 209 210
}

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

211 212
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
    // 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);
    }
239

240
    // Copy flags from the request to the response per RFC 2131
241
    resp_->setFlags(query_->getFlags());
242
}
243

244 245
void
Dhcpv4Exchange::copyDefaultOptions() {
246 247 248 249 250 251 252
    // Let's copy client-id to response. See RFC6842.
    // It is possible to disable RFC6842 to keep backward compatibility
    bool echo = CfgMgr::instance().echoClientId();
    OptionPtr client_id = query_->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (client_id && echo) {
        resp_->addOption(client_id);
    }
253 254 255 256 257

    // 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);
258
    }
259 260 261 262 263 264 265 266 267 268 269 270 271

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

274 275 276 277
void
Dhcpv4Exchange::setHostIdentifiers() {
    const ConstCfgHostOperationsPtr cfg =
        CfgMgr::instance().getCurrentCfg()->getCfgHostOperations4();
278 279
    // Collect host identifiers. The identifiers are stored in order of preference.
    // The server will use them in that order to search for host reservations.
280 281 282 283 284 285 286 287 288 289 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
    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;

321 322 323 324 325 326 327 328 329
        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;

330 331 332 333 334 335
        default:
            ;
        }
    }
}

336 337
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

338
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
339
                     const bool direct_response_desired)
340
    : shutdown_(true), alloc_engine_(), port_(port),
341
      use_bcast_(use_bcast) {
342

343
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
344
    try {
345 346 347
        // 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.
348
        if (port) {
349 350 351 352 353 354 355 356
            // 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);
357
        }
358

359 360 361 362
        // 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,
363
                                            false /* false = IPv4 */));
364

365 366
        /// @todo call loadLibraries() when handling configuration changes

367
    } catch (const std::exception &e) {
368
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
369 370 371
        shutdown_ = true;
        return;
    }
372

Tomek Mrugalski's avatar
Tomek Mrugalski committed
373
    shutdown_ = false;
374 375 376
}

Dhcpv4Srv::~Dhcpv4Srv() {
377 378 379 380 381 382
    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());
    }
383

384 385 386 387 388 389 390
    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
391
    IfaceMgr::instance().closeSockets();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
392

393 394
    // The lease manager was instantiated during DHCPv4Srv configuration,
    // so we should clean up after ourselves.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
395
    LeaseMgrFactory::destroy();
396 397 398

    // Explicitly unload hooks
    HooksManager::getHooksManager().unloadLibraries();
399 400
}

401 402
void
Dhcpv4Srv::shutdown() {
403
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
404 405 406
    shutdown_ = true;
}

407
isc::dhcp::Subnet4Ptr
408
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query) const {
409

410 411 412 413 414
    // DHCPv4-over-DHCPv6 is a special (and complex) case
    if (query->isDhcp4o6()) {
        return (selectSubnet4o6(query));
    }

415 416 417 418 419 420 421 422 423 424
    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();

425 426 427 428 429 430
    // If the link-selection sub-option is present, extract its value.
    // "The link-selection sub-option is used by any DHCP relay agent
    // that desires to specify a subnet/link for a DHCP client request
    // that it is relaying but needs the subnet/link specification to
    // be different from the IP address the DHCP server should use
    // when communicating with the relay agent." (RFC 3257)
431
    //
432
    // Try first Relay Agent Link Selection sub-option
433 434
    OptionPtr rai = query->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
435 436 437 438 439 440 441 442
        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)) {
443
                    selector.option_select_ =
444
                        IOAddress::fromBytes(AF_INET, &link_select_buf[0]);
445 446 447
                }
            }
        }
448 449 450 451 452 453 454 455 456 457
    } 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();
            }
        }
458 459
    }

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

    // Let's execute all callouts registered for subnet4_select
464
    if (HooksManager::calloutsPresent(Hooks.hook_index_subnet4_select_)) {
465 466 467 468 469
        CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

470 471 472
        // Enable copying options from the packet within hook library.
        ScopedEnableOptionsCopy<Pkt4> query4_options_copy(query);

473 474 475 476 477 478 479 480
        // 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
481
        HooksManager::callCallouts(Hooks.hook_index_subnet4_select_,
482 483 484 485 486
                                   *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)
487
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
488
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
489 490
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
491 492 493
            return (Subnet4Ptr());
        }

494 495
        /// @todo: Add support for DROP status

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

500 501
    if (subnet) {
        // Log at higher debug level that subnet has been found.
502
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
503 504 505 506
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
507
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
508 509 510 511
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
512
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
513 514 515 516
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

517
    return (subnet);
518 519
}

520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
isc::dhcp::Subnet4Ptr
Dhcpv4Srv::selectSubnet4o6(const Pkt4Ptr& query) const {

    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) {
540
        isc_throw(Unexpected, "Can't get DHCP4o6 message");
541 542 543 544 545 546 547 548 549 550 551 552 553 554
    }
    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,
555
                                      Pkt6::RELAY_GET_FIRST);
556 557
    }

Francis Dupont's avatar
Francis Dupont committed
558 559 560 561 562 563 564 565 566
    // 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();
        }
    }

567
    CfgMgr& cfgmgr = CfgMgr::instance();
Francis Dupont's avatar
Francis Dupont committed
568
    subnet = cfgmgr.getCurrentCfg()->getCfgSubnets4()->selectSubnet4o6(selector);
569 570

    // Let's execute all callouts registered for subnet4_select
571
    if (HooksManager::calloutsPresent(Hooks.hook_index_subnet4_select_)) {
572 573 574 575 576 577 578 579 580 581 582 583 584
        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
585
        HooksManager::callCallouts(Hooks.hook_index_subnet4_select_,
586 587 588 589 590
                                   *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)
591
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
592
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
593 594
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
595 596 597
            return (Subnet4Ptr());
        }

598 599
        /// @todo: Add support for DROP status

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

604 605
    if (subnet) {
        // Log at higher debug level that subnet has been found.
606
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
607 608 609 610
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
611
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
612 613 614 615
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
616
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
617 618 619 620
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

621
    return (subnet);
622 623
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
624 625
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
626 627 628
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
629 630
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
631 632 633
    IfaceMgr::instance().send(packet);
}

634 635
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
636
    while (!shutdown_) {
637
        try {
Francis Dupont's avatar
Francis Dupont committed
638
            run_one();
639
        } catch (const std::exception& e) {
640 641
            // General catch-all exception that are not caught by more specific
            // catches. This one is for exceptions derived from std::exception.
642
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_STD_EXCEPTION)
643
                .arg(e.what());
644 645 646 647
        } catch (...) {
            // General catch-all exception that are not caught by more specific
            // catches. This one is for other exceptions, not derived from
            // std::exception.
648
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_EXCEPTION);
649
        }
650 651 652 653
    }

    return (true);
}
654

Francis Dupont's avatar
Francis Dupont committed
655 656 657 658 659
void
Dhcpv4Srv::run_one() {
    // client's message and server's response
    Pkt4Ptr query;
    Pkt4Ptr rsp;
660

Francis Dupont's avatar
Francis Dupont committed
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
    try {
        uint32_t timeout = 1000;
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT).arg(timeout);
        query = receivePacket(timeout);

        // Log if packet has arrived. We can't log the detailed information
        // about the DHCP message because it hasn't been unpacked/parsed
        // yet, and it can't be parsed at this point because hooks will
        // have to process it first. The only information available at this
        // point are: the interface, source address and destination addresses
        // and ports.
        if (query) {
            LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_BUFFER_RECEIVED)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getRemotePort())
                .arg(query->getLocalAddr().toText())
                .arg(query->getLocalPort())
                .arg(query->getIface());
679

Francis Dupont's avatar
Francis Dupont committed
680 681 682
        } else {
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_INTERRUPTED)
                .arg(timeout);
683 684
        }

Francis Dupont's avatar
Francis Dupont committed
685 686 687 688 689 690 691 692 693 694 695 696
    } catch (const SignalInterruptOnSelect) {
        // Packet reception interrupted because a signal has been received.
        // This is not an error because we might have received a SIGTERM,
        // SIGINT, SIGHUP or SIGCHILD which are handled by the server. For
        // signals that are not handled by the server we rely on the default
        // behavior of the system.
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_SIGNAL)
            .arg(signal_set_->getNext());
    } catch (const std::exception& e) {
        // Log all other errors.
        LOG_ERROR(packet4_logger, DHCP4_BUFFER_RECEIVE_FAIL).arg(e.what());
    }
697

Francis Dupont's avatar
Francis Dupont committed
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
    // 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());
    }
716

Francis Dupont's avatar
Francis Dupont committed
717 718 719 720 721 722
    // 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;
    }
723

724
    processPacket(query, rsp);
725

726 727 728
    if (!rsp) {
        return;
    }
729

730 731 732 733 734 735
    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_)) {
736 737 738 739 740
            CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

741 742 743
            // Enable copying options from the packet within hook library.
            ScopedEnableOptionsCopy<Pkt4> resp4_options_copy(rsp);

744
            // Pass incoming packet as argument
745
            callout_handle->setArgument("response4", rsp);
746 747

            // Call callouts
748
            HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
749
                                       *callout_handle);
750 751 752

            // Callouts decided to skip the next processing step. The next
            // processing step would to parse the packet, so skip at this
753
            // stage means drop.
754
            if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
755 756 757 758
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                          DHCP4_HOOK_BUFFER_SEND_SKIP)
                    .arg(rsp->getLabel());
                return;
759 760
            }

761
            /// @todo: Add support for DROP status.
762

763
            callout_handle->getArgument("response4", rsp);
764 765
        }

766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_PACKET_SEND)
            .arg(rsp->getLabel())
            .arg(rsp->getName())
            .arg(static_cast<int>(rsp->getType()))
            .arg(rsp->getLocalAddr())
            .arg(rsp->getLocalPort())
            .arg(rsp->getRemoteAddr())
            .arg(rsp->getRemotePort())
            .arg(rsp->getIface());

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

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

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

794
void
795
Dhcpv4Srv::processPacket(Pkt4Ptr& query, Pkt4Ptr& rsp) {
796 797
    // Log reception of the packet. We need to increase it early, as any
    // failures in unpacking will cause the packet to be dropped. We
798
    // will increase type specific statistic further down the road.
799 800 801 802 803 804 805 806 807 808
    // 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);
809

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

813 814 815
        // Enable copying options from the packet within hook library.
        ScopedEnableOptionsCopy<Pkt4> query4_options_copy(query);

816 817
        // Pass incoming packet as argument
        callout_handle->setArgument("query4", query);
818

819 820 821
        // Call callouts
        HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                   *callout_handle);
822

823 824 825 826 827 828 829 830 831 832 833 834
        // 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;
        }
835

836
        callout_handle->getArgument("query4", query);
837

838 839
        /// @todo: add support for DROP status
    }
840

841 842 843
    // Unpack the packet information unless the buffer4_receive callouts
    // indicated they did it
    if (!skip_unpack) {
844
        try {
845 846 847 848 849
            LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_UNPACK)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getLocalAddr().toText())
                .arg(query->getIface());
            query->unpack();
850
        } catch (const std::exception& e) {
851 852 853 854 855 856
            // 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())
857
                .arg(e.what());
858

859 860 861
            // Increase the statistics of parse failues and dropped packets.
            isc::stats::StatsMgr::instance().addValue("pkt4-parse-failed",
                                                      static_cast<int64_t>(1));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
862
            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
863
                                                      static_cast<int64_t>(1));
864
            return;
865
        }
866
    }
867

868 869
    // Update statistics accordingly for received packet.
    processStatsReceived(query);
870

871 872 873 874
    // 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);
875

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

885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
    // 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
900
    if (HooksManager::calloutsPresent(Hooks.hook_index_pkt4_receive_)) {
901
        CalloutHandlePtr callout_handle = getCalloutHandle(query);
902

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

906 907 908
        // Enable copying options from the packet within hook library.
        ScopedEnableOptionsCopy<Pkt4> query4_options_copy(query);

909 910
        // Pass incoming packet as argument
        callout_handle->setArgument("query4", query);
911

912
        // Call callouts
Francis Dupont's avatar
Francis Dupont committed
913
        HooksManager::callCallouts(Hooks.hook_index_pkt4_receive_,
914
                                   *callout_handle);
915

916 917 918 919 920 921 922
        // Callouts decided to skip the next processing step. The next
        // processing step would to process the packet, so skip at this
        // stage means drop.
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_PACKET_RCVD_SKIP)
                .arg(query->getLabel());
923
            return;
924
        }
925

926
        /// @todo: Add support for DROP status
927

928 929
        callout_handle->getArgument("query4", query);
    }
930

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
    try {
        switch (query->getType()) {
        case DHCPDISCOVER:
            rsp = processDiscover(query);
            break;

        case DHCPREQUEST:
            // Note that REQUEST is used for many things in DHCPv4: for
            // requesting new leases, renewing existing ones and even
            // for rebinding.
            rsp = processRequest(query);
            break;

        case DHCPRELEASE:
            processRelease(query);
            break;

        case DHCPDECLINE:
            processDecline(query);
            break;

        case DHCPINFORM:
            rsp = processInform(query);
            break;

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

        // Catch-all exception (we used to call only isc::Exception, but
        // std::exception could potentially be raised and if we don't catch
        // it here, it would be caught in main() and the process would
        // terminate).  Just log the problem and ignore the packet.
        // (The problem is logged as a debug message because debug is
        // disabled by default - it prevents a DDOS attack based on the
        // sending of problem packets.)
        LOG_DEBUG(bad_packet4_logger, DBG_DHCP4_BASIC,
                  DHCP4_PACKET_DROP_0007)
            .arg(query->getLabel())
            .arg(e.what());
975

976 977 978 979
        // Increase the statistic of dropped packets.
        isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
                                                  static_cast<int64_t>(1));
    }
980

981 982 983
    if (!rsp) {
        return;
    }
984

985 986
    // Specifies if server should do the packing
    bool skip_pack = false;
987

988
    // Execute all callouts registered for pkt4_send
989
    if (HooksManager::calloutsPresent(Hooks.hook_index_pkt4_send_)) {
990
        CalloutHandlePtr callout_handle = getCalloutHandle(query);
991

992 993
        // Delete all previous arguments
        callout_handle->deleteAllArguments();
994

995 996
        // Clear skip flag if it was set in previous callouts
        callout_handle->setStatus(CalloutHandle::NEXT_STEP_CONTINUE);
997

Francis Dupont's avatar