ms/blueprintsprocessor/modules/commons/ssh-lib/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/ssh/service/BasicAuthSshClientService.kt

   1 /*
   2  *  Copyright © 2019 IBM.
   3  *
   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
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 package org.onap.ccsdk.cds.blueprintsprocessor.ssh.service
  18
  19 import org.apache.sshd.client.SshClient
  20 import org.apache.sshd.client.channel.ChannelExec
  21 import org.apache.sshd.client.channel.ClientChannel
  22 import org.apache.sshd.client.channel.ClientChannelEvent
  23 import org.apache.sshd.client.keyverifier.AcceptAllServerKeyVerifier
  24 import org.apache.sshd.client.session.ClientSession
  25 import org.onap.ccsdk.cds.blueprintsprocessor.ssh.BasicAuthSshClientProperties
  26 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
  27 import org.slf4j.LoggerFactory
  28 import java.io.ByteArrayOutputStream
  29 import java.util.*
  30
  31
  32 open class BasicAuthSshClientService(private val basicAuthSshClientProperties: BasicAuthSshClientProperties)
  33     : BlueprintSshClientService {
  34
  35     private val log = LoggerFactory.getLogger(BasicAuthSshClientService::class.java)!!
  36
  37     private lateinit var sshClient: SshClient
  38     private lateinit var clientSession: ClientSession
  39     var channel: ChannelExec? = null
  40
  41     override suspend fun startSessionNB(): ClientSession {
  42         sshClient = SshClient.setUpDefaultClient()
  43         sshClient.serverKeyVerifier = AcceptAllServerKeyVerifier.INSTANCE
  44         sshClient.start()
  45         log.debug("SSH Client Service started successfully")
  46         clientSession = sshClient.connect(basicAuthSshClientProperties.username, basicAuthSshClientProperties.host,
  47                 basicAuthSshClientProperties.port)
  48                 .verify(basicAuthSshClientProperties.connectionTimeOut)
  49                 .session
  50
  51         clientSession.addPasswordIdentity(basicAuthSshClientProperties.password)
  52         clientSession.auth().verify(basicAuthSshClientProperties.connectionTimeOut)
  53         log.info("SSH client session($clientSession) created")
  54         return clientSession
  55     }
  56
  57     override suspend fun executeCommandsNB(commands: List<String>, timeOut: Long): String {
  58         val buffer = StringBuffer()
  59         try {
  60             commands.forEach { command ->
  61                 buffer.append("\nCommand : $command")
  62                 buffer.append("\n" + executeCommandNB(command, timeOut))
  63             }
  64         } catch (e: Exception) {
  65             throw BluePrintProcessorException("Failed to execute commands, below the output : $buffer")
  66         }
  67         return buffer.toString()
  68     }
  69
  70     override suspend fun executeCommandNB(command: String, timeOut: Long): String {
  71         log.debug("Executing host($clientSession) command($command)")
  72
  73         channel = clientSession.createExecChannel(command)
  74         checkNotNull(channel) { "failed to create Channel for the command : $command" }
  75
  76         //TODO("Convert to streaming ")
  77         val outputStream = ByteArrayOutputStream()
  78         channel!!.out = outputStream
  79         channel!!.err = outputStream
  80         channel!!.open().await()
  81         val waitMask = channel!!.waitFor(Collections.unmodifiableSet(EnumSet.of(ClientChannelEvent.CLOSED)), timeOut)
  82         if (waitMask.contains(ClientChannelEvent.TIMEOUT)) {
  83             throw BluePrintProcessorException("Failed to retrieve command result in time: $command")
  84         }
  85         val exitStatus = channel!!.exitStatus
  86         ClientChannel.validateCommandExitStatusCode(command, exitStatus!!)
  87         return outputStream.toString()
  88     }
  89
  90     override suspend fun closeSessionNB() {
  91         if (channel != null)
  92             channel!!.close()
  93         if (sshClient.isStarted) {
  94             sshClient.stop()
  95         }
  96         log.debug("SSH Client Service stopped successfully")
  97     }
  98 }