mirror of
https://github.com/mandiant/capa.git
synced 2025-12-22 07:10:29 -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>
78 lines
2.3 KiB
Python
78 lines
2.3 KiB
Python
"""
|
|
Reformat the given capa rule into a consistent style.
|
|
Use the -i flag to update the rule in-place.
|
|
|
|
Usage:
|
|
|
|
$ python capafmt.py -i foo.yml
|
|
|
|
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
|
|
|
|
logger = logging.getLogger("capafmt")
|
|
|
|
|
|
def main(argv=None):
|
|
if argv is None:
|
|
argv = sys.argv[1:]
|
|
|
|
parser = argparse.ArgumentParser(description="Capa rule formatter.")
|
|
capa.main.install_common_args(parser)
|
|
parser.add_argument("path", type=str, help="Path to rule to format")
|
|
parser.add_argument(
|
|
"-i",
|
|
"--in-place",
|
|
action="store_true",
|
|
dest="in_place",
|
|
help="Format the rule in place, otherwise, write formatted rule to STDOUT",
|
|
)
|
|
parser.add_argument(
|
|
"-c",
|
|
"--check",
|
|
action="store_true",
|
|
help="Don't output (reformatted) rule, only return status. 0 = no changes, 1 = would reformat",
|
|
)
|
|
args = parser.parse_args(args=argv)
|
|
|
|
try:
|
|
capa.main.handle_common_args(args)
|
|
except capa.main.ShouldExitError as e:
|
|
return e.status_code
|
|
|
|
rule = capa.rules.Rule.from_yaml_file(args.path, use_ruamel=True)
|
|
reformatted_rule = rule.to_yaml()
|
|
|
|
if args.check:
|
|
if rule.definition == reformatted_rule:
|
|
logger.info("rule is formatted correctly, nice! (%s)", rule.name)
|
|
return 0
|
|
else:
|
|
logger.info("rule requires reformatting (%s)", rule.name)
|
|
if "\r\n" in rule.definition:
|
|
logger.info("please make sure that the file uses LF (\\n) line endings only")
|
|
return 1
|
|
|
|
if args.in_place:
|
|
Path(args.path).write_bytes(reformatted_rule.encode("utf-8"))
|
|
else:
|
|
print(reformatted_rule)
|
|
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|