1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
// Copyright (C) 2020-2024 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Kea Hooks Basic
// Commercial End User License Agreement v2.0. See COPYING file in the premium/
// directory.

#include <config.h>

#include <asiolink/io_service.h>
#include <database/audit_entry.h>
#include <hooks/hooks.h>
#include <dhcpsrv/cfgmgr.h>
#include <lease_query_log.h><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <lease_query_impl_factory.h><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <blq_service.h><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <process/daemon.h>
#include <stats/stats_mgr.h>

#include <string><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <vector><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.

using namespace isc;
using namespace isc::asiolink;
using namespace isc::lease_query;
using namespace isc::data;
using namespace isc::db;
using namespace isc::dhcp;
using namespace isc::hooks;
using namespace isc::log;
using namespace isc::process;
using namespace isc::stats;
using namespace std;

namespace {
/// @brief Extracts the library parameters into MapElement
///
/// @param handle the library handle
/// @return the config
///
ConstElementPtr getConfig(LibraryHandle& handle) {
    const std::vector<std::string> names = handle.getParameterNames();
    ElementPtr config = Element::createMap();

    for (auto const& name : names) {
        ConstElementPtr value = handle.getParameter(name);
        if (value) {
            config->set(name, value);
        }
    }

    // Note checkKeywords() will throw DhcpConfigError if there is a problem.
    SimpleParser::checkKeywords(LeaseQueryImpl::LEASE_QUERY_KEYWORDS, config);
    return (config);
}

/// @brief Upgrade v4 extended information.
///
/// @param handle Callout handle used to retrieve a command and
/// provide a response.
/// @return 0 if this callout has been invoked successfully,
/// 1 otherwise.
int extended_info4_upgrade(CalloutHandle& handle) {
    return (LeaseQueryImpl4::upgradeHandler(handle));
}

/// @brief Upgrade v6 extended information.
///
/// @param handle Callout handle used to retrieve a command and
/// provide a response.
/// @return 0 if this callout has been invoked successfully,
/// 1 otherwise.
int extended_info6_upgrade(CalloutHandle& handle) {
    return (LeaseQueryImpl6::upgradeHandler(handle));
}
} // end of anonymous namespace

extern "C" {

/// @brief This callout is called at the "buffer4_receive" hook.
///
/// If the inbound packet hasn't been unpacked, it is unpacked.  If it
/// is anything other than DHCPLEASEQUERY we set the call status to
/// NEXT_STEP_SKIP and return 0 to indicate success (i.e. we ignore the
/// packet).
///
/// The query is passed into LeaseQueryImpl4::processQuery() which carries
/// out all aspects of responding to it:
///
/// - Validating the query
/// - Searching for matching leases
/// - Constructing the response
/// - Sending the response to the requester
///
/// @return 0 if the packet was handled appropriately, 1 if an error
/// occurred.
///
/// @param handle CalloutHandle.
///
/// @return 0 upon success, non-zero otherwise.
int buffer4_receive(CalloutHandle& handle) {
    CalloutHandle::CalloutNextStep status = handle.getStatus();
    if (status == CalloutHandle::NEXT_STEP_DROP) {
        return (0);
    }

    // Get the received message.
    Pkt4Ptr query;
    handle.getArgument("query4", query);
    try {
        // If it's not already unpacked, unpack it
        if (handle.getStatus() != CalloutHandle::NEXT_STEP_SKIP) {
            query->unpack();
        }
    } catch (const std::exception& ex) {
        LOG_DEBUG(lease_query_logger, DBGLVL_TRACE_BASIC,
                  DHCP4_LEASE_QUERY_PACKET_UNPACK_FAILED)
            .arg(query->getRemoteAddr().toText())
            .arg(query->getLocalAddr().toText())
            .arg(query->getIface())
            .arg(ex.what());
        // Increase the statistics of parse failures and dropped packets.
        StatsMgr::instance().addValue("pkt4-parse-failed",
                                      static_cast<int64_t>(1));
        StatsMgr::instance().addValue("pkt4-receive-drop",
                                      static_cast<int64_t>(1));
        handle.setStatus(CalloutHandle::NEXT_STEP_DROP);
        return (0);
    }

    // Not a lease query, so return without handling it.
    // Make sure status is SKIP so it doesn't get unpacked again.
    if (query->getType() != DHCPLEASEQUERY) {
        handle.setStatus(CalloutHandle::NEXT_STEP_SKIP);
        return (0);
    }

    LOG_DEBUG(lease_query_logger, DBGLVL_TRACE_BASIC, DHCP4_LEASE_QUERY_RECEIVED)
              .arg(LeaseQueryImpl4::leaseQueryLabel(query));
    StatsMgr::instance().addValue("pkt4-lease-query-received", static_cast<int64_t>(1));

    try {
        LeaseQueryImplFactory::getImpl().processQuery(query);
    } catch (const std::exception& ex) {
        // Failed to parse the packet.
        LOG_DEBUG(lease_query_logger, DBGLVL_TRACE_BASIC,
                  DHCP4_LEASE_QUERY_PROCESS_FAILED)
                  .arg(LeaseQueryImpl4::leaseQueryLabel(query))
                  .arg(ex.what());

        StatsMgr::instance().addValue("pkt4-receive-drop",
                                      static_cast<int64_t>(1));
        handle.setStatus(CalloutHandle::NEXT_STEP_DROP);
        return (0);
    }

    // We always set status to DROP as the query has been handled.
    handle.setStatus(CalloutHandle::NEXT_STEP_DROP);
    return (0);
}

/// @brief This callout is called at the "buffer6_receive" hook.
///
/// If the inbound packet hasn't been unpacked, it is unpacked.  If it
/// is anything other than DHCPV6_LEASEQUERY we set the call status to
/// NEXT_STEP_SKIP and return 0 to indicate success (i.e. we ignore the
/// packet).
///
/// The query is passed into LeaseQueryImpl6::processQuery() which carries
/// out all aspects of responding to it:
///
/// - Validating the query
/// - Searching for matching leases
/// - Constructing the response
/// - Sending the response to the requester
///
/// @return 0 if the packet was handled appropriately, 1 if an error
/// occurred.
///
/// @param handle CalloutHandle.
///
/// @return 0 upon success, non-zero otherwise.
int buffer6_receive(CalloutHandle& handle) {
    CalloutHandle::CalloutNextStep status = handle.getStatus();
    if (status == CalloutHandle::NEXT_STEP_DROP) {
        return (0);
    }

    // Get the received message.
    Pkt6Ptr query;
    handle.getArgument("query6", query);

    try {
        // If it's not already unpacked, unpack it.
        if (handle.getStatus() != CalloutHandle::NEXT_STEP_SKIP) {
            query->unpack();
        }
    } catch (const std::exception& ex) {
        LOG_DEBUG(lease_query_logger, DBGLVL_TRACE_BASIC,
                  DHCP6_LEASE_QUERY_PACKET_UNPACK_FAILED)
            .arg(query->getRemoteAddr().toText())
            .arg(query->getLocalAddr().toText())
            .arg(query->getIface())
            .arg(ex.what());
        // Increase the statistics of parse failures and dropped packets.
        StatsMgr::instance().addValue("pkt6-parse-failed",
                                      static_cast<int64_t>(1));
        StatsMgr::instance().addValue("pkt6-receive-drop",
                                      static_cast<int64_t>(1));
        handle.setStatus(CalloutHandle::NEXT_STEP_DROP);
        return (0);
    }

    // Not a lease query, so return without handling it.
    // Make sure status is SKIP so it doesn't get unpacked again.
    if (query->getType() != DHCPV6_LEASEQUERY) {
        handle.setStatus(CalloutHandle::NEXT_STEP_SKIP);
        return (0);
    }

    LOG_DEBUG(lease_query_logger, DBGLVL_TRACE_BASIC, DHCP6_LEASE_QUERY_RECEIVED)
              .arg(LeaseQueryImpl6::leaseQueryLabel(query));
    StatsMgr::instance().addValue("pkt6-lease-query-received", static_cast<int64_t>(1));

    try {
        LeaseQueryImplFactory::getImpl().processQuery(query);
    } catch (const std::exception& ex) {
        // Log that we failed to process the packet.
        LOG_DEBUG(lease_query_logger, DBGLVL_TRACE_BASIC,
                  DHCP6_LEASE_QUERY_PROCESS_FAILED)
                  .arg(LeaseQueryImpl6::leaseQueryLabel(query))
                  .arg(ex.what());
    }

    // We always set status to DROP as the query has been handled.
    handle.setStatus(CalloutHandle::NEXT_STEP_DROP);
    return (0);
}

/// @brief This function is called when the library is loaded.
///
/// Reset lease-query related stats.
///
/// @return always 0.
int load(LibraryHandle& handle) {
    try {

        // Make the hook library not loadable by d2 or ca.
        uint16_t family = CfgMgr::instance().getFamily();
        const std::string& proc_name = Daemon::getProcName();
        if (family == AF_INET) {
            if (proc_name != "kea-dhcp4") {
                isc_throw(isc::Unexpected, "Bad process name: " << proc_name
                          << ", expected kea-dhcp4");
            }

            StatsMgr::instance().setValue("pkt4-lease-query-received",
                                          static_cast<int64_t>(0));
            StatsMgr::instance().setValue("pkt4-lease-query-response-unknown-sent",
                                          static_cast<int64_t>(0));
            StatsMgr::instance().setValue("pkt4-lease-query-response-unassigned-sent",
                                          static_cast<int64_t>(0));
            StatsMgr::instance().setValue("pkt4-lease-query-response-active-sent",
                                          static_cast<int64_t>(0));
            handle.registerCommandCallout("extended-info4-upgrade",
                                          extended_info4_upgrade);
        } else {
            if (proc_name != "kea-dhcp6") {
                isc_throw(isc::Unexpected, "Bad process name: " << proc_name
                          << ", expected kea-dhcp6");
            }

            StatsMgr::instance().setValue("pkt6-lease-query-received",
                                          static_cast<int64_t>(0));
            StatsMgr::instance().setValue("pkt6-lease-query-reply-sent",
                                          static_cast<int64_t>(0));
            handle.registerCommandCallout("extended-info6-upgrade",
                                          extended_info6_upgrade);
        }

        ConstElementPtr config = getConfig(handle);
        LeaseQueryImpl::terminated_ = false;
        LeaseQueryImplFactory::createImpl(family, config);
    } catch (const std::exception& ex) {
        LOG_ERROR(lease_query_logger, LEASE_QUERY_LOAD_FAILED)
                  .arg(ex.what());
        LeaseQueryImpl::terminated_ = true;
        LeaseQueryImplFactory::destroyImpl();
        return (1);
    }

    LOG_INFO(lease_query_logger, LEASE_QUERY_LOAD_OK);
    return (0);
}

/// @brief This function is called when the library is unloaded.
///
/// Remove lease-query stats.
///
/// @return always 0.
int unload() {
    // Helps current running works to terminate.
    LeaseQueryImpl::terminated_ = true;

    // Stop and Destroy the BulkLeaseQueryService instance.
    BulkLeaseQueryService::reset();

    // Destroy the LeaseQueryImpl instance.
    LeaseQueryImplFactory::destroyImpl();

    // Remove lease-query stats.
    if (CfgMgr::instance().getFamily() == AF_INET) {
        StatsMgr::instance().del("pkt4-lease-query-received");
        StatsMgr::instance().del("pkt4-lease-query-response-unknown-sent");
        StatsMgr::instance().del("pkt4-lease-query-response-unassigned-sent");
        StatsMgr::instance().del("pkt4-lease-query-response-active-sent");
    } else {
        StatsMgr::instance().del("pkt6-lease-query-received");
        StatsMgr::instance().del("pkt6-lease-query-reply-sent");
    }

    LOG_INFO(lease_query_logger, LEASE_QUERY_UNLOAD_OK);
    return (0);
}

/// @brief dhcp4_srv_configured callout implementation.
///
/// Starts the listener.
///
/// @param handle callout handle.
/// @return 0 on success, non-zero otherwise.
int dhcp4_srv_configured(CalloutHandle& handle) {
    IOServicePtr io_context;
    handle.getArgument("io_context", io_context);
    if (!io_context) {
        // Should not happen!
        handle.setStatus(isc::hooks::CalloutHandle::NEXT_STEP_DROP);
        const string error("Error: io_context is null");
        handle.setArgument("error", error);
        return (1);
    }
    io_context->post(BulkLeaseQueryService::doStartListener);
    return (0);
}

/// @brief This callout is called at the "cb6_updated" hook.
///
/// If it detects that any subnets were altered by the update it
/// repopulates the prefix length list.
///
/// @param handle CalloutHandle.
///
/// @return 0 upon success, number of expressions that failed otherwise.
int cb6_updated(CalloutHandle& handle) {
    // Only repopulate the list if CB updated subnets.
    AuditEntryCollectionPtr audit_entries;
    handle.getArgument("audit_entries", audit_entries);

    auto const& object_type_idx = audit_entries->get<AuditEntryObjectTypeTag>();
    auto range = object_type_idx.equal_range("dhcp6_subnet");
    if (std::distance(range.first, range.second)) {
        try {
            const SrvConfigPtr& cfg = CfgMgr::instance().getCurrentCfg();
            const LeaseQueryImpl6& impl6 = dynamic_cast<const LeaseQueryImpl6&>
                                           (LeaseQueryImplFactory::getImpl());
            LeaseQueryImpl6& impl = const_cast<LeaseQueryImpl6&>(impl6);
            impl.populatePrefixLengthList(cfg);
        } catch (const std::exception& ex) {
            const string error("Error: populatePrefixLengthList() failed");<--- Variable 'error' is assigned a value that is never used.
            handle.setArgument("error", ex.what());
            return (1);
        }
    }

    return (0);
}

/// @brief dhcp6_srv_configured callout implementation.
///
/// Starts the listener.
///
/// @param handle callout handle.
/// @return 0 on success, non-zero otherwise.
int dhcp6_srv_configured(CalloutHandle& handle) {
    try {
        SrvConfigPtr cfg;
        handle.getArgument("server_config", cfg);
        const LeaseQueryImpl6& impl6 = dynamic_cast<const LeaseQueryImpl6&>
                                       (LeaseQueryImplFactory::getImpl());
        LeaseQueryImpl6& impl = const_cast<LeaseQueryImpl6&>(impl6);
        impl.populatePrefixLengthList(cfg);
    } catch (const std::exception& ex) {
        handle.setStatus(isc::hooks::CalloutHandle::NEXT_STEP_DROP);
        const string error("Error: populatePrefixLengthList() failed");<--- Variable 'error' is assigned a value that is never used.
        handle.setArgument("error", ex.what());
        return (1);
    }

    IOServicePtr io_context;
    handle.getArgument("io_context", io_context);
    if (!io_context) {
        // Should not happen!
        handle.setStatus(isc::hooks::CalloutHandle::NEXT_STEP_DROP);
        const string error("Error: io_context is null");
        handle.setArgument("error", error);
        return (1);
    }

    io_context->post(BulkLeaseQueryService::doStartListener);
    return (0);
}

/// @brief This function is called to retrieve the multi-threading compatibility.
///
/// @return 1 which means compatible with multi-threading.
int multi_threading_compatible() {
    return (1);
}

} // end extern "C"