ms/blueprintsprocessor/modules/inbounds/selfservice-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/selfservice/api/KafkaPublishAuditService.kt

   1 /*
   2  * Copyright © 2020 Bell Canada
   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.selfservice.api
  18
  19 import com.fasterxml.jackson.databind.JsonNode
  20 import com.fasterxml.jackson.databind.node.ObjectNode
  21 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceInput
  22 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceOutput
  23 import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.ResourceResolutionConstants
  24 import org.onap.ccsdk.cds.blueprintsprocessor.message.service.BluePrintMessageLibPropertyService
  25 import org.onap.ccsdk.cds.blueprintsprocessor.message.service.BlueprintMessageProducerService
  26 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
  27 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonPrimitive
  28 import org.onap.ccsdk.cds.controllerblueprints.core.common.ApplicationConstants
  29 import org.onap.ccsdk.cds.controllerblueprints.core.interfaces.BluePrintCatalogService
  30 import org.onap.ccsdk.cds.controllerblueprints.core.utils.BluePrintMetadataUtils
  31 import org.onap.ccsdk.cds.controllerblueprints.core.utils.JacksonUtils
  32 import org.onap.ccsdk.cds.controllerblueprints.core.utils.PropertyDefinitionUtils
  33 import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
  34 import org.slf4j.LoggerFactory
  35 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty
  36 import org.springframework.stereotype.Service
  37 import javax.annotation.PostConstruct
  38
  39 /**
  40  * Audit service used to produce execution service input and output message
  41  * sent into dedicated kafka topics.
  42  */
  43 @ConditionalOnProperty(
  44         name = ["blueprintsprocessor.messageproducer.self-service-api.audit.kafkaEnable"],
  45         havingValue = "true"
  46 )
  47 @Service
  48 class KafkaPublishAuditService(
  49     private val bluePrintMessageLibPropertyService: BluePrintMessageLibPropertyService,
  50     private val blueprintsProcessorCatalogService: BluePrintCatalogService
  51 ) : PublishAuditService {
  52     private var inputInstance: BlueprintMessageProducerService? = null
  53     private var outputInstance: BlueprintMessageProducerService? = null
  54     private lateinit var correlationUUID: String
  55     private val log = LoggerFactory.getLogger(KafkaPublishAuditService::class.toString())
  56
  57     companion object {
  58         const val INPUT_SELECTOR = "self-service-api.audit.request"
  59         const val OUTPUT_SELECTOR = "self-service-api.audit.response"
  60     }
  61
  62     @PostConstruct
  63     private fun init() {
  64         log.info("Kakfa audit service is enabled")
  65     }
  66
  67     /**
  68      * Publish execution input into a kafka topic.
  69      * The correlation UUID is used to link the input to its output.
  70      * Sensitive data within the request are hidden.
  71      */
  72     override suspend fun publish(executionServiceInput: ExecutionServiceInput) {
  73         this.correlationUUID = executionServiceInput.correlationUUID
  74         val secureExecutionServiceInput = hideSensitiveData(executionServiceInput)
  75         this.inputInstance = this.getInputInstance(INPUT_SELECTOR)
  76         this.inputInstance!!.sendMessage(secureExecutionServiceInput)
  77     }
  78
  79     /**
  80      * Publish execution output into a kafka topic.
  81      * The correlation UUID is used to link the output to its input.
  82      * A correlation UUID is added to link the input to its output.
  83      */
  84     override fun publish(executionServiceOutput: ExecutionServiceOutput) {
  85         executionServiceOutput.correlationUUID = this.correlationUUID
  86         this.outputInstance = this.getOutputInstance(OUTPUT_SELECTOR)
  87         this.outputInstance!!.sendMessage(executionServiceOutput)
  88     }
  89
  90     /**
  91      * Return the input kafka producer instance using a selector.
  92      */
  93     private fun getInputInstance(selector: String): BlueprintMessageProducerService = inputInstance ?: createInstance(selector)
  94
  95     /**
  96      * Return the output kafka producer instance using a selector.
  97      */
  98     private fun getOutputInstance(selector: String): BlueprintMessageProducerService = outputInstance ?: createInstance(selector)
  99
 100     /**
 101      * Create a kafka producer instance.
 102      */
 103     private fun createInstance(selector: String): BlueprintMessageProducerService {
 104         log.info(
 105                 "Setting up message producer($selector)..."
 106         )
 107         return try {
 108             bluePrintMessageLibPropertyService
 109                     .blueprintMessageProducerService(selector)
 110         } catch (e: Exception) {
 111             throw BluePrintProcessorException("failed to create producer service ${e.message}")
 112         }
 113     }
 114
 115     /**
 116      * Hide sensitive data in the request.
 117      * Sensitive data are declared in the resource resolution mapping using
 118      * the property metadata "log-protect" set to true.
 119      */
 120     private suspend fun hideSensitiveData(
 121         executionServiceInput: ExecutionServiceInput
 122     ): ExecutionServiceInput {
 123
 124         var clonedExecutionServiceInput = ExecutionServiceInput().apply {
 125             correlationUUID = executionServiceInput.correlationUUID
 126             commonHeader = executionServiceInput.commonHeader
 127             actionIdentifiers = executionServiceInput.actionIdentifiers
 128             payload = executionServiceInput.payload.deepCopy()
 129             stepData = executionServiceInput.stepData
 130         }
 131
 132         val blueprintName = clonedExecutionServiceInput.actionIdentifiers.blueprintName
 133         val workflowName = clonedExecutionServiceInput.actionIdentifiers.actionName
 134
 135         if (blueprintName == "default") return clonedExecutionServiceInput
 136
 137         if (clonedExecutionServiceInput.payload
 138                         .path("$workflowName-request").has("$workflowName-properties")) {
 139
 140             /** Retrieving sensitive input parameters */
 141             val requestId = clonedExecutionServiceInput.commonHeader.requestId
 142             val blueprintVersion = clonedExecutionServiceInput.actionIdentifiers.blueprintVersion
 143
 144             val basePath = blueprintsProcessorCatalogService.getFromDatabase(blueprintName, blueprintVersion)
 145
 146             val blueprintRuntimeService = BluePrintMetadataUtils.getBluePrintRuntime(requestId, basePath.toString())
 147             val blueprintContext = blueprintRuntimeService.bluePrintContext()
 148
 149             val nodeTemplateName = blueprintContext.workflowFirstStepNodeTemplate(workflowName)
 150             val interfaceName = blueprintContext.nodeTemplateFirstInterfaceName(nodeTemplateName)
 151             val operationName = blueprintContext.nodeTemplateFirstInterfaceFirstOperationName(nodeTemplateName)
 152
 153             val propertyAssignments: MutableMap<String, JsonNode> =
 154                     blueprintContext.nodeTemplateInterfaceOperationInputs(nodeTemplateName, interfaceName, operationName)
 155                             ?: hashMapOf()
 156
 157             val artifactPrefixNamesNode = propertyAssignments[ResourceResolutionConstants.INPUT_ARTIFACT_PREFIX_NAMES]
 158             val artifactPrefixNames = JacksonUtils.getListFromJsonNode(artifactPrefixNamesNode!!, String::class.java)
 159
 160             /** Storing mapping entries with metadata log-protect set to true */
 161             val sensitiveParameters: List<String> = artifactPrefixNames
 162                     .map { "$it-mapping" }
 163                     .map { blueprintRuntimeService.resolveNodeTemplateArtifact(nodeTemplateName, it) }
 164                     .flatMap { JacksonUtils.getListFromJson(it, ResourceAssignment::class.java) }
 165                     .filter { PropertyDefinitionUtils.hasLogProtect(it.property) }
 166                     .map { it.name }
 167
 168             /** Hiding sensitive input parameters from the request */
 169             var workflowProperties: ObjectNode = clonedExecutionServiceInput.payload
 170                     .path("$workflowName-request")
 171                     .path("$workflowName-properties") as ObjectNode
 172
 173             sensitiveParameters.forEach { sensitiveParameter ->
 174                 if (workflowProperties.has(sensitiveParameter)) {
 175                     workflowProperties.replace(sensitiveParameter, ApplicationConstants.LOG_REDACTED.asJsonPrimitive())
 176                 }
 177             }
 178         }
 179
 180         return clonedExecutionServiceInput
 181     }
 182 }