diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 00000000..20e87422 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,42 @@ +name: CI + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + code_style: + runs-on: ubuntu-latest + steps: + - name: Checkout capa + uses: actions/checkout@v2 + - name: Set up Python 3.8 + uses: actions/setup-python@v2 + with: + python-version: 3.8 + - name: Install dependencies + run: pip install 'isort==5.*' black + - name: Lint with isort + run: isort --profile black --length-sort --line-width 120 -c . + - name: Lint with black + run: black -l 120 --check . + + rule_linter: + runs-on: ubuntu-latest + steps: + - name: Checkout capa with rules submodule + uses: actions/checkout@v2 + with: + submodules: true + - name: Set up Python 3.8 + uses: actions/setup-python@v2 + with: + python-version: 3.8 + # We don't need vivisect, so we can install capa using Python3 + - name: Install capa + run: pip install -e . + - name: Run rule linter + run: python scripts/lint.py rules/ + diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md index f20d7b3a..ad334d5b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ ![capa](.github/logo.png) -[![Number of rules](https://img.shields.io/badge/rules-261-blue.svg)](https://github.com/fireeye/capa-rules) +[![Code style checkers status](https://github.com/fireeye/capa/workflows/CI/badge.svg)](https://github.com/fireeye/capa/actions?query=workflow%3A%22CI%22) +[![Number of rules](https://img.shields.io/badge/rules-262-blue.svg)](https://github.com/fireeye/capa-rules) +[![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)](LICENSE.txt) capa detects capabilities in executable files. You run it against a PE file or shellcode and it tells you what it thinks the program can do. For example, it might suggest that the file is a backdoor, is capable of installing services, or relies on HTTP to communicate. +Check out the overview in our first [capa blog post](https://www.fireeye.com/blog/threat-research/2020/07/capa-automatically-identify-malware-capabilities.html). + ``` $ capa.exe suspicious.exe @@ -56,12 +60,14 @@ $ capa.exe suspicious.exe # download and usage -Download stable releases of the standalone capa binaries [here](/releases). You can run the standalone binaries without installation. +Download stable releases of the standalone capa binaries [here](https://github.com/fireeye/capa/releases). You can run the standalone binaries without installation. capa is a command line tool that should be run from the terminal. + To use capa as a library or integrate with another tool, see [doc/installation.md](doc/installation.md) for further setup instructions. diff --git a/capa/features/extractors/viv/__init__.py b/capa/features/extractors/viv/__init__.py index a73c0e9b..4f47b05d 100644 --- a/capa/features/extractors/viv/__init__.py +++ b/capa/features/extractors/viv/__init__.py @@ -2,12 +2,12 @@ import types -import viv_utils - import file import insn import function +import viv_utils import basicblock + import capa.features.extractors import capa.features.extractors.viv.file import capa.features.extractors.viv.insn diff --git a/capa/features/freeze.py b/capa/features/freeze.py index 0225c86d..39bb9398 100644 --- a/capa/features/freeze.py +++ b/capa/features/freeze.py @@ -205,6 +205,7 @@ def load(buf): def main(argv=None): import sys import argparse + import capa.main if argv is None: diff --git a/capa/main.py b/capa/main.py index a6aebba8..073f2d6d 100644 --- a/capa/main.py +++ b/capa/main.py @@ -9,12 +9,12 @@ import sys import hashlib import logging import os.path +import argparse import datetime import textwrap import collections import tqdm -import argparse import colorama import capa.rules diff --git a/capa/render/__init__.py b/capa/render/__init__.py index 0bc9e437..b4d3f053 100644 --- a/capa/render/__init__.py +++ b/capa/render/__init__.py @@ -245,8 +245,8 @@ def render_verbose(meta, rules, capabilities): def render_default(meta, rules, capabilities): # break import loop - import capa.render.verbose import capa.render.default + import capa.render.verbose doc = convert_capabilities_to_result_document(meta, rules, capabilities) return capa.render.default.render_default(doc) diff --git a/doc/img/approve.png b/doc/img/approve.png new file mode 100644 index 00000000..546c4b8c Binary files /dev/null and b/doc/img/approve.png differ diff --git a/doc/installation.md b/doc/installation.md index b7a1d753..18aaecb6 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -8,6 +8,12 @@ We use PyInstaller to create these packages. The capa [README](../README.md#download) also links to nightly builds of standalone binaries from the latest development branch. +### MacOS Standalone installation + +By default, on MacOS Catalina or greater, Gatekeeper will block execution of the standalone binary. To resolve this, simply try to execute it once on the command-line and then go to `System Preferences` / `Security & Privacy` / `General` and approve the application: + +![approve dialog](img/approve.png) + ## Method 2: Using capa as a Python library To install capa as a Python library, you'll need to install a few dependencies, and then use `pip` to fetch the capa module. Note: this technique doesn't pull the default rule set, so you should check it out separately from [capa-rules](https://github.com/fireeye/capa-rules/) and pass the directory to the entrypoint using `-r`. @@ -59,7 +65,7 @@ You'll find that the `capa.exe` (Windows) or `capa` (Linux) executables in your We use the following tools to ensure consistent code style and formatting: - [black](https://github.com/psf/black) code formatter, with `-l 120` - - [isort](https://pypi.org/project/isort/) code formatter, with `--length-sort --line-width 120` + - [isort 5](https://pypi.org/project/isort/) code formatter, with `--profile black --length-sort --line-width 120` - [dos2unix](https://linux.die.net/man/1/dos2unix) for UNIX-style LF newlines - [capafmt](https://github.com/fireeye/capa/blob/master/scripts/capafmt.py) rule formatter diff --git a/rules b/rules index 0357195d..d497b447 160000 --- a/rules +++ b/rules @@ -1 +1 @@ -Subproject commit 0357195d6642ab03dea5eb7bc9c025f5de2bb27a +Subproject commit d497b4472cbfa5edd5dc102f9949caa0522d46f3 diff --git a/scripts/capafmt.py b/scripts/capafmt.py index f95e3113..a787444d 100644 --- a/scripts/capafmt.py +++ b/scripts/capafmt.py @@ -10,7 +10,6 @@ Copyright (C) 2020 FireEye, Inc. All Rights Reserved. """ import sys import logging - import argparse import capa.rules diff --git a/scripts/lint.py b/scripts/lint.py index f0e532bc..ada15a9d 100644 --- a/scripts/lint.py +++ b/scripts/lint.py @@ -13,11 +13,10 @@ import string import hashlib import logging import os.path +import argparse import itertools import posixpath -import argparse - import capa.main import capa.engine import capa.features @@ -137,10 +136,12 @@ class MissingExampleOffset(Lint): def check_rule(self, ctx, rule): if rule.meta.get("scope") in ("function", "basic block"): - for example in rule.meta.get("examples", []): - if example and ":" not in example: - logger.debug("example: %s", example) - return True + examples = rule.meta.get("examples") + if isinstance(examples, list): + for example in examples: + if example and ":" not in example: + logger.debug("example: %s", example) + return True class ExampleFileDNE(Lint): diff --git a/scripts/migrate-rules.py b/scripts/migrate-rules.py index 5510752a..e32937c7 100644 --- a/scripts/migrate-rules.py +++ b/scripts/migrate-rules.py @@ -13,9 +13,8 @@ import csv import sys import logging import os.path -import collections - import argparse +import collections import capa.rules diff --git a/scripts/show-capabilities-by-function.py b/scripts/show-capabilities-by-function.py index 1a35dd22..e2568be8 100644 --- a/scripts/show-capabilities-by-function.py +++ b/scripts/show-capabilities-by-function.py @@ -45,9 +45,9 @@ Copyright (C) 2020 FireEye, Inc. All Rights Reserved. import os import sys import logging +import argparse import collections -import argparse import colorama import capa.main diff --git a/scripts/show-features.py b/scripts/show-features.py index a0638950..2339d5b8 100644 --- a/scripts/show-features.py +++ b/scripts/show-features.py @@ -60,7 +60,6 @@ Copyright (C) 2020 FireEye, Inc. All Rights Reserved. """ import sys import logging - import argparse import capa.main diff --git a/tests/test_freeze.py b/tests/test_freeze.py index 7b4b5e7b..9a1204e3 100644 --- a/tests/test_freeze.py +++ b/tests/test_freeze.py @@ -2,13 +2,14 @@ import textwrap +from fixtures import * + import capa.main import capa.helpers import capa.features import capa.features.insn import capa.features.freeze import capa.features.extractors -from fixtures import * EXTRACTOR = capa.features.extractors.NullFeatureExtractor( { diff --git a/tests/test_main.py b/tests/test_main.py index f9357ff3..dbd365dc 100644 --- a/tests/test_main.py +++ b/tests/test_main.py @@ -2,12 +2,13 @@ import textwrap +from fixtures import * + import capa.main import capa.rules import capa.engine import capa.features import capa.features.extractors.viv -from fixtures import * from capa.engine import * diff --git a/tests/test_viv_features.py b/tests/test_viv_features.py index 8610bbc9..564a2f12 100644 --- a/tests/test_viv_features.py +++ b/tests/test_viv_features.py @@ -1,6 +1,7 @@ # Copyright (C) 2020 FireEye, Inc. All Rights Reserved. import viv_utils +from fixtures import * import capa.features import capa.features.file @@ -10,7 +11,6 @@ import capa.features.extractors.viv.file import capa.features.extractors.viv.insn import capa.features.extractors.viv.function import capa.features.extractors.viv.basicblock -from fixtures import * def extract_file_features(vw, path):