netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/util/NetconfTopologyRPCProvider.java

   1 /*
   2  * Copyright (c) 2017 Brocade Communication Systems 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.util;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.MoreExecutors;
  16 import com.google.common.util.concurrent.SettableFuture;
  17 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
  18 import org.opendaylight.mdsal.binding.api.DataBroker;
  19 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  20 import org.opendaylight.mdsal.common.api.CommitInfo;
  21 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.CreateDeviceInput;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.CreateDeviceOutput;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.CreateDeviceOutputBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.DeleteDeviceInput;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.DeleteDeviceOutput;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.DeleteDeviceOutputBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeTopologyService;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPw;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPwBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.login.pw.LoginPassword;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.login.pw.LoginPasswordBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.common.RpcResult;
  45 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 public class NetconfTopologyRPCProvider implements NetconfNodeTopologyService {
  50     private static final Logger LOG = LoggerFactory.getLogger(NetconfTopologyRPCProvider.class);
  51
  52     private final InstanceIdentifier<Topology> topologyPath;
  53     private final AAAEncryptionService encryptionService;
  54     private final DataBroker dataBroker;
  55
  56     public NetconfTopologyRPCProvider(final DataBroker dataBroker,
  57                                       final AAAEncryptionService encryptionService,
  58                                       final String topologyId) {
  59         this.dataBroker = dataBroker;
  60         this.encryptionService = requireNonNull(encryptionService);
  61         this.topologyPath = InstanceIdentifier.builder(NetworkTopology.class)
  62                 .child(Topology.class, new TopologyKey(new TopologyId(requireNonNull(topologyId)))).build();
  63     }
  64
  65     @Override
  66     public ListenableFuture<RpcResult<CreateDeviceOutput>> createDevice(final CreateDeviceInput input) {
  67         final NetconfNode node = this.encryptPassword(input);
  68         final SettableFuture<RpcResult<CreateDeviceOutput>> futureResult = SettableFuture.create();
  69         final NodeId nodeId = new NodeId(input.getNodeId());
  70         writeToConfigDS(node, nodeId, futureResult);
  71         return futureResult;
  72     }
  73
  74     @VisibleForTesting
  75     public NetconfNode encryptPassword(final CreateDeviceInput input) {
  76         final NetconfNodeBuilder builder = new NetconfNodeBuilder();
  77         builder.fieldsFrom(input);
  78
  79         final Credentials credentials = handleEncryption(input.getCredentials());
  80         builder.setCredentials(credentials);
  81
  82         return builder.build();
  83     }
  84
  85     private Credentials handleEncryption(final Credentials credentials) {
  86         if (credentials instanceof LoginPw) {
  87             final LoginPassword loginPassword = ((LoginPw) credentials).getLoginPassword();
  88             final String encryptedPassword =
  89                     encryptionService.encrypt(loginPassword.getPassword());
  90
  91             return new LoginPwBuilder().setLoginPassword(new LoginPasswordBuilder()
  92                     .setPassword(encryptedPassword)
  93                     .setUsername(loginPassword.getUsername()).build()).build();
  94         }
  95
  96         // nothing else needs to be encrypted
  97         return credentials;
  98     }
  99
 100     private void writeToConfigDS(final NetconfNode node, final NodeId nodeId,
 101             final SettableFuture<RpcResult<CreateDeviceOutput>> futureResult) {
 102
 103         final WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 104         final InstanceIdentifier<NetconfNode> niid = topologyPath.child(Node.class,
 105                 new NodeKey(nodeId)).augmentation(NetconfNode.class);
 106         writeTransaction.merge(LogicalDatastoreType.CONFIGURATION, niid, node, true);
 107         writeTransaction.commit().addCallback(new FutureCallback<CommitInfo>() {
 108
 109             @Override
 110             public void onSuccess(final CommitInfo result) {
 111                 LOG.info("add-netconf-node RPC: Added netconf node successfully.");
 112                 futureResult.set(RpcResultBuilder.success(new CreateDeviceOutputBuilder().build()).build());
 113             }
 114
 115             @Override
 116             public void onFailure(final Throwable exception) {
 117                 LOG.error("add-netconf-node RPC: Unable to add netconf node.", exception);
 118                 futureResult.setException(exception);
 119             }
 120         }, MoreExecutors.directExecutor());
 121     }
 122
 123
 124     @Override
 125     public ListenableFuture<RpcResult<DeleteDeviceOutput>> deleteDevice(final DeleteDeviceInput input) {
 126         final NodeId nodeId = new NodeId(input.getNodeId());
 127
 128         final InstanceIdentifier<Node> niid = topologyPath.child(Node.class, new NodeKey(nodeId));
 129
 130         final WriteTransaction wtx = dataBroker.newWriteOnlyTransaction();
 131         wtx.delete(LogicalDatastoreType.CONFIGURATION, niid);
 132
 133         final SettableFuture<RpcResult<DeleteDeviceOutput>> rpcFuture = SettableFuture.create();
 134
 135         wtx.commit().addCallback(new FutureCallback<CommitInfo>() {
 136
 137             @Override
 138             public void onSuccess(final CommitInfo result) {
 139                 LOG.info("delete-device RPC: Removed netconf node successfully.");
 140                 rpcFuture.set(RpcResultBuilder.success(new DeleteDeviceOutputBuilder().build()).build());
 141             }
 142
 143             @Override
 144             public void onFailure(final Throwable exception) {
 145                 LOG.error("delete-device RPC: Unable to remove netconf node.", exception);
 146                 rpcFuture.setException(exception);
 147             }
 148         }, MoreExecutors.directExecutor());
 149
 150         return rpcFuture;
 151     }
 152 }