2 * Copyright © 2017-2019 AT&T, Bell Canada
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor.core
19 import com.google.common.collect.ImmutableList
20 import com.google.common.collect.ImmutableSet
21 import org.apache.sshd.client.SshClient
22 import org.apache.sshd.client.channel.ClientChannel
23 import org.apache.sshd.client.session.ClientSession
24 import org.apache.sshd.common.FactoryManager
25 import org.apache.sshd.server.keyprovider.SimpleGeneratorHostKeyProvider
26 import org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor.api.DeviceInfo
27 import org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor.api.NetconfException
28 import org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor.api.NetconfReceivedEvent
29 import org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor.api.NetconfRpcService
30 import org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor.api.NetconfSession
31 import org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor.api.NetconfSessionListener
32 import org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor.utils.NetconfMessageUtils
33 import org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor.utils.RpcMessageUtils
34 import org.onap.ccsdk.cds.blueprintsprocessor.functions.netconf.executor.utils.RpcStatus
35 import org.slf4j.LoggerFactory
36 import java.io.IOException
38 import java.util.concurrent.CompletableFuture
39 import java.util.concurrent.ConcurrentHashMap
40 import java.util.concurrent.ExecutionException
41 import java.util.concurrent.TimeUnit
42 import java.util.concurrent.TimeoutException
43 import java.util.concurrent.atomic.AtomicReference
45 class NetconfSessionImpl(private val deviceInfo: DeviceInfo, private val rpcService: NetconfRpcService) :
48 private val log = LoggerFactory.getLogger(NetconfSessionImpl::class.java)
50 private val errorReplies: MutableList<String> = Collections.synchronizedList(listOf())
51 private val replies: MutableMap<String, CompletableFuture<String>> = ConcurrentHashMap()
52 private val deviceCapabilities = setOf<String>()
54 private var connectionTimeout: Long = 0
55 private var replyTimeout: Int = 0
56 private var idleTimeout: Int = 0
57 private var sessionId: String? = null
59 private lateinit var session: ClientSession
60 private lateinit var client: SshClient
61 private lateinit var channel: ClientChannel
62 private lateinit var streamHandler: NetconfDeviceCommunicator
64 private var capabilities =
65 ImmutableList.of(RpcMessageUtils.NETCONF_10_CAPABILITY, RpcMessageUtils.NETCONF_11_CAPABILITY)
67 override fun connect() {
69 log.info("$deviceInfo: Connecting to Netconf Device with timeouts C:${deviceInfo.connectTimeout}, " +
70 "R:${deviceInfo.replyTimeout}, I:${deviceInfo.idleTimeout}")
72 log.info("$deviceInfo: Connected to Netconf Device")
73 } catch (e: NetconfException) {
74 log.error("$deviceInfo: Netconf Device Connection Failed. ${e.message}")
75 throw NetconfException(e)
79 override fun disconnect() {
80 if (rpcService.closeSession(false).status.equals(
81 RpcStatus.FAILURE, true)) {
82 rpcService.closeSession(true)
86 // Closes the socket which should interrupt the streamHandler
91 override fun reconnect() {
96 override fun syncRpc(request: String, messageId: String): String {
97 val formattedRequest = NetconfMessageUtils.formatRPCRequest(request, messageId, deviceCapabilities)
102 return streamHandler.sendMessage(formattedRequest, messageId).get(replyTimeout.toLong(), TimeUnit.SECONDS)
103 // replies.remove(messageId)
104 } catch (e: InterruptedException) {
105 Thread.currentThread().interrupt()
106 throw NetconfException("$deviceInfo: Interrupted while waiting for reply for request: $formattedRequest", e)
107 } catch (e: TimeoutException) {
108 throw NetconfException("$deviceInfo: Timed out while waiting for reply for request $formattedRequest after $replyTimeout sec.",
110 } catch (e: ExecutionException) {
111 log.warn("$deviceInfo: Closing session($sessionId) due to unexpected Error", e)
114 // Closes the socket which should interrupt the streamHandler
117 } catch (ioe: IOException) {
118 log.warn("$deviceInfo: Error closing session($sessionId) for host($deviceInfo)", ioe)
121 // NetconfReceivedEvent(NetconfReceivedEvent.Type.SESSION_CLOSED, "",
122 // "Closed due to unexpected error " + e.cause, "-1", deviceInfo)
123 errorReplies.clear() // move to cleanUp()?
126 throw NetconfException("$deviceInfo: Closing session $sessionId for request $formattedRequest", e)
130 override fun asyncRpc(request: String, messageId: String): CompletableFuture<String> {
131 val formattedRequest = NetconfMessageUtils.formatRPCRequest(request, messageId, deviceCapabilities)
133 checkAndReestablish()
135 return streamHandler.sendMessage(formattedRequest, messageId).handleAsync { reply, t ->
137 throw NetconfException(messageId, t)
143 override fun checkAndReestablish() {
145 if (client.isClosed) {
146 log.info("Trying to restart the whole SSH connection with {}", deviceInfo)
149 } else if (session.isClosed) {
150 log.info("Trying to restart the session with {}", deviceInfo)
153 } else if (channel.isClosed) {
154 log.info("Trying to reopen the channel with {}", deviceInfo)
160 } catch (e: IOException) {
161 log.error("Can't reopen connection for device {}", e.message)
162 throw NetconfException(String.format("Cannot re-open the connection with device (%s)", deviceInfo), e)
163 } catch (e: IllegalStateException) {
164 log.error("Can't reopen connection for device {}", e.message)
165 throw NetconfException(String.format("Cannot re-open the connection with device (%s)", deviceInfo), e)
170 override fun getDeviceInfo(): DeviceInfo {
174 override fun getSessionId(): String {
175 return this.sessionId!!
178 override fun getDeviceCapabilitiesSet(): Set<String> {
179 return Collections.unmodifiableSet(deviceCapabilities)
182 private fun startConnection() {
183 connectionTimeout = deviceInfo.connectTimeout
184 replyTimeout = deviceInfo.replyTimeout
185 idleTimeout = deviceInfo.idleTimeout
188 } catch (e: Exception) {
189 throw NetconfException("$deviceInfo: Failed to establish SSH session", e)
194 private fun startClient() {
195 client = SshClient.setUpDefaultClient()
197 client.properties.putIfAbsent(FactoryManager.IDLE_TIMEOUT, TimeUnit.SECONDS.toMillis(idleTimeout.toLong()))
198 client.properties.putIfAbsent(FactoryManager.NIO2_READ_TIMEOUT, TimeUnit.SECONDS.toMillis(idleTimeout + 15L))
204 private fun startSession() {
205 log.info("$deviceInfo: Starting SSH session")
206 val connectFuture = client.connect(deviceInfo.username, deviceInfo.ipAddress, deviceInfo.port)
207 .verify(connectionTimeout, TimeUnit.SECONDS)
208 session = connectFuture.session
209 log.info("$deviceInfo: SSH session created")
214 private fun authSession() {
215 session.addPasswordIdentity(deviceInfo.password)
216 session.auth().verify(connectionTimeout, TimeUnit.SECONDS)
217 val event = session.waitFor(ImmutableSet.of(ClientSession.ClientSessionEvent.WAIT_AUTH,
218 ClientSession.ClientSessionEvent.CLOSED, ClientSession.ClientSessionEvent.AUTHED), 0)
219 if (!event.contains(ClientSession.ClientSessionEvent.AUTHED)) {
220 throw NetconfException("$deviceInfo: Failed to authenticate session.")
222 log.info("$deviceInfo: SSH session authenticated")
227 private fun openChannel() {
228 channel = session.createSubsystemChannel("netconf")
229 val channelFuture = channel.open()
230 if (channelFuture.await(connectionTimeout, TimeUnit.SECONDS) && channelFuture.isOpened) {
231 log.info("$deviceInfo: SSH NETCONF subsystem channel opened")
234 throw NetconfException("$deviceInfo: Failed to open SSH subsystem channel")
238 private fun setupHandler() {
239 val sessionListener: NetconfSessionListener = NetconfSessionListenerImpl()
240 streamHandler = NetconfDeviceCommunicator(channel.invertedOut, channel.invertedIn, deviceInfo,
241 sessionListener, replies)
243 exchangeHelloMessage()
246 private fun exchangeHelloMessage() {
250 val serverHelloResponse = syncRpc(NetconfMessageUtils.createHelloString(capabilities), messageId)
251 val sessionIDMatcher = NetconfMessageUtils.SESSION_ID_REGEX_PATTERN.matcher(serverHelloResponse)
253 if (sessionIDMatcher.find()) {
254 sessionId = sessionIDMatcher.group(1)
256 throw NetconfException("$deviceInfo: Missing sessionId in server hello message: $serverHelloResponse")
259 val capabilityMatcher = NetconfMessageUtils.CAPABILITY_REGEX_PATTERN.matcher(serverHelloResponse)
260 while (capabilityMatcher.find()) {
261 deviceCapabilities.plus(capabilityMatcher.group(1))
265 inner class NetconfSessionListenerImpl : NetconfSessionListener {
266 override fun accept(event: NetconfReceivedEvent) {
267 val messageId = event.messageId
270 NetconfReceivedEvent.Type.DEVICE_UNREGISTERED -> disconnect()
271 NetconfReceivedEvent.Type.DEVICE_ERROR -> errorReplies.add(event.messagePayload)
272 NetconfReceivedEvent.Type.DEVICE_REPLY -> replies[messageId]?.complete(event.messagePayload)
273 NetconfReceivedEvent.Type.SESSION_CLOSED -> disconnect()
278 fun sessionstatus(state:String): Boolean{
280 "Close" -> channel.isClosed
281 "Open" -> channel.isOpen