dhcp4_srv.cc 85.2 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
namespace isc {
namespace dhcp {
86

87
Dhcpv4Exchange::Dhcpv4Exchange(const AllocEnginePtr& alloc_engine,
88 89
                               const Pkt4Ptr& query,
                               const Subnet4Ptr& subnet)
90 91
    : alloc_engine_(alloc_engine), query_(query), resp_(),
      context_(new AllocEngine::ClientContext4()) {
92 93 94 95 96 97 98

    if (!alloc_engine_ || !query_) {
        isc_throw(BadValue, "alloc_engine and query values must not"
                  " be NULL when creating an instance of the"
                  " Dhcpv4Exchange");
    }

99 100 101
    // Create response message.
    initResponse();
    // Select subnet for the query message.
102
    context_->subnet_ = subnet;
103
    // Hardware address.
104
    context_->hwaddr_ = query->getHWAddr();
105 106 107
    // Client Identifier
    OptionPtr opt_clientid = query->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (opt_clientid) {
108
        context_->clientid_.reset(new ClientId(opt_clientid->getData()));
109 110
    }
    // Check for static reservations.
111
    alloc_engine->findReservation(*context_);
112 113
};

114
void
115
Dhcpv4Exchange::initResponse() {
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
    uint8_t resp_type = 0;
    switch (getQuery()->getType()) {
    case DHCPDISCOVER:
        resp_type = DHCPOFFER;
        break;
    case DHCPREQUEST:
    case DHCPINFORM:
        resp_type = DHCPACK;
        break;
    default:
        ;
    }
    if (resp_type > 0) {
        resp_.reset(new Pkt4(resp_type, getQuery()->getTransid()));
    }
}

133 134
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

135
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
136
                     const bool direct_response_desired)
137 138 139
    : 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) {
140

141
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
142
    try {
143 144 145
        // 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.
146
        if (port) {
147 148 149 150 151 152 153 154
            // 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);
155
        }
156

157
        // Instantiate allocation engine
158 159
        alloc_engine_.reset(new AllocEngine(AllocEngine::ALLOC_ITERATIVE, 100,
                                            false /* false = IPv4 */));
160

161 162 163 164 165 166 167
        // 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

168
    } catch (const std::exception &e) {
169
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
170 171 172
        shutdown_ = true;
        return;
    }
173

Tomek Mrugalski's avatar
Tomek Mrugalski committed
174
    shutdown_ = false;
175 176 177
}

Dhcpv4Srv::~Dhcpv4Srv() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
178
    IfaceMgr::instance().closeSockets();
179 180
}

181 182
void
Dhcpv4Srv::shutdown() {
183
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
184 185 186
    shutdown_ = true;
}

187
isc::dhcp::Subnet4Ptr
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 230 231 232 233 234
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query, const bool run_hooks) const {

    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 (run_hooks && HooksManager::calloutsPresent(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(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);
235 236
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
237 238
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
239 240 241
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
242 243
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
244 245 246
    IfaceMgr::instance().send(packet);
}

247 248
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
249
    while (!shutdown_) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
250
        // client's message and server's response
251
        Pkt4Ptr query;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
252
        Pkt4Ptr rsp;
253

254
        try {
255 256 257 258 259 260 261 262 263 264
            // 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;
            }
265
            query = receivePacket(timeout);
266 267 268 269 270 271 272

        } 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.
273
        } catch (const std::exception& e) {
274
            // Log all other errors.
275 276 277
            LOG_ERROR(dhcp4_logger, DHCP4_PACKET_RECEIVE_FAIL).arg(e.what());
        }

278 279 280
        // 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
281 282 283 284 285 286 287
        // 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.
288 289
        handleSignal();

290 291
        // Execute ready timers for the lease database, e.g. Lease File Cleanup.
        try {
292
            LeaseMgrFactory::instance().getIOService()->poll();
293 294 295 296 297 298

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

299
        // Timeout may be reached or signal received, which breaks select()
Francis Dupont's avatar
Francis Dupont committed
300
        // with no reception occurred
301 302 303 304
        if (!query) {
            continue;
        }

305 306 307 308 309 310 311 312 313
        // 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));

314 315 316
        bool skip_unpack = false;

        // The packet has just been received so contains the uninterpreted wire
317
        // data; execute callouts registered for buffer4_receive.
318
        if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
319 320 321 322 323 324 325 326 327
            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
328 329
            HooksManager::callCallouts(Hooks.hook_index_buffer4_receive_,
                                       *callout_handle);
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345

            // 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
346 347 348
            try {
                query->unpack();
            } catch (const std::exception& e) {
349 350 351
                // Failed to parse the packet.
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL,
                          DHCP4_PACKET_PARSE_FAIL).arg(e.what());
352 353
                continue;
            }
354
        }
355

Tomek Mrugalski's avatar
Tomek Mrugalski committed
356 357 358
        // 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.
359 360
        classifyPacket(query);

361 362 363
        // 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)) {
364
            continue;
365
        }
366

367
        // We have sanity checked (in accept() that the Message Type option
368 369
        // exists, so we can safely get it here.
        int type = query->getType();
370
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_RECEIVED)
371
            .arg(serverReceivedPacketName(type))
372
            .arg(type)
373 374
            .arg(query->getIface());
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
375
            .arg(type)
376 377
            .arg(query->toText());

Tomek Mrugalski's avatar
Tomek Mrugalski committed
378
        // Let's execute all callouts registered for pkt4_receive
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
        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;
            }
399

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

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
        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:
425
                rsp = processInform(query);
426 427 428 429 430 431 432
                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.
                ;
433
            }
434 435
        } catch (const isc::Exception& e) {

436 437 438 439 440 441
            // 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.)
442 443 444 445 446
            if (dhcp4_logger.isDebugEnabled(DBG_DHCP4_BASIC)) {
                std::string source = "unknown";
                HWAddrPtr hwptr = query->getHWAddr();
                if (hwptr) {
                    source = hwptr->toText();
447
                }
448 449 450
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC,
                          DHCP4_PACKET_PROCESS_FAIL)
                    .arg(source).arg(e.what());
451
            }
452
        }
453

454 455 456
        if (!rsp) {
            continue;
        }
457

458

459 460
        // Specifies if server should do the packing
        bool skip_pack = false;
461

Tomek Mrugalski's avatar
Tomek Mrugalski committed
462
        // Execute all callouts registered for pkt4_send
463 464
        if (HooksManager::calloutsPresent(hook_index_pkt4_send_)) {
            CalloutHandlePtr callout_handle = getCalloutHandle(query);
465

466 467
            // Delete all previous arguments
            callout_handle->deleteAllArguments();
468

469 470
            // Clear skip flag if it was set in previous callouts
            callout_handle->setSkip(false);
471

472 473
            // Set our response
            callout_handle->setArgument("response4", rsp);
474

475 476 477
            // Call all installed callouts
            HooksManager::callCallouts(hook_index_pkt4_send_,
                                       *callout_handle);
478

479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
            // 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
501
            // Let's execute all callouts registered for buffer4_send
502
            if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_send_)) {
503
                CalloutHandlePtr callout_handle = getCalloutHandle(query);
504

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

508 509
                // Pass incoming packet as argument
                callout_handle->setArgument("response4", rsp);
510

511
                // Call callouts
Tomek Mrugalski's avatar
Tomek Mrugalski committed
512 513
                HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
                                           *callout_handle);
514

515 516 517 518
                // 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
519 520
                    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_HOOKS,
                              DHCP4_HOOK_BUFFER_SEND_SKIP);
521
                    continue;
522
                }
523 524

                callout_handle->getArgument("response4", rsp);
525
            }
526 527 528 529 530 531 532 533 534

            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());
535
        }
536 537 538 539 540
    }

    return (true);
}

541
string
542
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
    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());
559 560
}

561
isc::dhcp_ddns::D2Dhcid
562 563 564 565 566 567 568 569 570
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");

571 572
    }

573 574 575 576 577 578 579 580 581
    // 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);
582

583 584 585
    } catch (const Exception& ex) {
        isc_throw(DhcidComputeError, "unable to compute DHCID because the"
                  " hostname: " << lease->hostname_ << " is invalid");
586 587

    }
588 589 590

    // Prefer client id to HW address to compute DHCID. If Client Id is
    // NULL, use HW address.
591
    try {
592 593 594 595
        if (lease->client_id_) {
            return (D2Dhcid(lease->client_id_->getClientId(), fqdn_wire));

        } else {
596
            return (D2Dhcid(lease->hwaddr_, fqdn_wire));
597
        }
598
    } catch (const Exception& ex) {
599 600
        isc_throw(DhcidComputeError, "unable to compute DHCID: "
                  << ex.what());
601

602
    }
603 604 605

}

606
void
607
Dhcpv4Srv::copyDefaultFields(Dhcpv4Exchange& ex) {
608 609
    ex.getResponse()->setIface(ex.getQuery()->getIface());
    ex.getResponse()->setIndex(ex.getQuery()->getIndex());
610

611
    ex.getResponse()->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS()); // explicitly set this to 0
612 613
    // ciaddr is always 0, except for the Renew/Rebind state when it may
    // be set to the ciaddr sent by the client.
614 615
    ex.getResponse()->setCiaddr(IOAddress::IPV4_ZERO_ADDRESS());
    ex.getResponse()->setHops(ex.getQuery()->getHops());
616 617

    // copy MAC address
618
    ex.getResponse()->setHWAddr(ex.getQuery()->getHWAddr());
619 620

    // relay address
621
    ex.getResponse()->setGiaddr(ex.getQuery()->getGiaddr());
622

623
    // Let's copy client-id to response. See RFC6842.
624 625
    // It is possible to disable RFC6842 to keep backward compatibility
    bool echo = CfgMgr::instance().echoClientId();
626
    OptionPtr client_id = ex.getQuery()->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
627
    if (client_id && echo) {
628
        ex.getResponse()->addOption(client_id);
629
    }
630 631

    // If src/dest HW addresses are used by the packet filtering class
632 633 634 635 636 637
    // 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.
638
    HWAddrPtr src_hw_addr = ex.getQuery()->getLocalHWAddr();
639
    if (src_hw_addr) {
640
        ex.getResponse()->setLocalHWAddr(src_hw_addr);
641
    }
642
    HWAddrPtr dst_hw_addr = ex.getQuery()->getRemoteHWAddr();
643
    if (dst_hw_addr) {
644
        ex.getResponse()->setRemoteHWAddr(dst_hw_addr);
645
    }
646 647

    // If this packet is relayed, we want to copy Relay Agent Info option
648
    OptionPtr rai = ex.getQuery()->getOption(DHO_DHCP_AGENT_OPTIONS);
649
    if (rai) {
650
        ex.getResponse()->addOption(rai);
651
    }
652 653
}

654
void
655
Dhcpv4Srv::appendDefaultOptions(Dhcpv4Exchange& ex) {
656
    // no-op at this time
657 658
}

659
void
660
Dhcpv4Srv::appendServerID(Dhcpv4Exchange& ex) {
661 662 663
    // 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.
664 665
    /// @todo: perhaps we should consider some more sophisticated server id
    /// generation, but for the current use cases, it should be ok.
666 667
    ex.getResponse()->addOption(OptionPtr(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                                             ex.getResponse()->getLocalAddr())));
668 669
}

670
void
671
Dhcpv4Srv::appendRequestedOptions(Dhcpv4Exchange& ex) {
672 673
    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
674
    Subnet4Ptr subnet = ex.getContext()->subnet_;
675 676 677 678 679 680 681
    // 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;
    }
682

683 684 685
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
686
        OptionUint8Array>(ex.getQuery()->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
687 688 689 690 691
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
692

693 694 695 696 697 698
    // 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) {
699
        if (!ex.getResponse()->getOption(*opt)) {
700
            OptionDescriptor desc = subnet->getCfgOption()->get("dhcp4", *opt);
701 702
            if (desc.option_) {
                ex.getResponse()->addOption(desc.option_);
703
            }
704 705
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
706
}
707

708
void
709
Dhcpv4Srv::appendRequestedVendorOptions(Dhcpv4Exchange& ex) {
710
    // Get the configured subnet suitable for the incoming packet.
711
    Subnet4Ptr subnet = ex.getContext()->subnet_;
712 713 714 715 716 717 718 719 720 721
    // 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
722 723
    boost::shared_ptr<OptionVendor> vendor_req = boost::dynamic_pointer_cast<
        OptionVendor>(ex.getQuery()->getOption(DHO_VIVSO_SUBOPTIONS));
724 725 726 727 728 729 730
    if (!vendor_req) {
        return;
    }

    uint32_t vendor_id = vendor_req->getVendorId();

    // Let's try to get ORO within that vendor-option
731 732
    /// @todo This is very specific to vendor-id=4491 (Cable Labs). Other
    /// vendors may have different policies.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
733 734
    OptionUint8ArrayPtr oro =
        boost::dynamic_pointer_cast<OptionUint8Array>(vendor_req->getOption(DOCSIS3_V4_ORO));
735 736 737 738 739 740 741 742 743 744

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

Tomek Mrugalski's avatar
Tomek Mrugalski committed
747
    for (std::vector<uint8_t>::const_iterator code = requested_opts.begin();
748
         code != requested_opts.end(); ++code) {
749
        if  (!vendor_rsp->getOption(*code)) {
750 751
            OptionDescriptor desc = subnet->getCfgOption()->get(vendor_id,
                                                                *code);
752 753
            if (desc.option_) {
                vendor_rsp->addOption(desc.option_);
754 755
                added = true;
            }
756 757
        }

758
        if (added) {
759
            ex.getResponse()->addOption(vendor_rsp);
760 761
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
762
}
763

764

765
void
766
Dhcpv4Srv::appendBasicOptions(Dhcpv4Exchange& ex) {
767 768 769 770 771 772
    // 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 };
773

774 775 776 777
    static size_t required_options_size =
        sizeof(required_options) / sizeof(required_options[0]);

    // Get the subnet.
778
    Subnet4Ptr subnet = ex.getContext()->subnet_;
779 780 781 782 783 784 785
    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) {
786
        OptionPtr opt = ex.getResponse()->getOption(required_options[i]);
787 788
        if (!opt) {
            // Check whether option has been configured.
789 790
            OptionDescriptor desc = subnet->getCfgOption()->
                get("dhcp4", required_options[i]);
791
            if (desc.option_) {
792
                ex.getResponse()->addOption(desc.option_);
793 794 795
            }
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
796
}
797

798
void
799
Dhcpv4Srv::processClientName(Dhcpv4Exchange& ex) {
800 801 802
    // 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.
803
    try {
804
        Pkt4Ptr resp = ex.getResponse();
805
        Option4ClientFqdnPtr fqdn = boost::dynamic_pointer_cast<Option4ClientFqdn>
806
            (ex.getQuery()->getOption(DHO_FQDN));
807
        if (fqdn) {
808
            processClientFqdnOption(ex);
809 810

        } else {
811
            OptionStringPtr hostname = boost::dynamic_pointer_cast<OptionString>
812
                (ex.getQuery()->getOption(DHO_HOST_NAME));
813
            if (hostname) {
814
                processHostnameOption(ex);
815 816 817 818 819 820 821 822 823 824 825 826 827
            }
        }
    } 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());
828 829 830 831
    }
}

void
832
Dhcpv4Srv::processClientFqdnOption(Dhcpv4Exchange& ex) {
833 834 835 836
    // Obtain the FQDN option from the client's message.
    Option4ClientFqdnPtr fqdn = boost::dynamic_pointer_cast<
        Option4ClientFqdn>(ex.getQuery()->getOption(DHO_FQDN));

837 838 839 840
    // Create the DHCPv4 Client FQDN Option to be included in the server's
    // response to a client.
    Option4ClientFqdnPtr fqdn_resp(new Option4ClientFqdn(*fqdn));

841 842 843 844
    // 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);
845

846 847 848
    // Carry over the client's E flag.
    fqdn_resp->setFlag(Option4ClientFqdn::FLAG_E,
                       fqdn->getFlag(Option4ClientFqdn::FLAG_E));
849

850
    if (ex.getContext()->host_ && !ex.getContext()->host_->getHostname().empty()) {
851 852 853
        D2ClientMgr& d2_mgr = CfgMgr::instance().getD2ClientMgr();
        fqdn_resp->setDomainName(d2_mgr.qualifyName(ex.getContext()->host_->getHostname(),
                                                    true), Option4ClientFqdn::FULL);
854

855 856 857 858 859
    } 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);
    }
860 861 862 863 864 865 866 867 868 869

    // 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
870
    // If we don't store the option in the response message, we will have to
871 872
    // propagate it in the different way to the functions which acquire the
    // lease. This would require modifications to the API of this class.
873
    ex.getResponse()->addOption(fqdn_resp);
874 875 876
}

void
877
Dhcpv4Srv::processHostnameOption(Dhcpv4Exchange& ex) {
878 879 880 881
    // Obtain the Hostname option from the client's message.
    OptionStringPtr opt_hostname = boost::dynamic_pointer_cast<OptionString>
        (ex.getQuery()->getOption(DHO_HOST_NAME));

882 883 884
    // Fetch D2 configuration.
    D2ClientMgr& d2_mgr = CfgMgr::instance().getD2ClientMgr();

885
    // Do nothing if the DNS updates are disabled.
886
    if (!d2_mgr.ddnsEnabled()) {
887 888 889
        return;
    }

890
    std::string hostname = isc::util::str::trim(opt_hostname->getValue());
891
    unsigned int label_count = OptionDataTypeUtil::getLabelCount(hostname);
892
    // The hostname option sent by the client should be at least 1 octet long.
893 894 895
    // 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.
896 897 898 899
    if (label_count == 0) {
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_EMPTY_HOSTNAME);
        return;
    }
900 901 902 903
    // 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.
904
    OptionStringPtr opt_hostname_resp(new OptionString(*opt_hostname));
905 906 907 908 909 910 911 912

    // 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.

913
    // If there is a hostname reservation for this client, use it.
914
    if (ex.getContext()->host_ && !ex.getContext()->host_->getHostname().empty()) {
915 916
        opt_hostname_resp->setValue(d2_mgr.qualifyName(ex.getContext()->host_->getHostname(),
                                                       false));
917 918 919

    } else if ((d2_mgr.getD2ClientConfig()->getReplaceClientName()) ||
               (label_count < 2)) {
920 921
        // Set to root domain to signal later on that we should replace it.
        // DHO_HOST_NAME is a string option which cannot be empty.
922 923 924 925 926 927
        /// @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.