-
Notifications
You must be signed in to change notification settings - Fork 37
/
conf-file-processor.cpp
677 lines (593 loc) · 20.4 KB
/
conf-file-processor.cpp
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
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
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2014-2023, The University of Memphis,
* Regents of the University of California,
* Arizona Board of Regents.
*
* This file is part of NLSR (Named-data Link State Routing).
* See AUTHORS.md for complete list of NLSR authors and contributors.
*
* NLSR is free software: you can redistribute it and/or modify it under the terms
* of the GNU General Public License as published by the Free Software Foundation,
* either version 3 of the License, or (at your option) any later version.
*
* NLSR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
*/
#include "conf-file-processor.hpp"
#include "adjacent.hpp"
#include "update/prefix-update-processor.hpp"
#include "utility/name-helper.hpp"
#include <ndn-cxx/name.hpp>
#include <ndn-cxx/net/face-uri.hpp>
#include <ndn-cxx/util/io.hpp>
#include <boost/filesystem.hpp>
#include <boost/property_tree/info_parser.hpp>
#include <fstream>
#include <iostream>
namespace bf = boost::filesystem;
namespace nlsr {
template <class T>
class ConfigurationVariable
{
public:
typedef std::function<void(T)> ConfParameterCallback;
ConfigurationVariable(const std::string& key, const ConfParameterCallback& setter)
: m_key(key)
, m_setterCallback(setter)
, m_minValue(0)
, m_maxValue(0)
, m_shouldCheckRange(false)
, m_isRequired(true)
{
}
bool
parseFromConfigSection(const ConfigSection& section)
{
try {
T value = section.get<T>(m_key);
if (!isValidValue(value)) {
return false;
}
m_setterCallback(value);
return true;
}
catch (const std::exception& ex) {
if (m_isRequired) {
std::cerr << ex.what() << std::endl;
std::cerr << "Missing required configuration variable" << std::endl;
return false;
}
else {
m_setterCallback(m_defaultValue);
return true;
}
}
return false;
}
void
setMinAndMaxValue(T min, T max)
{
m_minValue = min;
m_maxValue = max;
m_shouldCheckRange = true;
}
void
setOptional(T defaultValue)
{
m_isRequired = false;
m_defaultValue = defaultValue;
}
private:
void
printOutOfRangeError(T value)
{
std::cerr << "Invalid value for " << m_key << ": "
<< value << ". "
<< "Valid values: "
<< m_minValue << " - "
<< m_maxValue << std::endl;
}
bool
isValidValue(T value)
{
if (!m_shouldCheckRange) {
return true;
}
else if (value < m_minValue || value > m_maxValue)
{
printOutOfRangeError(value);
return false;
}
return true;
}
private:
const std::string m_key;
const ConfParameterCallback m_setterCallback;
T m_defaultValue;
T m_minValue;
T m_maxValue;
bool m_shouldCheckRange;
bool m_isRequired;
};
ConfFileProcessor::ConfFileProcessor(ConfParameter& confParam)
: m_confFileName(confParam.getConfFileName())
, m_confParam(confParam)
{
}
bool
ConfFileProcessor::processConfFile()
{
std::ifstream inputFile(m_confFileName);
if (!inputFile.is_open()) {
std::cerr << "Failed to read configuration file: " << m_confFileName << std::endl;
return false;
}
if (!load(inputFile)) {
return false;
}
m_confParam.buildRouterAndSyncUserPrefix();
m_confParam.writeLog();
return true;
}
bool
ConfFileProcessor::load(std::istream& input)
{
ConfigSection pt;
try {
boost::property_tree::read_info(input, pt);
}
catch (const boost::property_tree::ptree_error& e) {
std::cerr << "Failed to parse configuration file '" << m_confFileName
<< "': " << e.what() << std::endl;
return false;
}
for (const auto& tn : pt) {
if (!processSection(tn.first, tn.second)) {
return false;
}
}
return true;
}
bool
ConfFileProcessor::processSection(const std::string& sectionName, const ConfigSection& section)
{
bool ret = true;
if (sectionName == "general") {
ret = processConfSectionGeneral(section);
}
else if (sectionName == "neighbors") {
ret = processConfSectionNeighbors(section);
}
else if (sectionName == "hyperbolic") {
ret = processConfSectionHyperbolic(section);
}
else if (sectionName == "fib") {
ret = processConfSectionFib(section);
}
else if (sectionName == "advertising") {
ret = processConfSectionAdvertising(section);
}
else if (sectionName == "security") {
ret = processConfSectionSecurity(section);
}
else {
std::cerr << "Unknown configuration section: " << sectionName << std::endl;
}
return ret;
}
bool
ConfFileProcessor::processConfSectionGeneral(const ConfigSection& section)
{
// sync-protocol
std::string syncProtocol = section.get<std::string>("sync-protocol", "psync");
if (syncProtocol == "chronosync") {
#ifdef HAVE_CHRONOSYNC
m_confParam.setSyncProtocol(SyncProtocol::CHRONOSYNC);
#else
std::cerr << "NLSR was compiled without ChronoSync support!\n";
return false;
#endif
}
else if (syncProtocol == "psync") {
#ifdef HAVE_PSYNC
m_confParam.setSyncProtocol(SyncProtocol::PSYNC);
#else
std::cerr << "NLSR was compiled without PSync support!\n";
return false;
#endif
}
else if (syncProtocol == "svs") {
#ifdef HAVE_SVS
m_confParam.setSyncProtocol(SyncProtocol::SVS);
#else
std::cerr << "NLSR was compiled without SVS support!\n";
return false;
#endif
}
else {
std::cerr << "Sync protocol '" << syncProtocol << "' is not supported!\n"
<< "Use 'chronosync' or 'psync' or 'svs'\n";
return false;
}
try {
std::string network = section.get<std::string>("network");
std::string site = section.get<std::string>("site");
std::string router = section.get<std::string>("router");
ndn::Name networkName(network);
if (!networkName.empty()) {
m_confParam.setNetwork(networkName);
}
else {
std::cerr << "Network can not be null or empty or in bad URI format" << std::endl;
return false;
}
ndn::Name siteName(site);
if (!siteName.empty()) {
m_confParam.setSiteName(siteName);
}
else {
std::cerr << "Site can not be null or empty or in bad URI format" << std::endl;
return false;
}
ndn::Name routerName(router);
if (!routerName.empty()) {
m_confParam.setRouterName(routerName);
}
else {
std::cerr << "Router name can not be null or empty or in bad URI format" << std::endl;
return false;
}
}
catch (const std::exception& ex) {
std::cerr << ex.what() << std::endl;
return false;
}
// lsa-refresh-time
uint32_t lsaRefreshTime = section.get<uint32_t>("lsa-refresh-time", LSA_REFRESH_TIME_DEFAULT);
if (lsaRefreshTime >= LSA_REFRESH_TIME_MIN && lsaRefreshTime <= LSA_REFRESH_TIME_MAX) {
m_confParam.setLsaRefreshTime(lsaRefreshTime);
}
else {
std::cerr << "Invalid value for lsa-refresh-time. "
<< "Allowed range: " << LSA_REFRESH_TIME_MIN
<< "-" << LSA_REFRESH_TIME_MAX << std::endl;
return false;
}
// router-dead-interval
uint32_t routerDeadInterval = section.get<uint32_t>("router-dead-interval", 2 * lsaRefreshTime);
if (routerDeadInterval > m_confParam.getLsaRefreshTime()) {
m_confParam.setRouterDeadInterval(routerDeadInterval);
}
else {
std::cerr << "Value of router-dead-interval must be larger than lsa-refresh-time" << std::endl;
return false;
}
// lsa-interest-lifetime
int lifetime = section.get<int>("lsa-interest-lifetime", LSA_INTEREST_LIFETIME_DEFAULT);
if (lifetime >= LSA_INTEREST_LIFETIME_MIN && lifetime <= LSA_INTEREST_LIFETIME_MAX) {
m_confParam.setLsaInterestLifetime(ndn::time::seconds(lifetime));
}
else {
std::cerr << "Invalid value for lsa-interest-timeout. "
<< "Allowed range: " << LSA_INTEREST_LIFETIME_MIN
<< "-" << LSA_INTEREST_LIFETIME_MAX << std::endl;
return false;
}
// sync-interest-lifetime
uint32_t syncInterestLifetime = section.get<uint32_t>("sync-interest-lifetime",
SYNC_INTEREST_LIFETIME_DEFAULT);
if (syncInterestLifetime >= SYNC_INTEREST_LIFETIME_MIN &&
syncInterestLifetime <= SYNC_INTEREST_LIFETIME_MAX) {
m_confParam.setSyncInterestLifetime(syncInterestLifetime);
}
else {
std::cerr << "Invalid value for sync-interest-lifetime. "
<< "Allowed range: " << SYNC_INTEREST_LIFETIME_MIN
<< "-" << SYNC_INTEREST_LIFETIME_MAX << std::endl;
return false;
}
try {
std::string stateDir = section.get<std::string>("state-dir");
if (bf::exists(stateDir)) {
if (bf::is_directory(stateDir)) {
// copying nlsr.conf file to a user-defined directory for possible modification
std::string conFileDynamic = (bf::path(stateDir) / "nlsr.conf").string();
if (m_confFileName == conFileDynamic) {
std::cerr << "Please use nlsr.conf stored at another location "
<< "or change the state-dir in the configuration." << std::endl;
std::cerr << "The file at " << conFileDynamic <<
" is used as dynamic file for saving NLSR runtime changes." << std::endl;
std::cerr << "The dynamic file can be used for next run "
<< "after copying to another location." << std::endl;
return false;
}
m_confParam.setConfFileNameDynamic(conFileDynamic);
try {
bf::copy_file(m_confFileName, conFileDynamic,
#if BOOST_VERSION >= 107400
bf::copy_options::overwrite_existing
#else
bf::copy_option::overwrite_if_exists
#endif
);
}
catch (const bf::filesystem_error& e) {
std::cerr << "Error copying conf file to the state directory: " << e.what() << std::endl;
return false;
}
std::string testFileName = (bf::path(stateDir) / "test.seq").string();
std::ofstream testOutFile(testFileName);
if (testOutFile) {
m_confParam.setStateFileDir(stateDir);
}
else {
std::cerr << "NLSR does not have read/write permission on the state directory" << std::endl;
return false;
}
testOutFile.close();
remove(testFileName.c_str());
}
else {
std::cerr << "Provided path '" << stateDir << "' is not a directory" << std::endl;
return false;
}
}
else {
std::cerr << "Provided state directory '" << stateDir << "' does not exist" << std::endl;
return false;
}
}
catch (const std::exception& ex) {
std::cerr << "You must configure state directory" << std::endl;
std::cerr << ex.what() << std::endl;
return false;
}
return true;
}
bool
ConfFileProcessor::processConfSectionNeighbors(const ConfigSection& section)
{
// hello-retries
int retrials = section.get<int>("hello-retries", HELLO_RETRIES_DEFAULT);
if (retrials >= HELLO_RETRIES_MIN && retrials <= HELLO_RETRIES_MAX) {
m_confParam.setInterestRetryNumber(retrials);
}
else {
std::cerr << "Invalid value for hello-retries. "
<< "Allowed range: " << HELLO_RETRIES_MIN << "-" << HELLO_RETRIES_MAX << std::endl;
return false;
}
// hello-timeout
uint32_t timeOut = section.get<uint32_t>("hello-timeout", HELLO_TIMEOUT_DEFAULT);
if (timeOut >= HELLO_TIMEOUT_MIN && timeOut <= HELLO_TIMEOUT_MAX) {
m_confParam.setInterestResendTime(timeOut);
}
else {
std::cerr << "Invalid value for hello-timeout. "
<< "Allowed range: " << HELLO_TIMEOUT_MIN << "-" << HELLO_TIMEOUT_MAX << std::endl;
return false;
}
// hello-interval
uint32_t interval = section.get<uint32_t>("hello-interval", HELLO_INTERVAL_DEFAULT);
if (interval >= HELLO_INTERVAL_MIN && interval <= HELLO_INTERVAL_MAX) {
m_confParam.setInfoInterestInterval(interval);
}
else {
std::cerr << "Invalid value for hello-interval. "
<< "Allowed range: " << HELLO_INTERVAL_MIN << "-" << HELLO_INTERVAL_MAX << std::endl;
return false;
}
// Event intervals
// adj-lsa-build-interval
ConfigurationVariable<uint32_t> adjLsaBuildInterval("adj-lsa-build-interval",
std::bind(&ConfParameter::setAdjLsaBuildInterval,
&m_confParam, _1));
adjLsaBuildInterval.setMinAndMaxValue(ADJ_LSA_BUILD_INTERVAL_MIN, ADJ_LSA_BUILD_INTERVAL_MAX);
adjLsaBuildInterval.setOptional(ADJ_LSA_BUILD_INTERVAL_DEFAULT);
if (!adjLsaBuildInterval.parseFromConfigSection(section)) {
return false;
}
// Set the retry count for fetching the FaceStatus dataset
ConfigurationVariable<uint32_t> faceDatasetFetchTries("face-dataset-fetch-tries",
std::bind(&ConfParameter::setFaceDatasetFetchTries,
&m_confParam, _1));
faceDatasetFetchTries.setMinAndMaxValue(FACE_DATASET_FETCH_TRIES_MIN,
FACE_DATASET_FETCH_TRIES_MAX);
faceDatasetFetchTries.setOptional(FACE_DATASET_FETCH_TRIES_DEFAULT);
if (!faceDatasetFetchTries.parseFromConfigSection(section)) {
return false;
}
// Set the interval between FaceStatus dataset fetch attempts.
ConfigurationVariable<uint32_t> faceDatasetFetchInterval("face-dataset-fetch-interval",
std::bind(&ConfParameter::setFaceDatasetFetchInterval,
&m_confParam, _1));
faceDatasetFetchInterval.setMinAndMaxValue(FACE_DATASET_FETCH_INTERVAL_MIN,
FACE_DATASET_FETCH_INTERVAL_MAX);
faceDatasetFetchInterval.setOptional(FACE_DATASET_FETCH_INTERVAL_DEFAULT);
if (!faceDatasetFetchInterval.parseFromConfigSection(section)) {
return false;
}
for (const auto& tn : section) {
if (tn.first == "neighbor") {
try {
ConfigSection CommandAttriTree = tn.second;
std::string name = CommandAttriTree.get<std::string>("name");
std::string uriString = CommandAttriTree.get<std::string>("face-uri");
ndn::FaceUri faceUri;
if (!faceUri.parse(uriString)) {
std::cerr << "face-uri parsing failed" << std::endl;
return false;
}
bool failedToCanonize = false;
faceUri.canonize([&faceUri] (const auto& canonicalUri) {
faceUri = canonicalUri;
},
[&faceUri, &failedToCanonize] (const auto& reason) {
failedToCanonize = true;
std::cerr << "Could not canonize URI: '" << faceUri
<< "' because: " << reason << std::endl;
},
m_io,
TIME_ALLOWED_FOR_CANONIZATION);
m_io.run();
m_io.reset();
if (failedToCanonize) {
return false;
}
double linkCost = CommandAttriTree.get<double>("link-cost", Adjacent::DEFAULT_LINK_COST);
ndn::Name neighborName(name);
if (!neighborName.empty()) {
Adjacent adj(name, faceUri, linkCost, Adjacent::STATUS_INACTIVE, 0, 0);
m_confParam.getAdjacencyList().insert(adj);
}
else {
std::cerr << " Wrong command format ! [name /nbr/name/ \n face-uri /uri\n]";
std::cerr << " or bad URI format" << std::endl;
}
}
catch (const std::exception& ex) {
std::cerr << ex.what() << std::endl;
return false;
}
}
}
return true;
}
bool
ConfFileProcessor::processConfSectionHyperbolic(const ConfigSection& section)
{
// state
std::string state = section.get<std::string>("state", "off");
if (boost::iequals(state, "off")) {
m_confParam.setHyperbolicState(HYPERBOLIC_STATE_OFF);
}
else if (boost::iequals(state, "on")) {
m_confParam.setHyperbolicState(HYPERBOLIC_STATE_ON);
}
else if (boost::iequals(state, "dry-run")) {
m_confParam.setHyperbolicState(HYPERBOLIC_STATE_DRY_RUN);
}
else {
std::cerr << "Invalid setting for hyperbolic state. "
<< "Allowed values: off, on, dry-run" << std::endl;
return false;
}
try {
// Radius and angle(s) are mandatory configuration parameters in hyperbolic section.
// Even if router can have hyperbolic routing calculation off but other router
// in the network may use hyperbolic routing calculation for FIB generation.
// So each router need to advertise its hyperbolic coordinates in the network
double radius = section.get<double>("radius");
std::string angleString = section.get<std::string>("angle");
std::stringstream ss(angleString);
std::vector<double> angles;
double angle;
while (ss >> angle) {
angles.push_back(angle);
if (ss.peek() == ',' || ss.peek() == ' ') {
ss.ignore();
}
}
if (!m_confParam.setCorR(radius)) {
return false;
}
m_confParam.setCorTheta(angles);
}
catch (const std::exception& ex) {
std::cerr << ex.what() << std::endl;
if (state == "on" || state == "dry-run") {
return false;
}
}
return true;
}
bool
ConfFileProcessor::processConfSectionFib(const ConfigSection& section)
{
// max-faces-per-prefix
int maxFacesPerPrefix = section.get<int>("max-faces-per-prefix", MAX_FACES_PER_PREFIX_DEFAULT);
if (maxFacesPerPrefix >= MAX_FACES_PER_PREFIX_MIN &&
maxFacesPerPrefix <= MAX_FACES_PER_PREFIX_MAX) {
m_confParam.setMaxFacesPerPrefix(maxFacesPerPrefix);
}
else {
std::cerr << "Invalid value for max-faces-per-prefix. "
<< "Allowed range: " << MAX_FACES_PER_PREFIX_MIN
<< "-" << MAX_FACES_PER_PREFIX_MAX << std::endl;
return false;
}
// routing-calc-interval
ConfigurationVariable<uint32_t> routingCalcInterval("routing-calc-interval",
std::bind(&ConfParameter::setRoutingCalcInterval,
&m_confParam, _1));
routingCalcInterval.setMinAndMaxValue(ROUTING_CALC_INTERVAL_MIN, ROUTING_CALC_INTERVAL_MAX);
routingCalcInterval.setOptional(ROUTING_CALC_INTERVAL_DEFAULT);
if (!routingCalcInterval.parseFromConfigSection(section)) {
return false;
}
return true;
}
bool
ConfFileProcessor::processConfSectionAdvertising(const ConfigSection& section)
{
for (const auto& tn : section) {
if (tn.first == "prefix") {
try {
ndn::Name namePrefix(tn.second.data());
if (!namePrefix.empty()) {
m_confParam.getNamePrefixList().insert(namePrefix);
}
else {
std::cerr << " Wrong command format ! [prefix /name/prefix] or bad URI" << std::endl;
return false;
}
}
catch (const std::exception& ex) {
std::cerr << ex.what() << std::endl;
return false;
}
}
}
return true;
}
bool
ConfFileProcessor::processConfSectionSecurity(const ConfigSection& section)
{
auto it = section.begin();
if (it == section.end() || it->first != "validator") {
std::cerr << "Error: Expected validator section!" << std::endl;
return false;
}
m_confParam.getValidator().load(it->second, m_confFileName);
it++;
if (it != section.end() && it->first == "prefix-update-validator") {
m_confParam.getPrefixUpdateValidator().load(it->second, m_confFileName);
it++;
for (; it != section.end(); it++) {
if (it->first != "cert-to-publish") {
std::cerr << "Error: Expected cert-to-publish!" << std::endl;
return false;
}
std::string file = it->second.data();
bf::path certfilePath = absolute(file, bf::path(m_confFileName).parent_path());
std::ifstream ifs(certfilePath.string());
ndn::security::Certificate idCert;
try {
idCert = ndn::io::loadTlv<ndn::security::Certificate>(ifs);
}
catch (const std::exception& e) {
std::cerr << "Error: Cannot load cert-to-publish '" << file << "': " << e.what() << std::endl;
return false;
}
m_confParam.addCertPath(certfilePath.string());
m_confParam.loadCertToValidator(idCert);
}
}
return true;
}
} // namespace nlsr