aboutsummaryrefslogtreecommitdiffstats
path: root/ms/blueprintsprocessor/modules/commons/ssh-lib/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/ssh/service/BasicAuthSshClientService.kt
blob: adbde0f87583cb6b679a1de126351358ee6ae362 (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
/*
 *  Copyright © 2019 IBM.
 *
 *  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.sshd.client.SshClient
import org.apache.sshd.client.channel.ChannelExec
import org.apache.sshd.client.channel.ClientChannel
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.util.*


open class BasicAuthSshClientService(private val basicAuthSshClientProperties: BasicAuthSshClientProperties)
    : BlueprintSshClientService {

    private val log = LoggerFactory.getLogger(BasicAuthSshClientService::class.java)!!

    private lateinit var sshClient: SshClient
    private lateinit var clientSession: ClientSession
    var channel: ChannelExec? = null

    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)
        log.info("SSH client session($clientSession) created")
        return clientSession
    }

    override suspend fun executeCommandsNB(commands: List<String>, timeOut: Long): String {
        val buffer = StringBuffer()
        try {
            commands.forEach { command ->
                buffer.append("\nCommand : $command")
                buffer.append("\n" + executeCommandNB(command, timeOut))
            }
        } catch (e: Exception) {
            throw BluePrintProcessorException("Failed to execute commands, below the output : $buffer")
        }
        return buffer.toString()
    }

    override suspend fun executeCommandNB(command: String, timeOut: Long): String {
        log.debug("Executing host($clientSession) command($command)")

        channel = clientSession.createExecChannel(command)
        checkNotNull(channel) { "failed to create Channel for the command : $command" }

        //TODO("Convert to streaming ")
        val outputStream = ByteArrayOutputStream()
        channel!!.out = outputStream
        channel!!.err = outputStream
        channel!!.open().await()
        val waitMask = channel!!.waitFor(Collections.unmodifiableSet(EnumSet.of(ClientChannelEvent.CLOSED)), timeOut)
        if (waitMask.contains(ClientChannelEvent.TIMEOUT)) {
            throw BluePrintProcessorException("Failed to retrieve command result in time: $command")
        }
        val exitStatus = channel!!.exitStatus
        ClientChannel.validateCommandExitStatusCode(command, exitStatus!!)
        return outputStream.toString()
    }

    override suspend fun closeSessionNB() {
        if (channel != null)
            channel!!.close()
        if (sshClient.isStarted) {
            sshClient.stop()
        }
        log.debug("SSH Client Service stopped successfully")
    }
}