org.owasp.dependencycheck.data.lucene.SearchFieldAnalyzer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dependency-check-core Show documentation
Show all versions of dependency-check-core Show documentation
dependency-check-core is the engine and reporting tool used to identify and report if there are any known, publicly disclosed vulnerabilities in the scanned project's dependencies. The engine extracts meta-data from the dependencies and uses this to do fuzzy key-word matching against the Common Platfrom Enumeration (CPE), if any CPE identifiers are found the associated Common Vulnerability and Exposure (CVE) entries are added to the generated report.
/*
* 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.data.lucene;
import java.io.IOException;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.TokenStream;
import org.apache.lucene.analysis.Tokenizer;
import org.apache.lucene.analysis.core.LowerCaseFilter;
import org.apache.lucene.analysis.core.StopFilter;
import org.apache.lucene.analysis.core.WhitespaceTokenizer;
import org.apache.lucene.analysis.miscellaneous.WordDelimiterGraphFilter;
import org.apache.lucene.analysis.CharArraySet;
import org.apache.lucene.analysis.en.EnglishAnalyzer;
/**
* A Lucene field analyzer used to analyzer queries against the CPE data.
*
* @author Jeremy Long
*/
public class SearchFieldAnalyzer extends Analyzer {
/**
* The list of additional stop words to use.
*/
private static final String[] ADDITIONAL_STOP_WORDS = {"software", "framework", "inc",
"com", "org", "net", "www", "consulting", "ltd", "foundation", "project"};
/**
* The set of stop words to use in the analyzer.
*/
private final CharArraySet stopWords;
/**
* A reference to the concatenating filter so that it can be reset/cleared.
*/
private TokenPairConcatenatingFilter concatenatingFilter;
/**
* Returns the set of stop words being used.
*
* @return the set of stop words being used
*/
public static CharArraySet getStopWords() {
final CharArraySet words = StopFilter.makeStopSet(ADDITIONAL_STOP_WORDS, true);
words.addAll(EnglishAnalyzer.ENGLISH_STOP_WORDS_SET);
return words;
}
/**
* Constructs a new SearchFieldAnalyzer.
*
*/
public SearchFieldAnalyzer() {
stopWords = getStopWords();
}
/**
* Creates a the TokenStreamComponents used to analyze the stream.
*
* @param fieldName the field that this lucene analyzer will process
* @return the token stream filter chain
*/
@Override
protected TokenStreamComponents createComponents(String fieldName) {
//final Tokenizer source = new AlphaNumericTokenizer();
final Tokenizer source = new WhitespaceTokenizer();
TokenStream stream = source;
stream = new UrlTokenizingFilter(stream);
stream = new AlphaNumericFilter(stream);
stream = new WordDelimiterGraphFilter(stream,
WordDelimiterGraphFilter.GENERATE_WORD_PARTS
//| WordDelimiterGraphFilter.GENERATE_NUMBER_PARTS
| WordDelimiterGraphFilter.PRESERVE_ORIGINAL
| WordDelimiterGraphFilter.SPLIT_ON_CASE_CHANGE
| WordDelimiterGraphFilter.SPLIT_ON_NUMERICS
| WordDelimiterGraphFilter.STEM_ENGLISH_POSSESSIVE, null);
stream = new LowerCaseFilter(stream);
stream = new StopFilter(stream, stopWords);
concatenatingFilter = new TokenPairConcatenatingFilter(stream);
return new TokenStreamComponents(source, concatenatingFilter);
}
/**
* Resets the analyzer. This must be manually called between searching and
* indexing.
*
* @throws IOException thrown if there is an error reseting the tokenizer
*/
public void reset() throws IOException {
concatenatingFilter.clear();
}
}