dhcp4_srv.cc 87.7 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 <asiolink/io_address.h>
16
#include <dhcp/dhcp4.h>
17 18
#include <dhcp/duid.h>
#include <dhcp/hwaddr.h>
19
#include <dhcp/iface_mgr.h>
20
#include <dhcp/option4_addrlst.h>
21
#include <dhcp/option_int.h>
22
#include <dhcp/option_int_array.h>
23
#include <dhcp/option_vendor.h>
24
#include <dhcp/option_string.h>
25
#include <dhcp/pkt4.h>
26
#include <dhcp/docsis3_option_defs.h>
27 28
#include <dhcp4/dhcp4_log.h>
#include <dhcp4/dhcp4_srv.h>
29 30
#include <dhcpsrv/addr_utilities.h>
#include <dhcpsrv/callout_handle_store.h>
31
#include <dhcpsrv/cfgmgr.h>
32
#include <dhcpsrv/cfg_subnets4.h>
33 34 35
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
#include <dhcpsrv/subnet.h>
36
#include <dhcpsrv/subnet_selector.h>
37
#include <dhcpsrv/utils.h>
38
#include <dhcpsrv/utils.h>
39
#include <hooks/callout_handle.h>
40
#include <hooks/hooks_manager.h>
41
#include <util/strutil.h>
42

43
#include <asio.hpp>
44
#include <boost/bind.hpp>
45
#include <boost/foreach.hpp>
46
#include <boost/shared_ptr.hpp>
47 48 49

#include <iomanip>

50 51
using namespace isc;
using namespace isc::asiolink;
52
using namespace isc::dhcp;
53
using namespace isc::dhcp_ddns;
54
using namespace isc::hooks;
55 56
using namespace isc::log;
using namespace std;
57

58
/// Structure that holds registered hook indexes
59 60
struct Dhcp4Hooks {
    int hook_index_buffer4_receive_;///< index for "buffer4_receive" hook point
61 62
    int hook_index_pkt4_receive_;   ///< index for "pkt4_receive" hook point
    int hook_index_subnet4_select_; ///< index for "subnet4_select" hook point
63
    int hook_index_lease4_release_; ///< index for "lease4_release" hook point
64
    int hook_index_pkt4_send_;      ///< index for "pkt4_send" hook point
65
    int hook_index_buffer4_send_;   ///< index for "buffer4_send" hook point
66

67 68 69
    /// Constructor that registers hook points for DHCPv4 engine
    Dhcp4Hooks() {
        hook_index_buffer4_receive_= HooksManager::registerHook("buffer4_receive");
70 71 72
        hook_index_pkt4_receive_   = HooksManager::registerHook("pkt4_receive");
        hook_index_subnet4_select_ = HooksManager::registerHook("subnet4_select");
        hook_index_pkt4_send_      = HooksManager::registerHook("pkt4_send");
73 74
        hook_index_lease4_release_ = HooksManager::registerHook("lease4_release");
        hook_index_buffer4_send_   = HooksManager::registerHook("buffer4_send");
75 76 77 78 79 80 81
    }
};

// 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.
82
Dhcp4Hooks Hooks;
83

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 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 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 218 219 220 221 222 223 224 225 226 227 228 229
namespace {

/// @brief DHCPv4 message exchange.
///
/// This class represents the DHCPv4 message exchange. The message exchange
/// consists of the single client message, server response to this message
/// and the mechanisms to generate the server's response. The server creates
/// the instance of the @c DHCPv4Exchange for each inbound message that it
/// accepts for processing.
///
/// The use of the @c DHCPv4Exchange object as a central repository of
/// information about the message exchange simplifies the API of the
/// @c Dhcpv4Srv class.
///
/// Another benefit of using this class is that different methods of the
/// @c Dhcpv4Srv may share information. For example, the constructor of this
/// class selects the subnet and multiple methods of @c Dhcpv4Srv use this
/// subnet, without the need to select it again.
///
/// @todo This is the initial version of this class. In the future a lot of
/// code from the @c Dhcpv4Srv class will be migrated here.
class DHCPv4Exchange {
public:
    /// @brief Constructor.
    ///
    /// The constructor selects the subnet for the query and checks for the
    /// static host reservations for the client which has sent the message.
    /// The information about the reservations is stored in the
    /// @c AllocEngine::ClientContext4 object, which can be obtained by
    /// calling the @c getContext.
    ///
    /// @param alloc_engine Pointer to the instance of the Allocation Engine
    /// used by the server.
    /// @param query Pointer to the client message.
    DHCPv4Exchange(const AllocEnginePtr& alloc_engine, const Pkt4Ptr& query);

    /// @brief Selects the subnet for the message processing.
    ///
    /// The pointer to the selected subnet is stored in the @c ClientContext4
    /// structure.
    void selectSubnet();

    /// @brief Selects the subnet for the message processing.
    ///
    /// @todo This variant of the @c selectSubnet method is static and public so
    /// as it may be invoked by the @c Dhcpv4Srv object. This is temporary solution
    /// and the function will go away once the server code fully supports the use
    /// of this class and it obtains the subnet from the context returned by the
    /// @c getContext method.
    ///
    /// @param query Pointer to the client's message.
    /// @return Pointer to the selected subnet or NULL if no suitable subnet
    /// has been found.
    static Subnet4Ptr selectSubnet(const Pkt4Ptr& query);

    /// @brief Returns the copy of the context for the Allocation engine.
    AllocEngine::ClientContext4 getContext() const {
        return (context_);
    }

private:
    /// @brief Pointer to the allocation engine used by the server.
    AllocEnginePtr alloc_engine_;
    /// @brief Pointer to the DHCPv4 message sent by the client.
    Pkt4Ptr query_;
    /// @brief Context for use with allocation engine.
    AllocEngine::ClientContext4 context_;
};

/// @brief Type representing the pointer to the @c DHCPv4Exchange.
typedef boost::shared_ptr<DHCPv4Exchange> DHCPv4ExchangePtr;

DHCPv4Exchange::DHCPv4Exchange(const AllocEnginePtr& alloc_engine,
                               const Pkt4Ptr& query)
    : alloc_engine_(alloc_engine), query_(query), context_() {
    selectSubnet();
    // Hardware address.
    context_.hwaddr_ = query->getHWAddr();
    // Client Identifier
    OptionPtr opt_clientid = query->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (opt_clientid) {
        context_.clientid_.reset(new ClientId(opt_clientid->getData()));
    }
    // Check for static reservations.
    alloc_engine->findReservation(context_);
};

void
DHCPv4Exchange::selectSubnet() {
    context_.subnet_ = selectSubnet(query_);
}

Subnet4Ptr
DHCPv4Exchange::selectSubnet(const Pkt4Ptr& query) {

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

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

    // Let's execute all callouts registered for subnet4_select
    if (HooksManager::calloutsPresent(Hooks.hook_index_subnet4_select_)) {
        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(Hooks.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)
        if (callout_handle->getSkip()) {
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP);
            return (Subnet4Ptr());
        }

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

    return (subnet);
}

DHCPv4ExchangePtr exchange;

};

230 231 232
namespace isc {
namespace dhcp {

233 234
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

235
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
236
                     const bool direct_response_desired)
237 238 239
    : 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) {
240

241
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
242
    try {
243 244 245
        // 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.
246
        if (port) {
247 248 249 250 251 252 253 254
            // 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);
255
        }
256

257
        // Instantiate allocation engine
258 259
        alloc_engine_.reset(new AllocEngine(AllocEngine::ALLOC_ITERATIVE, 100,
                                            false /* false = IPv4 */));
260

261 262 263 264 265 266 267
        // 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

268
    } catch (const std::exception &e) {
269
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
270 271 272
        shutdown_ = true;
        return;
    }
273

Tomek Mrugalski's avatar
Tomek Mrugalski committed
274
    shutdown_ = false;
275 276 277
}

Dhcpv4Srv::~Dhcpv4Srv() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
278
    IfaceMgr::instance().closeSockets();
279 280
}

281 282
void
Dhcpv4Srv::shutdown() {
283
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
284 285 286
    shutdown_ = true;
}

287 288 289 290 291
isc::dhcp::Subnet4Ptr
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& question) {
    return (DHCPv4Exchange::selectSubnet(question));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
292 293
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
294 295 296
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
297 298
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
299 300 301
    IfaceMgr::instance().send(packet);
}

302 303
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
304
    while (!shutdown_) {
305 306 307
        // Reset pointer to the current exchange.
        exchange.reset();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
308
        // client's message and server's response
309
        Pkt4Ptr query;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
310
        Pkt4Ptr rsp;
311

312
        try {
313 314 315 316 317 318 319 320 321 322
            // The lease database backend may install some timers for which
            // the handlers need to be executed periodically. Retrieve the
            // maximum interval at which the handlers must be executed from
            // the lease manager.
            uint32_t timeout = LeaseMgrFactory::instance().getIOServiceExecInterval();
            // If the returned value is zero it means that there are no
            // timers installed, so use a default value.
            if (timeout == 0) {
                timeout = 1000;
            }
323
            query = receivePacket(timeout);
324 325 326 327 328 329 330

        } 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 or SIGHUP which are handled by the server. For signals
            // that are not handled by the server we rely on the default
            // behavior of the system, but there is nothing we should log here.
331
        } catch (const std::exception& e) {
332
            // Log all other errors.
333 334 335
            LOG_ERROR(dhcp4_logger, DHCP4_PACKET_RECEIVE_FAIL).arg(e.what());
        }

336 337 338
        // 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
339 340 341 342 343 344 345
        // 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.
346 347
        handleSignal();

348 349
        // Execute ready timers for the lease database, e.g. Lease File Cleanup.
        try {
350
            LeaseMgrFactory::instance().getIOService()->poll();
351 352 353 354 355 356

        } catch (const std::exception& ex) {
            LOG_WARN(dhcp4_logger, DHCP4_LEASE_DATABASE_TIMERS_EXEC_FAIL)
                .arg(ex.what());
        }

357
        // Timeout may be reached or signal received, which breaks select()
Francis Dupont's avatar
Francis Dupont committed
358
        // with no reception occurred
359 360 361 362
        if (!query) {
            continue;
        }

363 364 365 366 367 368 369 370 371
        // 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));

372 373 374
        bool skip_unpack = false;

        // The packet has just been received so contains the uninterpreted wire
375
        // data; execute callouts registered for buffer4_receive.
376
        if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
377 378 379 380 381 382 383 384 385
            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
386 387
            HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                       *callout_handle);
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403

            // 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->getSkip()) {
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_BUFFER_RCVD_SKIP);
                skip_unpack = true;
            }

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

        // Unpack the packet information unless the buffer4_receive callouts
        // indicated they did it
        if (!skip_unpack) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
404 405 406
            try {
                query->unpack();
            } catch (const std::exception& e) {
407 408 409
                // Failed to parse the packet.
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL,
                          DHCP4_PACKET_PARSE_FAIL).arg(e.what());
410 411
                continue;
            }
412
        }
413

Tomek Mrugalski's avatar
Tomek Mrugalski committed
414 415 416
        // 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.
417 418
        classifyPacket(query);

419 420 421
        // 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)) {
422
            continue;
423
        }
424

425
        // We have sanity checked (in accept() that the Message Type option
426 427
        // exists, so we can safely get it here.
        int type = query->getType();
428
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_RECEIVED)
429
            .arg(serverReceivedPacketName(type))
430
            .arg(type)
431 432
            .arg(query->getIface());
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
433
            .arg(type)
434 435
            .arg(query->toText());

Tomek Mrugalski's avatar
Tomek Mrugalski committed
436
        // Let's execute all callouts registered for pkt4_receive
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
        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.
            if (callout_handle->getSkip()) {
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_RCVD_SKIP);
                continue;
            }
457

458 459
            callout_handle->getArgument("query4", query);
        }
460

461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
        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:
483
                rsp = processInform(query);
484 485 486 487 488 489 490
                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.
                ;
491
            }
492 493
        } catch (const isc::Exception& e) {

494 495 496 497 498 499
            // Catch-all exception (at least for ones based on the isc Exception
            // class, which covers more or less all that are explicitly raised
            // in the Kea code).  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.)
500 501 502 503 504
            if (dhcp4_logger.isDebugEnabled(DBG_DHCP4_BASIC)) {
                std::string source = "unknown";
                HWAddrPtr hwptr = query->getHWAddr();
                if (hwptr) {
                    source = hwptr->toText();
505
                }
506 507 508
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC,
                          DHCP4_PACKET_PROCESS_FAIL)
                    .arg(source).arg(e.what());
509
            }
510
        }
511

512 513 514
        if (!rsp) {
            continue;
        }
515

Tomek Mrugalski's avatar
Tomek Mrugalski committed
516 517 518 519 520
        // Let's do class specific processing. This is done before
        // pkt4_send.
        //
        /// @todo: decide whether we want to add a new hook point for
        /// doing class specific processing.
521 522 523 524 525 526 527
        if (!classSpecificProcessing(query, rsp)) {
            /// @todo add more verbosity here
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_CLASS_PROCESSING_FAILED);

            continue;
        }

528 529
        // Specifies if server should do the packing
        bool skip_pack = false;
530

Tomek Mrugalski's avatar
Tomek Mrugalski committed
531
        // Execute all callouts registered for pkt4_send
532 533
        if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
            CalloutHandlePtr callout_handle = getCalloutHandle(query);
534

535 536
            // Delete all previous arguments
            callout_handle->deleteAllArguments();
537

538 539
            // Clear skip flag if it was set in previous callouts
            callout_handle->setSkip(false);
540

541 542
            // Set our response
            callout_handle->setArgument("response4", rsp);
543

544 545 546
            // Call all installed callouts
            HooksManager::callCallouts(hook_index_pkt4_send_,
                                       *callout_handle);
547

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
            // 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->getSkip()) {
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS, DHCP4_HOOK_PACKET_SEND_SKIP);
                skip_pack = true;
            }
        }

        if (!skip_pack) {
            try {
                rsp->pack();
            } catch (const std::exception& e) {
                LOG_ERROR(dhcp4_logger, DHCP4_PACKET_SEND_FAIL)
                    .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
570
            // Let's execute all callouts registered for buffer4_send
571
            if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_send_)) {
572
                CalloutHandlePtr callout_handle = getCalloutHandle(query);
573

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

577 578
                // Pass incoming packet as argument
                callout_handle->setArgument("response4", rsp);
579

580
                // Call callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
581 582
                HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
                                           *callout_handle);
583

584 585 586 587
                // Callouts decided to skip the next processing step. The next
                // processing step would to parse the packet, so skip at this
                // stage means drop.
                if (callout_handle->getSkip()) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
588 589
                    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS,
                              DHCP4_HOOK_BUFFER_SEND_SKIP);
590
                    continue;
591
                }
592 593

                callout_handle->getArgument("response4", rsp);
594
            }
595 596 597 598 599 600 601 602 603

            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA,
                      DHCP4_RESPONSE_DATA)
                .arg(static_cast<int>(rsp->getType())).arg(rsp->toText());

            sendPacket(rsp);
        } catch (const std::exception& e) {
            LOG_ERROR(dhcp4_logger, DHCP4_PACKET_SEND_FAIL)
                .arg(e.what());
604
        }
605 606 607 608 609
    }

    return (true);
}

610
string
611
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
    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());
628 629
}

630
isc::dhcp_ddns::D2Dhcid
631 632 633 634 635 636 637 638 639
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");

640 641
    }

642 643 644 645 646 647 648 649 650
    // 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);
651

652 653 654
    } catch (const Exception& ex) {
        isc_throw(DhcidComputeError, "unable to compute DHCID because the"
                  " hostname: " << lease->hostname_ << " is invalid");
655 656

    }
657 658 659

    // Prefer client id to HW address to compute DHCID. If Client Id is
    // NULL, use HW address.
660
    try {
661 662 663 664
        if (lease->client_id_) {
            return (D2Dhcid(lease->client_id_->getClientId(), fqdn_wire));

        } else {
665
            return (D2Dhcid(lease->hwaddr_, fqdn_wire));
666
        }
667
    } catch (const Exception& ex) {
668 669
        isc_throw(DhcidComputeError, "unable to compute DHCID: "
                  << ex.what());
670

671
    }
672 673 674

}

675 676
void
Dhcpv4Srv::copyDefaultFields(const Pkt4Ptr& question, Pkt4Ptr& answer) {
677 678
    answer->setIface(question->getIface());
    answer->setIndex(question->getIndex());
679

680
    answer->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS()); // explicitly set this to 0
681 682
    // ciaddr is always 0, except for the Renew/Rebind state when it may
    // be set to the ciaddr sent by the client.
683
    answer->setCiaddr(IOAddress::IPV4_ZERO_ADDRESS());
684
    answer->setHops(question->getHops());
685 686

    // copy MAC address
687
    answer->setHWAddr(question->getHWAddr());
688 689

    // relay address
690 691
    answer->setGiaddr(question->getGiaddr());

692
    // Let's copy client-id to response. See RFC6842.
693 694
    // It is possible to disable RFC6842 to keep backward compatibility
    bool echo = CfgMgr::instance().echoClientId();
695
    OptionPtr client_id = question->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
696
    if (client_id && echo) {
697 698
        answer->addOption(client_id);
    }
699 700

    // If src/dest HW addresses are used by the packet filtering class
701 702 703 704 705 706
    // 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.
707 708
    HWAddrPtr src_hw_addr = question->getLocalHWAddr();
    if (src_hw_addr) {
709
        answer->setLocalHWAddr(src_hw_addr);
710
    }
711
    HWAddrPtr dst_hw_addr = question->getRemoteHWAddr();
712
    if (dst_hw_addr) {
713
        answer->setRemoteHWAddr(dst_hw_addr);
714
    }
715 716 717 718 719 720

    // If this packet is relayed, we want to copy Relay Agent Info option
    OptionPtr rai = question->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
        answer->addOption(rai);
    }
721 722
}

723 724
void
Dhcpv4Srv::appendDefaultOptions(Pkt4Ptr& msg, uint8_t msg_type) {
725
    OptionPtr opt;
726 727

    // add Message Type Option (type 53)
728
    msg->setType(msg_type);
729 730 731 732

    // more options will be added here later
}

733 734 735 736 737
void
Dhcpv4Srv::appendServerID(const Pkt4Ptr& response) {
    // 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.
738 739
    /// @todo: perhaps we should consider some more sophisticated server id
    /// generation, but for the current use cases, it should be ok.
740 741 742 743 744
    response->addOption(OptionPtr(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                                     response->getLocalAddr()))
                        );
}

745 746
void
Dhcpv4Srv::appendRequestedOptions(const Pkt4Ptr& question, Pkt4Ptr& msg) {
747 748 749

    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
750
    Subnet4Ptr subnet = DHCPv4Exchange::selectSubnet(question);
751 752 753 754 755 756 757
    // 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;
    }
758

759 760 761 762 763 764 765 766 767
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
        OptionUint8Array>(question->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
768

769 770 771 772 773 774
    // 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) {
775
        if (!msg->getOption(*opt)) {
776
            OptionDescriptor desc = subnet->getCfgOption()->get("dhcp4", *opt);
777 778
            if (desc.option_ && !msg->getOption(*opt)) {
                msg->addOption(desc.option_);
779
            }
780 781
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
782
}
783

784 785 786
void
Dhcpv4Srv::appendRequestedVendorOptions(const Pkt4Ptr& question, Pkt4Ptr& answer) {
    // Get the configured subnet suitable for the incoming packet.
787
    Subnet4Ptr subnet = DHCPv4Exchange::selectSubnet(question);
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
    // 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
    boost::shared_ptr<OptionVendor> vendor_req =
        boost::dynamic_pointer_cast<OptionVendor>(question->getOption(DHO_VIVSO_SUBOPTIONS));
    if (!vendor_req) {
        return;
    }

    uint32_t vendor_id = vendor_req->getVendorId();

    // Let's try to get ORO within that vendor-option
807 808
    /// @todo This is very specific to vendor-id=4491 (Cable Labs). Other
    /// vendors may have different policies.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
809 810
    OptionUint8ArrayPtr oro =
        boost::dynamic_pointer_cast<OptionUint8Array>(vendor_req->getOption(DOCSIS3_V4_ORO));
811 812 813 814 815 816 817 818 819 820

    // 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;
821
    const std::vector<uint8_t>& requested_opts = oro->getValues();
822

Tomek Mrugalski's avatar
Tomek Mrugalski committed
823
    for (std::vector<uint8_t>::const_iterator code = requested_opts.begin();
824
         code != requested_opts.end(); ++code) {
825
        if  (!vendor_rsp->getOption(*code)) {
826 827
            OptionDescriptor desc = subnet->getCfgOption()->get(vendor_id,
                                                                *code);
828 829
            if (desc.option_) {
                vendor_rsp->addOption(desc.option_);
830 831
                added = true;
            }
832 833
        }

834 835
        if (added) {
            answer->addOption(vendor_rsp);
836 837
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
838
}
839

840

841 842 843 844 845 846 847 848
void
Dhcpv4Srv::appendBasicOptions(const Pkt4Ptr& question, Pkt4Ptr& msg) {
    // Identify options that we always want to send to the
    // client (if they are configured).
    static const uint16_t required_options[] = {
        DHO_ROUTERS,
        DHO_DOMAIN_NAME_SERVERS,
        DHO_DOMAIN_NAME };
849

850 851 852 853
    static size_t required_options_size =
        sizeof(required_options) / sizeof(required_options[0]);

    // Get the subnet.
854
    Subnet4Ptr subnet = DHCPv4Exchange::selectSubnet(question);
855 856 857 858 859 860 861 862 863 864
    if (!subnet) {
        return;
    }

    // Try to find all 'required' options in the outgoing
    // message. Those that are not present will be added.
    for (int i = 0; i < required_options_size; ++i) {
        OptionPtr opt = msg->getOption(required_options[i]);
        if (!opt) {
            // Check whether option has been configured.
865 866
            OptionDescriptor desc = subnet->getCfgOption()->
                get("dhcp4", required_options[i]);
867 868
            if (desc.option_) {
                msg->addOption(desc.option_);
869 870 871
            }
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
872
}
873

874 875 876 877 878
void
Dhcpv4Srv::processClientName(const Pkt4Ptr& query, Pkt4Ptr& answer) {
    // It is possible that client has sent both Client FQDN and Hostname
    // option. In such case, server should prefer Client FQDN option and
    // ignore the Hostname option.
879 880 881 882 883 884 885
    try {
        Option4ClientFqdnPtr fqdn = boost::dynamic_pointer_cast<Option4ClientFqdn>
            (query->getOption(DHO_FQDN));
        if (fqdn) {
            processClientFqdnOption(fqdn, answer);

        } else {
886
            OptionStringPtr hostname = boost::dynamic_pointer_cast<OptionString>
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
                (query->getOption(DHO_HOST_NAME));
            if (hostname) {
                processHostnameOption(hostname, answer);
            }
        }
    } catch (const Exception& ex) {
        // In some rare cases it is possible that the client's name processing
        // fails. For example, the Hostname option may be malformed, or there
        // may be an error in the server's logic which would cause multiple
        // attempts to add the same option to the response message. This
        // error message aggregates all these errors so they can be diagnosed
        // from the log. We don't want to throw an exception here because,
        // it will impact the processing of the whole packet. We rather want
        // the processing to continue, even if the client's name is wrong.
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_CLIENT_NAME_PROC_FAIL)
            .arg(ex.what());
903 904 905 906
    }
}

void
907 908 909 910 911 912
Dhcpv4Srv::processClientFqdnOption(const Option4ClientFqdnPtr& fqdn,
                                   Pkt4Ptr& answer) {
    // Create the DHCPv4 Client FQDN Option to be included in the server's
    // response to a client.
    Option4ClientFqdnPtr fqdn_resp(new Option4ClientFqdn(*fqdn));

913 914 915 916
    // Set the server S, N, and O flags based on client's flags and
    // current configuration.
    D2ClientMgr& d2_mgr = CfgMgr::instance().getD2ClientMgr();
    d2_mgr.adjustFqdnFlags<Option4ClientFqdn>(*fqdn, *fqdn_resp);
917

918 919 920
    // Carry over the client's E flag.
    fqdn_resp->setFlag(Option4ClientFqdn::FLAG_E,
                       fqdn->getFlag(Option4ClientFqdn::FLAG_E));
921

922 923 924 925
    if (exchange && exchange->getContext().host_ &&
        !exchange->getContext().host_->getHostname().empty()) {
        fqdn_resp->setDomainName(exchange->getContext().host_->getHostname(),
                                 Option4ClientFqdn::FULL);
926

927 928 929 930 931
    } else {
        // Adjust the domain name based on domain name value and type sent by the
        // client and current configuration.
        d2_mgr.adjustDomainName<Option4ClientFqdn>(*fqdn, *fqdn_resp);
    }
932 933 934 935 936 937 938 939 940 941

    // Add FQDN option to the response message. Note that, there may be some
    // cases when server may choose not to include the FQDN option in a
    // response to a client. In such cases, the FQDN should be removed from the
    // outgoing message. In theory we could cease to include the FQDN option
    // in this function until it is confirmed that it should be included.
    // However, we include it here for simplicity. Functions used to acquire
    // lease for a client will scan the response message for FQDN and if it
    // is found they will take necessary actions to store the FQDN information
    // in the lease database as well as to generate NameChangeRequests to DNS.
Francis Dupont's avatar
Francis Dupont committed
942
    // If we don't store the option in the response message, we will have to
943 944
    // propagate it in the different way to the functions which acquire the
    // lease. This would require modifications to the API of this class.
945
    answer->addOption(fqdn_resp);
946 947 948
}

void
949
Dhcpv4Srv::processHostnameOption(const OptionStringPtr& opt_hostname,
950
                                 Pkt4Ptr& answer) {
951 952 953
    // Fetch D2 configuration.
    D2ClientMgr& d2_mgr = CfgMgr::instance().getD2ClientMgr();

954
    // Do nothing if the DNS updates are disabled.
955
    if (!d2_mgr.ddnsEnabled()) {
956 957 958
        return;
    }

959
    std::string hostname = isc::util::str::trim(opt_hostname->getValue());
960
    unsigned int label_count = OptionDataTypeUtil::getLabelCount(hostname);
961
    // The hostname option sent by the client should be at least 1 octet long.
962 963 964
    // If it isn't we ignore this option. (Per RFC 2131, section 3.14)
    /// @todo It would be more liberal to accept this and let it fall into
    /// the case  of replace or less than two below.
965 966 967 968
    if (label_count == 0) {
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_EMPTY_HOSTNAME);
        return;
    }
969 970 971 972
    // Copy construct the hostname provided by the client. It is entirely
    // possible that we will use the hostname option provided by the client
    // to perform the DNS update and we will send the same option to him to
    // indicate that we accepted this hostname.
973
    OptionStringPtr opt_hostname_resp(new OptionString(*opt_hostname));
974 975 976 977 978 979 980 981

    // The hostname option may be unqualified or fully qualified. The lab_count
    // holds the number of labels for the name. The number of 1 means that
    // there is only root label "." (even for unqualified names, as the
    // getLabelCount function treats each name as a fully qualified one).
    // By checking the number of labels present in the hostname we may infer
    // whether client has sent the fully qualified or unqualified hostname.

982 983 984 985 986 987 988
    // If there is a hostname reservation for this client, use it.
    if (exchange && exchange->getContext().host_ &&
        !exchange->getContext().host_->getHostname().empty()) {
        opt_hostname_resp->setValue(exchange->getContext().host_->getHostname());

    } else if ((d2_mgr.getD2ClientConfig()->getReplaceClientName()) ||
               (label_count < 2)) {
989 990
        // Set to root domain to signal later on that we should replace it.
        // DHO_HOST_NAME is a string option which cannot be empty.
991 992 993 994 995 996
        /// @todo We may want to reconsider whether it is appropriate for the
        /// client to send a root domain name as a Hostname. There are
        /// also extensions to the auto generation of the client's name,
        /// e.g. conversion to the puny code which may be considered at some point.
        /// For now, we just remain liberal and expect that the DNS will handle
        /// conversion if needed and possible.
997
        opt_hostname_resp->setValue(".");
998

999
    } else if (label_count == 2) {
1000
        // If there are two labels, it means that the client has specified
Francis Dupont's avatar
Francis Dupont committed
1001
        // the unqualified name. We have to concatenate the unqualified name
1002 1003 1004 1005 1006 1007
        // with the domain name. The false value passed as a second argument
        // indicates that the trailing dot should not be appended to the
        // hostname. We don't want to append the trailing dot because
        // we don't know whether the hostname is partial or not and some
        // clients do not handle the hostnames with the trailing dot.
        opt_hostname_resp->setValue(d2_mgr.qualifyName(hostname, false));
1008 1009 1010
    }

    answer->addOption(opt_hostname_resp);
1011 1012
}

1013 1014
void
Dhcpv4Srv::createNameChangeRequests(const Lease4Ptr& lease,
1015
                                    const Lease4Ptr& old_lease) {
1016 1017 1018 1019 1020
    if (!lease) {
        isc_throw(isc::Unexpected,
                  "NULL lease specified when creating NameChangeRequest");
    }

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
    // If old lease is not NULL, it is an indication that the lease has
    // just been renewed. In such case we may need to generate the
    // additional NameChangeRequest to remove an existing entry before
    // we create a NameChangeRequest to add the entry for an updated lease.
    // We may also decide not to generate any requests at all. This is when
    // we discover that nothing has changed in the client's FQDN data.
    if (old_lease) {
        if (!lease->matches(*old_lease)) {
            isc_throw(isc::Unexpected,
                      "there is no match between the current instance of the"
                      " lease: " << lease->toText() << ", and the previous"
                      " instance: " << lease->toText());
        } else {
            // There will be a NameChangeRequest generated to remove existing
            // DNS entries if the following conditions are met:
            // - The hostname is set for the existing lease, we can't generate
            //   removal request for non-existent hostname.
            // - A server has performed reverse, forward or both updates.
            // - FQDN data between the new and old lease do not match.
1040
            if (!lease->hasIdenticalFqdn(*old_lease)) {
1041 1042
                queueNameChangeRequest(isc::dhcp_ddns::CHG_REMOVE,
                                       old_lease);
1043 1044

            // If FQDN data from both leases match, there is no need to update.
1045
            } else if (lease->hasIdenticalFqdn(*old_lease)) {
1046
                return;
1047

1048 1049 1050 1051 1052
            }

        }
    }

1053 1054 1055 1056
    // We may need to generate the NameChangeRequest for the new lease. It
    // will be generated only if hostname is set and if forward or reverse
    // update has been requested.
    queueNameChangeRequest(isc::dhcp_ddns::CHG_ADD, lease);
1057 1058
}