mirror of
https://github.com/mandiant/capa.git
synced 2025-12-05 20:40:05 -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.
106 lines
3.4 KiB
Python
106 lines
3.4 KiB
Python
# Copyright 2023 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.
|
|
|
|
"""
|
|
Must invoke this script from within the Ghidra Runtime Environment
|
|
"""
|
|
import sys
|
|
import logging
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
try:
|
|
sys.path.append(str(Path(__file__).parent))
|
|
import fixtures
|
|
finally:
|
|
sys.path.pop()
|
|
|
|
|
|
logger = logging.getLogger("test_ghidra_features")
|
|
|
|
ghidra_present: bool = False
|
|
try:
|
|
import ghidra # noqa: F401
|
|
|
|
ghidra_present = True
|
|
except ImportError:
|
|
pass
|
|
|
|
|
|
def standardize_posix_str(psx_str):
|
|
"""fixture test passes the PosixPath to the test data
|
|
|
|
params: psx_str - PosixPath() to the test data
|
|
return: string that matches test-id sample name
|
|
"""
|
|
|
|
if "Practical Malware Analysis Lab" in str(psx_str):
|
|
# <PosixPath>/'Practical Malware Analysis Lab 16-01.exe_' -> 'pma16-01'
|
|
wanted_str = "pma" + str(psx_str).split("/")[-1][len("Practical Malware Analysis Lab ") : -5]
|
|
else:
|
|
# <PosixPath>/mimikatz.exe_ -> mimikatz
|
|
wanted_str = str(psx_str).split("/")[-1][:-5]
|
|
|
|
if "_" in wanted_str:
|
|
# al-khaser_x86 -> al-khaser x86
|
|
wanted_str = wanted_str.replace("_", " ")
|
|
|
|
return wanted_str
|
|
|
|
|
|
def check_input_file(wanted):
|
|
"""check that test is running on the loaded sample
|
|
|
|
params: wanted - PosixPath() passed from test arg
|
|
"""
|
|
|
|
import capa.ghidra.helpers as ghidra_helpers
|
|
|
|
found = ghidra_helpers.get_file_md5()
|
|
sample_name = standardize_posix_str(wanted)
|
|
|
|
if not found.startswith(fixtures.get_sample_md5_by_name(sample_name)):
|
|
raise RuntimeError(f"please run the tests against sample with MD5: `{found}`")
|
|
|
|
|
|
@pytest.mark.skipif(ghidra_present is False, reason="Ghidra tests must be ran within Ghidra")
|
|
@fixtures.parametrize("sample,scope,feature,expected", fixtures.FEATURE_PRESENCE_TESTS, indirect=["sample", "scope"])
|
|
def test_ghidra_features(sample, scope, feature, expected):
|
|
try:
|
|
check_input_file(sample)
|
|
except RuntimeError:
|
|
pytest.skip(reason="Test must be ran against sample loaded in Ghidra")
|
|
|
|
fixtures.do_test_feature_presence(fixtures.get_ghidra_extractor, sample, scope, feature, expected)
|
|
|
|
|
|
@pytest.mark.skipif(ghidra_present is False, reason="Ghidra tests must be ran within Ghidra")
|
|
@fixtures.parametrize(
|
|
"sample,scope,feature,expected", fixtures.FEATURE_COUNT_TESTS_GHIDRA, indirect=["sample", "scope"]
|
|
)
|
|
def test_ghidra_feature_counts(sample, scope, feature, expected):
|
|
try:
|
|
check_input_file(sample)
|
|
except RuntimeError:
|
|
pytest.skip(reason="Test must be ran against sample loaded in Ghidra")
|
|
|
|
fixtures.do_test_feature_count(fixtures.get_ghidra_extractor, sample, scope, feature, expected)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
# No support for faulthandler module in Ghidrathon, see:
|
|
# https://github.com/mandiant/Ghidrathon/issues/70
|
|
sys.exit(pytest.main(["--pyargs", "-p no:faulthandler", "test_ghidra_features"]))
|