com.metaeffekt.artifact.enrichment.details.DetailsFillingEnrichmentCustom Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ae-artifact-analysis Show documentation
There is a newer version: 0.132.0
/*
 * Copyright 2021-2024 the original author or authors.
 *
 * 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 com.metaeffekt.artifact.enrichment.details;

import com.metaeffekt.artifact.analysis.utils.StringUtils;
import com.metaeffekt.artifact.enrichment.configurations.CustomVulnerabilitiesDetailsFillingEnrichmentConfiguration;
import com.metaeffekt.mirror.contents.advisory.AdvisoryEntry;
import com.metaeffekt.mirror.contents.base.VulnerabilityContextInventory;
import com.metaeffekt.mirror.contents.vulnerability.Vulnerability;
import com.metaeffekt.mirror.download.documentation.EnricherMetadata;
import com.metaeffekt.mirror.download.documentation.InventoryEnrichmentPhase;
import com.metaeffekt.mirror.query.CustomVulnerabilityIndexQuery;
import org.metaeffekt.core.inventory.processor.model.Inventory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.util.Optional;

@EnricherMetadata(
        name = "Custom Vulnerability Details", phase = InventoryEnrichmentPhase.VULNERABILITY_DETAILS_FILLING,
        intermediateFileSuffix = "details-vulnerability-custom", mavenPropertyName = "customVulnerabilitiesFillDetailsEnrichment",
        explicitConfiguration = CustomVulnerabilitiesDetailsFillingEnrichmentConfiguration.class
)
public class DetailsFillingEnrichmentCustom extends DetailsFillingEnrichment {

    private static final Logger LOG = LoggerFactory.getLogger(DetailsFillingEnrichmentCustom.class);

    protected CustomVulnerabilityIndexQuery vulnerabilityQuery;

    private CustomVulnerabilitiesDetailsFillingEnrichmentConfiguration configuration = new CustomVulnerabilitiesDetailsFillingEnrichmentConfiguration();

    public DetailsFillingEnrichmentCustom(File baseMirrorDirectory) {
    }

    @Override
    public void performEnrichment(Inventory inventory) {
        vulnerabilityQuery = new CustomVulnerabilityIndexQuery(getConfiguration().getVulnerabilityFiles());
        super.performEnrichment(inventory);
    }

    public void setConfiguration(CustomVulnerabilitiesDetailsFillingEnrichmentConfiguration configuration) {
        this.configuration = configuration;
    }

    @Override
    public CustomVulnerabilitiesDetailsFillingEnrichmentConfiguration getConfiguration() {
        return configuration;
    }

    @Override
    public boolean isApplicable(Vulnerability vulnerability) {
        return StringUtils.isEmpty(vulnerability.getDescription());
    }

    @Override
    protected boolean isApplicable(AdvisoryEntry advisory) {
        // does not provide advisories
        return false;
    }

    @Override
    protected void fillDetailsOnVulnerability(Inventory inventory, VulnerabilityContextInventory vInventory, Vulnerability queryVulnerability) {
        final Optional potentialDbVulnerability = vulnerabilityQuery.findVulnerabilityByName(queryVulnerability.getId());

        if (!potentialDbVulnerability.isPresent()) {
            if (!String.valueOf(queryVulnerability.getId()).startsWith("ADV")) {
                LOG.warn("Custom Vulnerability [{}] not found", queryVulnerability.getId());
            }
        } else {
            final Vulnerability dbVulnerability = potentialDbVulnerability.get();
            queryVulnerability.appendFromDataClass(dbVulnerability);
        }
    }

    @Override
    protected void fillDetailsOnAdvisory(Inventory inventory, VulnerabilityContextInventory vInventory, AdvisoryEntry queryAdvisory) {
        // does not provide advisories
    }
}