ghidra/Ghidra/Features/BSim/ghidra_scripts/ExampleOverviewQuery.py
caheckman 0865a3dfb0 GP-4009 Introduced BSim functionality including support for postgresql,
elasticsearch and h2 databases.  Added BSim correlator to Version
Tracking.
2023-12-05 08:30:51 -05:00

47 lines
1.7 KiB
Python
Executable file

## ###
# IP: GHIDRA
#
# 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.
##
# Example of how to perform an overview query in a script
# @category BSim.python
import ghidra.query.facade.SFOverviewInfo as SFOverviewInfo
import ghidra.query.facade.SimilarFunctionQueryService as SimilarFunctionQueryService
import java.util.HashSet
SIMILARITY_BOUND = 0.7
SIGNIFICANCE_BOUND = 0.0
funcsToQuery = java.util.HashSet()
fIter = currentProgram.getFunctionManager().getFunctionsNoStubs(True)
for func in fIter:
funcsToQuery.add(func.getSymbol())
overviewInfo = SFOverviewInfo(funcsToQuery)
overviewInfo.setSimilarityThreshold(SIMILARITY_BOUND)
overviewInfo.setSignificanceThreshold(SIGNIFICANCE_BOUND)
queryService = SimilarFunctionQueryService(currentProgram)
DB_URL = askString("Enter database URL", "URL:")
queryService.initializeDatabase(DB_URL)
vectorFactory = queryService.getLSHVectorFactory()
overviewResults = queryService.overviewSimilarFunctions(overviewInfo, monitor)
for result in overviewResults.result:
print "Name: %s" % result.getBase().getFunctionName()
print "Hit Count: %d" % result.getTotalCount()
print "Self-significance: %f\n" % vectorFactory.getSelfSignificance(result.getBase().getSignatureRecord().getLSHVector())
queryService.dispose()