mirror of
https://github.com/mandiant/capa.git
synced 2025-12-06 04:41:00 -08:00
3cd97ae9f2
Replace the header from source code files using the following script:
```Python
for dir_path, dir_names, file_names in os.walk("capa"):
for file_name in file_names:
# header are only in `.py` and `.toml` files
if file_name[-3:] not in (".py", "oml"):
continue
file_path = f"{dir_path}/{file_name}"
f = open(file_path, "rb+")
content = f.read()
m = re.search(OLD_HEADER, content)
if not m:
continue
print(f"{file_path}: {m.group('year')}")
content = content.replace(m.group(0), NEW_HEADER % m.group("year"))
f.seek(0)
f.write(content)
```
Some files had the copyright headers inside a `"""` comment and needed
manual changes before applying the script. `hook-vivisect.py` and
`pyinstaller.spec` didn't include the license in the header and also
needed manual changes.
The old header had the confusing sentence `All rights reserved`, which
does not make sense for an open source license. Replace the header by
the default Google header that corrects this issue and keep capa
consistent with other Google projects.
Adapt the linter to work with the new header.
Replace also the copyright text in the `web/public/index.html` file for
consistency.
85 lines
2.4 KiB
Python
85 lines
2.4 KiB
Python
# Copyright 2020 Google LLC
|
|
#
|
|
# 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.
|
|
|
|
"""
|
|
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
|
|
"""
|
|
|
|
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())
|