/*

  * This file is part of dependency-check-core.

  *

  * 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.

  *

  * Copyright (c) 2012 Jeremy Long. All Rights Reserved.

  */

 package org.owasp.dependencycheck.analyzer;

 import java.util.ArrayList;

 import java.util.Iterator;

 import java.util.List;

 import java.util.Set;

 import org.owasp.dependencycheck.Engine;

 import org.owasp.dependencycheck.analyzer.exception.AnalysisException;

 import org.owasp.dependencycheck.dependency.Confidence;

 import org.owasp.dependencycheck.dependency.Dependency;

 import org.owasp.dependencycheck.dependency.Evidence;

 /**

  *

  * @author Jeremy Long

  */

 public class HintAnalyzer extends AbstractAnalyzer implements Analyzer {

     //<editor-fold defaultstate="collapsed" desc="All standard implementation details of Analyzer">

     /**

      * The name of the analyzer.

      */

     private static final String ANALYZER_NAME = "Hint Analyzer";

     /**

      * The phase that this analyzer is intended to run in.

      */

     private static final AnalysisPhase ANALYSIS_PHASE = AnalysisPhase.PRE_IDENTIFIER_ANALYSIS;

     /**

      * Returns the name of the analyzer.

      *

      * @return the name of the analyzer.

      */

     @Override

     public String getName() {

         return ANALYZER_NAME;

     }

     /**

      * Returns the phase that the analyzer is intended to run in.

      *

      * @return the phase that the analyzer is intended to run in.

      */

     @Override

     public AnalysisPhase getAnalysisPhase() {

         return ANALYSIS_PHASE;

     }

     //</editor-fold>

     /**

      * The HintAnalyzer uses knowledge about a dependency to add additional information to help in identification of identifiers

      * or vulnerabilities.

      *

      * @param dependency The dependency being analyzed

      * @param engine The scanning engine

      * @throws AnalysisException is thrown if there is an exception analyzing the dependency.

      */

     @Override

     public void analyze(Dependency dependency, Engine engine) throws AnalysisException {

         final Evidence springTest1 = new Evidence("Manifest",

                 "Implementation-Title",

                 "Spring Framework",

                 Confidence.HIGH);

         final Evidence springTest2 = new Evidence("Manifest",

                 "Implementation-Title",

                 "org.springframework.core",

                 Confidence.HIGH);

         final Evidence springTest3 = new Evidence("Manifest",

                 "Implementation-Title",

                 "spring-core",

                 Confidence.HIGH);

         final Evidence springTest4 = new Evidence("jar",

                 "package name",

                 "springframework",

                 Confidence.LOW);

         final Evidence springSecurityTest1 = new Evidence("Manifest",

                 "Bundle-Name",

                 "Spring Security Core",

                 Confidence.MEDIUM);

         final Evidence springSecurityTest2 = new Evidence("pom",

                 "artifactid",

                 "spring-security-core",

                 Confidence.HIGH);

         final Evidence symfony = new Evidence("composer.lock",

             "vendor",

             "symfony",

             Confidence.HIGHEST);

         final Evidence zendframeworkVendor = new Evidence("composer.lock",

             "vendor",

             "zendframework",

             Confidence.HIGHEST);

         final Evidence zendframeworkProduct = new Evidence("composer.lock",

             "product",

             "zendframework",

             Confidence.HIGHEST);

         //springsource/vware problem

         final Set<Evidence> product = dependency.getProductEvidence().getEvidence();

         final Set<Evidence> vendor = dependency.getVendorEvidence().getEvidence();

         if (product.contains(springTest1) || product.contains(springTest2) || product.contains(springTest3)

                 || (dependency.getFileName().contains("spring") && product.contains(springTest4))) {

             dependency.getProductEvidence().addEvidence("hint analyzer", "product", "springsource spring framework", Confidence.HIGH);

             dependency.getVendorEvidence().addEvidence("hint analyzer", "vendor", "SpringSource", Confidence.HIGH);

             dependency.getVendorEvidence().addEvidence("hint analyzer", "vendor", "vmware", Confidence.HIGH);

             dependency.getVendorEvidence().addEvidence("hint analyzer", "vendor", "pivotal", Confidence.HIGH);

         }

         if (vendor.contains(springTest4)) {

             dependency.getProductEvidence().addEvidence("hint analyzer", "product", "springsource_spring_framework", Confidence.HIGH);

             dependency.getVendorEvidence().addEvidence("hint analyzer", "vendor", "vmware", Confidence.HIGH);

             dependency.getVendorEvidence().addEvidence("hint analyzer", "vendor", "pivotal", Confidence.HIGH);

         }

         if (product.contains(springSecurityTest1) || product.contains(springSecurityTest2)) {

             dependency.getProductEvidence().addEvidence("hint analyzer", "product", "springsource_spring_security", Confidence.HIGH);

             dependency.getVendorEvidence().addEvidence("hint analyzer", "vendor", "SpringSource", Confidence.HIGH);

             dependency.getVendorEvidence().addEvidence("hint analyzer", "vendor", "vmware", Confidence.HIGH);

         }

         if (vendor.contains(symfony)) {

             dependency.getVendorEvidence().addEvidence("hint analyzer", "vendor", "sensiolabs", Confidence.HIGHEST);

         }

         if (vendor.contains(zendframeworkVendor)) {

             dependency.getVendorEvidence().addEvidence("hint analyzer", "vendor", "zend", Confidence.HIGHEST);

         }

         if (product.contains(zendframeworkProduct)) {

             dependency.getProductEvidence().addEvidence("hint analyzer", "vendor", "zend_framework", Confidence.HIGHEST);

         }

         //sun/oracle problem

         final Iterator<Evidence> itr = dependency.getVendorEvidence().iterator();

         final List<Evidence> newEntries = new ArrayList<Evidence>();

         while (itr.hasNext()) {

             final Evidence e = itr.next();

             if ("sun".equalsIgnoreCase(e.getValue(false))) {

                 final Evidence newEvidence = new Evidence(e.getSource() + " (hint)", e.getName(), "oracle", e.getConfidence());

                 newEntries.add(newEvidence);

             } else if ("oracle".equalsIgnoreCase(e.getValue(false))) {

                 final Evidence newEvidence = new Evidence(e.getSource() + " (hint)", e.getName(), "sun", e.getConfidence());

                 newEntries.add(newEvidence);

             }

         }

         for (Evidence e : newEntries) {

             dependency.getVendorEvidence().addEvidence(e);

         }

     }

 }