blob: 5fdca6d97b4f5dcbe75ceae5eb88e7722c1b6042 [file] [log] [blame]
Andrea Campanellad8d92db2016-01-14 16:24:41 -08001/*
Brian O'Connora09fe5b2017-08-03 21:12:30 -07002 * Copyright 2016-present Open Networking Foundation
Andrea Campanellad8d92db2016-01-14 16:24:41 -08003 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Andrea Campanella238d96e2016-01-20 11:52:02 -080017package org.onosproject.drivers.utilities;
Andrea Campanellad8d92db2016-01-14 16:24:41 -080018
Andrea Campanellad8d92db2016-01-14 16:24:41 -080019import org.apache.commons.configuration.ConfigurationException;
20import org.apache.commons.configuration.HierarchicalConfiguration;
21import org.apache.commons.configuration.XMLConfiguration;
22import org.apache.commons.configuration.tree.ConfigurationNode;
23import org.onlab.packet.IpAddress;
Andrea Campanellad8d92db2016-01-14 16:24:41 -080024import org.onosproject.net.behaviour.ControllerInfo;
Andrea Campanellad8d92db2016-01-14 16:24:41 -080025import org.slf4j.Logger;
26import org.slf4j.LoggerFactory;
27
Andrea Campanellaaf1fa392018-06-26 11:16:51 +020028import javax.xml.parsers.DocumentBuilderFactory;
29import javax.xml.parsers.ParserConfigurationException;
Yuta HIGUCHI0184a7b2017-03-31 13:13:58 -070030import java.io.ByteArrayInputStream;
Andrea Campanellad8d92db2016-01-14 16:24:41 -080031import java.io.InputStream;
32import java.io.StringWriter;
Yuta HIGUCHI0184a7b2017-03-31 13:13:58 -070033import java.nio.charset.StandardCharsets;
Andrea Campanellad8d92db2016-01-14 16:24:41 -080034import java.util.ArrayList;
35import java.util.List;
Aaron Kruglikov17b4c852016-01-15 16:37:04 -080036
Andrea Campanellad8d92db2016-01-14 16:24:41 -080037/**
38 * Parser for Netconf XML configurations and replys.
39 */
40public final class XmlConfigParser {
41 public static final Logger log = LoggerFactory
42 .getLogger(XmlConfigParser.class);
43
Andrea Campanellaaf1fa392018-06-26 11:16:51 +020044 private static final String DISALLOW_DTD_FEATURE = "http://apache.org/xml/features/disallow-doctype-decl";
45 private static final String DISALLOW_EXTERNAL_DTD =
46 "http://apache.org/xml/features/nonvalidating/load-external-dtd";
47
Andrea Campanellad8d92db2016-01-14 16:24:41 -080048 private XmlConfigParser() {
49 //not called, preventing any allocation
50 }
51
52
53 public static HierarchicalConfiguration loadXml(InputStream xmlStream) {
Andrea Campanellad8d92db2016-01-14 16:24:41 -080054 try {
Andrea Campanellaaf1fa392018-06-26 11:16:51 +020055 XMLConfiguration cfg = new XMLConfiguration();
56 DocumentBuilderFactory dbfactory = DocumentBuilderFactory.newInstance();
57 //Disabling DTDs in order to avoid XXE xml-based attacks.
58 disableFeature(dbfactory, DISALLOW_DTD_FEATURE);
59 disableFeature(dbfactory, DISALLOW_EXTERNAL_DTD);
60 dbfactory.setXIncludeAware(false);
61 dbfactory.setExpandEntityReferences(false);
62 cfg.setDocumentBuilder(dbfactory.newDocumentBuilder());
Andrea Campanellad8d92db2016-01-14 16:24:41 -080063 cfg.load(xmlStream);
64 return cfg;
Andrea Campanellaaf1fa392018-06-26 11:16:51 +020065 } catch (ConfigurationException | ParserConfigurationException e) {
Andrea Campanellad8d92db2016-01-14 16:24:41 -080066 throw new IllegalArgumentException("Cannot load xml from Stream", e);
67 }
68 }
69
Yuta HIGUCHI0184a7b2017-03-31 13:13:58 -070070 public static HierarchicalConfiguration loadXmlString(String xmlStr) {
71 return loadXml(new ByteArrayInputStream(xmlStr.getBytes(StandardCharsets.UTF_8)));
72 }
73
Andrea Campanellad8d92db2016-01-14 16:24:41 -080074 public static List<ControllerInfo> parseStreamControllers(HierarchicalConfiguration cfg) {
75 List<ControllerInfo> controllers = new ArrayList<>();
76 List<HierarchicalConfiguration> fields =
77 cfg.configurationsAt("data.capable-switch." +
Andrea Campanellaaf1fa392018-06-26 11:16:51 +020078 "logical-switches." +
79 "switch.controllers.controller");
Andrea Campanellad8d92db2016-01-14 16:24:41 -080080 for (HierarchicalConfiguration sub : fields) {
81 controllers.add(new ControllerInfo(
82 IpAddress.valueOf(sub.getString("ip-address")),
83 Integer.parseInt(sub.getString("port")),
84 sub.getString("protocol")));
85 }
86 return controllers;
87 }
88
Aaron Kruglikov17b4c852016-01-15 16:37:04 -080089
90 protected static String parseSwitchId(HierarchicalConfiguration cfg) {
Andrea Campanellad8d92db2016-01-14 16:24:41 -080091 HierarchicalConfiguration field =
92 cfg.configurationAt("data.capable-switch." +
Andrea Campanellaaf1fa392018-06-26 11:16:51 +020093 "logical-switches." +
94 "switch");
Andrea Campanellad8d92db2016-01-14 16:24:41 -080095 return field.getProperty("id").toString();
96 }
97
98 public static String parseCapableSwitchId(HierarchicalConfiguration cfg) {
99 HierarchicalConfiguration field =
100 cfg.configurationAt("data.capable-switch");
101 return field.getProperty("id").toString();
102 }
103
104 public static String createControllersConfig(HierarchicalConfiguration cfg,
105 HierarchicalConfiguration actualCfg,
106 String target, String netconfOperation,
107 String controllerOperation,
108 List<ControllerInfo> controllers) {
109 //cfg.getKeys().forEachRemaining(key -> System.out.println(key));
110 cfg.setProperty("edit-config.target", target);
111 cfg.setProperty("edit-config.default-operation", netconfOperation);
112 cfg.setProperty("edit-config.config.capable-switch.id",
Andrea Campanellaaf1fa392018-06-26 11:16:51 +0200113 parseCapableSwitchId(actualCfg));
Andrea Campanellad8d92db2016-01-14 16:24:41 -0800114 cfg.setProperty("edit-config.config.capable-switch." +
Andrea Campanellaaf1fa392018-06-26 11:16:51 +0200115 "logical-switches.switch.id", parseSwitchId(actualCfg));
Andrea Campanellad8d92db2016-01-14 16:24:41 -0800116 List<ConfigurationNode> newControllers = new ArrayList<>();
117 for (ControllerInfo ci : controllers) {
118 XMLConfiguration controller = new XMLConfiguration();
119 controller.setRoot(new HierarchicalConfiguration.Node("controller"));
120 String id = ci.type() + ":" + ci.ip() + ":" + ci.port();
121 controller.setProperty("id", id);
122 controller.setProperty("ip-address", ci.ip());
123 controller.setProperty("port", ci.port());
124 controller.setProperty("protocol", ci.type());
125 newControllers.add(controller.getRootNode());
126 }
127 cfg.addNodes("edit-config.config.capable-switch.logical-switches." +
Andrea Campanellaaf1fa392018-06-26 11:16:51 +0200128 "switch.controllers", newControllers);
Andrea Campanellad8d92db2016-01-14 16:24:41 -0800129 XMLConfiguration editcfg = (XMLConfiguration) cfg;
130 StringWriter stringWriter = new StringWriter();
131 try {
132 editcfg.save(stringWriter);
133 } catch (ConfigurationException e) {
134 log.error("createControllersConfig()", e);
135 }
136 String s = stringWriter.toString()
137 .replaceAll("<controller>",
Andrea Campanellaaf1fa392018-06-26 11:16:51 +0200138 "<controller nc:operation=\"" + controllerOperation + "\">");
Andrea Campanellad8d92db2016-01-14 16:24:41 -0800139 s = s.replace("<target>" + target + "</target>",
Andrea Campanellaaf1fa392018-06-26 11:16:51 +0200140 "<target><" + target + "/></target>");
Andrea Campanellad8d92db2016-01-14 16:24:41 -0800141 return s;
142
143 }
144
Andrea Campanellad8d92db2016-01-14 16:24:41 -0800145 //TODO implement mor methods for parsing configuration when you need them
Andreas Papazois1dff77c2016-02-16 16:27:33 +0200146
147 /**
148 * Parses a config reply and returns the result.
Andrea Campanellaaf1fa392018-06-26 11:16:51 +0200149 *
Andreas Papazois1dff77c2016-02-16 16:27:33 +0200150 * @param reply a tree-like source
151 * @return the configuration result
152 */
153 public static boolean configSuccess(HierarchicalConfiguration reply) {
154 if (reply != null) {
155 if (reply.containsKey("ok")) {
156 return true;
157 }
158 }
159 return false;
160 }
Andrea Campanellaaf1fa392018-06-26 11:16:51 +0200161
162 private static void disableFeature(DocumentBuilderFactory dbfactory, String feature) {
163 try {
164 dbfactory.setFeature(feature, true);
165 } catch (ParserConfigurationException e) {
166 // This should catch a failed setFeature feature
167 log.info("ParserConfigurationException was thrown. The feature '" +
168 feature + "' is probably not supported by your XML processor.");
169 }
170 }
Andrea Campanellad8d92db2016-01-14 16:24:41 -0800171}