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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434 | // Copyright (C) 2015-2024 Internet Systems Consortium, Inc. ("ISC")
//
// 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/.
#include <config.h>
#include <asiolink/io_address.h>
#include <cc/data.h>
#include <dhcp/testutils/iface_mgr_test_config.h>
#include <dhcp6/json_config_parser.h>
#include <dhcp6/tests/dhcp6_message_test.h>
#include <dhcpsrv/lease.h>
#ifdef HAVE_MYSQL
#include <mysql/testutils/mysql_schema.h>
#include <hooks/dhcp/mysql/mysql_lease_mgr.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#endif
#ifdef HAVE_PGSQL
#include <pgsql/testutils/pgsql_schema.h>
#include <hooks/dhcp/pgsql/pgsql_lease_mgr.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#endif
#include <stats/stats_mgr.h>
using namespace isc;
using namespace isc::asiolink;
using namespace isc::data;
using namespace isc::db;
using namespace isc::dhcp;
using namespace isc::dhcp::test;
using namespace isc::stats;
namespace {
/// @brief Set of JSON configurations used throughout the Renew tests.
///
/// - Configuration 0:
/// - only addresses (no prefixes)
/// - 1 subnet with 2001:db8:1::/64 pool
const char* DECLINE_CONFIGS[] = {
// Configuration 0
"{ \"interfaces-config\": {"
" \"interfaces\": [ \"*\" ]"
"},"
"\"preferred-lifetime\": 3000,"
"\"rebind-timer\": 2000, "
"\"renew-timer\": 1000, "
"\"subnet6\": [ { "
" \"id\": 1, "
" \"pools\": [ { \"pool\": \"2001:db8:1::/64\" } ],"
" \"subnet\": \"2001:db8:1::/48\", "
" \"interface-id\": \"\","
" \"interface\": \"eth0\""
" } ],"
"\"valid-lifetime\": 4000 }",
// Configuration 1 - only use when mysql is enabled
"{ \"interfaces-config\": {"
" \"interfaces\": [ \"*\" ]"
"},"
"\"lease-database\": {"
"\"type\": \"mysql\","
"\"name\": \"keatest\","
"\"user\": \"keatest\","
"\"password\": \"keatest\""
"},"
"\"preferred-lifetime\": 3000,"
"\"rebind-timer\": 2000, "
"\"renew-timer\": 1000, "
"\"subnet6\": [ { "
" \"id\": 1, "
" \"pools\": [ { \"pool\": \"2001:db8:1::/64\" } ],"
" \"subnet\": \"2001:db8:1::/48\", "
" \"interface-id\": \"\","
" \"interface\": \"eth0\""
" } ],"
"\"valid-lifetime\": 4000 }",
// Configuration 2 - only use when pgsql is enabled
"{ \"interfaces-config\": {"
" \"interfaces\": [ \"*\" ]"
"},"
"\"lease-database\": {"
"\"type\": \"postgresql\","
"\"name\": \"keatest\","
"\"user\": \"keatest\","
"\"password\": \"keatest\""
"},"
"\"preferred-lifetime\": 3000,"
"\"rebind-timer\": 2000, "
"\"renew-timer\": 1000, "
"\"subnet6\": [ { "
" \"id\": 1, "
" \"pools\": [ { \"pool\": \"2001:db8:1::/64\" } ],"
" \"subnet\": \"2001:db8:1::/48\", "
" \"interface-id\": \"\","
" \"interface\": \"eth0\""
" } ],"
"\"valid-lifetime\": 4000 }"
};
/// @brief Test fixture class for testing Renew.
class DeclineTest : public Dhcpv6MessageTest {
public:
/// @brief Constructor.
///
/// Sets up fake interfaces.
DeclineTest()
: Dhcpv6MessageTest(), na_iaid_(1234) {
}
/// @brief IAID used for IA_NA.
uint32_t na_iaid_;
};
}
namespace isc {
namespace dhcp {
namespace test {
void
Dhcpv6SrvTest::acquireAndDecline(Dhcp6Client& client,
const std::string& duid1,
const uint32_t iaid1,
const std::string& duid2,
const uint32_t iaid2,
AddressInclusion addr_type,
ExpectedResult expected_result,
uint8_t config_index) {
// Set this global statistic explicitly to zero.
StatsMgr::instance().setValue("declined-addresses", static_cast<int64_t>(0));
client.setDUID(duid1);
client.requestAddress(iaid1);
// Configure the server with a configuration.
ASSERT_NO_THROW(configure(DECLINE_CONFIGS[config_index], *client.getServer()));
// Let's get the subnet-id and generate statistics name out of it.
const Subnet6Collection* subnets =
CfgMgr::instance().getCurrentCfg()->getCfgSubnets6()->getAll();
ASSERT_EQ(1, subnets->size());
// Let's generate the subnet specific statistic
std::string name = StatsMgr::generateName("subnet",
(*subnets->begin())->getID(),
"declined-addresses");
// Set this statistic explicitly to zero.
StatsMgr::instance().setValue(name, static_cast<int64_t>(0));
// Perform 4-way exchange.
ASSERT_NO_THROW(client.doSARR());
// Make sure that the client has acquired NA lease.
std::vector<Lease6> leases_client_na = client.getLeasesByType(Lease::TYPE_NA);
ASSERT_EQ(1, leases_client_na.size());
EXPECT_EQ(STATUS_Success, client.getStatusCode(iaid1));
// Remember the acquired address.
IOAddress acquired_address = leases_client_na[0].addr_;
// Check the declined-addresses (subnet) before the Decline operation.
ObservationPtr declined_cnt = StatsMgr::instance().getObservation(name);
ASSERT_TRUE(declined_cnt);
uint64_t before = declined_cnt->getInteger().first;
// Check the global declined-addresses statistic before the Decline.
ObservationPtr declined_global = StatsMgr::instance()
.getObservation("declined-addresses");
ASSERT_TRUE(declined_global);
uint64_t before_global = declined_cnt->getInteger().first;
/// Determines if the client will include address in the messages it sends.
bool include_address_ = true;
// Let's tamper with the address if necessary.
switch (addr_type) {
case VALID_ADDR:
// Nothing to do, client will do its job correctly by default
break;
case BOGUS_ADDR:
// Simple increase by one.
client.config_.leases_[0].addr_ =
IOAddress::increase(client.config_.leases_[0].addr_);
break;
case NO_ADDR:
// Tell the client to not include an address in its IA_NA
include_address_ = false;
break;
case NO_IA:
// Tell the client to not include IA_NA at all
client.config_.clear();
client.clearRequestedIAs();
}
// Use the second duid
client.setDUID(duid2);
// Use the second IAID (but not in NO_IA which has cleared leases)
if (addr_type != NO_IA) {
ASSERT_NE(0, client.config_.leases_.size());
client.config_.leases_[0].iaid_ = iaid2;
}
// Ok, let's decline the lease.
ASSERT_NO_THROW(client.doDecline(include_address_));
// Let's check if there's a lease
Lease6Ptr lease = LeaseMgrFactory::instance().getLease6(Lease::TYPE_NA,
acquired_address);
ASSERT_TRUE(lease);
declined_cnt = StatsMgr::instance().getObservation(name);
ASSERT_TRUE(declined_cnt);
uint64_t after = declined_cnt->getInteger().first;
declined_global = StatsMgr::instance().getObservation("declined-addresses");
ASSERT_TRUE(declined_global);
uint64_t after_global = declined_global->getInteger().first;
// We check if the decline process was successful by checking if the
// lease is in the database and what is its state.
if (expected_result == SHOULD_PASS) {
ASSERT_EQ(Lease::STATE_DECLINED, lease->state_);
ASSERT_FALSE(lease->hwaddr_);
ASSERT_TRUE(lease->duid_);
ASSERT_EQ(*lease->duid_, DUID::EMPTY());
ASSERT_EQ(lease->preferred_lft_, 0);
ASSERT_TRUE(lease->hostname_.empty());
ASSERT_FALSE(lease->fqdn_fwd_);
ASSERT_FALSE(lease->fqdn_rev_);
// The decline succeeded, so the declined-addresses statistic should
// be increased by one
ASSERT_EQ(after, before + 1);
ASSERT_EQ(after_global, before_global + 1);
} else {
// the decline was supposed, to be rejected.
ASSERT_EQ(Lease::STATE_DEFAULT, lease->state_);
ASSERT_TRUE(lease->hwaddr_);
ASSERT_TRUE(lease->duid_);
ASSERT_NE(*lease->duid_, DUID::EMPTY());
ASSERT_NE(lease->preferred_lft_, 0);
ASSERT_FALSE(lease->fqdn_fwd_);
ASSERT_FALSE(lease->fqdn_rev_);
// The decline failed, so the declined-addresses should be the same
// as before
ASSERT_EQ(before, after);
ASSERT_EQ(before_global, after_global);
}
}
// This test checks that the client can acquire and decline the lease.
TEST_F(DeclineTest, basicMemfile) {<--- syntax error
Dhcp6Client client;
acquireAndDecline(client, "01:02:03:04:05:06", 1234, "01:02:03:04:05:06",
1234, VALID_ADDR, SHOULD_PASS);
}
#ifdef HAVE_MYSQL
// This test checks that the client can acquire and decline the lease.
TEST_F(DeclineTest, basicMySQL) {
MySqlLeaseMgrInit init;
Dhcp6Client client;
acquireAndDecline(client, "01:02:03:04:05:06", 1234, "01:02:03:04:05:06",
1234, VALID_ADDR, SHOULD_PASS, 1);
}
#endif
#ifdef HAVE_PGSQL
TEST_F(DeclineTest, basicPgSQL) {
PgSqlLeaseMgrInit init;
Dhcp6Client client;
acquireAndDecline(client, "01:02:03:04:05:06", 1234, "01:02:03:04:05:06",
1234, VALID_ADDR, SHOULD_PASS, 2);
}
#endif
}
}
}
namespace {
// This test verifies the decline is rejected in the following case:
// - Client acquires new lease using duid, iaid
// - Client sends the DECLINE with duid, iaid, but uses wrong address.
// - The server rejects Decline due to address mismatch
TEST_F(DeclineTest, addressMismatch) {
Dhcp6Client client;
acquireAndDecline(client, "01:02:03:04:05:06", 1234, "01:02:03:04:05:06",
1234, BOGUS_ADDR, SHOULD_FAIL);
}
// This test verifies the decline is rejected in the following case:
// - Client acquires new lease using duid, iaid1
// - Client sends the DECLINE with duid, iaid2
// - The server rejects Decline due to IAID mismatch
TEST_F(DeclineTest, iaidMismatch) {
Dhcp6Client client;
acquireAndDecline(client, "01:02:03:04:05:06", 1234, "01:02:03:04:05:06",
1235, VALID_ADDR, SHOULD_FAIL);
}
// This test verifies the decline correctness in the following case:
// - Client acquires new lease using duid1, iaid
// - Client sends the DECLINE using duid2, iaid
// - The server rejects the Decline due to DUID mismatch
TEST_F(DeclineTest, duidMismatch) {
Dhcp6Client client;
acquireAndDecline(client, "01:02:03:04:05:06", 1234,
"01:02:03:04:05:07", 1234,
VALID_ADDR, SHOULD_FAIL);
}
// This test verifies the decline correctness in the following case:
// - Client acquires new lease using duid1, iaid
// - Client sends the DECLINE using valid duid/iaid, but does not
// include the address in it
// - The server rejects the Decline due to missing address
TEST_F(DeclineTest, noAddrsSent) {
Dhcp6Client client;
acquireAndDecline(client, "01:02:03:04:05:06", 1234,
"01:02:03:04:05:06", 1234,
NO_ADDR, SHOULD_FAIL);
}
// This test verifies the decline correctness in the following case:
// - Client acquires new lease using duid1, iaid
// - Client sends the DECLINE using valid duid, but does not
// include IA_NA at all
// - The server rejects the Decline due to missing IA_NA
TEST_F(DeclineTest, noIAs) {
Dhcp6Client client;
acquireAndDecline(client, "01:02:03:04:05:06", 1234,
"01:02:03:04:05:06", 1234,
NO_IA, SHOULD_FAIL);
}
// Test that the released lease cannot be declined.
TEST_F(DeclineTest, declineAfterRelease) {
Dhcp6Client client;
uint32_t iaid = 1;
client.requestAddress(iaid);
// Configure DHCP server.
configure(DECLINE_CONFIGS[0], *client.getServer());
// Perform 4-way exchange to obtain a new lease.
client.doSARR();
auto leases = client.getLeasesByType(Lease::TYPE_NA);
ASSERT_EQ(1, leases.size());
EXPECT_EQ(STATUS_Success, client.getStatusCode(iaid));
// Release the acquired lease.
auto lease = LeaseMgrFactory::instance().getLease6(Lease::TYPE_NA, leases[0].addr_);
lease->state_ = Lease::STATE_RELEASED;
LeaseMgrFactory::instance().updateLease6(lease);
// Try to decline the released address.
ASSERT_NO_THROW(client.doDecline());
// The address should not be declined. It should still be in the
// released state.
lease = LeaseMgrFactory::instance().getLease6(Lease::TYPE_NA, lease->addr_);
ASSERT_TRUE(lease);
EXPECT_EQ(Lease::STATE_RELEASED, lease->state_);
}
// Test that the released lease cannot be declined.
TEST_F(DeclineTest, declineAfterExpire) {
Dhcp6Client client;
uint32_t iaid = 1;
client.requestAddress(iaid);
// Configure DHCP server.
configure(DECLINE_CONFIGS[0], *client.getServer());
// Perform 4-way exchange to obtain a new lease.
client.doSARR();
auto leases = client.getLeasesByType(Lease::TYPE_NA);
ASSERT_EQ(1, leases.size());
EXPECT_EQ(STATUS_Success, client.getStatusCode(iaid));
// Release the acquired lease.
auto lease = LeaseMgrFactory::instance().getLease6(Lease::TYPE_NA, leases[0].addr_);
lease->cltt_ -= 7200;
LeaseMgrFactory::instance().updateLease6(lease);
// Try to decline the expired lease.
ASSERT_NO_THROW(client.doDecline());
// The address should not be declined. It should still be in the
// default state.
lease = LeaseMgrFactory::instance().getLease6(Lease::TYPE_NA, lease->addr_);
ASSERT_TRUE(lease);
EXPECT_EQ(Lease::STATE_DEFAULT, lease->state_);
}
// Test that expired-reclaimed lease cannot be declined.
TEST_F(DeclineTest, declineAfterReclamation) {
Dhcp6Client client;
uint32_t iaid = 1;
client.requestAddress(iaid);
// Configure DHCP server.
configure(DECLINE_CONFIGS[0], *client.getServer());
// Perform 4-way exchange to obtain a new lease.
client.doSARR();
auto leases = client.getLeasesByType(Lease::TYPE_NA);
ASSERT_EQ(1, leases.size());
EXPECT_EQ(STATUS_Success, client.getStatusCode(iaid));
// Release the acquired lease.
auto lease = LeaseMgrFactory::instance().getLease6(Lease::TYPE_NA, leases[0].addr_);
lease->state_ = Lease::STATE_EXPIRED_RECLAIMED;
LeaseMgrFactory::instance().updateLease6(lease);
// Try to decline the reclaimed lease.
ASSERT_NO_THROW(client.doDecline());
// The address should not be declined. It should still be in the
// reclaimed state.
lease = LeaseMgrFactory::instance().getLease6(Lease::TYPE_NA, lease->addr_);
ASSERT_TRUE(lease);
EXPECT_EQ(Lease::STATE_EXPIRED_RECLAIMED, lease->state_);
}
} // end of anonymous namespace
|