apps/netconf-topology/src/main/java/org/opendaylight/netconf/topology/spi/NetconfClientConfigurationBuilderFactoryImpl.java

   1 /*
   2  * Copyright (c) 2023 PANTHEON.tech, s.r.o. 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.topology.spi;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.Strings;
  13 import java.io.IOException;
  14 import java.io.StringReader;
  15 import java.security.KeyPair;
  16 import java.security.Provider;
  17 import java.security.Security;
  18 import java.util.Base64;
  19 import java.util.List;
  20 import javax.inject.Inject;
  21 import javax.inject.Singleton;
  22 import org.bouncycastle.jce.provider.BouncyCastleProvider;
  23 import org.bouncycastle.openssl.PEMEncryptedKeyPair;
  24 import org.bouncycastle.openssl.PEMKeyPair;
  25 import org.bouncycastle.openssl.PEMParser;
  26 import org.bouncycastle.openssl.jcajce.JcaPEMKeyConverter;
  27 import org.bouncycastle.openssl.jcajce.JcePEMDecryptorProviderBuilder;
  28 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
  29 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration.NetconfClientProtocol;
  30 import org.opendaylight.netconf.client.conf.NetconfClientConfigurationBuilder;
  31 import org.opendaylight.netconf.client.mdsal.api.CredentialProvider;
  32 import org.opendaylight.netconf.client.mdsal.api.SslHandlerFactoryProvider;
  33 import org.opendaylight.netconf.shaded.sshd.client.auth.pubkey.UserAuthPublicKeyFactory;
  34 import org.opendaylight.netconf.shaded.sshd.common.keyprovider.KeyIdentityProvider;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.crypto.types.rev231228.password.grouping.password.type.CleartextPasswordBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.client.rev231228.netconf.client.initiate.stack.grouping.transport.ssh.ssh.SshClientParametersBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.client.rev231228.netconf.client.initiate.stack.grouping.transport.ssh.ssh.TcpClientParametersBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ssh.client.rev231228.ssh.client.grouping.ClientIdentity;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ssh.client.rev231228.ssh.client.grouping.ClientIdentityBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ssh.client.rev231228.ssh.client.grouping.client.identity.PasswordBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.connection.parameters.Protocol.Name;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.credentials.Credentials;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.credentials.credentials.KeyAuth;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.credentials.credentials.LoginPw;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.credentials.credentials.LoginPwUnencrypted;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev231121.NetconfNode;
  47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  48 import org.osgi.service.component.annotations.Activate;
  49 import org.osgi.service.component.annotations.Component;
  50 import org.osgi.service.component.annotations.Reference;
  51
  52 /**
  53  * Default implementation of NetconfClientConfigurationBuildFactory.
  54  */
  55 @Component
  56 @Singleton
  57 public final class NetconfClientConfigurationBuilderFactoryImpl implements NetconfClientConfigurationBuilderFactory {
  58     private static final Provider BCPROV;
  59
  60     static {
  61         final var prov = Security.getProvider(BouncyCastleProvider.PROVIDER_NAME);
  62         BCPROV = prov != null ? prov : new BouncyCastleProvider();
  63     }
  64
  65     private final SslHandlerFactoryProvider sslHandlerFactoryProvider;
  66     private final AAAEncryptionService encryptionService;
  67     private final CredentialProvider credentialProvider;
  68
  69     @Inject
  70     @Activate
  71     public NetconfClientConfigurationBuilderFactoryImpl(
  72             @Reference final AAAEncryptionService encryptionService,
  73             @Reference final CredentialProvider credentialProvider,
  74             @Reference final SslHandlerFactoryProvider sslHandlerFactoryProvider) {
  75         this.encryptionService = requireNonNull(encryptionService);
  76         this.credentialProvider = requireNonNull(credentialProvider);
  77         this.sslHandlerFactoryProvider = requireNonNull(sslHandlerFactoryProvider);
  78     }
  79
  80     @Override
  81     public NetconfClientConfigurationBuilder createClientConfigurationBuilder(final NodeId nodeId,
  82         final NetconfNode node) {
  83         final var builder = NetconfClientConfigurationBuilder.create();
  84         final var protocol = node.getProtocol();
  85         if (node.requireTcpOnly()) {
  86             builder.withProtocol(NetconfClientProtocol.TCP);
  87         } else if (protocol == null || protocol.getName() == Name.SSH) {
  88             builder.withProtocol(NetconfClientProtocol.SSH);
  89             setSshParametersFromCredentials(builder, node.getCredentials());
  90         } else if (protocol.getName() == Name.TLS) {
  91             builder.withProtocol(NetconfClientProtocol.TLS).withSslHandlerFactory(
  92                 channel -> sslHandlerFactoryProvider.getSslHandlerFactory(protocol.getSpecification())
  93                     .createSslHandler());
  94         } else {
  95             throw new IllegalArgumentException("Unsupported protocol type: " + protocol.getName());
  96         }
  97
  98         final var helloCapabilities = node.getOdlHelloMessageCapabilities();
  99         if (helloCapabilities != null) {
 100             builder.withOdlHelloCapabilities(List.copyOf(helloCapabilities.requireCapability()));
 101         }
 102
 103         return builder
 104             .withName(nodeId.getValue())
 105             .withTcpParameters(new TcpClientParametersBuilder()
 106                 .setRemoteAddress(node.requireHost())
 107                 .setRemotePort(node.requirePort()).build())
 108             .withConnectionTimeoutMillis(node.requireConnectionTimeoutMillis().toJava());
 109     }
 110
 111     private void setSshParametersFromCredentials(final NetconfClientConfigurationBuilder confBuilder,
 112             final Credentials credentials) {
 113         final var sshParamsBuilder = new SshClientParametersBuilder();
 114         if (credentials instanceof LoginPwUnencrypted unencrypted) {
 115             final var loginPassword = unencrypted.getLoginPasswordUnencrypted();
 116             sshParamsBuilder.setClientIdentity(loginPasswordIdentity(
 117                 loginPassword.getUsername(), loginPassword.getPassword()));
 118         } else if (credentials instanceof LoginPw loginPw) {
 119             final var loginPassword = loginPw.getLoginPassword();
 120             final var username = loginPassword.getUsername();
 121             final var password = Base64.getEncoder().encodeToString(loginPassword.getPassword());
 122             sshParamsBuilder.setClientIdentity(loginPasswordIdentity(username, encryptionService.decrypt(password)));
 123         } else if (credentials instanceof KeyAuth keyAuth) {
 124             final var keyBased = keyAuth.getKeyBased();
 125             sshParamsBuilder.setClientIdentity(new ClientIdentityBuilder().setUsername(keyBased.getUsername()).build());
 126             confBuilder.withSshConfigurator(factoryMgr -> {
 127                 final var keyPair = getKeyPair(keyBased.getKeyId());
 128                 factoryMgr.setKeyIdentityProvider(KeyIdentityProvider.wrapKeyPairs(keyPair));
 129                 final var factory = new UserAuthPublicKeyFactory();
 130                 factory.setSignatureFactories(factoryMgr.getSignatureFactories());
 131                 factoryMgr.setUserAuthFactories(List.of(factory));
 132             });
 133         } else {
 134             throw new IllegalArgumentException("Unsupported credential type: " + credentials.getClass());
 135         }
 136         confBuilder.withSshParameters(sshParamsBuilder.build());
 137     }
 138
 139     private static ClientIdentity loginPasswordIdentity(final String username, final String password) {
 140         return new ClientIdentityBuilder()
 141             .setUsername(requireNonNull(username, "username is undefined"))
 142             .setPassword(new PasswordBuilder()
 143                 .setPasswordType(new CleartextPasswordBuilder()
 144                     .setCleartextPassword(requireNonNull(password, "password is undefined"))
 145                     .build())
 146                 .build())
 147             .build();
 148     }
 149
 150     private KeyPair getKeyPair(final String keyId) {
 151         // public key retrieval logic taken from DatastoreBackedPublicKeyAuth
 152         final var dsKeypair = credentialProvider.credentialForId(keyId);
 153         if (dsKeypair == null) {
 154             throw new IllegalArgumentException("No keypair found with keyId=" + keyId);
 155         }
 156         final var passPhrase = Strings.isNullOrEmpty(dsKeypair.getPassphrase()) ? "" : dsKeypair.getPassphrase();
 157         try {
 158             return decodePrivateKey(encryptionService.decrypt(dsKeypair.getPrivateKey()),
 159                 encryptionService.decrypt(passPhrase));
 160         } catch (IOException e) {
 161             throw new IllegalStateException("Could not decode private key with keyId=" + keyId, e);
 162         }
 163     }
 164
 165     private static KeyPair decodePrivateKey(final String privateKey, final String passphrase) throws IOException {
 166         try (var keyReader = new PEMParser(new StringReader(privateKey.replace("\\n", "\n")))) {
 167             final var obj = keyReader.readObject();
 168
 169             final PEMKeyPair keyPair;
 170             if (obj instanceof PEMEncryptedKeyPair encrypted) {
 171                 keyPair = encrypted.decryptKeyPair(new JcePEMDecryptorProviderBuilder()
 172                     .setProvider(BCPROV)
 173                     .build(passphrase.toCharArray()));
 174             } else if (obj instanceof PEMKeyPair plain) {
 175                 keyPair = plain;
 176             } else {
 177                 throw new IllegalArgumentException("Unhandled private key " + obj.getClass());
 178             }
 179
 180             return new JcaPEMKeyConverter().getKeyPair(keyPair);
 181         }
 182     }
 183 }