dhcp4_srv.cc 104 KB
Newer Older
1
// Copyright (C) 2011-2016 Internet Systems Consortium, Inc. ("ISC")
2
//
3
4
5
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6

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

46
47
48
49
50
51
52
53
#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>

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

#include <iomanip>

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

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

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

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

98
99
100
namespace isc {
namespace dhcp {

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

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

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

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

142
143
144
145
146
        // Find static reservations if not disabled for our subnet.
        if (subnet->getHostReservationMode() != Subnet::HR_DISABLED) {
            // Before we can check for static reservations, we need to prepare a set
            // of identifiers to be used for this.
            setHostIdentifiers();
147

148
149
            // Check for static reservations.
            alloc_engine->findReservation(*context_);
150
151
        }
    }
152
153
};

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

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

181
182
    // explicitly set this to 0
    resp_->setSiaddr(IOAddress::IPV4_ZERO_ADDRESS());
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
    // ciaddr is always 0, except for the Renew/Rebind state when it may
    // be set to the ciaddr sent by the client.
    resp_->setCiaddr(IOAddress::IPV4_ZERO_ADDRESS());
    resp_->setHops(query_->getHops());

    // copy MAC address
    resp_->setHWAddr(query_->getHWAddr());

    // relay address
    resp_->setGiaddr(query_->getGiaddr());

    // If src/dest HW addresses are used by the packet filtering class
    // we need to copy them as well. There is a need to check that the
    // address being set is not-NULL because an attempt to set the NULL
    // HW would result in exception. If these values are not set, the
    // the default HW addresses (zeroed) should be generated by the
    // packet filtering class when creating Ethernet header for
    // outgoing packet.
    HWAddrPtr src_hw_addr = query_->getLocalHWAddr();
    if (src_hw_addr) {
        resp_->setLocalHWAddr(src_hw_addr);
    }
    HWAddrPtr dst_hw_addr = query_->getRemoteHWAddr();
    if (dst_hw_addr) {
        resp_->setRemoteHWAddr(dst_hw_addr);
    }
209

210
    // Copy flags from the request to the response per RFC 2131
211
    resp_->setFlags(query_->getFlags());
212
}
213

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

    // 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);
228
    }
229
230
231
232
233
234
235
236
237
238
239
240
241

    // RFC 3011 states about the Subnet Selection Option

    // "Servers configured to support this option MUST return an
    //  identical copy of the option to any client that sends it,
    //  regardless of whether or not the client requests the option in
    //  a parameter request list. Clients using this option MUST
    //  discard DHCPOFFER or DHCPACK packets that do not contain this
    //  option."
    OptionPtr subnet_sel = query_->getOption(DHO_SUBNET_SELECTION);
    if (subnet_sel) {
        resp_->addOption(subnet_sel);
    }
242
243
}

244
245
246
247
void
Dhcpv4Exchange::setHostIdentifiers() {
    const ConstCfgHostOperationsPtr cfg =
        CfgMgr::instance().getCurrentCfg()->getCfgHostOperations4();
248
249
    // Collect host identifiers. The identifiers are stored in order of preference.
    // The server will use them in that order to search for host reservations.
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
    BOOST_FOREACH(const Host::IdentifierType& id_type,
                  cfg->getIdentifierTypes()) {
        switch (id_type) {
        case Host::IDENT_HWADDR:
            if (context_->hwaddr_ && !context_->hwaddr_->hwaddr_.empty()) {
                context_->addHostIdentifier(id_type, context_->hwaddr_->hwaddr_);
            }
            break;

        case Host::IDENT_DUID:
            if (context_->clientid_) {
                const std::vector<uint8_t>& vec = context_->clientid_->getDuid();
                if (!vec.empty()) {
                    // Client identifier type = DUID? Client identifier holding a DUID
                    // comprises Type (1 byte), IAID (4 bytes), followed by the actual
                    // DUID. Thus, the minimal length is 6.
                    if ((vec[0] == CLIENT_ID_OPTION_TYPE_DUID) && (vec.size() > 5)) {
                        // Extract DUID, skip IAID.
                        context_->addHostIdentifier(id_type,
                                                    std::vector<uint8_t>(vec.begin() + 5,
                                                                         vec.end()));
                    }
                    /// @todo Add support for other client identifiers (see #4317).
                }
            }
            break;

        case Host::IDENT_CIRCUIT_ID:
            {
                OptionPtr rai = query_->getOption(DHO_DHCP_AGENT_OPTIONS);
                if (rai) {
                    OptionPtr circuit_id_opt = rai->getOption(RAI_OPTION_AGENT_CIRCUIT_ID);
                    if (circuit_id_opt) {
                        const OptionBuffer& circuit_id_vec = circuit_id_opt->getData();
                        if (!circuit_id_vec.empty()) {
                            context_->addHostIdentifier(id_type, circuit_id_vec);
                        }
                    }
                }
            }
            break;

        default:
            ;
        }
    }
}

298
299
const std::string Dhcpv4Srv::VENDOR_CLASS_PREFIX("VENDOR_CLASS_");

300
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const bool use_bcast,
301
                     const bool direct_response_desired)
302
303
304
    : 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) {
305

306
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
307
    try {
308
309
310
        // 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.
311
        if (port) {
312
313
314
315
316
317
318
319
            // 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);
320
        }
321

322
323
324
325
        // 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,
326
                                            false /* false = IPv4 */));
327

328
329
330
331
332
333
334
        // 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

335
    } catch (const std::exception &e) {
336
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
337
338
339
        shutdown_ = true;
        return;
    }
340

Tomek Mrugalski's avatar
Tomek Mrugalski committed
341
    shutdown_ = false;
342
343
344
}

Dhcpv4Srv::~Dhcpv4Srv() {
345
346
347
348
349
350
    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());
    }
351

Tomek Mrugalski's avatar
Tomek Mrugalski committed
352
    IfaceMgr::instance().closeSockets();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
353

354
355
    // The lease manager was instantiated during DHCPv4Srv configuration,
    // so we should clean up after ourselves.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
356
    LeaseMgrFactory::destroy();
357
358
359

    // Explicitly unload hooks
    HooksManager::getHooksManager().unloadLibraries();
360
361
}

362
363
void
Dhcpv4Srv::shutdown() {
364
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
365
366
367
    shutdown_ = true;
}

368
isc::dhcp::Subnet4Ptr
369
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& query) const {
370
371
372
373
374
375
376
377
378
379
380

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

381
382
383
384
385
386
    // 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)
387
    //
388
    // Try first Relay Agent Link Selection sub-option
389
390
    OptionPtr rai = query->getOption(DHO_DHCP_AGENT_OPTIONS);
    if (rai) {
391
392
393
394
395
396
397
398
        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)) {
399
                    selector.option_select_ =
400
                        IOAddress::fromBytes(AF_INET, &link_select_buf[0]);
401
402
403
                }
            }
        }
404
405
406
407
408
409
410
411
412
413
    } else {
        // Or Subnet Selection option
        OptionPtr sbnsel = query->getOption(DHO_SUBNET_SELECTION);
        if (sbnsel) {
            OptionCustomPtr oc =
                boost::dynamic_pointer_cast<OptionCustom>(sbnsel);
            if (oc) {
                selector.option_select_ = oc->readAddress();
            }
        }
414
415
    }

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

    // Let's execute all callouts registered for subnet4_select
420
    if (HooksManager::calloutsPresent(hook_index_subnet4_select_)) {
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
        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)
440
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
441
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
442
443
                      DHCP4_HOOK_SUBNET4_SELECT_SKIP)
                .arg(query->getLabel());
444
445
446
            return (Subnet4Ptr());
        }

447
448
        /// @todo: Add support for DROP status

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

453
454
    if (subnet) {
        // Log at higher debug level that subnet has been found.
455
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC_DATA, DHCP4_SUBNET_SELECTED)
456
457
458
459
            .arg(query->getLabel())
            .arg(subnet->getID());
        // Log detailed information about the selected subnet at the
        // lower debug level.
460
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_DATA)
461
462
463
464
            .arg(query->getLabel())
            .arg(subnet->toText());

    } else {
465
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL,
466
467
468
469
                  DHCP4_SUBNET_SELECTION_FAILED)
            .arg(query->getLabel());
    }

470
    return (subnet);
471
472
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
473
474
Pkt4Ptr
Dhcpv4Srv::receivePacket(int timeout) {
475
476
477
    return (IfaceMgr::instance().receive4(timeout));
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
478
479
void
Dhcpv4Srv::sendPacket(const Pkt4Ptr& packet) {
480
481
482
    IfaceMgr::instance().send(packet);
}

483
484
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
485
    while (!shutdown_) {
486
        try {
Francis Dupont's avatar
Francis Dupont committed
487
            run_one();
488
        } catch (const std::exception& e) {
489
490
            // General catch-all exception that are not caught by more specific
            // catches. This one is for exceptions derived from std::exception.
491
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_STD_EXCEPTION)
492
                .arg(e.what());
493
494
495
496
        } catch (...) {
            // General catch-all exception that are not caught by more specific
            // catches. This one is for other exceptions, not derived from
            // std::exception.
497
            LOG_ERROR(packet4_logger, DHCP4_PACKET_PROCESS_EXCEPTION);
498
        }
499
500
501
502
    }

    return (true);
}
503

Francis Dupont's avatar
Francis Dupont committed
504
505
506
507
508
void
Dhcpv4Srv::run_one() {
    // client's message and server's response
    Pkt4Ptr query;
    Pkt4Ptr rsp;
509

Francis Dupont's avatar
Francis Dupont committed
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
    try {
        uint32_t timeout = 1000;
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT).arg(timeout);
        query = receivePacket(timeout);

        // Log if packet has arrived. We can't log the detailed information
        // about the DHCP message because it hasn't been unpacked/parsed
        // yet, and it can't be parsed at this point because hooks will
        // have to process it first. The only information available at this
        // point are: the interface, source address and destination addresses
        // and ports.
        if (query) {
            LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_BUFFER_RECEIVED)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getRemotePort())
                .arg(query->getLocalAddr().toText())
                .arg(query->getLocalPort())
                .arg(query->getIface());
528

Francis Dupont's avatar
Francis Dupont committed
529
530
531
        } else {
            LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_INTERRUPTED)
                .arg(timeout);
532
533
        }

Francis Dupont's avatar
Francis Dupont committed
534
535
536
537
538
539
540
541
542
543
544
545
    } catch (const SignalInterruptOnSelect) {
        // Packet reception interrupted because a signal has been received.
        // This is not an error because we might have received a SIGTERM,
        // SIGINT, SIGHUP or SIGCHILD which are handled by the server. For
        // signals that are not handled by the server we rely on the default
        // behavior of the system.
        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL, DHCP4_BUFFER_WAIT_SIGNAL)
            .arg(signal_set_->getNext());
    } catch (const std::exception& e) {
        // Log all other errors.
        LOG_ERROR(packet4_logger, DHCP4_BUFFER_RECEIVE_FAIL).arg(e.what());
    }
546

Francis Dupont's avatar
Francis Dupont committed
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
    // Handle next signal received by the process. It must be called after
    // an attempt to receive a packet to properly handle server shut down.
    // The SIGTERM or SIGINT will be received prior to, or during execution
    // of select() (select is invoked by receivePacket()). When that
    // happens, select will be interrupted. The signal handler will be
    // invoked immediately after select(). The handler will set the
    // shutdown flag and cause the process to terminate before the next
    // select() function is called. If the function was called before
    // receivePacket the process could wait up to the duration of timeout
    // of select() to terminate.
    try {
        handleSignal();
    } catch (const std::exception& e) {
        // Standard exception occurred. Let's be on the safe side to
        // catch std::exception.
        LOG_ERROR(dhcp4_logger, DHCP4_HANDLE_SIGNAL_EXCEPTION)
            .arg(e.what());
    }
565

Francis Dupont's avatar
Francis Dupont committed
566
567
568
569
570
571
    // Timeout may be reached or signal received, which breaks select()
    // with no reception occurred. No need to log anything here because
    // we have logged right after the call to receivePacket().
    if (!query) {
        return;
    }
572

573
    processPacket(query, rsp);
574

575
576
577
    if (!rsp) {
        return;
    }
578

579
580
581
582
583
584
    try {
        // Now all fields and options are constructed into output wire buffer.
        // Option objects modification does not make sense anymore. Hooks
        // can only manipulate wire buffer at this stage.
        // Let's execute all callouts registered for buffer4_send
        if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_send_)) {
585
586
587
588
589
590
            CalloutHandlePtr callout_handle = getCalloutHandle(query);

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

            // Pass incoming packet as argument
591
            callout_handle->setArgument("response4", rsp);
592
593

            // Call callouts
594
            HooksManager::callCallouts(Hooks.hook_index_buffer4_send_,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
595
                                       *callout_handle);
596
597
598

            // Callouts decided to skip the next processing step. The next
            // processing step would to parse the packet, so skip at this
599
            // stage means drop.
600
            if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
601
602
603
604
                LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                          DHCP4_HOOK_BUFFER_SEND_SKIP)
                    .arg(rsp->getLabel());
                return;
605
606
            }

607
            /// @todo: Add support for DROP status.
608

609
            callout_handle->getArgument("response4", rsp);
610
611
        }

612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
        LOG_DEBUG(packet4_logger, DBG_DHCP4_BASIC, DHCP4_PACKET_SEND)
            .arg(rsp->getLabel())
            .arg(rsp->getName())
            .arg(static_cast<int>(rsp->getType()))
            .arg(rsp->getLocalAddr())
            .arg(rsp->getLocalPort())
            .arg(rsp->getRemoteAddr())
            .arg(rsp->getRemotePort())
            .arg(rsp->getIface());

        LOG_DEBUG(packet4_logger, DBG_DHCP4_DETAIL_DATA,
                  DHCP4_RESPONSE_DATA)
            .arg(rsp->getLabel())
            .arg(rsp->getName())
            .arg(static_cast<int>(rsp->getType()))
            .arg(rsp->toText());
        sendPacket(rsp);

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

    } catch (const std::exception& e) {
        LOG_ERROR(packet4_logger, DHCP4_PACKET_SEND_FAIL)
            .arg(rsp->getLabel())
            .arg(e.what());
    }
638
}
639

640
void
641
Dhcpv4Srv::processPacket(Pkt4Ptr& query, Pkt4Ptr& rsp) {
642
643
    // Log reception of the packet. We need to increase it early, as any
    // failures in unpacking will cause the packet to be dropped. We
644
    // will increase type specific statistic further down the road.
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
    // See processStatsReceived().
    isc::stats::StatsMgr::instance().addValue("pkt4-received",
                                              static_cast<int64_t>(1));

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

    bool skip_unpack = false;

    // The packet has just been received so contains the uninterpreted wire
    // data; execute callouts registered for buffer4_receive.
    if (HooksManager::calloutsPresent(Hooks.hook_index_buffer4_receive_)) {
        CalloutHandlePtr callout_handle = getCalloutHandle(query);
664

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

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

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

675
676
677
678
679
680
681
682
683
684
685
686
        // Callouts decided to skip the next processing step. The next
        // processing step would to parse the packet, so skip at this
        // stage means that callouts did the parsing already, so server
        // should skip parsing.
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
            LOG_DEBUG(hooks_logger, DBG_DHCP4_DETAIL,
                      DHCP4_HOOK_BUFFER_RCVD_SKIP)
                .arg(query->getRemoteAddr().toText())
                .arg(query->getLocalAddr().toText())
                .arg(query->getIface());
            skip_unpack = true;
        }
687

688
        callout_handle->getArgument("query4", query);
689

690
691
        /// @todo: add support for DROP status
    }
692

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

711
712
713
            // Increase the statistics of parse failues and dropped packets.
            isc::stats::StatsMgr::instance().addValue("pkt4-parse-failed",
                                                      static_cast<int64_t>(1));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
714
            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
715
                                                      static_cast<int64_t>(1));
716
            return;
717
        }
718
    }
719

720
721
    // Update statistics accordingly for received packet.
    processStatsReceived(query);
722

723
724
725
726
    // Assign this packet to one or more classes if needed. We need to do
    // this before calling accept(), because getSubnet4() may need client
    // class information.
    classifyPacket(query);
727

728
729
730
731
732
733
734
735
    // Check whether the message should be further processed or discarded.
    // There is no need to log anything here. This function logs by itself.
    if (!accept(query)) {
        // Increase the statistic of dropped packets.
        isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop",
                                                  static_cast<int64_t>(1));
        return;
    }
736

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

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

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

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

761
762
763
        // Call callouts
        HooksManager::callCallouts(hook_index_pkt4_receive_,
                                   *callout_handle);
764

765
766
767
768
769
770
771
        // Callouts decided to skip the next processing step. The next
        // processing step would to process the packet, so skip at this
        // stage means drop.
        if (callout_handle->getStatus() == CalloutHandle::NEXT_STEP_SKIP) {
            LOG_DEBUG(hooks_logger, DBG_DHCP4_HOOKS,
                      DHCP4_HOOK_PACKET_RCVD_SKIP)
                .arg(query->getLabel());
772
            return;
773
        }
774

775
        /// @todo: Add support for DROP status
776

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

780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
    try {
        switch (query->getType()) {
        case DHCPDISCOVER:
            rsp = processDiscover(query);
            break;

        case DHCPREQUEST:
            // Note that REQUEST is used for many things in DHCPv4: for
            // requesting new leases, renewing existing ones and even
            // for rebinding.
            rsp = processRequest(query);
            break;

        case DHCPRELEASE:
            processRelease(query);
            break;

        case DHCPDECLINE:
            processDecline(query);
            break;

        case DHCPINFORM:
            rsp = processInform(query);
            break;

        default:
            // Only action is to output a message if debug is enabled,
            // and that is covered by the debug statement before the
            // "switch" statement.
            ;
810
        }
811
812
813
814
815
816
817
818
819
820
821
822
823
    } catch (const std::exception& e) {

        // Catch-all exception (we used to call only isc::Exception, but
        // std::exception could potentially be raised and if we don't catch
        // it here, it would be caught in main() and the process would
        // terminate).  Just log the problem and ignore the packet.
        // (The problem is logged as a debug message because debug is
        // disabled by default - it prevents a DDOS attack based on the
        // sending of problem packets.)
        LOG_DEBUG(bad_packet4_logger, DBG_DHCP4_BASIC,
                  DHCP4_PACKET_DROP_0007)
            .arg(query->getLabel())
            .arg(e.what());
824

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

830
831
832
    if (!rsp) {
        return;
    }
833

834
835
    // Specifies if server should do the packing
    bool skip_pack = false;
836

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

841
842
        // Delete all previous arguments
        callout_handle->deleteAllArguments();
843

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

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

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

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

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

867
868
        /// @todo: Add support for DROP status
    }
869

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

883
string
884
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
    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());
901
902
}

903
void
904
Dhcpv4Srv::appendServerID(Dhcpv4Exchange& ex) {
905
906
907
    // 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.
908
909
    /// @todo: perhaps we should consider some more sophisticated server id
    /// generation, but for the current use cases, it should be ok.
910
911
912
    OptionPtr opt_srvid(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                           ex.getResponse()->getLocalAddr()));
    ex.getResponse()->addOption(opt_srvid);
913
914
}

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

    // First subnet configured options
    Subnet4Ptr subnet = ex.getContext()->subnet_;
921
922
923
924
925
926
    if (!subnet) {
        // All methods using the CfgOptionList object return soon when
        // there is no subnet so do the same
        return;
    }
    if (!subnet->getCfgOption()->empty()) {
927
928
929
930
931
932
933
934
935
936
937
938
        co_list.push_back(subnet->getCfgOption());
    }

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

    // Last global options
957
958
959
    if (!CfgMgr::instance().getCurrentCfg()->getCfgOption()->empty()) {
        co_list.push_back(CfgMgr::instance().getCurrentCfg()->getCfgOption());
    }
960
961
}

962
void
963
Dhcpv4Srv::appendRequestedOptions(Dhcpv4Exchange& ex) {
964
965
    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
966
    Subnet4Ptr subnet = ex.getContext()->subnet_;
967
968
969
970
971
972
973
    // 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;
    }
974

975
976
977
978
979
980
    // Unlikely short cut
    const CfgOptionList& co_list = ex.getCfgOptionList();
    if (co_list.empty()) {
        return;
    }

981
982
    Pkt4Ptr query = ex.getQuery();

983
984
985
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
986
        OptionUint8Array>(query->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
987
988
989
990
991
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
992

993
994
    Pkt4Ptr resp = ex.getResponse();

995
996
997
998
999
1000
    // 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) {