dhcp4_srv.cc 103 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_subnets4.h>
26 27
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
28
#include <dhcpsrv/ncr_generator.h>
29
#include <dhcpsrv/subnet.h>
30
#include <dhcpsrv/subnet_selector.h>
31
#include <dhcpsrv/utils.h>
32
#include <dhcpsrv/utils.h>
33 34
#include <eval/evaluate.h>
#include <eval/eval_messages.h>
35
#include <hooks/callout_handle.h>
36
#include <hooks/hooks_log.h>
37
#include <hooks/hooks_manager.h>
38
#include <stats/stats_mgr.h>
39
#include <util/strutil.h>
40
#include <stats/stats_mgr.h>
41 42
#include <log/logger.h>
#include <cryptolink/cryptolink.h>
43
#include <cfgrpt/config_report.h>
44

45 46 47 48 49 50 51 52
#ifdef HAVE_MYSQL
#include <dhcpsrv/mysql_lease_mgr.h>
#endif
#ifdef HAVE_PGSQL
#include <dhcpsrv/pgsql_lease_mgr.h>
#endif
#include <dhcpsrv/memfile_lease_mgr.h>

53
#include <boost/bind.hpp>
54
#include <boost/foreach.hpp>
55
#include <boost/shared_ptr.hpp>
56 57 58

#include <iomanip>

59 60
using namespace isc;
using namespace isc::asiolink;
61
using namespace isc::cryptolink;
62
using namespace isc::dhcp;
63
using namespace isc::dhcp_ddns;
64
using namespace isc::hooks;
65
using namespace isc::log;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
66
using namespace isc::stats;
67
using namespace std;
68

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

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

// 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.
95
Dhcp4Hooks Hooks;
96

97 98 99
namespace isc {
namespace dhcp {

100
Dhcpv4Exchange::Dhcpv4Exchange(const AllocEnginePtr& alloc_engine,
101 102
                               const Pkt4Ptr& query,
                               const Subnet4Ptr& subnet)
103 104
    : alloc_engine_(alloc_engine), query_(query), resp_(),
      context_(new AllocEngine::ClientContext4()) {
105

106 107 108 109 110 111 112 113
    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");
114 115
    }

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

125
    // Set client identifier if the match-client-id flag is enabled (default).
126 127 128
    // 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) {
129
        if (subnet->getMatchClientId()) {
130 131 132 133 134 135 136 137 138 139
            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());
        }
140
    }
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

    // Before we can check for static reservations, we need to prepare a set
    // of identifiers to be used for this.

    // HW address.
    if (context_->hwaddr_ && !context_->hwaddr_->hwaddr_.empty()) {
        context_->host_identifiers_[Host::IDENT_HWADDR] = context_->hwaddr_->hwaddr_;
    }

    // Client identifier
    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_->host_identifiers_.insert(
                        AllocEngine::IdentifierPair(Host::IDENT_DUID,
                                                    std::vector<uint8_t>(vec.begin() + 5,
                                                                         vec.end())));
            }
            /// @todo Add support for other client identifiers (see #4317).
        }
    }
    // 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_->host_identifiers_[Host::IDENT_CIRCUIT_ID] = circuit_id_vec;
            }
        }
    }

179
    // Check for static reservations.
180
    alloc_engine->findReservation(*context_);
181 182
};

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

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

210 211
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
212 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
    // 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);
    }
238

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

243 244
void
Dhcpv4Exchange::copyDefaultOptions() {
245 246 247 248 249 250 251
    // 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);
    }
252 253 254 255 256

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

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

273 274
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

275
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
276
                     const bool direct_response_desired)
277 278 279
    : 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) {
280

281
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
282
    try {
283 284 285
        // 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.
286
        if (port) {
287 288 289 290 291 292 293 294
            // 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);
295
        }
296

297 298 299 300
        // 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,
301
                                            false /* false = IPv4 */));
302

303 304 305 306 307 308 309
        // 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

310
    } catch (const std::exception &e) {
311
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
312 313 314
        shutdown_ = true;
        return;
    }
315

Tomek Mrugalski's avatar
Tomek Mrugalski committed
316
    shutdown_ = false;
317 318 319
}

Dhcpv4Srv::~Dhcpv4Srv() {
320 321 322 323 324 325
    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());
    }
326

Tomek Mrugalski's avatar
Tomek Mrugalski committed
327
    IfaceMgr::instance().closeSockets();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
328

329 330
    // The lease manager was instantiated during DHCPv4Srv configuration,
    // so we should clean up after ourselves.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
331
    LeaseMgrFactory::destroy();
332 333
}

334 335
void
Dhcpv4Srv::shutdown() {
336
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
337 338 339
    shutdown_ = true;
}

340
isc::dhcp::Subnet4Ptr
341
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query) const {
342 343 344 345 346 347 348 349 350 351 352

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

353 354 355 356 357 358
    // 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)
359
    //
360
    // Try first Relay Agent Link Selection sub-option
361 362
    OptionPtr rai = query->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
363 364 365 366 367 368 369 370
        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)) {
371
                    selector.option_select_ =
372
                        IOAddress::fromBytes(AF_INET, &link_select_buf[0]);
373 374 375
                }
            }
        }
376 377 378 379 380 381 382 383 384 385
    } 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();
            }
        }
386 387
    }

388 389 390 391
    CfgMgr& cfgmgr = CfgMgr::instance();
    subnet = cfgmgr.getCurrentCfg()->getCfgSubnets4()->selectSubnet(selector);

    // Let's execute all callouts registered for subnet4_select
392
    if (HooksManager::calloutsPresent(hook_index_subnet4_select_)) {
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
        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)
412
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
413
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
414 415
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
416 417 418
            return (Subnet4Ptr());
        }

419 420
        /// @todo: Add support for DROP status

421 422 423 424
        // Use whatever subnet was specified by the callout
        callout_handle->getArgument("subnet4", subnet);
    }

425 426
    if (subnet) {
        // Log at higher debug level that subnet has been found.
427
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
428 429 430 431
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
432
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
433 434 435 436
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
437
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
438 439 440 441
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

442
    return (subnet);
443 444
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
445 446
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
447 448 449
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
450 451
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
452 453 454
    IfaceMgr::instance().send(packet);
}

455 456
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
457
    while (!shutdown_) {
458
        try {
Francis Dupont's avatar
Francis Dupont committed
459
            run_one();
460
        } catch (const std::exception& e) {
461 462
            // General catch-all exception that are not caught by more specific
            // catches. This one is for exceptions derived from std::exception.
463
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_STD_EXCEPTION)
464
                .arg(e.what());
465 466 467 468
        } catch (...) {
            // General catch-all exception that are not caught by more specific
            // catches. This one is for other exceptions, not derived from
            // std::exception.
469
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_EXCEPTION);
470
        }
471 472 473 474
    }

    return (true);
}
475

Francis Dupont's avatar
Francis Dupont committed
476 477 478 479 480
void
Dhcpv4Srv::run_one() {
    // client's message and server's response
    Pkt4Ptr query;
    Pkt4Ptr rsp;
481

Francis Dupont's avatar
Francis Dupont committed
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
    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());
500

Francis Dupont's avatar
Francis Dupont committed
501 502 503
        } else {
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_INTERRUPTED)
                .arg(timeout);
504 505
        }

Francis Dupont's avatar
Francis Dupont committed
506 507 508 509 510 511 512 513 514 515 516 517
    } 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());
    }
518

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

Francis Dupont's avatar
Francis Dupont committed
538 539 540 541 542 543
    // 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;
    }
544

545
    processPacket(query, rsp);
546

547 548 549
    if (!rsp) {
        return;
    }
550

551 552 553 554 555 556
    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_)) {
557 558 559 560 561 562
            CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

            // Pass incoming packet as argument
563
            callout_handle->setArgument("response4", rsp);
564 565

            // Call callouts
566
            HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
567
                                       *callout_handle);
568 569 570

            // Callouts decided to skip the next processing step. The next
            // processing step would to parse the packet, so skip at this
571
            // stage means drop.
572
            if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
573 574 575 576
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                          DHCP4_HOOK_BUFFER_SEND_SKIP)
                    .arg(rsp->getLabel());
                return;
577 578
            }

579
            /// @todo: Add support for DROP status.
580

581
            callout_handle->getArgument("response4", rsp);
582 583
        }

584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
        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());
    }
610
}
611

612
void
613
Dhcpv4Srv::processPacket(Pkt4Ptr& query, Pkt4Ptr& rsp) {
614 615
    // Log reception of the packet. We need to increase it early, as any
    // failures in unpacking will cause the packet to be dropped. We
616
    // will increase type specific statistic further down the road.
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
    // See processStatsReceived().
    isc::stats::StatsMgr::instance().addValue("pkt4-received",
                                              static_cast<int64_t>(1));

    // In order to parse the DHCP options, the server needs to use some
    // configuration information such as: existing option spaces, option
    // definitions etc. This is the kind of information which is not
    // available in the libdhcp, so we need to supply our own implementation
    // of the option parsing function here, which would rely on the
    // configuration data.
    query->setCallback(boost::bind(&Dhcpv4Srv::unpackOptions, this,
                                   _1, _2, _3));

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

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

640 641
        // Pass incoming packet as argument
        callout_handle->setArgument("query4", query);
642

643 644 645
        // Call callouts
        HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                   *callout_handle);
646

647 648 649 650 651 652 653 654 655 656 657 658
        // 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;
        }
659

660
        callout_handle->getArgument("query4", query);
661

662 663
        /// @todo: add support for DROP status
    }
664

665 666 667
    // Unpack the packet information unless the buffer4_receive callouts
    // indicated they did it
    if (!skip_unpack) {
668
        try {
669 670 671 672 673
            LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_UNPACK)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getLocalAddr().toText())
                .arg(query->getIface());
            query->unpack();
674
        } catch (const std::exception& e) {
675 676 677 678 679 680
            // 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())
681
                .arg(e.what());
682

683 684 685
            // 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
686
            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
687
                                                      static_cast<int64_t>(1));
688
            return;
689
        }
690
    }
691

692 693
    // Update statistics accordingly for received packet.
    processStatsReceived(query);
694

695 696 697 698
    // 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);
699

700 701 702 703 704 705 706 707
    // 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;
    }
708

709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
    // 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);
726

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

730 731
        // Pass incoming packet as argument
        callout_handle->setArgument("query4", query);
732

733 734 735
        // Call callouts
        HooksManager::callCallouts(hook_index_pkt4_receive_,
                                   *callout_handle);
736

737 738 739 740 741 742 743
        // 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());
744
            return;
745
        }
746

747
        /// @todo: Add support for DROP status
748

749 750
        callout_handle->getArgument("query4", query);
    }
751

752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
    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.
            ;
782
        }
783 784 785 786 787 788 789 790 791 792 793 794 795
    } 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());
796

797 798 799 800
        // Increase the statistic of dropped packets.
        isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
                                                  static_cast<int64_t>(1));
    }
801

802 803 804
    if (!rsp) {
        return;
    }
805

806 807
    // Specifies if server should do the packing
    bool skip_pack = false;
808

809 810 811
    // Execute all callouts registered for pkt4_send
    if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
        CalloutHandlePtr callout_handle = getCalloutHandle(query);
812

813 814
        // Delete all previous arguments
        callout_handle->deleteAllArguments();
815

816 817
        // Clear skip flag if it was set in previous callouts
        callout_handle->setStatus(CalloutHandle::NEXT_STEP_CONTINUE);
818

819 820
        // Set our response
        callout_handle->setArgument("response4", rsp);
821

822 823 824
        // Also pass the corresponding query packet as argument
        callout_handle->setArgument("query4", query);

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

839 840
        /// @todo: Add support for DROP status
    }
841

842 843 844 845 846
    if (!skip_pack) {
        try {
            LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_PACK)
                .arg(rsp->getLabel());
            rsp->pack();
847
        } catch (const std::exception& e) {
848 849
            LOG_ERROR(options4_logger, DHCP4_PACKET_PACK_FAIL)
                .arg(rsp->getLabel())
850 851
                .arg(e.what());
        }
852 853 854
    }
}

855
string
856
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
    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());
873 874
}

875
void
876
Dhcpv4Srv::appendServerID(Dhcpv4Exchange& ex) {
877 878 879
    // 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.
880 881
    /// @todo: perhaps we should consider some more sophisticated server id
    /// generation, but for the current use cases, it should be ok.
882 883 884
    OptionPtr opt_srvid(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                           ex.getResponse()->getLocalAddr()));
    ex.getResponse()->addOption(opt_srvid);
885 886
}

887 888 889 890 891 892
void
Dhcpv4Srv::buildCfgOptionList(Dhcpv4Exchange& ex) {
    CfgOptionList& co_list = ex.getCfgOptionList();

    // First subnet configured options
    Subnet4Ptr subnet = ex.getContext()->subnet_;
893 894 895 896 897 898
    if (!subnet) {
        // All methods using the CfgOptionList object return soon when
        // there is no subnet so do the same
        return;
    }
    if (!subnet->getCfgOption()->empty()) {
899 900 901 902 903 904 905 906 907 908 909 910
        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
911 912 913
            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
914
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_CLASS_UNCONFIGURED)
915 916 917 918
                    .arg(ex.getQuery()->getLabel())
                    .arg(*cclass);
            }
            // Skip it
919 920
            continue;
        }
921 922 923 924
        if (ccdef->getCfgOption()->empty()) {
            // Skip classes which don't configure options
            continue;
        }
925 926 927 928
        co_list.push_back(ccdef->getCfgOption());
    }

    // Last global options
929 930 931
    if (!CfgMgr::instance().getCurrentCfg()->getCfgOption()->empty()) {
        co_list.push_back(CfgMgr::instance().getCurrentCfg()->getCfgOption());
    }
932 933
}

934
void
935
Dhcpv4Srv::appendRequestedOptions(Dhcpv4Exchange& ex) {
936 937
    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
938
    Subnet4Ptr subnet = ex.getContext()->subnet_;
939 940 941 942 943 944 945
    // 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;
    }
946

947 948 949 950 951 952
    // Unlikely short cut
    const CfgOptionList& co_list = ex.getCfgOptionList();
    if (co_list.empty()) {
        return;
    }

953 954
    Pkt4Ptr query = ex.getQuery();

955 956 957
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
958
        OptionUint8Array>(query->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
959 960 961 962 963
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
964

965 966
    Pkt4Ptr resp = ex.getResponse();

967 968 969 970 971 972
    // 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) {
973
        // Add nothing when it is already there
974
        if (!resp->getOption(*opt)) {
975 976 977 978 979
            // 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
980 981
                if (desc.option_) {
                    resp->addOption(desc.option_);
982
                    break;
983 984 985 986
                }
            }
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
987
}
988

989
void
990
Dhcpv4Srv::appendRequestedVendorOptions(Dhcpv4Exchange& ex) {
991
    // Get the configured subnet suitable for the incoming packet.
992
    Subnet4Ptr subnet = ex.getContext()->subnet_;
993 994 995 996 997 998 999 1000 1001
    // 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;
    }

1002 1003