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 | // 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 <dhcp/pkt6.h>
#include <dhcp/iface_mgr.h>
#include <dhcp/testutils/iface_mgr_test_config.h>
#include <dhcp/testutils/pkt_filter6_test_stub.h>
#include <dhcp6/dhcp6to4_ipc.h>
#include <dhcpsrv/cfgmgr.h>
#include <dhcpsrv/testutils/dhcp4o6_test_ipc.h>
#include <stats/stats_mgr.h>
#include <hooks/callout_handle.h>
#include <hooks/hooks_manager.h>
#include <hooks/library_handle.h>
#include <gtest/gtest.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <stdint.h><--- 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::dhcp;
using namespace isc::dhcp::test;
using namespace isc::stats;
using namespace isc::hooks;
using namespace isc::util;
namespace {
/// @brief Port number used in tests.
const uint16_t TEST_PORT = 32000;
/// @brief Define short name for the test IPC.
typedef Dhcp4o6TestIpc TestIpc;
/// @brief Test fixture class for DHCPv4 endpoint of DHCPv4o6 IPC.
class Dhcp6to4IpcTest : public ::testing::Test {
public:
/// @brief Constructor
///
/// Configures IPC to use a test port. It also provides a fake
/// configuration of interfaces and opens IPv6 sockets.
Dhcp6to4IpcTest()
: iface_mgr_test_config_(true) {
IfaceMgr::instance().openSockets6();
configurePort(TEST_PORT);
// Install buffer6_send_callout
EXPECT_NO_THROW(HooksManager::preCalloutsLibraryHandle().
registerCallout("buffer6_send", buffer6_send_callout));
// Let's wipe all existing statistics.
StatsMgr::instance().removeAll();
// Reset the flag which we expect to be set in the callout.
callback_pkt_options_copy_ = false;
}
/// @brief Destructor
///
/// Various cleanups.
virtual ~Dhcp6to4IpcTest() {
Dhcp6to4Ipc::client_port = 0;
HooksManager::preCalloutsLibraryHandle().deregisterAllCallouts("buffer6_send");
callback_pkt_.reset();
bool status = HooksManager::unloadLibraries();
if (!status) {
std::cerr << "(fixture dtor) unloadLibraries failed" << std::endl;
}
}
/// @brief Configure DHCP4o6 port.
///
/// @param port New port.
void configurePort(const uint16_t port);
/// @brief Creates an instance of the DHCPv4o6 Message option.
///
/// The option will contain an empty DHCPREQUEST message, with
/// just the Message Type option inside and nothing else.
///
/// @return Pointer to the instance of the DHCPv4-query Message option.
OptionPtr createDHCPv4MsgOption() const;
/// @brief Handler for the buffer6_send hook
///
/// @param callout_handle handle passed by the hooks framework
/// @return always 0
static int
buffer6_send_callout(CalloutHandle& callout_handle) {
callout_handle.getArgument("response6", callback_pkt_);
if (callback_pkt_) {
callback_pkt_options_copy_ = callback_pkt_->isCopyRetrievedOptions();
}
return (0);
}
/// @brief Response Pkt6 shared pointer returned in the callout
static Pkt6Ptr callback_pkt_;
/// Flag indicating if copying retrieved options was enabled for
/// a received packet during callout execution.
static bool callback_pkt_options_copy_;
private:
/// @brief Provides fake configuration of interfaces.
IfaceMgrTestConfig iface_mgr_test_config_;
};
Pkt6Ptr Dhcp6to4IpcTest::callback_pkt_;
bool Dhcp6to4IpcTest::callback_pkt_options_copy_;
void
Dhcp6to4IpcTest::configurePort(const uint16_t port) {
CfgMgr::instance().getStagingCfg()->setDhcp4o6Port(port);
}
OptionPtr
Dhcp6to4IpcTest::createDHCPv4MsgOption() const {
// Create the DHCPv4 message.
Pkt4Ptr pkt(new Pkt4(DHCPREQUEST, 1234));
// Make a wire representation of the DHCPv4 message.
pkt->pack();
const OptionBuffer& option_buffer = pkt->getBuffer().getVector();
// Create the DHCPv4 Message option holding the created message.
OptionPtr opt_msg(new Option(Option::V6, D6O_DHCPV4_MSG, option_buffer));
return (opt_msg);
}
// This test verifies that the IPC returns an error when trying to bind
// to the out of range port.
TEST_F(Dhcp6to4IpcTest, invalidPortError) {<--- syntax error
// Create instance of the IPC endpoint under test with out-of-range port.
configurePort(65535);
Dhcp6to4Ipc& ipc = Dhcp6to4Ipc::instance();
EXPECT_THROW(ipc.open(), isc::OutOfRange);
}
// This test verifies that the DHCPv4 endpoint of the DHCPv4o6 IPC can
// receive messages.
TEST_F(Dhcp6to4IpcTest, receive) {
// Create instance of the IPC endpoint under test.
Dhcp6to4Ipc& ipc = Dhcp6to4Ipc::instance();
// Create instance of the IPC endpoint being used as a source of messages.
TestIpc src_ipc(TEST_PORT, TestIpc::ENDPOINT_TYPE_V4);
// Reset the IPC.
ASSERT_NO_THROW(ipc.close());
// Open both endpoints.
ASSERT_NO_THROW(ipc.open());
ASSERT_NO_THROW(src_ipc.open());
// Get statistics
StatsMgr& mgr = StatsMgr::instance();
ObservationPtr pkt6_snd = mgr.getObservation("pkt6-sent");
ObservationPtr d4_resp = mgr.getObservation("pkt6-dhcpv4-response-sent");
EXPECT_FALSE(pkt6_snd);
EXPECT_FALSE(d4_resp);
// Create message to be sent over IPC.
Pkt6Ptr pkt(new Pkt6(DHCPV6_DHCPV4_RESPONSE, 1234));
pkt->addOption(createDHCPv4MsgOption());
pkt->setIface("eth0");
pkt->setIndex(ETH0_INDEX);
pkt->setRemoteAddr(IOAddress("2001:db8:1::123"));
ASSERT_NO_THROW(pkt->pack());
// Reset the callout cached packet
Dhcp6to4IpcTest::callback_pkt_.reset();
// Send and wait up to 1 second to receive it.
ASSERT_NO_THROW(src_ipc.send(pkt));
ASSERT_NO_THROW(IfaceMgr::instance().receive6(1, 0));
// Make sure that the received packet was configured to return copy of
// retrieved options within a callout.
EXPECT_TRUE(callback_pkt_options_copy_);
// Get the forwarded packet from the callout
Pkt6Ptr forwarded = Dhcp6to4IpcTest::callback_pkt_;
ASSERT_TRUE(forwarded);
// Verify the packet received.
EXPECT_EQ(DHCP6_CLIENT_PORT, forwarded->getRemotePort());
EXPECT_EQ(forwarded->getType(), pkt->getType());
EXPECT_TRUE(forwarded->getOption(D6O_DHCPV4_MSG));
EXPECT_EQ("eth0", forwarded->getIface());
EXPECT_EQ(ETH0_INDEX, forwarded->getIndex());
EXPECT_EQ("2001:db8:1::123", forwarded->getRemoteAddr().toText());
// Verify statistics
pkt6_snd = mgr.getObservation("pkt6-sent");
d4_resp = mgr.getObservation("pkt6-dhcpv4-response-sent");
ASSERT_TRUE(pkt6_snd);
ASSERT_TRUE(d4_resp);
EXPECT_EQ(1, pkt6_snd->getInteger().first);
EXPECT_EQ(1, d4_resp->getInteger().first);
}
// This test verifies that the DHCPv4 endpoint of the DHCPv4o6 IPC can
// receive relayed messages.
// This is currently not supported: it is a known defect addressed by #4296.
TEST_F(Dhcp6to4IpcTest, DISABLED_receiveRelayed) {
// Create instance of the IPC endpoint under test.
Dhcp6to4Ipc& ipc = Dhcp6to4Ipc::instance();
// Create instance of the IPC endpoint being used as a source of messages.
TestIpc src_ipc(TEST_PORT, TestIpc::ENDPOINT_TYPE_V4);
// Reset the IPC.
ASSERT_NO_THROW(ipc.close());
// Open both endpoints.
ASSERT_NO_THROW(ipc.open());
ASSERT_NO_THROW(src_ipc.open());
// Get statistics
StatsMgr& mgr = StatsMgr::instance();
ObservationPtr pkt6_snd = mgr.getObservation("pkt6-sent");
ObservationPtr d4_resp = mgr.getObservation("pkt6-dhcpv4-response-sent");
EXPECT_FALSE(pkt6_snd);
EXPECT_FALSE(d4_resp);
// Create relayed message to be sent over IPC.
Pkt6Ptr pkt(new Pkt6(DHCPV6_DHCPV4_RESPONSE, 1234));
pkt->addOption(createDHCPv4MsgOption());
Pkt6::RelayInfo relay;
relay.linkaddr_ = IOAddress("3000:1::1");
relay.peeraddr_ = IOAddress("fe80::1");
relay.msg_type_ = DHCPV6_RELAY_FORW;
relay.hop_count_ = 1;
pkt->relay_info_.push_back(relay);
pkt->setIface("eth0");
pkt->setIndex(ETH0_INDEX);
pkt->setRemoteAddr(IOAddress("2001:db8:1::123"));
ASSERT_NO_THROW(pkt->pack());
// Reset the callout cached packet
Dhcp6to4IpcTest::callback_pkt_.reset();
// Send and wait up to 1 second to receive it.
ASSERT_NO_THROW(src_ipc.send(pkt));
ASSERT_NO_THROW(IfaceMgr::instance().receive6(1, 0));
// Get the forwarded packet from the callout
Pkt6Ptr forwarded = Dhcp6to4IpcTest::callback_pkt_;
ASSERT_TRUE(forwarded);
// Verify the packet received.
EXPECT_EQ(DHCP6_CLIENT_PORT, forwarded->getRemotePort());
EXPECT_EQ(forwarded->getType(), pkt->getType());
EXPECT_TRUE(forwarded->getOption(D6O_DHCPV4_MSG));
EXPECT_EQ("eth0", forwarded->getIface());
EXPECT_EQ(ETH0_INDEX, forwarded->getIndex());
EXPECT_EQ("2001:db8:1::123", forwarded->getRemoteAddr().toText());
EXPECT_EQ(DHCP6_CLIENT_PORT, forwarded->getRemotePort());
// Verify statistics
pkt6_snd = mgr.getObservation("pkt6-sent");
d4_resp = mgr.getObservation("pkt6-dhcpv4-response-sent");
ASSERT_TRUE(pkt6_snd);
ASSERT_TRUE(d4_resp);
EXPECT_EQ(1, pkt6_snd->getInteger().first);
EXPECT_EQ(1, d4_resp->getInteger().first);
}
// This test verifies the client port is enforced also with DHCP4o6.
TEST_F(Dhcp6to4IpcTest, clientPort) {
// Create instance of the IPC endpoint under test.
Dhcp6to4Ipc& ipc = Dhcp6to4Ipc::instance();
// Set the client port.
ipc.client_port = 1234;
// Create instance of the IPC endpoint being used as a source of messages.
TestIpc src_ipc(TEST_PORT, TestIpc::ENDPOINT_TYPE_V4);
// Reset the IPC.
ASSERT_NO_THROW(ipc.close());
// Open both endpoints.
ASSERT_NO_THROW(ipc.open());
ASSERT_NO_THROW(src_ipc.open());
// Create message to be sent over IPC.
Pkt6Ptr pkt(new Pkt6(DHCPV6_DHCPV4_RESPONSE, 1234));
pkt->addOption(createDHCPv4MsgOption());
pkt->setIface("eth0");
pkt->setIndex(ETH0_INDEX);
pkt->setRemoteAddr(IOAddress("2001:db8:1::123"));
ASSERT_NO_THROW(pkt->pack());
// Reset the callout cached packet
Dhcp6to4IpcTest::callback_pkt_.reset();
// Send and wait up to 1 second to receive it.
ASSERT_NO_THROW(src_ipc.send(pkt));
ASSERT_NO_THROW(IfaceMgr::instance().receive6(1, 0));
// Make sure that the received packet was configured to return copy of
// retrieved options within a callout.
EXPECT_TRUE(callback_pkt_options_copy_);
// Get the forwarded packet from the callout
Pkt6Ptr forwarded = Dhcp6to4IpcTest::callback_pkt_;
ASSERT_TRUE(forwarded);
// Verify the packet received.
EXPECT_EQ(ipc.client_port, forwarded->getRemotePort());
}
} // end of anonymous namespace
|