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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
|
/*******************************************************************************
* Copyright (c) 2011 SAP AG
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Lazar Kirchev, SAP AG - initial API and implementation
*******************************************************************************/
package org.eclipse.equinox.console.ssh;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.InputStream;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.StringBufferInputStream;
import java.util.Collection;
import java.util.Dictionary;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Map;
import org.apache.felix.service.command.CommandProcessor;
import org.apache.felix.service.command.CommandSession;
import org.apache.sshd.ClientChannel;
import org.apache.sshd.ClientSession;
import org.apache.sshd.SshClient;
import org.apache.sshd.client.future.ConnectFuture;
import org.apache.sshd.client.future.DefaultConnectFuture;
import org.apache.sshd.common.RuntimeSshException;
import org.apache.sshd.server.Environment;
import org.easymock.EasyMock;
import org.easymock.IAnswer;
import org.eclipse.equinox.console.common.ConsoleInputStream;
import org.eclipse.equinox.console.storage.DigestUtil;
import org.eclipse.equinox.console.storage.SecureUserStore;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleException;
import org.osgi.framework.BundleListener;
import org.osgi.framework.Filter;
import org.osgi.framework.FrameworkListener;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceListener;
import org.osgi.framework.ServiceReference;
import org.osgi.framework.ServiceRegistration;
import org.osgi.service.cm.ManagedService;
public class SshCommandWithConfigAdminTests {
private static final int TEST_CONTENT = 100;
private static final String USER_STORE_FILE_NAME = "org.eclipse.equinox.console.jaas.file";
private static final String JAAS_CONFIG_FILE_NAME = "jaas.config";
private static final String JAAS_CONFIG_PROPERTY_NAME = "java.security.auth.login.config";
private static final String DEFAULT_USER_STORAGE = "osgi.console.ssh.useDefaultSecureStorage";
private static final String STORE_FILE_NAME = SshCommandTests.class.getName() + "_store";
private static final String GOGO_SHELL_COMMAND = "gosh --login --noshutdown";
private static final String TRUE = "true";
private static final String FALSE = "false";
private static final String USERNAME = "username";
private static final String PASSWORD = "password";
private static final String STOP_COMMAND = "stop";
private static final String TERM_PROPERTY = "TERM";
private static final String XTERM = "XTERM";
private static final String HOST = "localhost";
private static final String SSH_PORT = "2222";
private static final long WAIT_TIME = 5000;
private static final String USE_CONFIG_ADMIN_PROP = "osgi.console.useConfigAdmin";
private ManagedService configurator;
@Before
public void init() throws Exception {
clean();
initStore();
initJaasConfigFile();
}
@Test
public void testSshCommandWithConfigAdmin() throws Exception {
CommandSession session = EasyMock.createMock(CommandSession.class);
EasyMock.makeThreadSafe(session, true);
session.put((String)EasyMock.anyObject(), EasyMock.anyObject());
EasyMock.expectLastCall().times(5);
EasyMock.expect(session.execute(GOGO_SHELL_COMMAND)).andReturn(null);
session.close();
EasyMock.expectLastCall();
EasyMock.replay(session);
CommandProcessor processor = EasyMock.createMock(CommandProcessor.class);
EasyMock.expect(processor.createSession((ConsoleInputStream)EasyMock.anyObject(), (PrintStream)EasyMock.anyObject(), (PrintStream)EasyMock.anyObject())).andReturn(session);
EasyMock.replay(processor);
final ServiceRegistration<?> registration = EasyMock.createMock(ServiceRegistration.class);
registration.setProperties((Dictionary)EasyMock.anyObject());
EasyMock.expectLastCall();
EasyMock.replay(registration);
BundleContext context = EasyMock.createMock(BundleContext.class);
EasyMock.makeThreadSafe(context, true);
EasyMock.expect(context.getProperty(USE_CONFIG_ADMIN_PROP)).andReturn(TRUE);
EasyMock.expect(context.getProperty(DEFAULT_USER_STORAGE)).andReturn(TRUE).anyTimes();
EasyMock.expect(
(ServiceRegistration) context.registerService(
(String)EasyMock.anyObject(),
(ManagedService)EasyMock.anyObject(),
(Dictionary<String, ?>)EasyMock.anyObject())
).andAnswer((IAnswer<ServiceRegistration<?>>) new IAnswer<ServiceRegistration<?>>() {
public ServiceRegistration<?> answer() {
configurator = (ManagedService) EasyMock.getCurrentArguments()[1];
return registration;
}
});
EasyMock.expect(
context.registerService(
(String)EasyMock.anyObject(),
(SshCommand)EasyMock.anyObject(),
(Dictionary<String, ?>)EasyMock.anyObject())).andReturn(null);
EasyMock.replay(context);
Map<String, String> environment = new HashMap<String, String>();
environment.put(TERM_PROPERTY, XTERM);
Environment env = EasyMock.createMock(Environment.class);
EasyMock.expect(env.getEnv()).andReturn(environment);
EasyMock.replay(env);
SshCommand command = new SshCommand(processor, context);
Dictionary props = new Hashtable();
props.put("port", SSH_PORT);
props.put("host", HOST);
props.put("enabled", TRUE);
configurator.updated(props);
SshClient client = SshClient.setUpDefaultClient();
client.start();
try {
ConnectFuture connectFuture = client.connect(HOST, Integer.valueOf(SSH_PORT));
DefaultConnectFuture defaultConnectFuture = (DefaultConnectFuture) connectFuture;
try {
Thread.sleep(WAIT_TIME);
} catch (InterruptedException ie) {
// do nothing
}
ClientSession sshSession = defaultConnectFuture.getSession();
int ret = ClientSession.WAIT_AUTH;
sshSession.authPassword(USERNAME, PASSWORD);
ret = sshSession.waitFor(ClientSession.WAIT_AUTH | ClientSession.CLOSED | ClientSession.AUTHED, 0);
if ((ret & ClientSession.CLOSED) != 0) {
System.err.println("error");
System.exit(-1);
}
ClientChannel channel = sshSession.createChannel("shell");
channel.setIn(new StringBufferInputStream(TEST_CONTENT + "\n"));
ByteArrayOutputStream byteOut = new ByteArrayOutputStream();
channel.setOut(byteOut);
channel.setErr(byteOut);
channel.open();
try {
Thread.sleep(WAIT_TIME);
} catch (InterruptedException ie) {
// do nothing
}
byte[] output = byteOut.toByteArray();
Assert.assertEquals("Output not as expected",Integer.toString(TEST_CONTENT), new String(output).trim());
sshSession.close(true);
} finally {
client.stop();
}
command.ssh(new String[] {STOP_COMMAND});
return;
}
@Test
public void testSshCommandWithConfigAdminDisabledSsh() throws Exception {
testDisabled(false);
}
@Test
public void testSshCommandWithConfigAdminDisabledSshByDefault() throws Exception {
testDisabled(true);
}
private void testDisabled(boolean isDefault) throws Exception {
CommandSession session = EasyMock.createMock(CommandSession.class);
session.put((String)EasyMock.anyObject(), EasyMock.anyObject());
EasyMock.expectLastCall().times(4);
EasyMock.expect(session.execute(GOGO_SHELL_COMMAND)).andReturn(null);
session.close();
EasyMock.expectLastCall();
EasyMock.replay(session);
CommandProcessor processor = EasyMock.createMock(CommandProcessor.class);
EasyMock.expect(processor.createSession((ConsoleInputStream)EasyMock.anyObject(), (PrintStream)EasyMock.anyObject(), (PrintStream)EasyMock.anyObject())).andReturn(session);
EasyMock.replay(processor);
final ServiceRegistration<?> registration = EasyMock.createMock(ServiceRegistration.class);
registration.setProperties((Dictionary)EasyMock.anyObject());
EasyMock.expectLastCall();
EasyMock.replay(registration);
BundleContext context = EasyMock.createMock(BundleContext.class);
EasyMock.expect(context.getProperty(USE_CONFIG_ADMIN_PROP)).andReturn(TRUE);
EasyMock.expect(context.getProperty(DEFAULT_USER_STORAGE)).andReturn(TRUE).anyTimes();
EasyMock.expect(
(ServiceRegistration) context.registerService(
(String)EasyMock.anyObject(),
(ManagedService)EasyMock.anyObject(),
(Dictionary<String, ?>)EasyMock.anyObject())
).andAnswer((IAnswer<ServiceRegistration<?>>) new IAnswer<ServiceRegistration<?>>() {
public ServiceRegistration<?> answer() {
configurator = (ManagedService) EasyMock.getCurrentArguments()[1];
return registration;
}
});
EasyMock.expect(
context.registerService(
(String)EasyMock.anyObject(),
(SshCommand)EasyMock.anyObject(),
(Dictionary<String, ?>)EasyMock.anyObject())).andReturn(null);
EasyMock.replay(context);
Map<String, String> environment = new HashMap<String, String>();
environment.put(TERM_PROPERTY, XTERM);
Environment env = EasyMock.createMock(Environment.class);
EasyMock.expect(env.getEnv()).andReturn(environment);
EasyMock.replay(env);
SshCommand command = new SshCommand(processor, context);
Dictionary props = new Hashtable();
props.put("port", SSH_PORT);
props.put("host", HOST);
if (isDefault == false) {
props.put("enabled", FALSE);
}
configurator.updated(props);
SshClient client = SshClient.setUpDefaultClient();
client.start();
try {
ConnectFuture connectFuture = client.connect(HOST, Integer.valueOf(SSH_PORT));
DefaultConnectFuture defaultConnectFuture = (DefaultConnectFuture) connectFuture;
try {
Thread.sleep(WAIT_TIME);
} catch (InterruptedException ie) {
// do nothing
}
ClientSession sshSession;
try {
sshSession = defaultConnectFuture.getSession();
Assert.fail("It should not be possible to connect to " + HOST + ":" + SSH_PORT);
} catch (RuntimeSshException e) {
//this is expected
}
} finally {
client.stop();
}
try {
command.ssh(new String[] {STOP_COMMAND});
} catch (IllegalStateException e) {
// this is expected
}
return;
}
@After
public void cleanUp() {
clean();
}
private void clean() {
System.setProperty(USER_STORE_FILE_NAME, "");
File file = new File(STORE_FILE_NAME);
if (file.exists()) {
file.delete();
}
System.setProperty(JAAS_CONFIG_PROPERTY_NAME, "");
File jaasConfFile = new File(JAAS_CONFIG_FILE_NAME);
if (jaasConfFile.exists()) {
jaasConfFile.delete();
}
}
private void initStore() throws Exception {
System.setProperty(USER_STORE_FILE_NAME, STORE_FILE_NAME);
SecureUserStore.initStorage();
SecureUserStore.putUser(USERNAME, DigestUtil.encrypt(PASSWORD), null);
}
private void initJaasConfigFile() throws Exception {
System.setProperty(JAAS_CONFIG_PROPERTY_NAME, JAAS_CONFIG_FILE_NAME);
File jaasConfFile = new File(JAAS_CONFIG_FILE_NAME);
if (!jaasConfFile.exists()) {
PrintWriter out = null;
try {
out = new PrintWriter(jaasConfFile);
out.println("equinox_console {");
out.println(" org.eclipse.equinox.console.jaas.SecureStorageLoginModule REQUIRED;");
out.println("};");
} finally {
if (out != null) {
out.close();
}
}
}
}
}
|
