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
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
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
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577 | // Copyright (C) 2017-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 <host_cmds.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <config/command_mgr.h>
#include <config/cmds_impl.h>
#include <host_data_parser.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <cc/command_interpreter.h>
#include <cc/simple_parser.h>
#include <cc/data.h>
#include <asiolink/io_address.h>
#include <host_cmds_log.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <dhcpsrv/cfgmgr.h>
#include <dhcpsrv/host_mgr.h>
#include <dhcpsrv/cfg_hosts.h>
#include <dhcpsrv/cfg_subnets4.h>
#include <dhcpsrv/cfg_subnets6.h>
#include <dhcpsrv/subnet_id.h>
#include <util/encode/encode.h>
#include <util/str.h>
#include <exceptions/exceptions.h>
#include <boost/algorithm/string.hpp><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <boost/foreach.hpp><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <string><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <sstream><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
using namespace isc::dhcp;
using namespace isc::data;
using namespace isc::config;
using namespace isc::asiolink;
using namespace isc::hooks;
using namespace std;
namespace isc {
namespace host_cmds {
/// @brief Wrapper class around reservation command handlers.
class HostCmdsImpl : private CmdsImpl {
public:
/// @brief Constructor.
HostCmdsImpl();
/// @brief Destructor.
~HostCmdsImpl();
/// @brief Parameters specified for reservation-get and reservation-del
///
/// As both call types (get and delete) need specify which reservation to
/// act on, they have the same set of parameters. In particular, those
/// two call types support the following sets of parameters:
/// - subnet-id, address
/// - subnet-id, identifier type, identifier value
///
/// This class stores those parameters and is used to pass them around.
class Parameters {
public:
/// @brief Specifies subnet-id
SubnetID subnet_id;
/// @brief Specifies if subnet-id is present
bool has_subnet_id;
/// @brief Specifies IPv4 or IPv6 address (used when query_by_addr is true)
IOAddress addr;
/// @brief Specifies identifier type (usually FLEX_ID, used when
/// query_by_addr is false)
Host::IdentifierType type;
/// @brief Specifies identifier value (used when query_by_addr is false)
std::vector<uint8_t> ident;
/// @brief Specifies parameter types (true = query by address, false =
/// query by identifier-type,identifier)
bool query_by_addr;
/// @brief Specifies page limit (no default).
size_t page_limit;
/// @brief Specifies source index (default 0).
size_t source_index;
/// @brief Specifies host identifier (default 0).
uint64_t host_id;
/// @brief Specifies host name (default "").
std::string hostname;
/// @brief Specifies the target host source (default UNSPECIFIED_SOURCE
/// which means the default host source is command-related).
HostMgrOperationTarget operation_target;
/// @brief Default constructor.
Parameters()
: subnet_id(0), has_subnet_id(false), addr("::"),
type(Host::IdentifierType::IDENT_HWADDR), query_by_addr(true),
page_limit(0), source_index(0), host_id(0),
operation_target(HostMgrOperationTarget::UNSPECIFIED_SOURCE) {
}
};
public:
/// @brief reservation-add command handler
///
/// Provides the implementation for @ref isc::host_cmds::HostCmds::reservationAddHandler
///
/// @param handle Callout context - which is expected to contain the
/// add command JSON text in the "command" argument
/// @return 0 upon success, non-zero otherwise
int
reservationAddHandler(CalloutHandle& handle);
/// @brief reservation-get command handler
///
/// Provides the implementation for @ref isc::host_cmds::HostCmds::reservationGetHandler
///
/// @param handle Callout context - which is expected to contain the
/// get command JSON text in the "command" argument
/// @return 0 upon success, non-zero otherwise
int
reservationGetHandler(CalloutHandle& handle);
/// @brief reservation-get-by-address command handler
///
/// Provides the implementation for @ref isc::host_cmds::HostCmds::reservationGetByAddressHandler
///
/// @param handle Callout context - which is expected to contain the
/// get command JSON text in the "command" argument
/// @return 0 upon success, non-zero otherwise
int reservationGetByAddressHandler(CalloutHandle& handle);
/// @brief reservation-del command handler
///
/// Provides the implementation for @ref isc::host_cmds::HostCmds::reservationDelHandler
///
/// @param handle Callout context - which is expected to contain the
/// delete command JSON text in the "command" argument
/// @return 0 upon success, non-zero otherwise
int
reservationDelHandler(CalloutHandle& handle);
/// @brief reservation-get-all command handler
///
/// Provides the implementation for @ref isc::host_cmds::HostCmds::reservationGetAllHandler
///
/// @param handle Callout context - which is expected to contain the
/// reservation-get-all command JSON text in the "command" argument
/// @return 0 upon success, non-zero otherwise
int
reservationGetAllHandler(CalloutHandle& handle);
/// @brief reservation-get-page command handler
///
/// Provides the implementation for @ref isc::host_cmds::HostCmds::reservationGetPageHandler
///
/// @param handle Callout context - which is expected to contain the
/// reservation-get-page command JSON text in the "command" argument
/// @return 0 upon success, non-zero otherwise
int
reservationGetPageHandler(CalloutHandle& handle);
/// @brief reservation-get-by-hostname command handler
///
/// Provides the implementation for @ref isc::host_cmds::HostCmds::reservationGetByHostnameHandler
///
/// @param handle Callout context - which is expected to contain the
/// reservation-get-by-hostname command JSON text in the "command" argument
/// @return 0 upon success, non-zero otherwise
int
reservationGetByHostnameHandler(CalloutHandle& handle);
/// @brief reservation-get-by-id command handler
///
/// Provides the implementation for @ref isc::host_cmds::HostCmds::reservationGetByIdHandler
///
/// @param handle Callout context - which is expected to contain the
/// reservation-get-by-id command JSON text in the "command" argument
/// @return 0 upon success, non-zero otherwise
int
reservationGetByIdHandler(CalloutHandle& handle);
/// @brief reservation-update command handler
///
/// Provides the implementation for @ref isc::host_cmds::HostCmds::reservationUpdateHandler.
///
/// @param handle callout context
///
/// @return 0 upon success, non-zero otherwise
int
reservationUpdateHandler(CalloutHandle& handle);
private:
/// @brief Extracts parameters required for reservation-get and reservation-del
///
/// See @ref Parameters class for detailed description of what is expected
/// in the args structure.
///
/// @param args - arguments passed to command
/// @return parsed parameters
/// @throw BadValue if input arguments don't make sense.
Parameters getParameters(const ConstElementPtr& args);
/// @brief Extracts parameters required for reservation-get-all
///
/// See @ref Parameters class for detailed description of what is expected
/// in the args structure.
///
/// @param args - arguments passed to command
/// @return parsed parameters
/// @throw BadValue if input arguments don't make sense.
Parameters getAllParameters(const ConstElementPtr& args);
/// @brief Extracts parameters required for reservation-get-page
///
/// See @ref Parameters class for detailed description of what is expected
/// in the args structure.
///
/// @param args - arguments passed to command
/// @return parsed parameters
/// @throw BadValue if input arguments don't make sense.
Parameters getPageParameters(const ConstElementPtr& args);
/// @brief Extracts parameters required for reservation-get-by-hostname
///
/// See @ref Parameters class for detailed description of what is expected
/// in the args structure.
///
/// @param args - arguments passed to command
/// @return parsed parameters
/// @throw BadValue if input arguments don't make sense.
Parameters getByHostnameParameters(const ConstElementPtr& args);
/// @brief Extracts parameters required for reservation-get-by-id
///
/// See @ref Parameters class for detailed description of what is expected
/// in the args structure.
///
/// @param args - arguments passed to command
/// @return parsed parameters
/// @throw BadValue if input arguments don't make sense.
Parameters getByIdParameters(const ConstElementPtr& args);
/// @brief Extracts parameters required for reservation-get-by-address
///
/// See @ref Parameters class for detailed description of what is expected
/// in the args structure.
///
/// @param args - arguments passed to command
/// @return parsed parameters
/// @throw BadValue if input arguments don't make sense.
Parameters getByAddressParameters(const ConstElementPtr& params);
/// @brief Extract the operation target from the parameters.
/// @param args - arguments passed to command
/// @return OperationTarget enum value. The target is unspecified if the
/// related argument doesn't exist.
HostMgrOperationTarget getOperationTarget(const ConstElementPtr& args);
/// @brief Checks if the specified IPv4 subnet exists and the reserved address
/// belongs to this subnet.
///
/// @param subnet_id Subnet identifier. The value of 0 is allowed in which
/// case no checks are performed and the function simply returns.
/// @param address Reserved IPv4 address. If this address is 0 it indicates
/// that no IPv4 address reservation is made and therefore the address is
/// not checked against the selected subnet.
///
/// @throw isc::BadValue if the subnet id is specified but the subnet does
/// not exist or if the specified address does not belong to the subnet.
void validateHostForSubnet4(SubnetID subnet_id, const IOAddress& address);
/// @brief Checks if the specified IPv6 subnet exists and the reserved
/// addresses belong to this subnet.
///
/// @param subnet_id Subnet identifier. The value of 0 is allowed in which
/// case no checks are performed and the function simply returns.
/// @param addresses Reserved IPv6 addresses. This vector may be empty
/// indicating that no IPv6 address reservation is made.
///
/// @throw isc::BadValue if the subnet id is specified but the subnet does
/// not exist or if any of the specified addresses do not belong to the
/// subnet.
void validateHostForSubnet6(SubnetID subnet_id,
const std::vector<IOAddress>& addresses);
/// @brief Checks if the subnet is set in the given IPv4 host and
/// if not add a hint to the error message or return true when empty.
///
/// @param host The host.
/// @return false if the entry is valid, true if the entry must be
/// enforced to global (i.e. invalid empty host).
/// @throw isc::BadValue if the subnet is not set in the host.
bool checkHost4(const ConstHostPtr& host);
/// @brief Checks if the subnet is set in the given IPv6 host and
/// if not add a hint to the error message or return true when empty.
///
/// @param host The host.
/// @return false if the entry is valid, true if the entry must be
/// enforced to global (i.e. invalid empty host).
/// @throw isc::BadValue if the subnet is not set in the host.
bool checkHost6(const ConstHostPtr& host);
/// @brief Convenience pointer used to access database storage
HostDataSourcePtr db_storage_;
/// @brief Protocol family (IPv4 or IPv6)
uint16_t family_;
};
HostCmdsImpl::HostCmdsImpl() {
// There are two ways we can store host reservations: either in configuration
// or in DB backends. The prime interface we provide - HostMgr class - does
// not allow storing hosts if alternate data source (DB backend) is not
// available. Therefore we need to check both. If available, we will store
// reservations in SQL data source. If not, we will *one day* be able to
// update the configuration, but it is not possible yet. Current configuration
// is retrieved as const pointer. We would need a way to clone current
// configuration to staging, add a host and then commit the change.
// We need to think this through as we don't want to go through the whole
// reconfiguration process when a new host is added.
// Try to get alternate storage.
db_storage_ = HostMgr::instance().getHostDataSource();<--- Variable 'db_storage_' is assigned in constructor body. Consider performing initialization in initialization list. [+]When an object of a class is created, the constructors of all member variables are called consecutively in the order the variables are declared, even if you don't explicitly write them to the initialization list. You could avoid assigning 'db_storage_' a value by passing the value to the constructor in the initialization list.
// Try to get the configuration storage. This will come in handy one day.
// cfg_storage_ = CfgMgr::instance().getCurrentCfg()->getCfgHosts();
family_ = CfgMgr::instance().getFamily();
}
HostCmdsImpl::~HostCmdsImpl() {
db_storage_.reset();
}
int
HostCmdsImpl::reservationAddHandler(CalloutHandle& handle) {
string txt = "(missing parameters)";
bool force_global(false);
try {
extractCommand(handle);
if (cmd_args_) {
txt = cmd_args_->str();
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_ADD)
.arg(txt);
if (!cmd_args_) {
isc_throw(isc::BadValue, "no parameters specified for the command");
}
HostMgrOperationTarget operation_target = getOperationTarget(cmd_args_);
if (operation_target == HostMgrOperationTarget::UNSPECIFIED_SOURCE) {
operation_target = HostMgrOperationTarget::ALTERNATE_SOURCES;
}
ConstElementPtr reservation = cmd_args_->get("reservation");
if (!reservation) {
isc_throw(isc::BadValue, "reservation must be specified");
}
HostPtr host;
if (family_ == AF_INET) {
HostDataParser4 parser;
host = parser.parseWithSubnet(reservation, false);
force_global = checkHost4(host);
if (force_global) {
host->setIPv4SubnetID(SUBNET_ID_GLOBAL);
}
} else {
HostDataParser6 parser;
host = parser.parseWithSubnet(reservation, false);
force_global = checkHost6(host);
if (force_global) {
host->setIPv6SubnetID(SUBNET_ID_GLOBAL);
}
}
// If we haven't accessed db_storage_ yet, try to retrieve it.
if (!db_storage_) {
db_storage_ = HostMgr::instance().getHostDataSource();
}
if (!db_storage_ && operation_target == HostMgrOperationTarget::ALTERNATE_SOURCES) {
// If it's still not available, bail out.
isc_throw(isc::BadValue, "Host database not available, cannot add host.");
}
if (family_ == AF_INET) {
// Validate the IPv4 subnet id against configured subnet and also verify
// that the reserved IPv4 address (if non-zero) belongs to this subnet.
validateHostForSubnet4(host->getIPv4SubnetID(),
host->getIPv4Reservation());
} else {
// Retrieve all reserved addresses from the host. We're going to
// check if these addresses are in range with the specified subnet.
// If any of them is not in range, we will reject the command.
// Note that we do not validate delegated prefixes because they don't
// have to match the subnet prefix.
auto const& range = host->getIPv6Reservations(IPv6Resrv::TYPE_NA);
std::vector<IOAddress> addresses;
BOOST_FOREACH(auto const& address, range) {
addresses.push_back(address.second.getPrefix());
}
// Validate the IPv6 subnet id against configured subnet and also
// verify that the reserved IPv6 addresses (if any) belong to this
// subnet.
validateHostForSubnet6(host->getIPv6SubnetID(), addresses);
}
HostMgr::instance().add(host, operation_target);
} catch (const std::exception& ex) {
LOG_ERROR(host_cmds_logger, HOST_CMDS_RESERV_ADD_FAILED)
.arg(txt)
.arg(ex.what());
setErrorResponse(handle, ex.what());
return (1);
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_ADD_SUCCESS)
.arg(txt);
string msg("Host added.");
if (force_global) {
msg += " subnet-id not specified, assumed global (subnet-id 0).";
}
setSuccessResponse(handle, msg);
return (0);
}
HostCmdsImpl::Parameters
HostCmdsImpl::getParameters(const ConstElementPtr& params) {
Parameters x;
if (!params || params->getType() != Element::map) {
isc_throw(BadValue, "Parameters missing or are not a map.");
}
// We support 2 types of reservation-get:
// reservation-get(subnet-id, address, operation-target)
// reservation-get(subnet-id, identifier-type, identifier, operation-target)
ConstElementPtr addr = params->get("ip-address");
ConstElementPtr type = params->get("identifier-type");
ConstElementPtr ident = params->get("identifier");
if (params->contains("subnet-id") || (!addr && !type && !ident)) {
int64_t value = data::SimpleParser::getInteger(params, "subnet-id",
0, dhcp::SUBNET_ID_MAX);
x.subnet_id = static_cast<SubnetID>(value);
x.has_subnet_id = true;
} else {
x.has_subnet_id = false;
}
x.operation_target = getOperationTarget(params);
if (addr) {
if (addr->getType() != Element::string) {
isc_throw(BadValue, "'ip-address' is not a string.");
}
x.addr = IOAddress(addr->stringValue());
x.query_by_addr = true;
if (!x.has_subnet_id) {
isc_throw(BadValue, "missing parameter 'subnet-id', use "
"'reservation-get-by-address' with 'ip-address' set to \""
<< addr->stringValue() << "\" to get the list of "
<< "reservations with this address");
}
return (x);
}
// No address specified. Ok, so it must be identifier based query.
// "identifier-type": "duid",
// "identifier": "aa:bb:cc:dd:ee:..."
if (!type || type->getType() != Element::string) {
isc_throw(BadValue, "No 'ip-address' provided"
" and 'identifier-type' is either missing or not a string.");
}
if (!ident || ident->getType() != Element::string) {
isc_throw(BadValue, "No 'ip-address' provided"
" and 'identifier' is either missing or not a string.");
}
// Got the parameters. Let's see if their values make sense.
// Try to parse the identifier value first.
try {
x.ident = util::str::quotedStringToBinary(ident->stringValue());
if (x.ident.empty()) {
util::str::decodeFormattedHexString(ident->stringValue(),
x.ident);
}
} catch (...) {
// The string doesn't match any known pattern, so we have to
// report an error at this point.
isc_throw(BadValue, "Unable to parse 'identifier' value.");
}
if (x.ident.empty()) {
isc_throw(BadValue, "Unable to query for empty 'identifier'.");
}
// Next, try to convert identifier-type
try {
x.type = Host::getIdentifierType(type->stringValue());
} catch (const std::exception& ex) {
isc_throw(BadValue, "Value of 'identifier-type' was not recognized.");
}
x.query_by_addr = false;
if (!x.has_subnet_id) {
isc_throw(BadValue, "missing parameter 'subnet-id', use "
"'reservation-get-by-id' with 'identifier-type' set to \""
<< type->stringValue() << "\" and 'identifier' to \""
<< ident->stringValue() << "\" to get the list of "
<< "reservations with this identifier");
}
return (x);
}
void
HostCmdsImpl::validateHostForSubnet4(SubnetID subnet_id, const IOAddress& address) {
if (subnet_id != 0) {
auto cfg = CfgMgr::instance().getCurrentCfg()->getCfgSubnets4();
auto subnet = cfg->getBySubnetId(subnet_id);
if (!subnet) {
isc_throw(isc::BadValue,
"IPv4 subnet with ID of '" << subnet_id
<< "' is not configured");
}
if (!address.isV4Zero() && !address.isV6Zero()
&& !subnet->inRange(address)) {
isc_throw(isc::BadValue,
"specified reservation '" << address
<< "' is not matching the IPv4 subnet prefix '"
<< subnet->toText() << "'");
}
}
}
void
HostCmdsImpl::validateHostForSubnet6(SubnetID subnet_id,
const std::vector<IOAddress>& addresses) {
if (subnet_id != 0) {
auto cfg = CfgMgr::instance().getCurrentCfg()->getCfgSubnets6();
auto subnet = cfg->getBySubnetId(subnet_id);
if (!subnet) {
isc_throw(isc::BadValue,
"IPv6 subnet with ID of '" << subnet_id
<< "' is not configured");
}
for (auto const& address : addresses) {
if (!subnet->inRange(address)) {
isc_throw(isc::BadValue,
"specified reservation '" << address
<< "' is not matching the IPv6 subnet prefix '"
<< subnet->toText() << "'");
}
}
}
}
bool
HostCmdsImpl::checkHost4(const ConstHostPtr& host) {
if (host->getIPv4SubnetID() != SUBNET_ID_UNUSED) {
return (false);
}
const IOAddress& addr = host->getIPv4Reservation();
if (!addr.isV4Zero()) {
// Try to find a subnet hint.
auto subnets = CfgMgr::instance().getCurrentCfg()->getCfgSubnets4();
ConstSubnet4Ptr guarded;
ConstSubnet4Ptr candidate;
bool others = false;
for (auto const& subnet : *subnets->getAll()) {
if (!subnet->inRange(addr)) {
continue;
}
if (subnet->clientSupported(ClientClasses())) {
if (!candidate) {
candidate = subnet;
} else {
others = true;
}
} else if (!guarded) {
guarded = subnet;
} else {
others = true;
}
}
if (guarded && candidate) {
others = true;
}
if (!guarded && !candidate) {
isc_throw(isc::BadValue, "Mandatory 'subnet-id' parameter missing."
<< " The address '" << addr.toText()
<< "' belongs to no configured subnet.");
}
if (candidate) {
isc_throw(isc::BadValue, "Mandatory 'subnet-id' parameter missing."
<< " The address '" << addr.toText()
<< "' belongs to subnet '" << candidate->toText()
<< "' id " << candidate->getID()
<< (others ? " and others." : "."));
} else {
isc_throw(isc::BadValue, "Mandatory 'subnet-id' parameter missing."
<< " The address '" << addr.toText()
<< "' belongs to guarded subnet '" << guarded->toText()
<< "' id " << guarded->getID()
<< (others ? " and others." : "."));
}
} else {
return (true);
}
}
bool
HostCmdsImpl::checkHost6(const ConstHostPtr& host) {
if (host->getIPv6SubnetID() != SUBNET_ID_UNUSED) {
return (false);
}
auto const& range = host->getIPv6Reservations();
std::vector<IOAddress> addresses;
bool has_prefixes = false;
BOOST_FOREACH(auto const& address, range) {
if (address.first == IPv6Resrv::TYPE_NA) {
addresses.push_back(address.second.getPrefix());
} else {
has_prefixes = true;
}
}
if (!addresses.empty()) {
// Try to find a subnet hint.
auto subnets = CfgMgr::instance().getCurrentCfg()->getCfgSubnets6();
ConstSubnet6Ptr guarded;
ConstSubnet6Ptr candidate;
bool others = false;
for (auto const& subnet : *subnets->getAll()) {
bool in_range = true;
for (auto const& address : addresses) {
if (!subnet->inRange(address)) {<--- Consider using std::any_of algorithm instead of a raw loop.
in_range = false;
break;
}
}
if (!in_range) {
continue;
}
if (subnet->clientSupported(ClientClasses())) {
if (!candidate) {
candidate = subnet;
} else {
others = true;
}
} else if (!guarded) {
guarded = subnet;
} else {
others = true;
}
}
if (guarded && candidate) {
others = true;
}
if (!guarded && !candidate) {
isc_throw(isc::BadValue, "Mandatory 'subnet-id' parameter missing."
<< " Reserved IPv6 addresses do not belong to a"
<< " common configured subnet.");
}
if (candidate) {
isc_throw(isc::BadValue, "Mandatory 'subnet-id' parameter missing."
<< " Reserved IPv6 addresses belong to subnet '"
<< candidate->toText() << "' id " << candidate->getID()
<< (others ? " and others." : "."));
} else {
isc_throw(isc::BadValue, "Mandatory 'subnet-id' parameter missing."
<< " Reserved IPv6 addresses belong to guarded subnet '"
<< guarded->toText() << "' id " << guarded->getID()
<< (others ? " and others." : "."));
}
} else if (has_prefixes) {
isc_throw(isc::BadValue, "Mandatory 'subnet-id' parameter missing."
<< " Prefixes are not attached to subnets so no hint is"
<< " available.");
} else {
return (true);
}
}
int
HostCmdsImpl::reservationGetHandler(CalloutHandle& handle) {
string txt = "(missing parameters)";
Parameters p;
ElementPtr host_json;
try {
extractCommand(handle);
if (cmd_args_) {
txt = cmd_args_->str();
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET)
.arg(txt);
p = getParameters(cmd_args_);
if (p.operation_target == HostMgrOperationTarget::UNSPECIFIED_SOURCE) {
p.operation_target = HostMgrOperationTarget::ALL_SOURCES;
}
ConstHostPtr host;
if (p.query_by_addr) {
// Query by address
if (p.addr.isV4()) {
host = HostMgr::instance().get4(p.subnet_id, p.addr, p.operation_target);
} else {
host = HostMgr::instance().get6(p.subnet_id, p.addr, p.operation_target);
}
} else {
// Query by identifier
if (family_ == AF_INET) {
host = HostMgr::instance().get4(p.subnet_id, p.type, &p.ident[0],
p.ident.size(), p.operation_target);
} else {
host = HostMgr::instance().get6(p.subnet_id, p.type, &p.ident[0],
p.ident.size(), p.operation_target);
}
}
if (host) {
SubnetID subnet_id;
if (family_ == AF_INET) {
host_json = host->toElement4();
subnet_id = host->getIPv4SubnetID();
} else {
host_json = host->toElement6();
subnet_id = host->getIPv6SubnetID();
}
host_json->set("subnet-id", Element::create(subnet_id));
}
} catch (const std::exception& ex) {
LOG_ERROR(host_cmds_logger, HOST_CMDS_RESERV_GET_FAILED)
.arg(txt)
.arg(ex.what());
setErrorResponse(handle, ex.what());
return (1);
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET_SUCCESS)
.arg(txt);
if (host_json) {
ConstElementPtr response = createAnswer(CONTROL_RESULT_SUCCESS,
"Host found.", host_json);
setResponse(handle, response);
} else {
setErrorResponse(handle, "Host not found.", CONTROL_RESULT_EMPTY);
}
return (0);
}
int
HostCmdsImpl::reservationGetByAddressHandler(CalloutHandle& handle) {
string txt = "(missing parameters)";
Parameters p;
ElementPtr hosts_json = Element::createList();
try {
extractCommand(handle);
if (cmd_args_) {
txt = cmd_args_->str();
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET_BY_ADDRESS)
.arg(txt);
p = getByAddressParameters(cmd_args_);
if (p.operation_target == HostMgrOperationTarget::UNSPECIFIED_SOURCE) {
p.operation_target = HostMgrOperationTarget::ALL_SOURCES;
}
ConstHostCollection hosts;
if (p.has_subnet_id) {
if (family_ == AF_INET) {
validateHostForSubnet4(p.subnet_id,
IOAddress::IPV4_ZERO_ADDRESS());
hosts = HostMgr::instance().getAll4(p.subnet_id, p.addr, p.operation_target);
} else {
validateHostForSubnet6(p.subnet_id, std::vector<IOAddress>());
hosts = HostMgr::instance().getAll6(p.subnet_id, p.addr, p.operation_target);
}
} else {
if (family_ == AF_INET) {
hosts = HostMgr::instance().getAll4(p.addr, p.operation_target);
} else {
hosts = HostMgr::instance().getAll6(p.addr, p.operation_target);
}
}
// Add the subnet-id when it was not specified by the command
// parameters and filter out wrong universe entries.
SubnetID subnet_id = p.subnet_id;
ElementPtr host_json;
for (auto const& host : hosts) {
if (!p.has_subnet_id) {
if (family_ == AF_INET) {
subnet_id = host->getIPv4SubnetID();
} else {
subnet_id = host->getIPv6SubnetID();
}
if (subnet_id == SUBNET_ID_UNUSED) {
continue;
}
}
if (family_ == AF_INET) {
host_json = host->toElement4();
} else {
host_json = host->toElement6();
}
host_json->set("subnet-id", Element::create(subnet_id));
hosts_json->add(host_json);
}
} catch (const std::exception& ex) {
LOG_ERROR(host_cmds_logger, HOST_CMDS_RESERV_GET_BY_ADDRESS_FAILED)
.arg(txt)
.arg(ex.what());
setErrorResponse(handle, ex.what());
return (1);
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET_BY_ADDRESS_SUCCESS)
.arg(txt);
ostringstream msg;
msg << hosts_json->size()
<< " IPv" << (family_ == AF_INET ? "4" : "6")
<< " host(s) found.";
ElementPtr result = Element::createMap();
result->set("hosts", hosts_json);
ConstElementPtr response = createAnswer(hosts_json->size() > 0 ?
CONTROL_RESULT_SUCCESS :
CONTROL_RESULT_EMPTY,
msg.str(), result);
setResponse(handle, response);
return (0);
}
int
HostCmdsImpl::reservationDelHandler(CalloutHandle& handle) {
string txt = "(missing parameters)";
Parameters p;
bool deleted;
try {
extractCommand(handle);
if (cmd_args_) {
txt = cmd_args_->str();
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_DEL)
.arg(txt);
p = getParameters(cmd_args_);
if (p.operation_target == HostMgrOperationTarget::UNSPECIFIED_SOURCE) {
p.operation_target = HostMgrOperationTarget::ALTERNATE_SOURCES;
}
if (p.query_by_addr) {
// try to delete by address
deleted = HostMgr::instance().del(p.subnet_id, p.addr, p.operation_target);
} else {
// try to delete by identifier
if (family_ == AF_INET) {
deleted = HostMgr::instance().del4(p.subnet_id, p.type,
&p.ident[0], p.ident.size(),
p.operation_target);
} else {
deleted = HostMgr::instance().del6(p.subnet_id, p.type,
&p.ident[0], p.ident.size(),
p.operation_target);
}
}
} catch (const std::exception& ex) {
LOG_ERROR(host_cmds_logger, HOST_CMDS_RESERV_DEL_FAILED)
.arg(txt)
.arg(ex.what());
setErrorResponse(handle, ex.what());
return (1);
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_DEL_SUCCESS)
.arg(txt);
if (deleted) {
setSuccessResponse(handle, "Host deleted.");
} else {
setErrorResponse(handle, "Host not deleted (not found).",
CONTROL_RESULT_EMPTY);
}
return (0);
}
HostCmdsImpl::Parameters
HostCmdsImpl::getAllParameters(const ConstElementPtr& params) {
Parameters x;
if (!params || params->getType() != Element::map) {
isc_throw(BadValue, "Parameters missing or are not a map.");
}
// We support one type of reservation-get-all(subnet-id)
int64_t tmp = data::SimpleParser::getInteger(params, "subnet-id",
0, dhcp::SUBNET_ID_MAX);
x.subnet_id = static_cast<SubnetID>(tmp);
x.has_subnet_id = true;
x.operation_target = getOperationTarget(params);
return (x);
}
HostCmdsImpl::Parameters
HostCmdsImpl::getPageParameters(const ConstElementPtr& params) {
Parameters x;
if (!params || params->getType() != Element::map) {
isc_throw(BadValue, "Parameters missing or are not a map.");
}
int64_t tmp = data::SimpleParser::getInteger(params, "limit", 0,
numeric_limits<uint32_t>::max());
x.page_limit = static_cast<size_t>(tmp);
// subnet-id, source-index and from host-id are optional.
if (params->contains("subnet-id")) {
tmp = data::SimpleParser::getInteger(params, "subnet-id",
0, dhcp::SUBNET_ID_MAX);
x.subnet_id = static_cast<SubnetID>(tmp);
x.has_subnet_id = true;
}
x.source_index = 0;
if (params->get("source-index")) {
tmp = data::SimpleParser::getInteger(params, "source-index", 0, 10);
x.source_index = static_cast<size_t>(tmp);
}
x.host_id = 0;
if (params->get("from")) {
tmp = data::SimpleParser::getInteger(params, "from");
x.host_id = static_cast<uint64_t>(tmp);
}
return (x);
}
HostCmdsImpl::Parameters
HostCmdsImpl::getByHostnameParameters(const ConstElementPtr& params) {
Parameters x;
if (!params || params->getType() != Element::map) {
isc_throw(BadValue, "Parameters missing or are not a map.");
}
string hostname = data::SimpleParser::getString(params, "hostname");
x.hostname = hostname;
// subnet-id is optional.
if (params->contains("subnet-id")) {
int64_t tmp = data::SimpleParser::getInteger(params, "subnet-id",
0, dhcp::SUBNET_ID_MAX);
x.subnet_id = static_cast<SubnetID>(tmp);
x.has_subnet_id = true;
}
x.operation_target = getOperationTarget(params);
return (x);
}
HostCmdsImpl::Parameters
HostCmdsImpl::getByIdParameters(const ConstElementPtr& params) {
Parameters x;
if (!params || params->getType() != Element::map) {
isc_throw(BadValue, "Parameters missing or are not a map.");
}
ConstElementPtr type = params->get("identifier-type");
ConstElementPtr ident = params->get("identifier");
if (!type || type->getType() != Element::string) {
isc_throw(BadValue, "'identifier-type' is either missing"
" or not a string.");
}
if (!ident || ident->getType() != Element::string) {
isc_throw(BadValue, "'identifier' is either missing or not a string.");
}
// subnet-id is forbidden.
if (params->contains("subnet-id")) {
isc_throw(BadValue, "'subnet-id' is forbidden in reservation-get-by-id");
}
// Got the parameters. Let's see if their values make sense.
// Try to parse the identifier value first.
try {
x.ident = util::str::quotedStringToBinary(ident->stringValue());
if (x.ident.empty()) {
util::str::decodeFormattedHexString(ident->stringValue(),
x.ident);
}
} catch (...) {
// The string doesn't match any known pattern, so we have to
// report an error at this point.
isc_throw(BadValue, "Unable to parse 'identifier' value.");
}
if (x.ident.empty()) {
isc_throw(BadValue, "Unable to query for empty 'identifier'.");
}
// Next, try to convert identifier-type
try {
x.type = Host::getIdentifierType(type->stringValue());
} catch (const std::exception& ex) {
isc_throw(BadValue, "Value of 'identifier-type' was not recognized.");
}
x.operation_target = getOperationTarget(params);
return (x);
}
HostCmdsImpl::Parameters
HostCmdsImpl::getByAddressParameters(const ConstElementPtr& params) {
Parameters x;
if (!params || params->getType() != Element::map) {
isc_throw(BadValue, "Parameters missing or are not a map.");
}
// We support 1 type of reservation-get-by-address:
// reservation-get-by-address(subnet-id, address, operation-target)
// where subnet-id and operation-target are optional
IOAddress addr = data::SimpleParser::getAddress(params, "ip-address");
if (!addr.isV4() && !addr.isV6()) {
isc_throw(BadValue, "Failed to parse IP address " << addr);
}
x.addr = addr;
x.query_by_addr = true;
if (params->contains("subnet-id")) {
int64_t tmp = data::SimpleParser::getInteger(params, "subnet-id",
0, dhcp::SUBNET_ID_MAX);
x.subnet_id = static_cast<SubnetID>(tmp);
x.has_subnet_id = true;
}
x.operation_target = getOperationTarget(params);
return (x);
}
HostMgrOperationTarget
HostCmdsImpl::getOperationTarget(const ConstElementPtr& args) {
// Operation target is optional.
if (!args->get("operation-target")) {
return HostMgrOperationTarget::UNSPECIFIED_SOURCE;
}
std::string raw = data::SimpleParser::getString(args, "operation-target");
if (raw == "memory") {
return HostMgrOperationTarget::PRIMARY_SOURCE;
} else if (raw == "database") {
return HostMgrOperationTarget::ALTERNATE_SOURCES;
} else if (raw == "all") {
return HostMgrOperationTarget::ALL_SOURCES;
} else if (raw == "default") {
return HostMgrOperationTarget::UNSPECIFIED_SOURCE;
} else {
isc_throw(BadValue,
"The 'operation-target' value (" << raw
<< ") is not within expected set: (memory, database, all, "
<< "default)");
}
}
int
HostCmdsImpl::reservationGetAllHandler(CalloutHandle& handle) {
string txt = "(missing parameters)";
Parameters p;
ElementPtr hosts_json = Element::createList();
try {
extractCommand(handle);
if (cmd_args_) {
txt = cmd_args_->str();
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET_ALL)
.arg(txt);
p = getAllParameters(cmd_args_);
if (p.operation_target == HostMgrOperationTarget::UNSPECIFIED_SOURCE) {
p.operation_target = HostMgrOperationTarget::ALL_SOURCES;
}
ConstHostCollection hosts;
if (family_ == AF_INET) {
validateHostForSubnet4(p.subnet_id,
IOAddress::IPV4_ZERO_ADDRESS());
hosts = HostMgr::instance().getAll4(p.subnet_id, p.operation_target);
} else {
validateHostForSubnet6(p.subnet_id, std::vector<IOAddress>());
hosts = HostMgr::instance().getAll6(p.subnet_id, p.operation_target);
}
for (auto const& host : hosts) {
ElementPtr host_json;
if (family_ == AF_INET) {
host_json = host->toElement4();
SubnetID subnet_id = host->getIPv4SubnetID();
host_json->set("subnet-id", Element::create(subnet_id));
} else {
host_json = host->toElement6();
SubnetID subnet_id = host->getIPv6SubnetID();
host_json->set("subnet-id", Element::create(subnet_id));
}
hosts_json->add(host_json);
}
} catch (const std::exception& ex) {
LOG_ERROR(host_cmds_logger, HOST_CMDS_RESERV_GET_ALL_FAILED)
.arg(txt)
.arg(ex.what());
setErrorResponse(handle, ex.what());
return (1);
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET_ALL_SUCCESS)
.arg(txt);
ostringstream msg;
msg << hosts_json->size()
<< " IPv" << (family_ == AF_INET ? "4" : "6")
<< " host(s) found.";
ElementPtr result = Element::createMap();
result->set("hosts", hosts_json);
ConstElementPtr response = createAnswer(hosts_json->size() > 0 ?
CONTROL_RESULT_SUCCESS :
CONTROL_RESULT_EMPTY,
msg.str(), result);
setResponse(handle, response);
return (0);
}
int
HostCmdsImpl::reservationGetPageHandler(CalloutHandle& handle) {
string txt = "(missing parameters)";
Parameters p;
size_t idx;
ElementPtr hosts_json = Element::createList();
uint64_t last_id(0);
try {
extractCommand(handle);
if (cmd_args_) {
txt = cmd_args_->str();
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET_PAGE)
.arg(txt);
p = getPageParameters(cmd_args_);
idx = p.source_index;
HostPageSize page_size(p.page_limit);
ConstHostCollection hosts;
if (p.has_subnet_id) {
if (family_ == AF_INET) {
validateHostForSubnet4(p.subnet_id,
IOAddress::IPV4_ZERO_ADDRESS());
hosts = HostMgr::instance().getPage4(p.subnet_id, idx,
p.host_id, page_size);
} else {
validateHostForSubnet6(p.subnet_id, std::vector<IOAddress>());
hosts = HostMgr::instance().getPage6(p.subnet_id, idx,
p.host_id, page_size);
}
} else {
if (family_ == AF_INET) {
hosts = HostMgr::instance().getPage4(idx, p.host_id, page_size);
} else {
hosts = HostMgr::instance().getPage6(idx, p.host_id, page_size);
}
}
SubnetID subnet_id = p.subnet_id;
ElementPtr host_json;
for (auto const& host : hosts) {
if (!p.has_subnet_id) {
if (family_ == AF_INET) {
subnet_id = host->getIPv4SubnetID();
} else {
subnet_id = host->getIPv6SubnetID();
}
if (subnet_id == SUBNET_ID_UNUSED) {
continue;
}
}
if (family_ == AF_INET) {
host_json = host->toElement4();
} else {
host_json = host->toElement6();
}
host_json->set("subnet-id", Element::create(subnet_id));
hosts_json->add(host_json);
last_id = host->getHostId();
}
} catch (const std::exception& ex) {
LOG_ERROR(host_cmds_logger, HOST_CMDS_RESERV_GET_PAGE_FAILED)
.arg(txt)
.arg(ex.what());
setErrorResponse(handle, ex.what());
return (1);
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET_PAGE_SUCCESS)
.arg(txt);
ostringstream msg;
msg << hosts_json->size()
<< " IPv" << (family_ == AF_INET ? "4" : "6")
<< " host(s) found.";
ElementPtr result = Element::createMap();
result->set("hosts", hosts_json);
result->set("count",
Element::create(static_cast<int64_t>(hosts_json->size())));
if (hosts_json->size() > 0) {
ElementPtr next = Element::createMap();
next->set("source-index",
Element::create(static_cast<int64_t>(idx)));
next->set("from", Element::create(static_cast<int64_t>(last_id)));
result->set("next", next);
}
ConstElementPtr response = createAnswer(hosts_json->size() > 0 ?
CONTROL_RESULT_SUCCESS :
CONTROL_RESULT_EMPTY,
msg.str(), result);
setResponse(handle, response);
return (0);
}
int
HostCmdsImpl::reservationGetByHostnameHandler(CalloutHandle& handle) {
string txt = "(missing parameters)";
Parameters p;
ElementPtr hosts_json = Element::createList();
try {
extractCommand(handle);
if (cmd_args_) {
txt = cmd_args_->str();
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET_BY_HOSTNAME)
.arg(txt);
p = getByHostnameParameters(cmd_args_);
if (p.operation_target == HostMgrOperationTarget::UNSPECIFIED_SOURCE) {
p.operation_target = HostMgrOperationTarget::ALL_SOURCES;
}
string hostname = p.hostname;
if (hostname.empty()) {
isc_throw(isc::BadValue, "Empty hostname");
}
boost::algorithm::to_lower(hostname);
ConstHostCollection hosts;
if (p.has_subnet_id) {
if (family_ == AF_INET) {
validateHostForSubnet4(p.subnet_id,
IOAddress::IPV4_ZERO_ADDRESS());
hosts = HostMgr::instance().getAllbyHostname4(hostname,
p.subnet_id,
p.operation_target);
} else {
validateHostForSubnet6(p.subnet_id, std::vector<IOAddress>());
hosts = HostMgr::instance().getAllbyHostname6(hostname,
p.subnet_id,
p.operation_target);
}
} else {
hosts = HostMgr::instance().getAllbyHostname(hostname, p.operation_target);
}
// Add the subnet-id when it was not specified by the command
// parameters and filter out wrong universe entries.
SubnetID subnet_id = p.subnet_id;
ElementPtr host_json;
for (auto const& host : hosts) {
if (!p.has_subnet_id) {
if (family_ == AF_INET) {
subnet_id = host->getIPv4SubnetID();
} else {
subnet_id = host->getIPv6SubnetID();
}
if (subnet_id == SUBNET_ID_UNUSED) {
continue;
}
}
if (family_ == AF_INET) {
host_json = host->toElement4();
} else {
host_json = host->toElement6();
}
host_json->set("subnet-id", Element::create(subnet_id));
hosts_json->add(host_json);
}
} catch (const std::exception& ex) {
LOG_ERROR(host_cmds_logger, HOST_CMDS_RESERV_GET_BY_HOSTNAME_FAILED)
.arg(txt)
.arg(ex.what());
setErrorResponse(handle, ex.what());
return (1);
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET_BY_HOSTNAME_SUCCESS)
.arg(txt);
ostringstream msg;
msg << hosts_json->size()
<< " IPv" << (family_ == AF_INET ? "4" : "6")
<< " host(s) found.";
ElementPtr result = Element::createMap();
result->set("hosts", hosts_json);
ConstElementPtr response = createAnswer(hosts_json->size() > 0 ?
CONTROL_RESULT_SUCCESS :
CONTROL_RESULT_EMPTY,
msg.str(), result);
setResponse(handle, response);
return (0);
}
int
HostCmdsImpl::reservationGetByIdHandler(CalloutHandle& handle) {
string txt = "(missing parameters)";
Parameters p;
ElementPtr hosts_json = Element::createList();
try {
extractCommand(handle);
if (cmd_args_) {
txt = cmd_args_->str();
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET_BY_ID)
.arg(txt);
p = getByIdParameters(cmd_args_);
if (p.operation_target == HostMgrOperationTarget::UNSPECIFIED_SOURCE) {
p.operation_target = HostMgrOperationTarget::ALL_SOURCES;
}
ConstHostCollection hosts;
hosts = HostMgr::instance().getAll(p.type, &p.ident[0], p.ident.size(),
p.operation_target);
SubnetID subnet_id;
ElementPtr host_json;
for (auto const& host : hosts) {
if (family_ == AF_INET) {
subnet_id = host->getIPv4SubnetID();
} else {
subnet_id = host->getIPv6SubnetID();
}
if (subnet_id == SUBNET_ID_UNUSED) {
continue;
}
if (family_ == AF_INET) {
host_json = host->toElement4();
} else {
host_json = host->toElement6();
}
host_json->set("subnet-id", Element::create(subnet_id));
hosts_json->add(host_json);
}
} catch (const std::exception& ex) {
LOG_ERROR(host_cmds_logger, HOST_CMDS_RESERV_GET_BY_ID_FAILED)
.arg(txt)
.arg(ex.what());
setErrorResponse(handle, ex.what());
return (1);
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_GET_BY_ID_SUCCESS)
.arg(txt);
ostringstream msg;
msg << hosts_json->size()
<< " IPv" << (family_ == AF_INET ? "4" : "6")
<< " host(s) found.";
ElementPtr result = Element::createMap();
result->set("hosts", hosts_json);
ConstElementPtr response = createAnswer(hosts_json->size() > 0 ?
CONTROL_RESULT_SUCCESS :
CONTROL_RESULT_EMPTY,
msg.str(), result);
setResponse(handle, response);
return (0);
}
int
HostCmdsImpl::reservationUpdateHandler(CalloutHandle& handle) {
string parameters("(missing parameters)");
try {
// Basic command extraction
extractCommand(handle);
if (cmd_args_) {
parameters = cmd_args_->str();
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_UPDATE)
.arg(parameters);
// Sanity checks
if (!cmd_args_) {
isc_throw(BadValue,
"invalid command: does not contain mandatory '" << CONTROL_ARGUMENTS << "'");
}
if (cmd_args_->getType() != Element::map) {
isc_throw(BadValue, "invalid command: expected '"
<< CONTROL_ARGUMENTS << "' to be a map, got "
<< Element::typeToName(cmd_args_->getType()) << " instead");
}
ConstElementPtr const reservation(cmd_args_->get("reservation"));
if (!reservation) {
isc_throw(BadValue, "invalid command: expected 'reservation' as the sole parameter "
"inside the 'arguments' map, didn't get it instead");
}
if (reservation->getType() != Element::map) {
isc_throw(BadValue, "invalid command: expected 'reservation' to be a map, got "
<< Element::typeToName(reservation->getType()) << " instead");
}
HostMgrOperationTarget operation_target = getOperationTarget(cmd_args_);
if (operation_target == HostMgrOperationTarget::UNSPECIFIED_SOURCE) {
operation_target = HostMgrOperationTarget::ALTERNATE_SOURCES;
}
// Parse host-specific parameters.
HostPtr host;
if (family_ == AF_INET) {
HostDataParser4 parser;
host = parser.parseWithSubnet(reservation);
} else {
HostDataParser6 parser;
host = parser.parseWithSubnet(reservation);
}
// If db_storage_ was not accessed yet, try to retrieve it.
if (!db_storage_) {
db_storage_ = HostMgr::instance().getHostDataSource();
}
if (!db_storage_ && operation_target == HostMgrOperationTarget::ALTERNATE_SOURCES) {
// If it's still not available, bail out.
isc_throw(BadValue, "host database not available, cannot update host");
}
if (family_ == AF_INET) {
// Validate the IPv4 subnet id against configured subnet and also verify
// that the reserved IPv4 address (if non-zero) belongs to this subnet.
validateHostForSubnet4(host->getIPv4SubnetID(),
host->getIPv4Reservation());
} else {
// Retrieve all reserved addresses from the host. We're going to
// check if these addresses are in range with the specified subnet.
// If any of them is not in range, we will reject the command.
// Note that we do not validate delegated prefixes because they don't
// have to match the subnet prefix.
auto const& range = host->getIPv6Reservations(IPv6Resrv::TYPE_NA);
std::vector<IOAddress> addresses;
BOOST_FOREACH(auto const& address, range) {
addresses.push_back(address.second.getPrefix());
}
// Validate the IPv6 subnet id against configured subnet and also
// verify that the reserved IPv6 addresses (if any) belong to this
// subnet.
validateHostForSubnet6(host->getIPv6SubnetID(), addresses);
}
// Do the update.
HostMgr::instance().update(host, operation_target);
} catch (exception const& exception) {
LOG_ERROR(host_cmds_logger, HOST_CMDS_RESERV_UPDATE_FAILED)
.arg(parameters)
.arg(exception.what());
setErrorResponse(handle, exception.what());
return (1);
}
LOG_INFO(host_cmds_logger, HOST_CMDS_RESERV_UPDATE_SUCCESS).arg(parameters);
setSuccessResponse(handle, "Host updated.");
return (0);
}
HostCmds::HostCmds()
:impl_(new HostCmdsImpl()) {
}
int
HostCmds::reservationAddHandler(CalloutHandle& handle) {
return (impl_->reservationAddHandler(handle));
}
int
HostCmds::reservationGetHandler(CalloutHandle& handle) {
return (impl_->reservationGetHandler(handle));
}
int
HostCmds::reservationDelHandler(CalloutHandle& handle) {
return (impl_->reservationDelHandler(handle));
}
int
HostCmds::reservationGetAllHandler(CalloutHandle& handle) {
return (impl_->reservationGetAllHandler(handle));
}
int
HostCmds::reservationGetPageHandler(CalloutHandle& handle) {
return (impl_->reservationGetPageHandler(handle));
}
int
HostCmds::reservationGetByHostnameHandler(CalloutHandle& handle) {
return (impl_->reservationGetByHostnameHandler(handle));
}
int
HostCmds::reservationGetByIdHandler(CalloutHandle& handle) {
return (impl_->reservationGetByIdHandler(handle));
}
int
HostCmds::reservationUpdateHandler(CalloutHandle& handle) {
return (impl_->reservationUpdateHandler(handle));
}
int
HostCmds::reservationGetByAddressHandler(CalloutHandle& handle) {
return (impl_->reservationGetByAddressHandler(handle));
}
} // namespace host_cmds
} // namespace isc
|