mirror of
https://github.com/mandiant/capa.git
synced 2025-12-12 23:59:48 -08:00
c3301d3b3f
* main: split main into a bunch of "main routines" [wip] since there are a few references to BinExport2 that are in progress elsewhre. Next commit will remove them. * main: remove references to wip BinExport2 code * changelog * main: rename first position argument "input_file" closes #1946 * main: linters * main: move rule-related routines to capa.rules ref #1821 * main: extract routines to capa.loader module closes #1821 * add loader module * loader: learn to load freeze format * freeze: use new cli arg handling * Update capa/loader.py Co-authored-by: Moritz <mr-tz@users.noreply.github.com> * main: remove duplicate documentation * main: add doc about where some functions live * scripts: migrate to new main wrapper helper functions * scripts: port to main routines * main: better handle auto-detection of backend * scripts: migrate bulk-process to main wrappers * scripts: migrate scripts to main wrappers * main: rename *_from_args to *_from_cli * changelog * cache-ruleset: remove duplication * main: fix tag handling * cache-ruleset: fix cli args * cache-ruleset: fix special rule cli handling * scripts: fix type bytes * main: remove old TODO message * loader: fix references to binja extractor --------- Co-authored-by: Moritz <mr-tz@users.noreply.github.com>
75 lines
2.5 KiB
Python
75 lines
2.5 KiB
Python
"""
|
|
Create a cache of the given rules.
|
|
This is only really intended to be used by CI to pre-cache rulesets
|
|
that will be distributed within PyInstaller binaries.
|
|
|
|
Usage:
|
|
|
|
$ python scripts/cache-ruleset.py rules/ /path/to/cache/directory
|
|
|
|
Copyright (C) 2023 Mandiant, Inc. All Rights Reserved.
|
|
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: [package root]/LICENSE.txt
|
|
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.
|
|
"""
|
|
import sys
|
|
import logging
|
|
import argparse
|
|
from pathlib import Path
|
|
|
|
import capa.main
|
|
import capa.rules
|
|
import capa.engine
|
|
import capa.helpers
|
|
import capa.rules.cache
|
|
import capa.features.insn
|
|
|
|
logger = logging.getLogger("cache-ruleset")
|
|
|
|
|
|
def main(argv=None):
|
|
if argv is None:
|
|
argv = sys.argv[1:]
|
|
|
|
parser = argparse.ArgumentParser(description="Cache ruleset.")
|
|
capa.main.install_common_args(parser)
|
|
parser.add_argument("rules", type=str, help="Path to rules directory")
|
|
parser.add_argument("cache", type=str, help="Path to cache directory")
|
|
args = parser.parse_args(args=argv)
|
|
|
|
# don't use capa.main.handle_common_args
|
|
# because it expects a different format for the --rules argument
|
|
|
|
if args.quiet:
|
|
logging.basicConfig(level=logging.WARNING)
|
|
logging.getLogger().setLevel(logging.WARNING)
|
|
elif args.debug:
|
|
logging.basicConfig(level=logging.DEBUG)
|
|
logging.getLogger().setLevel(logging.DEBUG)
|
|
else:
|
|
logging.basicConfig(level=logging.INFO)
|
|
logging.getLogger().setLevel(logging.INFO)
|
|
|
|
try:
|
|
cache_dir = Path(args.cache)
|
|
cache_dir.mkdir(parents=True, exist_ok=True)
|
|
rules = capa.rules.get_rules([Path(args.rules)], cache_dir)
|
|
logger.info("successfully loaded %s rules", len(rules))
|
|
except (IOError, capa.rules.InvalidRule, capa.rules.InvalidRuleSet) as e:
|
|
logger.error("%s", str(e))
|
|
return -1
|
|
|
|
content = capa.rules.cache.get_ruleset_content(rules)
|
|
id = capa.rules.cache.compute_cache_identifier(content)
|
|
path = capa.rules.cache.get_cache_path(cache_dir, id)
|
|
|
|
assert path.exists()
|
|
logger.info("cached to: %s", path)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|