clean test environment
[transportpce.git] / tests / honeynode / 2.2.1 / netconf-netty-util / src / main / java / org / opendaylight / netconf / nettyutil / handler / NetconfEXICodec.java
diff --git a/tests/honeynode/2.2.1/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/NetconfEXICodec.java b/tests/honeynode/2.2.1/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/NetconfEXICodec.java
new file mode 100644 (file)
index 0000000..b8924bb
--- /dev/null
@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.netconf.nettyutil.handler;
+
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.cache.CacheBuilder;
+import com.google.common.cache.CacheLoader;
+import com.google.common.cache.LoadingCache;
+import com.siemens.ct.exi.core.EXIFactory;
+import com.siemens.ct.exi.core.exceptions.EXIException;
+import com.siemens.ct.exi.main.api.sax.SAXEncoder;
+import com.siemens.ct.exi.main.api.sax.SAXFactory;
+import org.opendaylight.netconf.nettyutil.handler.exi.EXIParameters;
+import org.xml.sax.EntityResolver;
+import org.xml.sax.InputSource;
+import org.xml.sax.XMLReader;
+
+public final class NetconfEXICodec {
+    /**
+     * OpenEXI does not allow us to directly prevent resolution of external entities. In order
+     * to prevent XXE attacks, we reuse a single no-op entity resolver.
+     */
+    private static final EntityResolver ENTITY_RESOLVER = (publicId, systemId) -> new InputSource();
+
+    /**
+     * Since we have a limited number of options we can have, instantiating a weak cache
+     * will allow us to reuse instances where possible.
+     */
+    private static final LoadingCache<EXIParameters, NetconfEXICodec> CODECS =
+            CacheBuilder.newBuilder().weakValues().build(new CacheLoader<EXIParameters, NetconfEXICodec>() {
+                @Override
+                public NetconfEXICodec load(final EXIParameters key) {
+                    return new NetconfEXICodec(key.getFactory());
+                }
+            });
+
+    private final SAXFactory exiFactory;
+
+    private NetconfEXICodec(final EXIFactory exiFactory) {
+        this.exiFactory = new SAXFactory(requireNonNull(exiFactory));
+    }
+
+    public static NetconfEXICodec forParameters(final EXIParameters parameters) {
+        return CODECS.getUnchecked(parameters);
+    }
+
+    XMLReader getReader() throws EXIException {
+        final XMLReader reader = exiFactory.createEXIReader();
+        reader.setEntityResolver(ENTITY_RESOLVER);
+        return reader;
+    }
+
+    SAXEncoder getWriter() throws EXIException {
+        final SAXEncoder writer = exiFactory.createEXIWriter();
+        return writer;
+    }
+}