netconf/sal-netconf-connector/src/test/java/org/opendaylight/netconf/sal/connect/netconf/util/NetconfSalKeystoreServiceTest.java

   1 /*
   2  * Copyright (c) 2018 ZTE Corporation. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netconf.sal.connect.netconf.util;
   9
  10 import static org.mockito.ArgumentMatchers.any;
  11 import static org.mockito.Mockito.doNothing;
  12 import static org.mockito.Mockito.doReturn;
  13 import static org.mockito.Mockito.times;
  14 import static org.mockito.Mockito.verify;
  15 import static org.opendaylight.mdsal.common.api.CommitInfo.emptyFluentFuture;
  16
  17 import java.util.ArrayList;
  18 import java.util.List;
  19 import org.junit.Before;
  20 import org.junit.Test;
  21 import org.mockito.Mock;
  22 import org.mockito.MockitoAnnotations;
  23 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
  24 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  25 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  27 import org.opendaylight.netconf.api.xml.XmlUtil;
  28 import org.opendaylight.netconf.sal.connect.util.NetconfSalKeystoreService;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.AddPrivateKeyInput;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.AddPrivateKeyInputBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.AddTrustedCertificateInput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.AddTrustedCertificateInputBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017._private.keys.PrivateKey;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017._private.keys.PrivateKeyBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017._private.keys.PrivateKeyKey;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.trusted.certificates.TrustedCertificate;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.trusted.certificates.TrustedCertificateBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.trusted.certificates.TrustedCertificateKey;
  39 import org.opendaylight.yangtools.yang.binding.DataObject;
  40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  41 import org.w3c.dom.Document;
  42 import org.w3c.dom.Element;
  43 import org.w3c.dom.Node;
  44 import org.w3c.dom.NodeList;
  45
  46 public class NetconfSalKeystoreServiceTest {
  47     private static final String XML_ELEMENT_PRIVATE_KEY = "private-key";
  48     private static final String XML_ELEMENT_NAME = "name";
  49     private static final String XML_ELEMENT_DATA = "data";
  50     private static final String XML_ELEMENT_CERT_CHAIN = "certificate-chain";
  51     private static final String XML_ELEMENT_TRUSTED_CERT = "trusted-certificate";
  52     private static final String XML_ELEMENT_CERT = "certificate";
  53
  54     @Mock
  55     private WriteTransaction writeTx;
  56     @Mock
  57     private DataBroker dataBroker;
  58     @Mock
  59     private AAAEncryptionService encryptionService;
  60
  61     @Before
  62     public void setUp() {
  63         MockitoAnnotations.initMocks(this);
  64         doReturn(writeTx).when(dataBroker).newWriteOnlyTransaction();
  65         doNothing().when(writeTx)
  66             .merge(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(DataObject.class));
  67     }
  68
  69     @Test
  70     public void testAddPrivateKey() throws Exception {
  71         doReturn(emptyFluentFuture()).when(writeTx).commit();
  72         NetconfSalKeystoreService keystoreService = new NetconfSalKeystoreService(dataBroker, encryptionService);
  73
  74         final AddPrivateKeyInput input = getPrivateKeyInput();
  75         keystoreService.addPrivateKey(input);
  76
  77         verify(writeTx, times(input.getPrivateKey().size() + 1))
  78             .merge(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(DataObject.class));
  79     }
  80
  81     @Test
  82     public void testAddTrustedCertificate() throws Exception {
  83         doReturn(emptyFluentFuture()).when(writeTx).commit();
  84         NetconfSalKeystoreService keystoreService = new NetconfSalKeystoreService(dataBroker, encryptionService);
  85
  86         final AddTrustedCertificateInput input = getTrustedCertificateInput();
  87         keystoreService.addTrustedCertificate(input);
  88
  89         verify(writeTx, times(input.getTrustedCertificate().size() + 1))
  90             .merge(any(LogicalDatastoreType.class), any(InstanceIdentifier.class), any(DataObject.class));
  91     }
  92
  93     private AddPrivateKeyInput getPrivateKeyInput() throws Exception {
  94         final List<PrivateKey> privateKeys = new ArrayList<>();
  95         final Document document = readKeystoreXML();
  96         final NodeList nodeList = document.getElementsByTagName(XML_ELEMENT_PRIVATE_KEY);
  97         for (int i = 0; i < nodeList.getLength(); i++) {
  98             final Node node = nodeList.item(i);
  99             if (node.getNodeType() != Node.ELEMENT_NODE) {
 100                 continue;
 101             }
 102             final Element element = (Element)node;
 103             final String keyName = element.getElementsByTagName(XML_ELEMENT_NAME).item(0).getTextContent();
 104             final String keyData = element.getElementsByTagName(XML_ELEMENT_DATA).item(0).getTextContent();
 105             final NodeList certNodes = element.getElementsByTagName(XML_ELEMENT_CERT_CHAIN);
 106             final List<String> certChain = new ArrayList<>();
 107             for (int j = 0; j < certNodes.getLength(); j++) {
 108                 final Node certNode = certNodes.item(j);
 109                 if (certNode.getNodeType() != Node.ELEMENT_NODE) {
 110                     continue;
 111                 }
 112                 certChain.add(certNode.getTextContent());
 113             }
 114
 115             final PrivateKey privateKey = new PrivateKeyBuilder()
 116                     .withKey(new PrivateKeyKey(keyName))
 117                     .setName(keyName)
 118                     .setData(keyData)
 119                     .setCertificateChain(certChain)
 120                     .build();
 121             privateKeys.add(privateKey);
 122         }
 123
 124         return new AddPrivateKeyInputBuilder().setPrivateKey(privateKeys).build();
 125     }
 126
 127     private AddTrustedCertificateInput getTrustedCertificateInput() throws Exception {
 128         final List<TrustedCertificate> trustedCertificates = new ArrayList<>();
 129         final Document document = readKeystoreXML();
 130         final NodeList nodeList = document.getElementsByTagName(XML_ELEMENT_TRUSTED_CERT);
 131         for (int i = 0; i < nodeList.getLength(); i++) {
 132             final Node node = nodeList.item(i);
 133             if (node.getNodeType() != Node.ELEMENT_NODE) {
 134                 continue;
 135             }
 136             final Element element = (Element)node;
 137             final String certName = element.getElementsByTagName(XML_ELEMENT_NAME).item(0).getTextContent();
 138             final String certData = element.getElementsByTagName(XML_ELEMENT_CERT).item(0).getTextContent();
 139
 140             final TrustedCertificate certificate = new TrustedCertificateBuilder()
 141                     .withKey(new TrustedCertificateKey(certName))
 142                     .setName(certName)
 143                     .setCertificate(certData)
 144                     .build();
 145             trustedCertificates.add(certificate);
 146         }
 147
 148         return new AddTrustedCertificateInputBuilder().setTrustedCertificate(trustedCertificates).build();
 149     }
 150
 151     private Document readKeystoreXML() throws Exception {
 152         return XmlUtil.readXmlToDocument(getClass().getResourceAsStream("/netconf-keystore.xml"));
 153     }
 154 }