aboutsummaryrefslogtreecommitdiffstats
path: root/appc-adapters/appc-ssh-adapter/appc-ssh-adapter-sshd/src/main/java/org/openecomp/appc/adapter/ssh/sshd/SshConnectionSshd.java
blob: 4d8b83b6f818e85b454d46e47a61bf8656550d07 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/*-
 * ============LICENSE_START=======================================================
 * openECOMP : APP-C
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights
 * 						reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.appc.adapter.ssh.sshd;

import org.apache.sshd.ClientChannel;
import org.apache.sshd.ClientSession;
import org.apache.sshd.SshClient;
import org.apache.sshd.client.channel.ChannelExec;
import org.apache.sshd.client.future.AuthFuture;
import org.apache.sshd.client.future.OpenFuture;
import org.apache.sshd.common.KeyPairProvider;
import org.apache.sshd.common.keyprovider.FileKeyPairProvider;
import org.openecomp.appc.adapter.ssh.SshConnection;
import org.openecomp.appc.adapter.ssh.SshException;
import org.openecomp.appc.encryption.EncryptionTool;
import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;

import java.io.OutputStream;
import java.security.KeyPair;

/**
 * Implementation of SshConnection interface based on Apache MINA SSHD library.
 */
class SshConnectionSshd implements SshConnection {

	private static final EELFLogger logger = EELFManager.getInstance().getApplicationLogger();

	private static final long AUTH_TIMEOUT = 60000;
	private static final long EXEC_TIMEOUT = 120000;

	private String host;
	private int port;
	private String username;
	private String password;
	private long timeout = EXEC_TIMEOUT;
	private String keyFile;
	private SshClient sshClient;
	private ClientSession clientSession;

	public SshConnectionSshd(String host, int port, String username, String password, String keyFile) {
		this.host = host;
		this.port = port;
		this.username = username;
		this.password = password;
		this.keyFile = keyFile;
	}

	public SshConnectionSshd(String host, int port, String username, String password) {
		this(host, port, username, password, null);
	}

	public SshConnectionSshd(String host, int port, String keyFile) {
		this(host, port, null, null, keyFile);
	}

	@Override
	public void connect() {
		sshClient = SshClient.setUpDefaultClient();
		sshClient.start();
		try {
			clientSession = sshClient.connect(EncryptionTool.getInstance().decrypt(username), host, port).await().getSession();
			if(password != null) {
				clientSession.addPasswordIdentity(EncryptionTool.getInstance().decrypt(password));
			}
			if(keyFile != null) {
				KeyPairProvider keyPairProvider = new FileKeyPairProvider(new String[]{keyFile});
				KeyPair keyPair = keyPairProvider.loadKeys().iterator().next();
				clientSession.addPublicKeyIdentity(keyPair);
			}
			AuthFuture authFuture = clientSession.auth();
			authFuture.await(AUTH_TIMEOUT);
			if(!authFuture.isSuccess()) {
				throw new SshException("Error establishing ssh connection to [" + username + "@" + host + ":" + port + "]. Authentication failed.");
			}
		} catch(RuntimeException e) {
			throw e;
		} catch(Exception e) {
			throw new SshException("Error establishing ssh connection to [" + username + "@" + host + ":" + port + "].", e);
		}
		if(logger.isDebugEnabled()) {
			logger.debug("SSH: connected to [" + toString() + "]");
		}
	}

	@Override
	public void disconnect() {
		try {
			if(logger.isDebugEnabled()) {
				logger.debug("SSH: disconnecting from [" + toString() + "]");
			}
			clientSession.close(false);
		} finally {
			if(sshClient != null) {
				sshClient.stop();
			}
		}
	}

	@Override
	public void setExecTimeout(long timeout) {
		this.timeout = timeout;
	}

	@Override
	public int execCommand(String cmd, OutputStream out, OutputStream err) {
		return execCommand(cmd, out, err, false);
	}

	@Override
	public int execCommandWithPty(String cmd, OutputStream out) {
		return execCommand(cmd, out, out, true);
	}

	private int execCommand(String cmd, OutputStream out, OutputStream err, boolean usePty) {
		try {
			if(logger.isDebugEnabled()) {
				logger.debug("SSH: executing command");
			}
			ChannelExec client = clientSession.createExecChannel(cmd);
            client.setUsePty(usePty); // use pseudo-tty?
			client.setOut(out);
			client.setErr(err);
			OpenFuture openFuture = client.open();
			int exitStatus = 0;
			try {
				client.waitFor(ClientChannel.CLOSED, timeout);
				openFuture.verify();
				Integer exitStatusI = client.getExitStatus();
				if(exitStatusI == null) {
					throw new SshException("Error executing command [" + cmd + "] over SSH [" + username + "@" + host + ":" + port + "]. Operation timed out.");
				}
				exitStatus = exitStatusI;
			} finally {
				client.close(false);
			}
			return exitStatus;
		} catch(RuntimeException e) {
			throw e;
		} catch(Exception t) {
			throw new SshException("Error executing command [" + cmd + "] over SSH [" + username + "@" + host + ":" + port + "]", t);
		}
	}

	@Override
	public String toString() {
		String address = host;
		if(username != null) {
			address = username + '@' +address;
		}
		return address;
	}
}