dhcp4_srv.cc 99.6 KB
Newer Older
1
// Copyright (C) 2011-2015 Internet Systems Consortium, Inc. ("ISC")
2 3 4 5 6 7 8 9 10 11 12 13 14
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

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

50 51 52 53 54 55 56 57
#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>

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

#include <iomanip>

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

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

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

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

103 104 105
namespace isc {
namespace dhcp {

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

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

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

131
    // Set client identifier if the match-client-id flag is enabled (default).
132 133 134
    // 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) {
135
        if (subnet->getMatchClientId()) {
136 137 138 139 140 141 142 143 144 145
            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());
        }
146 147
    }
    // Check for static reservations.
148
    alloc_engine->findReservation(*context_);
149 150
};

151
void
152
Dhcpv4Exchange::initResponse() {
153 154 155 156 157 158 159 160 161 162 163 164
    uint8_t resp_type = 0;
    switch (getQuery()->getType()) {
    case DHCPDISCOVER:
        resp_type = DHCPOFFER;
        break;
    case DHCPREQUEST:
    case DHCPINFORM:
        resp_type = DHCPACK;
        break;
    default:
        ;
    }
165
    // Only create a response if one is required.
166 167
    if (resp_type > 0) {
        resp_.reset(new Pkt4(resp_type, getQuery()->getTransid()));
168 169 170 171 172 173 174 175 176
        copyDefaultFields();
    }
}

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

177 178
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
179 180 181 182 183 184 185 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 212 213 214 215 216 217
    // 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());

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

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

    // 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);
218 219 220
    }
}

221 222
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

223
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
224
                     const bool direct_response_desired)
225 226 227
    : 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) {
228

229
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
230
    try {
231 232 233
        // 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.
234
        if (port) {
235 236 237 238 239 240 241 242
            // 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);
243
        }
244

245 246 247 248
        // 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,
249
                                            false /* false = IPv4 */));
250

251 252 253 254 255 256 257
        // 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

258
    } catch (const std::exception &e) {
259
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
260 261 262
        shutdown_ = true;
        return;
    }
263

Tomek Mrugalski's avatar
Tomek Mrugalski committed
264
    shutdown_ = false;
265 266 267
}

Dhcpv4Srv::~Dhcpv4Srv() {
268 269 270 271 272 273
    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());
    }
274

Tomek Mrugalski's avatar
Tomek Mrugalski committed
275
    IfaceMgr::instance().closeSockets();
276 277
}

278 279
void
Dhcpv4Srv::shutdown() {
280
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
281 282 283
    shutdown_ = true;
}

284
isc::dhcp::Subnet4Ptr
285
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query) const {
286 287 288 289 290 291 292 293 294 295 296

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

297 298 299 300 301 302
    // 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)
303 304
    OptionPtr rai = query->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
305 306 307 308 309 310 311 312
        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)) {
313
                    selector.option_select_ =
314
                        IOAddress::fromBytes(AF_INET, &link_select_buf[0]);
315 316 317 318 319
                }
            }
        }
    }

320 321 322 323
    CfgMgr& cfgmgr = CfgMgr::instance();
    subnet = cfgmgr.getCurrentCfg()->getCfgSubnets4()->selectSubnet(selector);

    // Let's execute all callouts registered for subnet4_select
324
    if (HooksManager::calloutsPresent(hook_index_subnet4_select_)) {
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
        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)
344
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
345
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
346 347
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
348 349 350
            return (Subnet4Ptr());
        }

351 352
        /// @todo: Add support for DROP status

353 354 355 356
        // Use whatever subnet was specified by the callout
        callout_handle->getArgument("subnet4", subnet);
    }

357 358
    if (subnet) {
        // Log at higher debug level that subnet has been found.
359
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
360 361 362 363
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
364
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
365 366 367 368
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
369
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
370 371 372 373
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

374
    return (subnet);
375 376
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
377 378
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
379 380 381
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
382 383
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
384 385 386
    IfaceMgr::instance().send(packet);
}

387 388
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
389
    while (!shutdown_) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
390
        // client's message and server's response
391
        Pkt4Ptr query;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
392
        Pkt4Ptr rsp;
393

394
        try {
395
            uint32_t timeout = 1000;
396
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT).arg(timeout);
397
            query = receivePacket(timeout);
398

399 400 401 402 403 404 405
            // 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) {
406
                LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_BUFFER_RECEIVED)
407 408 409 410 411 412 413
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getRemotePort())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getLocalPort())
                    .arg(query->getIface());

            } else {
414
                LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_INTERRUPTED)
415 416 417
                    .arg(timeout);
            }

418 419 420
        } catch (const SignalInterruptOnSelect) {
            // Packet reception interrupted because a signal has been received.
            // This is not an error because we might have received a SIGTERM,
421 422
            // SIGINT, SIGHUP or SIGCHILD which are handled by the server. For
            // signals that are not handled by the server we rely on the default
423
            // behavior of the system.
424
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_SIGNAL)
425
                .arg(signal_set_->getNext());
426
        } catch (const std::exception& e) {
427
            // Log all other errors.
428
            LOG_ERROR(packet4_logger, DHCP4_BUFFER_RECEIVE_FAIL).arg(e.what());
429 430
        }

431 432 433
        // 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
Francis Dupont's avatar
Francis Dupont committed
434 435 436 437 438 439 440
        // 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.
441 442 443
        try {
            handleSignal();
        } catch (const std::exception& e) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
444 445 446
            // Standard exception occurred. Let's be on the safe side to
            // catch std::exception.
            LOG_ERROR(dhcp4_logger, DHCP4_HANDLE_SIGNAL_EXCEPTION)
447 448
                .arg(e.what());
        }
449

450
        // Timeout may be reached or signal received, which breaks select()
451 452
        // with no reception occurred. No need to log anything here because
        // we have logged right after the call to receivePacket().
453 454 455 456
        if (!query) {
            continue;
        }

457 458 459 460
        // Log reception of the packet. We need to increase it early, as any
        // failures in unpacking will cause the packet to be dropped. We
        // will increase type specific packets further down the road.
        // See processStatsReceived().
Tomek Mrugalski's avatar
Tomek Mrugalski committed
461
        isc::stats::StatsMgr::instance().addValue("pkt4-received",
462
                                                  static_cast<int64_t>(1));
463

464 465 466 467 468 469 470 471 472
        // 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));

473 474 475
        bool skip_unpack = false;

        // The packet has just been received so contains the uninterpreted wire
476
        // data; execute callouts registered for buffer4_receive.
477
        if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
478 479 480 481 482 483 484 485 486
            CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

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

            // Call callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
487 488
            HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                       *callout_handle);
489 490 491 492 493

            // 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.
494
            if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
495
                LOG_DEBUG(hooks_logger, DBG_DHCP4_DETAIL, DHCP4_HOOK_BUFFER_RCVD_SKIP)
496 497 498
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface());
499 500 501 502
                skip_unpack = true;
            }

            callout_handle->getArgument("query4", query);
503 504

            /// @todo: add support for DROP status
505 506 507 508 509
        }

        // Unpack the packet information unless the buffer4_receive callouts
        // indicated they did it
        if (!skip_unpack) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
510
            try {
511
                LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_UNPACK)
512 513 514
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface());
Tomek Mrugalski's avatar
Tomek Mrugalski committed
515 516
                query->unpack();
            } catch (const std::exception& e) {
517
                // Failed to parse the packet.
518
                LOG_DEBUG(bad_packet4_logger, DBG_DHCP4_DETAIL,
519
                          DHCP4_PACKET_DROP_0001)
520 521 522
                    .arg(query->getRemoteAddr().toText())
                    .arg(query->getLocalAddr().toText())
                    .arg(query->getIface())
523
                    .arg(e.what());
524 525

                // Increase the statistics of parse failues and dropped packets.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
526
                isc::stats::StatsMgr::instance().addValue("pkt4-parse-failed",
527
                                                          static_cast<int64_t>(1));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
528
                isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
529
                                                          static_cast<int64_t>(1));
530 531
                continue;
            }
532
        }
533

534 535 536
        // Update statistics accordingly for received packet.
        processStatsReceived(query);

Tomek Mrugalski's avatar
Tomek Mrugalski committed
537 538 539
        // 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.
540 541
        classifyPacket(query);

542 543 544
        // 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)) {
545
            // Increase the statistic of dropped packets.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
546
            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
547
                                                      static_cast<int64_t>(1));
548
            continue;
549
        }
550

551
        // We have sanity checked (in accept() that the Message Type option
552 553
        // exists, so we can safely get it here.
        int type = query->getType();
554
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_PACKET_RECEIVED)
555
            .arg(query->getLabel())
556
            .arg(query->getName())
557
            .arg(type)
558 559
            .arg(query->getRemoteAddr())
            .arg(query->getLocalAddr())
560
            .arg(query->getIface());
561
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
562
            .arg(query->getLabel())
563 564
            .arg(query->toText());

Tomek Mrugalski's avatar
Tomek Mrugalski committed
565
        // Let's execute all callouts registered for pkt4_receive
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
        if (HooksManager::calloutsPresent(hook_index_pkt4_receive_)) {
            CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

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

            // Call callouts
            HooksManager::callCallouts(hook_index_pkt4_receive_,
                                       *callout_handle);

            // Callouts decided to skip the next processing step. The next
            // processing step would to process the packet, so skip at this
            // stage means drop.
582
            if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
583
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_RCVD_SKIP)
584
                    .arg(query->getLabel());
585 586
                continue;
            }
587

588 589
            /// @todo: Add support for DROP status

590 591
            callout_handle->getArgument("query4", query);
        }
592

593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
        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:
615
                rsp = processInform(query);
616 617 618 619 620 621 622
                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.
                ;
623
            }
624
        } catch (const std::exception& e) {
625

626 627 628 629
            // 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.
630 631 632
            // (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.)
633
            LOG_DEBUG(bad_packet4_logger, DBG_DHCP4_BASIC,
634 635 636
                      DHCP4_PACKET_DROP_0007)
                .arg(query->getLabel())
                .arg(e.what());
637 638

            // Increase the statistic of dropped packets.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
639
            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
640
                                                      static_cast<int64_t>(1));
641
        }
642

643 644 645
        if (!rsp) {
            continue;
        }
646

647

648 649
        // Specifies if server should do the packing
        bool skip_pack = false;
650

Tomek Mrugalski's avatar
Tomek Mrugalski committed
651
        // Execute all callouts registered for pkt4_send
652 653
        if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
            CalloutHandlePtr callout_handle = getCalloutHandle(query);
654

655 656
            // Delete all previous arguments
            callout_handle->deleteAllArguments();
657

658
            // Clear skip flag if it was set in previous callouts
659
            callout_handle->setStatus(CalloutHandle::NEXT_STEP_CONTINUE);
660

661 662
            // Set our response
            callout_handle->setArgument("response4", rsp);
663

664 665 666
            // Call all installed callouts
            HooksManager::callCallouts(hook_index_pkt4_send_,
                                       *callout_handle);
667

668 669 670
            // 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".
671
            if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
672
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_SEND_SKIP)
673
                    .arg(query->getLabel());
674 675
                skip_pack = true;
            }
676 677

            /// @todo: Add support for DROP status
678 679 680 681
        }

        if (!skip_pack) {
            try {
682
                LOG_DEBUG(options4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_PACK)
683
                    .arg(rsp->getLabel());
684 685
                rsp->pack();
            } catch (const std::exception& e) {
686
                LOG_ERROR(options4_logger, DHCP4_PACKET_PACK_FAIL)
687
                    .arg(rsp->getLabel())
688 689 690 691 692 693 694 695
                    .arg(e.what());
            }
        }

        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.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
696
            // Let's execute all callouts registered for buffer4_send
697
            if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_send_)) {
698
                CalloutHandlePtr callout_handle = getCalloutHandle(query);
699

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

703 704
                // Pass incoming packet as argument
                callout_handle->setArgument("response4", rsp);
705

706
                // Call callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
707 708
                HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
                                           *callout_handle);
709

710 711 712
                // Callouts decided to skip the next processing step. The next
                // processing step would to parse the packet, so skip at this
                // stage means drop.
713
                if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
714
                    LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
715 716
                              DHCP4_HOOK_BUFFER_SEND_SKIP)
                        .arg(rsp->getLabel());
717
                    continue;
718
                }
719

720 721
                /// @todo: Add support for DROP status.

722
                callout_handle->getArgument("response4", rsp);
723
            }
724

725
            LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_PACKET_SEND)
726
                .arg(rsp->getLabel())
727
                .arg(rsp->getName())
728 729 730 731 732 733
                .arg(static_cast<int>(rsp->getType()))
                .arg(rsp->getLocalAddr())
                .arg(rsp->getLocalPort())
                .arg(rsp->getRemoteAddr())
                .arg(rsp->getRemotePort())
                .arg(rsp->getIface());
734

735
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA,
736
                      DHCP4_RESPONSE_DATA)
737 738 739 740
                .arg(rsp->getLabel())
                .arg(rsp->getName())
                .arg(static_cast<int>(rsp->getType()))
                .arg(rsp->toText());
741
            sendPacket(rsp);
742 743 744 745

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

746
        } catch (const std::exception& e) {
747
            LOG_ERROR(packet4_logger, DHCP4_PACKET_SEND_FAIL)
748
                .arg(rsp->getLabel())
749
                .arg(e.what());
750
        }
751 752 753 754 755
    }

    return (true);
}

756
string
757
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
    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());
774 775
}

776
isc::dhcp_ddns::D2Dhcid
777 778 779 780 781 782 783 784 785
Dhcpv4Srv::computeDhcid(const Lease4Ptr& lease) {
    if (!lease) {
        isc_throw(DhcidComputeError, "a pointer to the lease must be not"
                  " NULL to compute DHCID");

    } else if (lease->hostname_.empty()) {
        isc_throw(DhcidComputeError, "unable to compute the DHCID for the"
                  " lease which has empty hostname set");

786 787
    }

788 789 790 791 792 793 794 795 796
    // In order to compute DHCID the client's hostname must be encoded in
    // canonical wire format. It is unlikely that the FQDN is malformed
    // because it is validated by the classes which encapsulate options
    // carrying client FQDN. However, if the client name was carried in the
    // Hostname option it is more likely as it carries the hostname as a
    // regular string.
    std::vector<uint8_t> fqdn_wire;
    try {
        OptionDataTypeUtil::writeFqdn(lease->hostname_, fqdn_wire, true);
797

798 799 800
    } catch (const Exception& ex) {
        isc_throw(DhcidComputeError, "unable to compute DHCID because the"
                  " hostname: " << lease->hostname_ << " is invalid");
801 802

    }
803 804 805

    // Prefer client id to HW address to compute DHCID. If Client Id is
    // NULL, use HW address.
806
    try {
807 808 809 810
        if (lease->client_id_) {
            return (D2Dhcid(lease->client_id_->getClientId(), fqdn_wire));

        } else {
811
            return (D2Dhcid(lease->hwaddr_, fqdn_wire));
812
        }
813
    } catch (const Exception& ex) {
814 815
        isc_throw(DhcidComputeError, "unable to compute DHCID: "
                  << ex.what());
816

817
    }
818 819 820

}

821
void
822
Dhcpv4Srv::appendServerID(Dhcpv4Exchange& ex) {
823 824 825
    // 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.
826 827
    /// @todo: perhaps we should consider some more sophisticated server id
    /// generation, but for the current use cases, it should be ok.
828 829 830
    OptionPtr opt_srvid(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                           ex.getResponse()->getLocalAddr()));
    ex.getResponse()->addOption(opt_srvid);
831 832
}

833
void
834
Dhcpv4Srv::appendRequestedOptions(Dhcpv4Exchange& ex) {
835 836
    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
837
    Subnet4Ptr subnet = ex.getContext()->subnet_;
838 839 840 841 842 843 844
    // 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;
    }
845

846 847
    Pkt4Ptr query = ex.getQuery();

848 849 850
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
851
        OptionUint8Array>(query->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
852 853 854 855 856
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
857

858 859
    Pkt4Ptr resp = ex.getResponse();

860 861 862 863 864 865
    // 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) {
866
        if (!resp->getOption(*opt)) {
867
            OptionDescriptor desc = subnet->getCfgOption()->get("dhcp4", *opt);
868
            if (desc.option_) {
869
                resp->addOption(desc.option_);
870
            }
871 872
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
873
}
874

875
void
876
Dhcpv4Srv::appendRequestedVendorOptions(Dhcpv4Exchange& ex) {
877
    // Get the configured subnet suitable for the incoming packet.
878
    Subnet4Ptr subnet = ex.getContext()->subnet_;
879 880 881 882 883 884 885 886 887 888
    // 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;
    }

    // Try to get the vendor option
889 890
    boost::shared_ptr<OptionVendor> vendor_req = boost::dynamic_pointer_cast<
        OptionVendor>(ex.getQuery()->getOption(DHO_VIVSO_SUBOPTIONS));
891 892 893 894 895 896 897
    if (!vendor_req) {
        return;
    }

    uint32_t vendor_id = vendor_req->getVendorId();

    // Let's try to get ORO within that vendor-option
898 899
    /// @todo This is very specific to vendor-id=4491 (Cable Labs). Other
    /// vendors may have different policies.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
900 901
    OptionUint8ArrayPtr oro =
        boost::dynamic_pointer_cast<OptionUint8Array>(vendor_req-></