config_parser.cc 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832
  1. // Copyright (C) 2012-2013 Internet Systems Consortium, Inc. ("ISC")
  2. //
  3. // Permission to use, copy, modify, and/or distribute this software for any
  4. // purpose with or without fee is hereby granted, provided that the above
  5. // copyright notice and this permission notice appear in all copies.
  6. //
  7. // THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  8. // REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  9. // AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  10. // INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  11. // LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  12. // OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  13. // PERFORMANCE OF THIS SOFTWARE.
  14. #include <asiolink/io_address.h>
  15. #include <cc/data.h>
  16. #include <config/ccsession.h>
  17. #include <dhcp/libdhcp++.h>
  18. #include <dhcp6/config_parser.h>
  19. #include <dhcp6/dhcp6_log.h>
  20. #include <dhcp/iface_mgr.h>
  21. #include <dhcpsrv/cfgmgr.h>
  22. #include <dhcpsrv/dbaccess_parser.h>
  23. #include <dhcpsrv/dhcp_config_parser.h>
  24. #include <dhcpsrv/dhcp_parsers.h>
  25. #include <dhcpsrv/pool.h>
  26. #include <dhcpsrv/subnet.h>
  27. #include <dhcpsrv/triplet.h>
  28. #include <log/logger_support.h>
  29. #include <util/encode/hex.h>
  30. #include <util/strutil.h>
  31. #include <boost/algorithm/string.hpp>
  32. #include <boost/foreach.hpp>
  33. #include <boost/lexical_cast.hpp>
  34. #include <boost/scoped_ptr.hpp>
  35. #include <boost/shared_ptr.hpp>
  36. #include <iostream>
  37. #include <map>
  38. #include <vector>
  39. #include <stdint.h>
  40. using namespace std;
  41. using namespace isc;
  42. using namespace isc::data;
  43. using namespace isc::dhcp;
  44. using namespace isc::asiolink;
  45. namespace {
  46. // Pointers to various parser objects.
  47. typedef boost::shared_ptr<BooleanParser> BooleanParserPtr;
  48. typedef boost::shared_ptr<StringParser> StringParserPtr;
  49. typedef boost::shared_ptr<Uint32Parser> Uint32ParserPtr;
  50. /// @brief Parser for DHCP6 option data value.
  51. ///
  52. /// This parser parses configuration entries that specify value of
  53. /// a single option specific to DHCP6. It provides the DHCP6-specific
  54. /// implementation of the abstract class OptionDataParser.
  55. class Dhcp6OptionDataParser : public OptionDataParser {
  56. public:
  57. /// @brief Constructor.
  58. ///
  59. /// @param dummy first param, option names are always "Dhcp6/option-data[n]"
  60. /// @param options is the option storage in which to store the parsed option
  61. /// upon "commit".
  62. /// @param global_context is a pointer to the global context which
  63. /// stores global scope parameters, options, option defintions.
  64. Dhcp6OptionDataParser(const std::string&, OptionStoragePtr options,
  65. ParserContextPtr global_context)
  66. :OptionDataParser("", options, global_context) {
  67. }
  68. /// @brief static factory method for instantiating Dhcp4OptionDataParsers
  69. ///
  70. /// @param param_name name of the parameter to be parsed.
  71. /// @param options storage where the parameter value is to be stored.
  72. /// @param global_context is a pointer to the global context which
  73. /// stores global scope parameters, options, option defintions.
  74. /// @return returns a pointer to a new OptionDataParser. Caller is
  75. /// is responsible for deleting it when it is no longer needed.
  76. static OptionDataParser* factory(const std::string& param_name,
  77. OptionStoragePtr options, ParserContextPtr global_context) {
  78. return (new Dhcp6OptionDataParser(param_name, options, global_context));
  79. }
  80. protected:
  81. /// @brief Finds an option definition within the server's option space
  82. ///
  83. /// Given an option space and an option code, find the correpsonding
  84. /// option defintion within the server's option defintion storage.
  85. ///
  86. /// @param option_space name of the parameter option space
  87. /// @param option_code numeric value of the parameter to find
  88. /// @return OptionDefintionPtr of the option defintion or an
  89. /// empty OptionDefinitionPtr if not found.
  90. /// @throw DhcpConfigError if the option space requested is not valid
  91. /// for this server.
  92. virtual OptionDefinitionPtr findServerSpaceOptionDefinition (
  93. std::string& option_space, uint32_t option_code) {
  94. OptionDefinitionPtr def;
  95. if (option_space == "dhcp6" &&
  96. LibDHCP::isStandardOption(Option::V6, option_code)) {
  97. def = LibDHCP::getOptionDef(Option::V6, option_code);
  98. } else if (option_space == "dhcp4") {
  99. isc_throw(DhcpConfigError, "'dhcp4' option space name is reserved"
  100. << " for DHCPv4 server");
  101. } else {
  102. // Check if this is a vendor-option. If it is, get vendor-specific
  103. // definition.
  104. uint32_t vendor_id = SubnetConfigParser::optionSpaceToVendorId(option_space);
  105. if (vendor_id) {
  106. def = LibDHCP::getVendorOptionDef(Option::V6, vendor_id, option_code);
  107. }
  108. }
  109. return (def);
  110. }
  111. };
  112. /// @brief Parser for IPv4 pool definitions.
  113. ///
  114. /// This is the IPv6 derivation of the PoolParser class and handles pool
  115. /// definitions, i.e. a list of entries of one of two syntaxes: min-max and
  116. /// prefix/len for IPv6 pools. Pool6 objects are created and stored in chosen
  117. /// PoolStorage container.
  118. ///
  119. /// It is useful for parsing Dhcp6/subnet6[X]/pool parameters.
  120. class Pool6Parser : public PoolParser {
  121. public:
  122. /// @brief Constructor.
  123. ///
  124. /// @param param_name name of the parameter. Note, it is passed through
  125. /// but unused, parameter is currently always "Dhcp6/subnet6[X]/pool"
  126. /// @param pools storage container in which to store the parsed pool
  127. /// upon "commit"
  128. Pool6Parser(const std::string& param_name, PoolStoragePtr pools)
  129. :PoolParser(param_name, pools) {
  130. }
  131. protected:
  132. /// @brief Creates a Pool6 object given a IPv6 prefix and the prefix length.
  133. ///
  134. /// @param addr is the IPv6 prefix of the pool.
  135. /// @param len is the prefix length.
  136. /// @param ptype is the type of IPv6 pool (Pool::PoolType). Note this is
  137. /// passed in as an int32_t and cast to PoolType to accommodate a
  138. /// polymorphic interface.
  139. /// @return returns a PoolPtr to the new Pool4 object.
  140. PoolPtr poolMaker (IOAddress &addr, uint32_t len, int32_t ptype)
  141. {
  142. return (PoolPtr(new Pool6(static_cast<isc::dhcp::Lease::Type>
  143. (ptype), addr, len)));
  144. }
  145. /// @brief Creates a Pool6 object given starting and ending IPv6 addresses.
  146. ///
  147. /// @param min is the first IPv6 address in the pool.
  148. /// @param max is the last IPv6 address in the pool.
  149. /// @param ptype is the type of IPv6 pool (Pool::PoolType). Note this is
  150. /// passed in as an int32_t and cast to PoolType to accommodate a
  151. /// polymorphic interface.
  152. /// @return returns a PoolPtr to the new Pool4 object.
  153. PoolPtr poolMaker (IOAddress &min, IOAddress &max, int32_t ptype)
  154. {
  155. return (PoolPtr(new Pool6(static_cast<isc::dhcp::Lease::Type>
  156. (ptype), min, max)));
  157. }
  158. };
  159. /// @brief Parser for IPv6 prefix delegation definitions.
  160. ///
  161. /// This class handles prefix delegation pool definitions for IPv6 subnets
  162. /// Pool6 objects are created and stored in the given PoolStorage container.
  163. ///
  164. /// PdPool defintions currently support three elements: prefix, prefix-len,
  165. /// and delegated-len, as shown in the example JSON text below:
  166. ///
  167. /// @code
  168. ///
  169. /// {
  170. /// "prefix": "2001:db8:1::",
  171. /// "prefix-len": 64,
  172. /// "delegated-len": 128
  173. /// }
  174. /// @endcode
  175. ///
  176. class PdPoolParser : public DhcpConfigParser {
  177. public:
  178. /// @brief Constructor.
  179. ///
  180. /// @param param_name name of the parameter. Note, it is passed through
  181. /// but unused, parameter is currently always "Dhcp6/subnet6[X]/pool"
  182. /// @param pools storage container in which to store the parsed pool
  183. /// upon "commit"
  184. PdPoolParser(const std::string&, PoolStoragePtr pools)
  185. : uint32_values_(new Uint32Storage()),
  186. string_values_(new StringStorage()), pools_(pools) {
  187. if (!pools_) {
  188. isc_throw(isc::dhcp::DhcpConfigError,
  189. "PdPoolParser context storage may not be NULL");
  190. }
  191. }
  192. /// @brief Builds a prefix delegation pool from the given configuration
  193. ///
  194. /// This function parses configuration entries and creates an instance
  195. /// of a dhcp::Pool6 configured for prefix delegation.
  196. ///
  197. /// @param pd_pool_ pointer to an element that holds configuration entries
  198. /// that define a prefix delegation pool.
  199. ///
  200. /// @throw DhcpConfigError if configuration parsing fails.
  201. virtual void build(ConstElementPtr pd_pool_) {
  202. // Parse the elements that make up the option definition.
  203. BOOST_FOREACH(ConfigPair param, pd_pool_->mapValue()) {
  204. std::string entry(param.first);
  205. ParserPtr parser;
  206. if (entry == "prefix") {
  207. StringParserPtr str_parser(new StringParser(entry,
  208. string_values_));
  209. parser = str_parser;
  210. } else if (entry == "prefix-len" || entry == "delegated-len") {
  211. Uint32ParserPtr code_parser(new Uint32Parser(entry,
  212. uint32_values_));
  213. parser = code_parser;
  214. } else {
  215. isc_throw(DhcpConfigError, "invalid parameter: " << entry);
  216. }
  217. parser->build(param.second);
  218. parser->commit();
  219. }
  220. try {
  221. // We should now have all of the pool elements we need to create
  222. // the pool. Fetch them and pass them into the Pool6 constructor.
  223. // The constructor is expected to enforce any value validation.
  224. const std::string addr_str = string_values_->getParam("prefix");
  225. IOAddress addr(addr_str);
  226. uint32_t prefix_len = uint32_values_->getParam("prefix-len");
  227. uint32_t delegated_len = uint32_values_->getParam("delegated-len");
  228. // Attempt to construct the local pool.
  229. pool_.reset(new Pool6(Lease::TYPE_PD, addr, prefix_len,
  230. delegated_len));
  231. } catch (const std::exception& ex) {
  232. isc_throw(isc::dhcp::DhcpConfigError,
  233. "PdPoolParser failed to build pool: " << ex.what());
  234. }
  235. }
  236. // @brief Commits the constructed local pool to the pool storage.
  237. virtual void commit() {
  238. // Add the local pool to the external storage ptr.
  239. pools_->push_back(pool_);
  240. }
  241. protected:
  242. /// Storage for subnet-specific integer values.
  243. Uint32StoragePtr uint32_values_;
  244. /// Storage for subnet-specific string values.
  245. StringStoragePtr string_values_;
  246. /// Parsers are stored here.
  247. ParserCollection parsers_;
  248. /// Pointer to the created pool object.
  249. isc::dhcp::Pool6Ptr pool_;
  250. /// Pointer to storage to which the local pool is written upon commit.
  251. isc::dhcp::PoolStoragePtr pools_;
  252. };
  253. /// @brief Parser for a list of prefix delegation pools.
  254. ///
  255. /// This parser iterates over a list of prefix delegation pool entries and
  256. /// creates pool instances for each one. If the parsing is successful, the
  257. /// collection of pools is committed to the provided storage.
  258. class PdPoolListParser : public DhcpConfigParser {
  259. public:
  260. /// @brief Constructor.
  261. ///
  262. /// @param dummy first argument is ignored, all Parser constructors
  263. /// accept string as first argument.
  264. /// @param storage is the pool storage in which to store the parsed
  265. /// pools in this list
  266. /// @throw isc::dhcp::DhcpConfigError if storage is null.
  267. PdPoolListParser(const std::string&, PoolStoragePtr pools)
  268. : local_pools_(new PoolStorage()), pools_(pools) {
  269. if (!pools_) {
  270. isc_throw(isc::dhcp::DhcpConfigError,
  271. "PdPoolListParser pools storage may not be NULL");
  272. }
  273. }
  274. /// @brief Parse configuration entries.
  275. ///
  276. /// This function parses configuration entries and creates instances
  277. /// of prefix delegation pools .
  278. ///
  279. /// @param pd_pool_list pointer to an element that holds entries
  280. /// that define a prefix delegation pool.
  281. ///
  282. /// @throw DhcpConfigError if configuration parsing fails.
  283. void build(isc::data::ConstElementPtr pd_pool_list) {
  284. // Make sure the local list is empty.
  285. local_pools_.reset(new PoolStorage());
  286. // Make sure we have a configuration elements to parse.
  287. if (!pd_pool_list) {
  288. isc_throw(DhcpConfigError,
  289. "PdPoolListParser: list of pool definitions is empty");
  290. }
  291. // Loop through the list of pd pools.
  292. BOOST_FOREACH(ConstElementPtr pd_pool, pd_pool_list->listValue()) {
  293. boost::shared_ptr<PdPoolParser>
  294. // Create the PdPool parser.
  295. parser(new PdPoolParser("pd-pool", local_pools_));
  296. // Build the pool instance
  297. parser->build(pd_pool);
  298. // Commit the pool to the local list of pools.
  299. parser->commit();
  300. }
  301. }
  302. /// @brief Commits the pools created to the external storage area.
  303. ///
  304. /// Note that this method adds the local list of pools to the storage area
  305. /// rather than replacing its contents. This permits other parsers to
  306. /// contribute to the set of pools.
  307. void commit() {
  308. // local_pools_ holds the values produced by the build function.
  309. // At this point parsing should have completed successfully so
  310. // we can append new data to the supplied storage.
  311. pools_->insert(pools_->end(), local_pools_->begin(),
  312. local_pools_->end());
  313. }
  314. private:
  315. /// @brief storage for local pools
  316. PoolStoragePtr local_pools_;
  317. /// @brief External storage where pools are stored upon list commit.
  318. PoolStoragePtr pools_;
  319. };
  320. /// @brief This class parses a single IPv6 subnet.
  321. ///
  322. /// This is the IPv6 derivation of the SubnetConfigParser class and it parses
  323. /// the whole subnet definition. It creates parsersfor received configuration
  324. /// parameters as needed.
  325. class Subnet6ConfigParser : public SubnetConfigParser {
  326. public:
  327. /// @brief Constructor
  328. ///
  329. /// @param ignored first parameter
  330. /// stores global scope parameters, options, option defintions.
  331. Subnet6ConfigParser(const std::string&)
  332. :SubnetConfigParser("", globalContext(), IOAddress("::")) {
  333. }
  334. /// @brief Adds the created subnet to a server's configuration.
  335. /// @throw throws Unexpected if dynamic cast fails.
  336. void commit() {
  337. if (subnet_) {
  338. Subnet6Ptr sub6ptr = boost::dynamic_pointer_cast<Subnet6>(subnet_);
  339. if (!sub6ptr) {
  340. // If we hit this, it is a programming error.
  341. isc_throw(Unexpected,
  342. "Invalid cast in Subnet4ConfigParser::commit");
  343. }
  344. // Set relay infomation if it was provided
  345. if (relay_info_) {
  346. sub6ptr->setRelayInfo(*relay_info_);
  347. }
  348. isc::dhcp::CfgMgr::instance().addSubnet6(sub6ptr);
  349. }
  350. }
  351. protected:
  352. /// @brief creates parsers for entries in subnet definition
  353. ///
  354. /// @param config_id name of the entry
  355. ///
  356. /// @return parser object for specified entry name. Note the caller is
  357. /// responsible for deleting the parser created.
  358. /// @throw isc::dhcp::DhcpConfigError if trying to create a parser
  359. /// for unknown config element
  360. DhcpConfigParser* createSubnetConfigParser(const std::string& config_id) {
  361. DhcpConfigParser* parser = NULL;
  362. if ((config_id.compare("preferred-lifetime") == 0) ||
  363. (config_id.compare("valid-lifetime") == 0) ||
  364. (config_id.compare("renew-timer") == 0) ||
  365. (config_id.compare("rebind-timer") == 0)) {
  366. parser = new Uint32Parser(config_id, uint32_values_);
  367. } else if ((config_id.compare("subnet") == 0) ||
  368. (config_id.compare("interface") == 0) ||
  369. (config_id.compare("client-class") == 0) ||
  370. (config_id.compare("interface-id") == 0)) {
  371. parser = new StringParser(config_id, string_values_);
  372. } else if (config_id.compare("pool") == 0) {
  373. parser = new Pool6Parser(config_id, pools_);
  374. } else if (config_id.compare("relay") == 0) {
  375. parser = new RelayInfoParser(config_id, relay_info_, Option::V6);
  376. } else if (config_id.compare("pd-pools") == 0) {
  377. parser = new PdPoolListParser(config_id, pools_);
  378. } else if (config_id.compare("option-data") == 0) {
  379. parser = new OptionDataListParser(config_id, options_,
  380. global_context_,
  381. Dhcp6OptionDataParser::factory);
  382. } else {
  383. isc_throw(NotImplemented,
  384. "parser error: Subnet6 parameter not supported: " << config_id);
  385. }
  386. return (parser);
  387. }
  388. /// @brief Determines if the given option space name and code describe
  389. /// a standard option for the DHCP6 server.
  390. ///
  391. /// @param option_space is the name of the option space to consider
  392. /// @param code is the numeric option code to consider
  393. /// @return returns true if the space and code are part of the server's
  394. /// standard options.
  395. bool isServerStdOption(std::string option_space, uint32_t code) {
  396. return ((option_space.compare("dhcp6") == 0)
  397. && LibDHCP::isStandardOption(Option::V6, code));
  398. }
  399. /// @brief Returns the option definition for a given option code from
  400. /// the DHCP6 server's standard set of options.
  401. /// @param code is the numeric option code of the desired option definition.
  402. /// @return returns a pointer the option definition
  403. OptionDefinitionPtr getServerStdOptionDefinition (uint32_t code) {
  404. return (LibDHCP::getOptionDef(Option::V6, code));
  405. }
  406. /// @brief Issues a DHCP6 server specific warning regarding duplicate subnet
  407. /// options.
  408. ///
  409. /// @param code is the numeric option code of the duplicate option
  410. /// @param addr is the subnet address
  411. /// @todo A means to know the correct logger and perhaps a common
  412. /// message would allow this message to be emitted by the base class.
  413. virtual void duplicate_option_warning(uint32_t code,
  414. isc::asiolink::IOAddress& addr) {
  415. LOG_WARN(dhcp6_logger, DHCP6_CONFIG_OPTION_DUPLICATE)
  416. .arg(code).arg(addr.toText());
  417. }
  418. /// @brief Instantiates the IPv6 Subnet based on a given IPv6 address
  419. /// and prefix length.
  420. ///
  421. /// @param addr is IPv6 prefix of the subnet.
  422. /// @param len is the prefix length
  423. void initSubnet(isc::asiolink::IOAddress addr, uint8_t len) {
  424. // Get all 'time' parameters using inheritance.
  425. // If the subnet-specific value is defined then use it, else
  426. // use the global value. The global value must always be
  427. // present. If it is not, it is an internal error and exception
  428. // is thrown.
  429. Triplet<uint32_t> t1 = getParam("renew-timer");
  430. Triplet<uint32_t> t2 = getParam("rebind-timer");
  431. Triplet<uint32_t> pref = getParam("preferred-lifetime");
  432. Triplet<uint32_t> valid = getParam("valid-lifetime");
  433. // Get interface-id option content. For now we support string
  434. // represenation only
  435. std::string ifaceid;
  436. try {
  437. ifaceid = string_values_->getParam("interface-id");
  438. } catch (const DhcpConfigError &) {
  439. // interface-id is not mandatory
  440. }
  441. // Specifying both interface for locally reachable subnets and
  442. // interface id for relays is mutually exclusive. Need to test for
  443. // this condition.
  444. if (!ifaceid.empty()) {
  445. std::string iface;
  446. try {
  447. iface = string_values_->getParam("interface");
  448. } catch (const DhcpConfigError &) {
  449. // iface not mandatory
  450. }
  451. if (!iface.empty()) {
  452. isc_throw(isc::dhcp::DhcpConfigError,
  453. "parser error: interface (defined for locally reachable "
  454. "subnets) and interface-id (defined for subnets reachable"
  455. " via relays) cannot be defined at the same time for "
  456. "subnet " << addr << "/" << (int)len);
  457. }
  458. }
  459. stringstream tmp;
  460. tmp << addr << "/" << static_cast<int>(len)
  461. << " with params t1=" << t1 << ", t2=" << t2 << ", pref="
  462. << pref << ", valid=" << valid;
  463. LOG_INFO(dhcp6_logger, DHCP6_CONFIG_NEW_SUBNET).arg(tmp.str());
  464. // Create a new subnet.
  465. Subnet6* subnet6 = new Subnet6(addr, len, t1, t2, pref, valid);
  466. // Configure interface-id for remote interfaces, if defined
  467. if (!ifaceid.empty()) {
  468. OptionBuffer tmp(ifaceid.begin(), ifaceid.end());
  469. OptionPtr opt(new Option(Option::V6, D6O_INTERFACE_ID, tmp));
  470. subnet6->setInterfaceId(opt);
  471. }
  472. // Try setting up client class (if specified)
  473. try {
  474. string client_class = string_values_->getParam("client-class");
  475. subnet6->allowClientClass(client_class);
  476. } catch (const DhcpConfigError&) {
  477. // That's ok if it fails. client-class is optional.
  478. }
  479. subnet_.reset(subnet6);
  480. }
  481. };
  482. /// @brief this class parses a list of DHCP6 subnets
  483. ///
  484. /// This is a wrapper parser that handles the whole list of Subnet6
  485. /// definitions. It iterates over all entries and creates Subnet6ConfigParser
  486. /// for each entry.
  487. class Subnets6ListConfigParser : public DhcpConfigParser {
  488. public:
  489. /// @brief constructor
  490. ///
  491. /// @param dummy first argument, always ignored. All parsers accept a
  492. /// string parameter "name" as their first argument.
  493. Subnets6ListConfigParser(const std::string&) {
  494. }
  495. /// @brief parses contents of the list
  496. ///
  497. /// Iterates over all entries on the list and creates a Subnet6ConfigParser
  498. /// for each entry.
  499. ///
  500. /// @param subnets_list pointer to a list of IPv6 subnets
  501. void build(ConstElementPtr subnets_list) {
  502. BOOST_FOREACH(ConstElementPtr subnet, subnets_list->listValue()) {
  503. ParserPtr parser(new Subnet6ConfigParser("subnet"));
  504. parser->build(subnet);
  505. subnets_.push_back(parser);
  506. }
  507. }
  508. /// @brief commits subnets definitions.
  509. ///
  510. /// Iterates over all Subnet6 parsers. Each parser contains definitions of
  511. /// a single subnet and its parameters and commits each subnet separately.
  512. void commit() {
  513. // @todo: Implement more subtle reconfiguration than toss
  514. // the old one and replace with the new one.
  515. // remove old subnets
  516. isc::dhcp::CfgMgr::instance().deleteSubnets6();
  517. BOOST_FOREACH(ParserPtr subnet, subnets_) {
  518. subnet->commit();
  519. }
  520. }
  521. /// @brief Returns Subnet6ListConfigParser object
  522. /// @param param_name name of the parameter
  523. /// @return Subnets6ListConfigParser object
  524. static DhcpConfigParser* factory(const std::string& param_name) {
  525. return (new Subnets6ListConfigParser(param_name));
  526. }
  527. /// @brief collection of subnet parsers.
  528. ParserCollection subnets_;
  529. };
  530. } // anonymous namespace
  531. namespace isc {
  532. namespace dhcp {
  533. /// @brief creates global parsers
  534. ///
  535. /// This method creates global parsers that parse global parameters, i.e.
  536. /// those that take format of Dhcp6/param1, Dhcp6/param2 and so forth.
  537. ///
  538. /// @param config_id pointer to received global configuration entry
  539. /// @return parser for specified global DHCPv6 parameter
  540. /// @throw NotImplemented if trying to create a parser for unknown config
  541. /// element
  542. DhcpConfigParser* createGlobal6DhcpConfigParser(const std::string& config_id) {
  543. DhcpConfigParser* parser = NULL;
  544. if ((config_id.compare("preferred-lifetime") == 0) ||
  545. (config_id.compare("valid-lifetime") == 0) ||
  546. (config_id.compare("renew-timer") == 0) ||
  547. (config_id.compare("rebind-timer") == 0)) {
  548. parser = new Uint32Parser(config_id,
  549. globalContext()->uint32_values_);
  550. } else if (config_id.compare("interfaces") == 0) {
  551. parser = new InterfaceListConfigParser(config_id);
  552. } else if (config_id.compare("subnet6") == 0) {
  553. parser = new Subnets6ListConfigParser(config_id);
  554. } else if (config_id.compare("option-data") == 0) {
  555. parser = new OptionDataListParser(config_id,
  556. globalContext()->options_,
  557. globalContext(),
  558. Dhcp6OptionDataParser::factory);
  559. } else if (config_id.compare("option-def") == 0) {
  560. parser = new OptionDefListParser(config_id,
  561. globalContext()->option_defs_);
  562. } else if (config_id.compare("version") == 0) {
  563. parser = new StringParser(config_id,
  564. globalContext()->string_values_);
  565. } else if (config_id.compare("lease-database") == 0) {
  566. parser = new DbAccessParser(config_id);
  567. } else if (config_id.compare("hooks-libraries") == 0) {
  568. parser = new HooksLibrariesParser(config_id);
  569. } else if (config_id.compare("dhcp-ddns") == 0) {
  570. parser = new D2ClientConfigParser(config_id);
  571. } else {
  572. isc_throw(NotImplemented,
  573. "Parser error: Global configuration parameter not supported: "
  574. << config_id);
  575. }
  576. return (parser);
  577. }
  578. isc::data::ConstElementPtr
  579. configureDhcp6Server(Dhcpv6Srv&, isc::data::ConstElementPtr config_set) {
  580. if (!config_set) {
  581. ConstElementPtr answer = isc::config::createAnswer(1,
  582. string("Can't parse NULL config"));
  583. return (answer);
  584. }
  585. /// @todo: Append most essential info here (like "2 new subnets configured")
  586. string config_details;
  587. LOG_DEBUG(dhcp6_logger, DBG_DHCP6_COMMAND,
  588. DHCP6_CONFIG_START).arg(config_set->str());
  589. // Before starting any subnet operations, let's reset the subnet-id counter,
  590. // so newly recreated configuration starts with first subnet-id equal 1.
  591. Subnet::resetSubnetID();
  592. // Some of the values specified in the configuration depend on
  593. // other values. Typically, the values in the subnet6 structure
  594. // depend on the global values. Also, option values configuration
  595. // must be performed after the option definitions configurations.
  596. // Thus we group parsers and will fire them in the right order:
  597. // all parsers other than subnet6 and option-data parser,
  598. // option-data parser, subnet6 parser.
  599. ParserCollection independent_parsers;
  600. ParserPtr subnet_parser;
  601. ParserPtr option_parser;
  602. ParserPtr iface_parser;
  603. // Some of the parsers alter state of the system that can't easily
  604. // be undone. (Or alter it in a way such that undoing the change
  605. // has the same risk of failure as doing the change.)
  606. ParserPtr hooks_parser;
  607. // The subnet parsers implement data inheritance by directly
  608. // accessing global storage. For this reason the global data
  609. // parsers must store the parsed data into global storages
  610. // immediately. This may cause data inconsistency if the
  611. // parsing operation fails after the global storage has been
  612. // modified. We need to preserve the original global data here
  613. // so as we can rollback changes when an error occurs.
  614. ParserContext original_context(*globalContext());
  615. // answer will hold the result.
  616. ConstElementPtr answer;
  617. // rollback informs whether error occured and original data
  618. // have to be restored to global storages.
  619. bool rollback = false;
  620. // config_pair holds ther details of the current parser when iterating over
  621. // the parsers. It is declared outside the loop so in case of error, the
  622. // name of the failing parser can be retrieved within the "catch" clause.
  623. ConfigPair config_pair;
  624. try {
  625. // Make parsers grouping.
  626. const std::map<std::string, ConstElementPtr>& values_map =
  627. config_set->mapValue();
  628. BOOST_FOREACH(config_pair, values_map) {
  629. ParserPtr parser(createGlobal6DhcpConfigParser(config_pair.first));
  630. LOG_DEBUG(dhcp6_logger, DBG_DHCP6_DETAIL, DHCP6_PARSER_CREATED)
  631. .arg(config_pair.first);
  632. if (config_pair.first == "subnet6") {
  633. subnet_parser = parser;
  634. } else if (config_pair.first == "option-data") {
  635. option_parser = parser;
  636. } else if (config_pair.first == "hooks-libraries") {
  637. // Executing the commit will alter currently loaded hooks
  638. // libraries. Check if the supplied libraries are valid,
  639. // but defer the commit until after everything else has
  640. // committed.
  641. hooks_parser = parser;
  642. hooks_parser->build(config_pair.second);
  643. } else if (config_pair.first == "interfaces") {
  644. // The interface parser is independent from any other parser and
  645. // can be run here before other parsers.
  646. parser->build(config_pair.second);
  647. iface_parser = parser;
  648. } else {
  649. // Those parsers should be started before other
  650. // parsers so we can call build straight away.
  651. independent_parsers.push_back(parser);
  652. parser->build(config_pair.second);
  653. // The commit operation here may modify the global storage
  654. // but we need it so as the subnet6 parser can access the
  655. // parsed data.
  656. parser->commit();
  657. }
  658. }
  659. // The option values parser is the next one to be run.
  660. std::map<std::string, ConstElementPtr>::const_iterator option_config =
  661. values_map.find("option-data");
  662. if (option_config != values_map.end()) {
  663. option_parser->build(option_config->second);
  664. option_parser->commit();
  665. }
  666. // The subnet parser is the last one to be run.
  667. std::map<std::string, ConstElementPtr>::const_iterator subnet_config =
  668. values_map.find("subnet6");
  669. if (subnet_config != values_map.end()) {
  670. subnet_parser->build(subnet_config->second);
  671. }
  672. } catch (const isc::Exception& ex) {
  673. LOG_ERROR(dhcp6_logger, DHCP6_PARSER_FAIL)
  674. .arg(config_pair.first).arg(ex.what());
  675. answer = isc::config::createAnswer(1,
  676. string("Configuration parsing failed: ") + ex.what());
  677. // An error occured, so make sure that we restore original data.
  678. rollback = true;
  679. } catch (...) {
  680. // for things like bad_cast in boost::lexical_cast
  681. LOG_ERROR(dhcp6_logger, DHCP6_PARSER_EXCEPTION).arg(config_pair.first);
  682. answer = isc::config::createAnswer(1,
  683. string("Configuration parsing failed"));
  684. // An error occured, so make sure that we restore original data.
  685. rollback = true;
  686. }
  687. // So far so good, there was no parsing error so let's commit the
  688. // configuration. This will add created subnets and option values into
  689. // the server's configuration.
  690. // This operation should be exception safe but let's make sure.
  691. if (!rollback) {
  692. try {
  693. if (subnet_parser) {
  694. subnet_parser->commit();
  695. }
  696. if (iface_parser) {
  697. iface_parser->commit();
  698. }
  699. // This occurs last as if it succeeds, there is no easy way to
  700. // revert it. As a result, the failure to commit a subsequent
  701. // change causes problems when trying to roll back.
  702. if (hooks_parser) {
  703. hooks_parser->commit();
  704. }
  705. }
  706. catch (const isc::Exception& ex) {
  707. LOG_ERROR(dhcp6_logger, DHCP6_PARSER_COMMIT_FAIL).arg(ex.what());
  708. answer = isc::config::createAnswer(2,
  709. string("Configuration commit failed:") + ex.what());
  710. // An error occured, so make sure to restore the original data.
  711. rollback = true;
  712. } catch (...) {
  713. // for things like bad_cast in boost::lexical_cast
  714. LOG_ERROR(dhcp6_logger, DHCP6_PARSER_COMMIT_EXCEPTION);
  715. answer = isc::config::createAnswer(2,
  716. string("Configuration commit failed"));
  717. // An error occured, so make sure to restore the original data.
  718. rollback = true;
  719. }
  720. }
  721. // Rollback changes as the configuration parsing failed.
  722. if (rollback) {
  723. globalContext().reset(new ParserContext(original_context));
  724. return (answer);
  725. }
  726. LOG_INFO(dhcp6_logger, DHCP6_CONFIG_COMPLETE).arg(config_details);
  727. // Everything was fine. Configuration is successful.
  728. answer = isc::config::createAnswer(0, "Configuration committed.");
  729. return (answer);
  730. }
  731. ParserContextPtr& globalContext() {
  732. static ParserContextPtr global_context_ptr(new ParserContext(Option::V6));
  733. return (global_context_ptr);
  734. }
  735. }; // end of isc::dhcp namespace
  736. }; // end of isc namespace