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
|
/*
* Copyright © 2019 IBM.
*
* Modifications Copyright © 2018-2020 IBM, Bell Canada.
*
* 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.
*/
package org.onap.ccsdk.cds.blueprintsprocessor.ssh.service
import org.apache.commons.io.output.TeeOutputStream
import org.apache.sshd.client.SshClient
import org.apache.sshd.client.channel.ChannelShell
import org.apache.sshd.client.channel.ClientChannelEvent
import org.apache.sshd.client.keyverifier.AcceptAllServerKeyVerifier
import org.apache.sshd.client.session.ClientSession
import org.onap.ccsdk.cds.blueprintsprocessor.ssh.BasicAuthSshClientProperties
import org.onap.ccsdk.cds.controllerblueprints.core.BlueprintProcessorException
import org.slf4j.LoggerFactory
import java.io.ByteArrayOutputStream
import java.io.IOException
import java.io.PipedInputStream
import java.io.PipedOutputStream
import java.util.ArrayList
import java.util.Collections
import java.util.EnumSet
import java.util.Scanner
open class BasicAuthSshClientService(private val basicAuthSshClientProperties: BasicAuthSshClientProperties) :
BlueprintSshClientService {
private val log = LoggerFactory.getLogger(BasicAuthSshClientService::class.java)!!
private val newLine = "\n".toByteArray()
private var channel: ChannelShell? = null
private var teeOutput: TeeOutputStream? = null
private lateinit var sshClient: SshClient
private lateinit var clientSession: ClientSession
override suspend fun startSessionNB(): ClientSession {
sshClient = SshClient.setUpDefaultClient()
sshClient.serverKeyVerifier = AcceptAllServerKeyVerifier.INSTANCE
sshClient.start()
log.debug("SSH Client Service started successfully")
clientSession = sshClient.connect(
basicAuthSshClientProperties.username, basicAuthSshClientProperties.host,
basicAuthSshClientProperties.port
).verify(basicAuthSshClientProperties.connectionTimeOut).session
clientSession.addPasswordIdentity(basicAuthSshClientProperties.password)
clientSession.auth().verify(basicAuthSshClientProperties.connectionTimeOut)
startChannel()
log.info("SSH client session($clientSession) created")
return clientSession
}
private fun startChannel() {
try {
channel = clientSession.createShellChannel()
val pipedIn = PipedOutputStream()
channel!!.setIn(PipedInputStream(pipedIn))
teeOutput = TeeOutputStream(ByteArrayOutputStream(), pipedIn)
channel!!.out = ByteArrayOutputStream()
channel!!.err = ByteArrayOutputStream()
channel!!.open()
} catch (e: Exception) {
throw BlueprintProcessorException("Failed to start Shell channel: ${e.message}")
}
}
override suspend fun executeCommandsNB(commands: List<String>, timeOut: Long): List<CommandResult> {
val response = ArrayList<CommandResult>()
try {
var stopLoop = false
val commandsIterator = commands.iterator()
while (commandsIterator.hasNext() && !stopLoop) {
val command = commandsIterator.next()
log.debug("Executing host command($command) \n")
val result = executeCommand(command, timeOut)
response.add(result)
// Once a command in the template has failed break out of the loop to stop executing further commands
if (!result.successful) {
log.debug("Template execution will stop because command ({}) has failed.", command)
stopLoop = true
}
}
} catch (e: Exception) {
throw BlueprintProcessorException("Failed to execute commands, below the error message : ${e.message}")
}
return response
}
override suspend fun executeCommandNB(command: String, timeOut: Long): CommandResult {
val deviceOutput: String
var isSuccessful = true
try {
teeOutput!!.write(command.toByteArray())
teeOutput!!.write(newLine)
teeOutput!!.flush()
deviceOutput = waitForPrompt(timeOut)
} catch (e: IOException) {
throw BlueprintProcessorException("Exception during command execution: ${e.message}", e)
}
if (detectFailure(deviceOutput)) {
isSuccessful = false
}
val commandResult = CommandResult(command, deviceOutput, isSuccessful)
if (basicAuthSshClientProperties.logging) {
log.info("Command Response: ({}) $newLine", commandResult)
}
return commandResult
}
private fun waitForPrompt(timeOut: Long): String {
val waitMask = channel!!.waitFor(
Collections.unmodifiableSet(EnumSet.of(ClientChannelEvent.CLOSED)), timeOut
)
if (channel!!.out.toString().indexOfAny(arrayListOf("$", ">", "#")) <= 0 && waitMask.contains(ClientChannelEvent.TIMEOUT)) {
throw BlueprintProcessorException("Timeout: Failed to retrieve commands result in $timeOut ms")
}
val outputResult = channel!!.out.toString()
channel!!.out.flush()
return outputResult
}
override suspend fun closeSessionNB() {
if (channel != null) {
channel!!.close()
}
if (clientSession.isOpen && !clientSession.isClosing) {
clientSession.close()
}
if (sshClient.isStarted) {
sshClient.stop()
}
log.debug("SSH Client Service stopped successfully")
}
// TODO filter output to check error message
private fun detectFailure(output: String): Boolean {
if (output.isNotBlank()) {
// Output can be multiline, need to check if any of the line starts with %
Scanner(output).use { scanner ->
while (scanner.hasNextLine()) {
val temp = scanner.nextLine()
if (temp.isNotBlank() && (
temp.trim { it <= ' ' }.startsWith("%") ||
temp.trim { it <= ' ' }.startsWith("syntax error")
)
) {
return true
}
}
}
}
return false
}
}
data class CommandResult(val command: String, val deviceOutput: String, val successful: Boolean)
|
