2 * Copyright (c) 2016 Brocade Communication Systems and others. All rights reserved.
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
8 package org.opendaylight.netconf.callhome.mount;
10 import com.google.common.net.InetAddresses;
11 import java.io.IOException;
12 import java.net.InetSocketAddress;
13 import java.net.SocketAddress;
14 import java.security.GeneralSecurityException;
15 import java.security.PublicKey;
16 import java.util.Collection;
17 import java.util.concurrent.ConcurrentHashMap;
18 import java.util.concurrent.ConcurrentMap;
19 import javax.annotation.Nonnull;
20 import org.opendaylight.mdsal.binding.api.DataBroker;
21 import org.opendaylight.mdsal.binding.api.DataObjectModification;
22 import org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType;
23 import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
24 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
25 import org.opendaylight.mdsal.binding.api.DataTreeModification;
26 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
27 import org.opendaylight.netconf.callhome.protocol.AuthorizedKeysDecoder;
28 import org.opendaylight.netconf.callhome.protocol.CallHomeAuthorization;
29 import org.opendaylight.netconf.callhome.protocol.CallHomeAuthorization.Builder;
30 import org.opendaylight.netconf.callhome.protocol.CallHomeAuthorizationProvider;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netconf.callhome.server.rev161109.NetconfCallhomeServer;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netconf.callhome.server.rev161109.credentials.Credentials;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netconf.callhome.server.rev161109.netconf.callhome.server.AllowedDevices;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netconf.callhome.server.rev161109.netconf.callhome.server.Global;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netconf.callhome.server.rev161109.netconf.callhome.server.allowed.devices.Device;
36 import org.opendaylight.yangtools.concepts.ListenerRegistration;
37 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
41 public class CallHomeAuthProviderImpl implements CallHomeAuthorizationProvider, AutoCloseable {
43 private static final Logger LOG = LoggerFactory.getLogger(CallHomeAuthProviderImpl.class);
44 private static final InstanceIdentifier<Global> GLOBAL_PATH =
45 InstanceIdentifier.create(NetconfCallhomeServer.class).child(Global.class);
46 private static final DataTreeIdentifier<Global> GLOBAL =
47 DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION, GLOBAL_PATH);
49 private static final InstanceIdentifier<Device> ALLOWED_DEVICES_PATH =
50 InstanceIdentifier.create(NetconfCallhomeServer.class).child(AllowedDevices.class).child(Device.class);
51 private static final DataTreeIdentifier<Device> ALLOWED_DEVICES =
52 DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION, ALLOWED_DEVICES_PATH);
53 private static final DataTreeIdentifier<Device> ALLOWED_OP_DEVICES =
54 DataTreeIdentifier.create(LogicalDatastoreType.OPERATIONAL, ALLOWED_DEVICES_PATH);
56 private final GlobalConfig globalConfig = new GlobalConfig();
57 private final DeviceConfig deviceConfig = new DeviceConfig();
58 private final DeviceOp deviceOp = new DeviceOp();
59 private final ListenerRegistration<GlobalConfig> configReg;
60 private final ListenerRegistration<DeviceConfig> deviceReg;
61 private final ListenerRegistration<DeviceOp> deviceOpReg;
63 private final CallhomeStatusReporter statusReporter;
65 CallHomeAuthProviderImpl(final DataBroker broker) {
66 configReg = broker.registerDataTreeChangeListener(GLOBAL, globalConfig);
67 deviceReg = broker.registerDataTreeChangeListener(ALLOWED_DEVICES, deviceConfig);
68 deviceOpReg = broker.registerDataTreeChangeListener(ALLOWED_OP_DEVICES, deviceOp);
69 statusReporter = new CallhomeStatusReporter(broker);
74 public CallHomeAuthorization provideAuth(@Nonnull final SocketAddress remoteAddress,
75 @Nonnull final PublicKey serverKey) {
76 Device deviceSpecific = deviceConfig.get(serverKey);
78 Credentials deviceCred;
80 if (deviceSpecific != null) {
81 sessionName = deviceSpecific.getUniqueId();
82 deviceCred = deviceSpecific.getCredentials();
84 String syntheticId = fromRemoteAddress(remoteAddress);
85 if (globalConfig.allowedUnknownKeys()) {
86 sessionName = syntheticId;
88 statusReporter.asForceListedDevice(syntheticId, serverKey);
90 Device opDevice = deviceOp.get(serverKey);
91 if (opDevice == null) {
92 statusReporter.asUnlistedDevice(syntheticId, serverKey);
94 LOG.info("Repeating rejection of unlisted device with id of {}", opDevice.getUniqueId());
96 return CallHomeAuthorization.rejected();
100 final Credentials credentials = deviceCred != null ? deviceCred : globalConfig.getCredentials();
102 if (credentials == null) {
103 LOG.info("No credentials found for {}, rejecting.", remoteAddress);
104 return CallHomeAuthorization.rejected();
107 Builder authBuilder = CallHomeAuthorization.serverAccepted(sessionName, credentials.getUsername());
108 for (String password : credentials.getPasswords()) {
109 authBuilder.addPassword(password);
111 return authBuilder.build();
115 public void close() {
121 private static String fromRemoteAddress(final SocketAddress remoteAddress) {
122 if (remoteAddress instanceof InetSocketAddress) {
123 InetSocketAddress socketAddress = (InetSocketAddress) remoteAddress;
124 return InetAddresses.toAddrString(socketAddress.getAddress()) + ":" + socketAddress.getPort();
126 return remoteAddress.toString();
129 private abstract static class AbstractDeviceListener implements DataTreeChangeListener<Device> {
132 public final void onDataTreeChanged(final Collection<DataTreeModification<Device>> mods) {
133 for (DataTreeModification<Device> dataTreeModification : mods) {
134 final DataObjectModification<Device> deviceMod = dataTreeModification.getRootNode();
135 final ModificationType modType = deviceMod.getModificationType();
138 deleteDevice(deviceMod.getDataBefore());
140 case SUBTREE_MODIFIED:
142 deleteDevice(deviceMod.getDataBefore());
143 writeDevice(deviceMod.getDataAfter());
146 throw new IllegalStateException("Unhandled modification type " + modType);
151 private void deleteDevice(final Device dataBefore) {
152 if (dataBefore != null) {
153 final String publicKey = dataBefore.getSshHostKey();
154 if (publicKey != null) {
155 LOG.debug("Removing device {}", dataBefore.getUniqueId());
156 removeDevice(publicKey, dataBefore);
158 LOG.debug("Ignoring removal of device {}, no host key present", dataBefore.getUniqueId());
163 private void writeDevice(final Device dataAfter) {
164 final String publicKey = dataAfter.getSshHostKey();
165 if (publicKey != null) {
166 LOG.debug("Adding device {}", dataAfter.getUniqueId());
167 addDevice(publicKey, dataAfter);
169 LOG.debug("Ignoring addition of device {}, no host key present", dataAfter.getUniqueId());
173 abstract void addDevice(String publicKey, Device device);
175 abstract void removeDevice(String publicKey, Device device);
178 private static class DeviceConfig extends AbstractDeviceListener {
179 private final ConcurrentMap<PublicKey, Device> byPublicKey = new ConcurrentHashMap<>();
180 private final AuthorizedKeysDecoder keyDecoder = new AuthorizedKeysDecoder();
182 Device get(final PublicKey key) {
183 return byPublicKey.get(key);
187 void addDevice(final String publicKey, final Device device) {
188 final PublicKey key = publicKey(publicKey, device);
190 byPublicKey.put(key, device);
195 void removeDevice(final String publicKey, final Device device) {
196 final PublicKey key = publicKey(publicKey, device);
198 byPublicKey.remove(key);
202 private PublicKey publicKey(final String hostKey, final Device device) {
204 return keyDecoder.decodePublicKey(hostKey);
205 } catch (GeneralSecurityException e) {
206 LOG.error("Unable to decode SSH key for {}. Ignoring update for this device", device.getUniqueId(), e);
212 private static class DeviceOp extends AbstractDeviceListener {
213 private final ConcurrentMap<String, Device> byPublicKey = new ConcurrentHashMap<>();
215 Device get(final PublicKey serverKey) {
218 skey = AuthorizedKeysDecoder.encodePublicKey(serverKey);
219 } catch (IOException | IllegalArgumentException e) {
220 LOG.error("Unable to encode server key: {}", serverKey, e);
224 return byPublicKey.get(skey);
228 void removeDevice(final String publicKey, final Device device) {
229 byPublicKey.remove(publicKey);
233 void addDevice(final String publicKey, final Device device) {
234 byPublicKey.put(publicKey, device);
238 private static class GlobalConfig implements DataTreeChangeListener<Global> {
239 private volatile Global current = null;
242 public void onDataTreeChanged(@Nonnull final Collection<DataTreeModification<Global>> mods) {
243 for (DataTreeModification<Global> dataTreeModification : mods) {
244 current = dataTreeModification.getRootNode().getDataAfter();
248 boolean allowedUnknownKeys() {
249 final Global local = current;
250 // Deal with null values.
251 return local != null && Boolean.TRUE.equals(local.isAcceptAllSshKeys());
254 Credentials getCredentials() {
255 final Global local = current;
256 return local != null ? local.getCredentials() : null;