dhcp4_srv.cc 100 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
#include <dhcp/docsis3_option_defs.h>
20 21
#include <dhcp4/dhcp4_log.h>
#include <dhcp4/dhcp4_srv.h>
22 23
#include <dhcpsrv/addr_utilities.h>
#include <dhcpsrv/callout_handle_store.h>
24
#include <dhcpsrv/cfgmgr.h>
25
#include <dhcpsrv/cfg_host_operations.h>
26
#include <dhcpsrv/cfg_subnets4.h>
27 28
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
29
#include <dhcpsrv/ncr_generator.h>
30
#include <dhcpsrv/subnet.h>
31
#include <dhcpsrv/subnet_selector.h>
32
#include <dhcpsrv/utils.h>
33
#include <dhcpsrv/utils.h>
34 35
#include <eval/evaluate.h>
#include <eval/eval_messages.h>
36
#include <hooks/callout_handle.h>
37
#include <hooks/hooks_log.h>
38
#include <hooks/hooks_manager.h>
39
#include <stats/stats_mgr.h>
40
#include <util/strutil.h>
41
#include <stats/stats_mgr.h>
42 43
#include <log/logger.h>
#include <cryptolink/cryptolink.h>
44
#include <cfgrpt/config_report.h>
45

46 47 48 49 50 51
#ifdef HAVE_MYSQL
#include <dhcpsrv/mysql_lease_mgr.h>
#endif
#ifdef HAVE_PGSQL
#include <dhcpsrv/pgsql_lease_mgr.h>
#endif
52 53 54
#ifdef HAVE_DSCSQL
#include <dhcpsrv/dscsql_lease_mgr.h>
#endif
55 56
#include <dhcpsrv/memfile_lease_mgr.h>

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

#include <iomanip>

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

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

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

// 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.
99
Dhcp4Hooks Hooks;
100

101 102 103
namespace isc {
namespace dhcp {

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

110 111 112 113 114 115 116 117
    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");
118 119
    }

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

129
    // Set client identifier if the match-client-id flag is enabled (default).
130 131 132
    // 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) {
133
        if (subnet->getMatchClientId()) {
134 135 136 137 138 139 140 141 142 143
            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());
        }
144

145 146 147 148 149
        // 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();
150

151 152
            // Check for static reservations.
            alloc_engine->findReservation(*context_);
153 154
        }
    }
155 156
};

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

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

184 185
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
    // 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);
    }
212

213
    // Copy flags from the request to the response per RFC 2131
214
    resp_->setFlags(query_->getFlags());
215
}
216

217 218
void
Dhcpv4Exchange::copyDefaultOptions() {
219 220 221 222 223 224 225
    // 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);
    }
226 227 228 229 230

    // 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);
231
    }
232 233 234 235 236 237 238 239 240 241 242 243 244

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

247 248 249 250
void
Dhcpv4Exchange::setHostIdentifiers() {
    const ConstCfgHostOperationsPtr cfg =
        CfgMgr::instance().getCurrentCfg()->getCfgHostOperations4();
251 252
    // Collect host identifiers. The identifiers are stored in order of preference.
    // The server will use them in that order to search for host reservations.
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
    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;

294 295 296 297 298 299 300 301 302
        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;

303 304 305 306 307 308
        default:
            ;
        }
    }
}

309 310
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

311
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
312
                     const bool direct_response_desired)
313 314 315
    : shutdown_(true), alloc_engine_(), port_(port),
      use_bcast_(use_bcast), hook_index_pkt4_receive_(-1),
      hook_index_subnet4_select_(-1), hook_index_pkt4_send_(-1) {
316

317
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
318
    try {
319 320 321
        // 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.
322
        if (port) {
323 324 325 326 327 328 329 330
            // 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);
331
        }
332

333 334 335 336
        // 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,
337
                                            false /* false = IPv4 */));
338

339 340 341 342 343 344 345
        // Register hook points
        hook_index_pkt4_receive_   = Hooks.hook_index_pkt4_receive_;
        hook_index_subnet4_select_ = Hooks.hook_index_subnet4_select_;
        hook_index_pkt4_send_      = Hooks.hook_index_pkt4_send_;

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

346
    } catch (const std::exception &e) {
347
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
348 349 350
        shutdown_ = true;
        return;
    }
351

Tomek Mrugalski's avatar
Tomek Mrugalski committed
352
    shutdown_ = false;
353 354 355
}

Dhcpv4Srv::~Dhcpv4Srv() {
356 357 358 359 360 361
    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());
    }
362

Tomek Mrugalski's avatar
Tomek Mrugalski committed
363
    IfaceMgr::instance().closeSockets();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
364

365 366
    // The lease manager was instantiated during DHCPv4Srv configuration,
    // so we should clean up after ourselves.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
367
    LeaseMgrFactory::destroy();
368 369 370

    // Explicitly unload hooks
    HooksManager::getHooksManager().unloadLibraries();
371 372
}

373 374
void
Dhcpv4Srv::shutdown() {
375
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
376 377 378
    shutdown_ = true;
}

379
isc::dhcp::Subnet4Ptr
380
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query) const {
381 382 383 384 385 386 387 388 389 390 391

    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();

392 393 394 395 396 397
    // 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)
398
    //
399
    // Try first Relay Agent Link Selection sub-option
400 401
    OptionPtr rai = query->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
402 403 404 405 406 407 408 409
        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)) {
410
                    selector.option_select_ =
411
                        IOAddress::fromBytes(AF_INET, &link_select_buf[0]);
412 413 414
                }
            }
        }
415 416 417 418 419 420 421 422 423 424
    } 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();
            }
        }
425 426
    }

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

    // Let's execute all callouts registered for subnet4_select
431
    if (HooksManager::calloutsPresent(hook_index_subnet4_select_)) {
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
        CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

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

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

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

458 459
        /// @todo: Add support for DROP status

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

464 465
    if (subnet) {
        // Log at higher debug level that subnet has been found.
466
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
467 468 469 470
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
471
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
472 473 474 475
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
476
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
477 478 479 480
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

481
    return (subnet);
482 483
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
484 485
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
486 487 488
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
489 490
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
491 492 493
    IfaceMgr::instance().send(packet);
}

494 495
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
496
    while (!shutdown_) {
497
        try {
Francis Dupont's avatar
Francis Dupont committed
498
            run_one();
499
        } catch (const std::exception& e) {
500 501
            // General catch-all exception that are not caught by more specific
            // catches. This one is for exceptions derived from std::exception.
502
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_STD_EXCEPTION)
503
                .arg(e.what());
504 505 506 507
        } catch (...) {
            // General catch-all exception that are not caught by more specific
            // catches. This one is for other exceptions, not derived from
            // std::exception.
508
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_EXCEPTION);
509
        }
510 511 512 513
    }

    return (true);
}
514

Francis Dupont's avatar
Francis Dupont committed
515 516 517 518 519
void
Dhcpv4Srv::run_one() {
    // client's message and server's response
    Pkt4Ptr query;
    Pkt4Ptr rsp;
520

Francis Dupont's avatar
Francis Dupont committed
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
    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());
539

Francis Dupont's avatar
Francis Dupont committed
540 541 542
        } else {
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_INTERRUPTED)
                .arg(timeout);
543 544
        }

Francis Dupont's avatar
Francis Dupont committed
545 546 547 548 549 550 551 552 553 554 555 556
    } 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());
    }
557

Francis Dupont's avatar
Francis Dupont committed
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
    // 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());
    }
576

Francis Dupont's avatar
Francis Dupont committed
577 578 579 580 581 582
    // 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;
    }
583

584
    processPacket(query, rsp);
585

586 587 588
    if (!rsp) {
        return;
    }
589

590 591 592 593 594 595
    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_)) {
596 597 598 599 600 601
            CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

            // Pass incoming packet as argument
602
            callout_handle->setArgument("response4", rsp);
603 604

            // Call callouts
605
            HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
606
                                       *callout_handle);
607 608 609

            // Callouts decided to skip the next processing step. The next
            // processing step would to parse the packet, so skip at this
610
            // stage means drop.
611
            if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
612 613 614 615
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                          DHCP4_HOOK_BUFFER_SEND_SKIP)
                    .arg(rsp->getLabel());
                return;
616 617
            }

618
            /// @todo: Add support for DROP status.
619

620
            callout_handle->getArgument("response4", rsp);
621 622
        }

623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
        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());
    }
649
}
650

651
void
652
Dhcpv4Srv::processPacket(Pkt4Ptr& query, Pkt4Ptr& rsp) {
653 654
    // Log reception of the packet. We need to increase it early, as any
    // failures in unpacking will cause the packet to be dropped. We
655
    // will increase type specific statistic further down the road.
656 657 658 659 660 661 662 663 664 665
    // 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);
666

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

670 671
        // Pass incoming packet as argument
        callout_handle->setArgument("query4", query);
672

673 674 675
        // Call callouts
        HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                   *callout_handle);
676

677 678 679 680 681 682 683 684 685 686 687 688
        // 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;
        }
689

690
        callout_handle->getArgument("query4", query);
691

692 693
        /// @todo: add support for DROP status
    }
694

695 696 697
    // Unpack the packet information unless the buffer4_receive callouts
    // indicated they did it
    if (!skip_unpack) {
698
        try {
699 700 701 702 703
            LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_UNPACK)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getLocalAddr().toText())
                .arg(query->getIface());
            query->unpack();
704
        } catch (const std::exception& e) {
705 706 707 708 709 710
            // 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())
711
                .arg(e.what());
712

713 714 715
            // 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
716
            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
717
                                                      static_cast<int64_t>(1));
718
            return;
719
        }
720
    }
721

722 723
    // Update statistics accordingly for received packet.
    processStatsReceived(query);
724

725 726 727 728
    // 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);
729

730 731 732 733 734 735 736 737
    // 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;
    }
738

739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
    // We have sanity checked (in accept() that the Message Type option
    // exists, so we can safely get it here.
    int type = query->getType();
    LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_PACKET_RECEIVED)
        .arg(query->getLabel())
        .arg(query->getName())
        .arg(type)
        .arg(query->getRemoteAddr())
        .arg(query->getLocalAddr())
        .arg(query->getIface());
    LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
        .arg(query->getLabel())
        .arg(query->toText());

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

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

760 761
        // Pass incoming packet as argument
        callout_handle->setArgument("query4", query);
762

763 764 765
        // Call callouts
        HooksManager::callCallouts(hook_index_pkt4_receive_,
                                   *callout_handle);
766

767 768 769 770 771 772 773
        // 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());
774
            return;
775
        }
776

777
        /// @todo: Add support for DROP status
778

779 780
        callout_handle->getArgument("query4", query);
    }
781

782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
    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.
            ;
812
        }
813 814 815 816 817 818 819 820 821 822 823 824 825
    } 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());
826

827 828 829 830
        // Increase the statistic of dropped packets.
        isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
                                                  static_cast<int64_t>(1));
    }
831

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

836 837
    // Specifies if server should do the packing
    bool skip_pack = false;
838

839 840 841
    // Execute all callouts registered for pkt4_send
    if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
        CalloutHandlePtr callout_handle = getCalloutHandle(query);
842

843 844
        // Delete all previous arguments
        callout_handle->deleteAllArguments();
845

846 847
        // Clear skip flag if it was set in previous callouts
        callout_handle->setStatus(CalloutHandle::NEXT_STEP_CONTINUE);
848

849 850
        // Set our response
        callout_handle->setArgument("response4", rsp);
851

852 853 854
        // Also pass the corresponding query packet as argument
        callout_handle->setArgument("query4", query);

855 856 857 858 859 860 861 862 863 864 865 866
        // Call all installed callouts
        HooksManager::callCallouts(hook_index_pkt4_send_,
                                   *callout_handle);

        // Callouts decided to skip the next processing step. The next
        // processing step would to send the packet, so skip at this
        // stage means "drop response".
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_PACKET_SEND_SKIP)
                .arg(query->getLabel());
            skip_pack = true;
867
        }
868

869 870
        /// @todo: Add support for DROP status
    }
871

872 873 874 875 876
    if (!skip_pack) {
        try {
            LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_PACK)
                .arg(rsp->getLabel());
            rsp->pack();
877
        } catch (const std::exception& e) {
878 879
            LOG_ERROR(options4_logger, DHCP4_PACKET_PACK_FAIL)
                .arg(rsp->getLabel())
880 881
                .arg(e.what());
        }
882 883 884
    }
}

885
string
886
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
    if (!srvid) {
        isc_throw(BadValue, "NULL pointer passed to srvidToString()");
    }
    boost::shared_ptr<Option4AddrLst> generated =
        boost::dynamic_pointer_cast<Option4AddrLst>(srvid);
    if (!srvid) {
        isc_throw(BadValue, "Pointer to invalid option passed to srvidToString()");
    }

    Option4AddrLst::AddressContainer addrs = generated->getAddresses();
    if (addrs.size() != 1) {
        isc_throw(BadValue, "Malformed option passed to srvidToString(). "
                  << "Expected to contain a single IPv4 address.");
    }

    return (addrs[0].toText());
903 904
}

905
void
906
Dhcpv4Srv::appendServerID(Dhcpv4Exchange& ex) {
907 908 909
    // The source address for the outbound message should have been set already.
    // This is the address that to the best of the server's knowledge will be
    // available from the client.
910 911
    /// @todo: perhaps we should consider some more sophisticated server id
    /// generation, but for the current use cases, it should be ok.
912 913 914
    OptionPtr opt_srvid(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                           ex.getResponse()->getLocalAddr()));
    ex.getResponse()->addOption(opt_srvid);
915 916
}

917 918 919 920
void
Dhcpv4Srv::buildCfgOptionList(Dhcpv4Exchange& ex) {
    CfgOptionList& co_list = ex.getCfgOptionList();

921
    // Retrieve subnet.
922
    Subnet4Ptr subnet = ex.getContext()->subnet_;
923 924 925 926 927
    if (!subnet) {
        // All methods using the CfgOptionList object return soon when
        // there is no subnet so do the same
        return;
    }
928 929 930

    // Firstly, host specific options.
    const ConstHostPtr& host = ex.getContext()->host_;
931
    if (host && !host->getCfgOption4()->empty()) {
932 933 934 935
        co_list.push_back(host->getCfgOption4());
    }

    // Secondly, subnet configured options.
936
    if (!subnet->getCfgOption()->empty()) {
937 938 939 940 941 942 943 944 945 946 947 948
        co_list.push_back(subnet->getCfgOption());
    }

    // Each class in the incoming packet
    const ClientClasses& classes = ex.getQuery()->getClasses();
    for (ClientClasses::const_iterator cclass = classes.begin();
         cclass != classes.end(); ++cclass) {
        // Find the client class definition for this class
        const ClientClassDefPtr& ccdef = CfgMgr::instance().getCurrentCfg()->
            getClientClassDictionary()->findClass(*cclass);
        if (!ccdef) {
            // Not found: the class is not configured
949 950 951
            if (((*cclass).size() <= VENDOR_CLASS_PREFIX.size()) ||
                ((*cclass).compare(0, VENDOR_CLASS_PREFIX.size(), VENDOR_CLASS_PREFIX) != 0)) {
                // Not a VENDOR_CLASS_* so should be configured
952
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_CLASS_UNCONFIGURED)
953 954 955 956
                    .arg(ex.getQuery()->getLabel())
                    .arg(*cclass);
            }
            // Skip it
957 958
            continue;
        }
959 960 961 962
        if (ccdef->getCfgOption()->empty()) {
            // Skip classes which don't configure options
            continue;
        }
963 964 965 966
        co_list.push_back(ccdef->getCfgOption());
    }

    // Last global options
967 968 969
    if (!CfgMgr::instance().getCurrentCfg()->getCfgOption()->empty()) {
        co_list.push_back(CfgMgr::instance().getCurrentCfg()->getCfgOption());
    }
970 971
}

972
void
973
Dhcpv4Srv::appendRequestedOptions(Dhcpv4Exchange& ex) {
974 975
    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
976
    Subnet4Ptr subnet = ex.getContext()->subnet_;
977 978 979 980 981 982 983
    // If we can't find the subnet for the client there is no way
    // to get the options to be sent to a client. We don't log an
    // error because it will be logged by the assignLease method
    // anyway.
    if (!subnet) {
        return;
    }
984

985 986 987 988 989 990
    // Unlikely short cut
    const CfgOptionList& co_list = ex.getCfgOptionList();
    if (co_list.empty()) {
        return;
    }

991 992
    Pkt4Ptr query = ex.getQuery();

993 994 995
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
996
        OptionUint8Array>(query->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
997 998 999 1000 1001
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
1002

1003 1004
    Pkt4Ptr resp = ex.getResponse();

1005 1006 1007 1008 1009 1010
    // Get the codes of requested options.
    const std::vector<uint8_t>& requested_opts = option_prl->getValues();
    // For each requested option code get the instance of the option
    // to be returned to the client.
    for (std::vector<uint8_t>::const_iterator opt = requested_opts.begin();
         opt != requested_opts.end(); ++opt) {
1011
        // Add nothing when it is already there
1012
        if (!resp->getOption(*opt)) {
1013 1014 1015 1016 1017
            // Iterate on the configured option list
            for (CfgOptionList::const_iterator copts = co_list.begin();
                 copts != co_list.end(); ++copts) {
                OptionDescriptor desc = (*copts)->get("dhcp4", *opt);
                // Got it: add it and jump to the outer loop
1018 1019
                if (desc.option_) {
                    resp->addOption(desc.option_);
1020
                    break;
1021 1022 1023 1024
                }
            }
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1025
}
1026

1027
void
1028
Dhcpv4Srv::appendRequestedVendorOptions(Dhcpv4Exchange& ex) {
1029
    // Get the configured subnet suitable for the incoming packet.
1030
    Subnet4Ptr subnet = ex.getContext()->subnet_;
1031 1032 1033 1034 1035 1036 1037 1038 1039
    // Leave if there is no subnet matching the incoming packet.
    // There is no need to log the error message here because
    // it will be logged in the assignLease() when it fails to
    // pick the suitable subnet. We don't want to duplicate
    // error messages in such case.
    if (!subnet) {
        return;
    }

1040 1041 1042 1043 1044 1045
    // Unlikely short cut
    const CfgOptionList& co_list = ex.getCfgOptionList();
    if (co_list.empty()) {
        return;
    }

1046
    // Try to get the vendor option
1047 1048
    boost::shared_ptr<OptionVendor> vendor_req = boost::dynamic_pointer_cast<
        OptionVendor>(ex.getQuery()->getOption(DHO_VIVSO_SUBOPTIONS));
1049 1050 1051 1052 1053 1054 1055
    if (!vendor_req) {
        return;
    }

    uint32_t vendor_id = vendor_req->getVendorId();

    // Let's try to get ORO within that vendor-option
1056 1057
    /// @todo This is very specific to vendor-id=4491 (Cable Labs). Other
    /// vendors may have different policies.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
1058 1059
    OptionUint8ArrayPtr oro =
        boost::dynamic_pointer_cast<OptionUint8Array>(vendor_req->getOption(DOCSIS3_V4_ORO));
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069

    // Option ORO not found. Don't do anything then.
    if (!oro) {
        return;
    }

    boost::shared_ptr<OptionVendor> vendor_rsp(new OptionVendor(Option::V4, vendor_id));

    // Get the list of options that client requested.
    bool added = false;
1070
    const std::vector<uint8_t>& requested_opts = oro->getValues();
1071

Tomek Mrugalski's avatar
Tomek Mrugalski committed
1072
    for (std::vector<uint8_t>::const_iterator code = requested_opts.begin();
1073
         code != requested_opts.end(); ++code) {
1074
        if  (!vendor_rsp->getOption(*code)) {
1075 1076 1077 1078 1079 1080 1081 1082
            for (CfgOptionList::const_iterator copts = co_list.begin();
                 copts != co_list.end(); ++copts) {
                OptionDescriptor desc = (*copts)->get(vendor_id, *code);
                if (desc.option_) {
                    vendor_rsp->addOption(desc.option_);
                    added = true;
                    break;
                }
1083
            }