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
|
/*-
* ============LICENSE_START=======================================================
* APPC
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* Copyright (C) 2017 Amdocs
* ================================================================================
* 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=========================================================
* ECOMP is a trademark and service mark of AT&T Intellectual Property.
*/
package org.openecomp.appc.adapter.netconf.jsch;
import com.jcraft.jsch.Channel;
import com.jcraft.jsch.ChannelSubsystem;
import com.jcraft.jsch.JSch;
import com.jcraft.jsch.Session;
import java.io.IOException;
import java.util.List;
import java.util.Properties;
import org.openecomp.appc.adapter.netconf.NetconfClient;
import org.openecomp.appc.adapter.netconf.NetconfConnectionDetails;
import org.openecomp.appc.adapter.netconf.internal.NetconfAdapter;
import org.openecomp.appc.adapter.netconf.internal.NetconfConstMessages;
import org.openecomp.appc.encryption.EncryptionTool;
import org.openecomp.appc.exceptions.APPCException;
import org.openecomp.appc.i18n.Msg;
import com.att.eelf.i18n.EELFResourceManager;
/**
* Implementation of NetconfClient interface based on JCraft jsch library.
*/
public class NetconfClientJsch implements NetconfClient {
private static final int SESSION_CONNECT_TIMEOUT = 30000;
private static final int CHANNEL_CONNECT_TIMEOUT = 10000;
private Session session;
private Channel channel;
private NetconfAdapter netconfAdapter;
@Override
public void connect(NetconfConnectionDetails connectionDetails) throws APPCException {
String host = connectionDetails.getHost();
int port = connectionDetails.getPort();
String username = connectionDetails.getUsername();
String password = connectionDetails.getPassword();
try {
JSch.setLogger(new JSchLogger());
JSch jsch = new JSch();
session = jsch.getSession(EncryptionTool.getInstance().decrypt(username), host, port);
session.setPassword(EncryptionTool.getInstance().decrypt(password));
session.setConfig("StrictHostKeyChecking", "no");
Properties additionalProps = connectionDetails.getAdditionalProperties();
if((additionalProps != null) && !additionalProps.isEmpty()) {
session.setConfig(additionalProps);
}
session.connect(SESSION_CONNECT_TIMEOUT);
session.setTimeout(10000);
try {
// session.setServerAliveCountMax(0); // If this is not set to '0', then socket timeout on all reads will not work!!!!
channel = session.openChannel("subsystem");
((ChannelSubsystem)channel).setSubsystem("netconf");
netconfAdapter = new NetconfAdapter(channel.getInputStream(), channel.getOutputStream());
channel.connect(CHANNEL_CONNECT_TIMEOUT);
hello(connectionDetails.getCapabilities());
} catch(Exception e) {
disconnect();
throw e;
}
} catch(Exception e) {
String message = EELFResourceManager.format(Msg.CANNOT_ESTABLISH_CONNECTION, host, String.valueOf(port), username);
throw new APPCException(message, e);
}
}
@Override
public String exchangeMessage(String message) throws APPCException {
try {
netconfAdapter.sendMessage(message);
return netconfAdapter.receiveMessage();
} catch(IOException e) {
throw new APPCException(e);
}
}
@Override
public void configure(String configuration) throws APPCException {
try {
isOk(exchangeMessage(configuration));
} catch(IOException e) {
throw new APPCException(e);
}
}
@Override
public String getConfiguration() throws APPCException {
return exchangeMessage(NetconfConstMessages.GET_RUNNING_CONFIG);
}
@Override
public void disconnect() {
try {
if((channel != null) && !channel.isClosed()) {
netconfAdapter.sendMessage(NetconfConstMessages.CLOSE_SESSION);
isOk(netconfAdapter.receiveMessage());
}
} catch(IOException e) {
throw new RuntimeException("Error closing netconf device", e);
} finally {
netconfAdapter = null;
if(channel != null) {
channel.disconnect();
channel = null;
}
if(session != null) {
session.disconnect();
session = null;
}
}
}
private void hello(List<String> capabilities) throws IOException {
String helloIn = netconfAdapter.receiveMessage();
if(helloIn == null) {
throw new IOException("Expected hello message, but nothing received error from netconf device");
}
if(helloIn.contains("<rpc-error>")) {
throw new IOException("Expected hello message, but received error from netconf device:\n" + helloIn);
}
StringBuilder sb = new StringBuilder();
sb.append(NetconfConstMessages.CAPABILITIES_START);
sb.append(NetconfConstMessages.CAPABILITIES_BASE);
if(capabilities != null) {
for(String capability: capabilities) {
sb.append(" ").append(capability).append("\n");
}
}
sb.append(NetconfConstMessages.CAPABILITIES_END);
String helloOut = sb.toString();
netconfAdapter.sendMessage(helloOut);
}
private void isOk(String response) throws IOException {
if(response == null) {
throw new IOException("No response from netconf device");
}
if(!response.contains("<ok/>")) {
throw new IOException("Error response from netconf device: \n" + response);
}
}
}
|
