appc-adapters/appc-ssh-adapter/appc-ssh-adapter-sshd/src/main/java/org/onap/appc/adapter/ssh/sshd/SshConnectionSshd.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.appc.adapter.ssh.sshd;
  25
  26 import org.onap.appc.adapter.ssh.Constants;
  27 import org.onap.appc.adapter.ssh.SshConnection;
  28 import org.onap.appc.adapter.ssh.SshException;
  29 import org.onap.appc.encryption.EncryptionTool;
  30 import org.onap.appc.configuration.Configuration;
  31 import org.onap.appc.configuration.ConfigurationFactory;
  32 import org.apache.sshd.ClientChannel;
  33 import org.apache.sshd.ClientSession;
  34 import org.apache.sshd.SshClient;
  35 import org.apache.sshd.client.channel.ChannelExec;
  36 import org.apache.sshd.client.future.AuthFuture;
  37 import org.apache.sshd.client.future.OpenFuture;
  38 import org.apache.sshd.common.KeyPairProvider;
  39 import org.apache.sshd.common.keyprovider.FileKeyPairProvider;
  40
  41 import com.att.eelf.configuration.EELFLogger;
  42 import com.att.eelf.configuration.EELFManager;
  43
  44 import java.io.OutputStream;
  45 import java.security.KeyPair;
  46
  47 /**
  48  * Implementation of SshConnection interface based on Apache MINA SSHD library.
  49  */
  50 class SshConnectionSshd implements SshConnection {
  51
  52     private static final EELFLogger logger = EELFManager.getInstance().getApplicationLogger();
  53
  54     private static final long AUTH_TIMEOUT = 60000;
  55     private static final long EXEC_TIMEOUT = 120000;
  56
  57     private String host;
  58     private int port;
  59     private String username;
  60     private String password;
  61     private long timeout = EXEC_TIMEOUT;
  62     private String keyFile;
  63     private SshClient sshClient;
  64     private ClientSession clientSession;
  65     private static final Configuration configuration = ConfigurationFactory.getConfiguration();
  66
  67     public SshConnectionSshd(String host, int port, String username, String password, String keyFile) {
  68         this.host = host;
  69         this.port = port;
  70         this.username = username;
  71         this.password = password;
  72         this.keyFile = keyFile;
  73     }
  74
  75     public SshConnectionSshd(String host, int port, String username, String password) {
  76         this(host, port, username, password, null);
  77     }
  78
  79     public SshConnectionSshd(String host, int port, String keyFile) {
  80         this(host, port, null, null, keyFile);
  81     }
  82
  83     @Override
  84     public void connect() {
  85         sshClient = SshClient.setUpDefaultClient();
  86         sshClient.start();
  87         try {
  88             clientSession =
  89                 sshClient.connect(EncryptionTool.getInstance().decrypt(username), host, port).await().getSession();
  90             if (password != null) {
  91                 clientSession.addPasswordIdentity(EncryptionTool.getInstance().decrypt(password));
  92             }
  93             if (keyFile != null) {
  94                 KeyPairProvider keyPairProvider = new FileKeyPairProvider(new String[] {
  95                     keyFile
  96                 });
  97                 KeyPair keyPair = keyPairProvider.loadKeys().iterator().next();
  98                 clientSession.addPublicKeyIdentity(keyPair);
  99             }
 100             AuthFuture authFuture = clientSession.auth();
 101             authFuture.await(AUTH_TIMEOUT);
 102             if (!authFuture.isSuccess()) {
 103                 throw new SshException("Error establishing ssh connection to [" + username + "@" + host + ":" + port
 104                     + "]. Authentication failed.");
 105             }
 106         } catch (RuntimeException e) {
 107             throw e;
 108         } catch (Exception e) {
 109             throw new SshException("Error establishing ssh connection to [" + username + "@" + host + ":" + port + "].",
 110                 e);
 111         }
 112         if (logger.isDebugEnabled()) {
 113             logger.debug("SSH: connected to [" + toString() + "]");
 114         }
 115     }
 116
 117     @Override
 118     public void connectWithRetry() {
 119         int retryCount ;
 120         int retryDelay ;
 121         int retriesLeft;
 122         retryCount = configuration.getIntegerProperty(Constants.CONNECTION_RETRY_COUNT,
 123             Constants.DEFAULT_CONNECTION_RETRY_COUNT);
 124         retryDelay = configuration.getIntegerProperty(Constants.CONNECTION_RETRY_DELAY,
 125             Constants.DEFAULT_CONNECTION_RETRY_DELAY);
 126         retriesLeft = retryCount + 1;
 127         do {
 128             try {
 129                 this.connect();
 130                 break;
 131             } catch (RuntimeException e) {
 132                 if (retriesLeft > 1) {
 133                     logger.debug("SSH Connection failed. Waiting for change in server's state.");
 134                     waitForConnection(retryDelay);
 135                     retriesLeft--;
 136                     logger.debug("Retrying SSH connection. Attempt [" + Integer.toString(retryCount - retriesLeft + 1)
 137                         + "] out of [" + retryCount + "]");
 138                 } else {
 139                     throw e;
 140                 }
 141           }
 142         } while (retriesLeft > 0);
 143     }
 144
 145     @Override
 146     public void disconnect() {
 147         try {
 148             if (logger.isDebugEnabled()) {
 149                 logger.debug("SSH: disconnecting from [" + toString() + "]");
 150             }
 151             clientSession.close(false);
 152         } finally {
 153             if (sshClient != null) {
 154                 sshClient.stop();
 155             }
 156         }
 157     }
 158
 159     @Override
 160     public void setExecTimeout(long timeout) {
 161         this.timeout = timeout;
 162     }
 163
 164     @Override
 165     public int execCommand(String cmd, OutputStream out, OutputStream err) {
 166         return execCommand(cmd, out, err, false);
 167     }
 168
 169     @Override
 170     public int execCommandWithPty(String cmd, OutputStream out) {
 171         return execCommand(cmd, out, out, true);
 172     }
 173
 174     private int execCommand(String cmd, OutputStream out, OutputStream err, boolean usePty) {
 175         try {
 176             if (logger.isDebugEnabled()) {
 177                 logger.debug("SSH: executing command");
 178             }
 179             ChannelExec client = clientSession.createExecChannel(cmd);
 180             client.setUsePty(usePty); // use pseudo-tty?
 181             client.setOut(out);
 182             client.setErr(err);
 183             OpenFuture openFuture = client.open();
 184             int exitStatus;
 185             try {
 186                 client.waitFor(ClientChannel.CLOSED, timeout);
 187                 openFuture.verify();
 188                 Integer exitStatusI = client.getExitStatus();
 189                 if (exitStatusI == null) {
 190                     throw new SshException("Error executing command [" + cmd + "] over SSH [" + username + "@" + host
 191                         + ":" + port + "]. Operation timed out.");
 192                 }
 193                 exitStatus = exitStatusI;
 194             } finally {
 195                 client.close(false);
 196             }
 197             return exitStatus;
 198         } catch (RuntimeException e) {
 199             throw e;
 200         } catch (Exception e1) {
 201             throw new SshException(
 202                 "Error executing command [" + cmd + "] over SSH [" + username + "@" + host + ":" + port + "]", e1);
 203         }
 204     }
 205
 206     private void waitForConnection(int retryDelay) {
 207         long time = retryDelay * 1000L;
 208         long future = System.currentTimeMillis() + time;
 209         if (time != 0) {
 210             while (System.currentTimeMillis() < future && time > 0) {
 211                 try {
 212                     Thread.sleep(time);
 213                 } catch (InterruptedException e) {
 214                     /*
 215                      * This is rare, but it can happen if another thread interrupts us while we are sleeping. In that
 216                      * case, the thread is resumed before the delay time has actually expired, so re-calculate the
 217                      * amount of delay time needed and reenter the sleep until we get to the future time.
 218                      */
 219                     time = future - System.currentTimeMillis();
 220                 }
 221             }
 222         }
 223     }
 224
 225     @Override
 226     public String toString() {
 227         String address = host;
 228         if (username != null) {
 229             address = username + '@' + address;
 230         }
 231         return address;
 232     }
 233 }