mirror of
https://github.com/mandiant/capa.git
synced 2025-12-12 15:49:46 -08:00
a33f67b48e
* web: index: add gif of capa running * index: add screencast of running capa produced via: ``` asciinema capa.cast ./capa Practical\ Malware\ Analysis\ Lab\ 01-01.dll_ <ctrl-d> agg --no-loop --theme solarized-light capa.cast capa.gif ``` * web: index: start to sketch out style * web: landing page * web: merge rules website * web: rules: update bootstrap and integrate rules * web: rules: use pygments to syntax highlight rules Use the Pygments syntax-highlighting library to parse and render the YAML rule content. This way we don't have to manually traverse the rule nodes and emit lists; instead, we rely on the fact that YAML is pretty easy for humans to read and let them consume it directly, with some text formatting to help hint at the types/structure. * web: rules: use capa to load rule content capa (the library) has routines for deserializing the YAML content into structured objects, which means we can use tools like mypy to find bugs. So, prefer to use those routines instead of parsing YAML ourselves. * web: rules: linters Run and fix the issues identified by the following linters: - isort - black - ruff - mypy * web: rules: add some links to rule page Add links to the following external resources: - GitHub rule source in capa-rules repo - VirusTotal search for matching samples * web: rules: accept ?q= parameter for initial search Update the rules landing page to accept a HTTP query parameter named "q" that specifies an initial search term to to pass to pagefind. This enables external pages link to rule searches. * web: rules: add link to namespace search * web: rules: use consistent header Import header from root capa landing page. * web: rules: add umami script * web: add initial whats new section, TODOs * web: rules: remove old images * changelog * CI: remove temporary branch push event triggers * Delete web/rules/public/css/bootstrap-4.5.2.min.css * Delete web/rules/public/js/bootstrap-4.5.2.min.js * Delete web/public/img/capa.cast * Rename readme.md to README.md * web: rules: add scripts to pre-commit configs * web: rules: add scripts to pre-commit configs * lints * ci: add temporary branch push trigger to get incremental builds * web: rules: assert start_dir must exist * ci: web: rules: deep checkout so we can get rule history * web: rules: check output of subprocess * web: rules: factor out common CSS * web: rules: fix header links * web: rules: only index rule content, not surrounding text * ci: web: remote temporary branch push trigger
146 lines
3.7 KiB
YAML
146 lines
3.7 KiB
YAML
# install the pre-commit hooks:
|
||
#
|
||
# ❯ pre-commit install --hook-type pre-commit
|
||
# pre-commit installed at .git/hooks/pre-commit
|
||
#
|
||
# ❯ pre-commit install --hook-type pre-push
|
||
# pre-commit installed at .git/hooks/pre-push
|
||
#
|
||
# run all linters liks:
|
||
#
|
||
# ❯ pre-commit run --all-files
|
||
# isort....................................................................Passed
|
||
# black....................................................................Passed
|
||
# ruff.....................................................................Passed
|
||
# flake8...................................................................Passed
|
||
# mypy.....................................................................Passed
|
||
#
|
||
# run a single linter like:
|
||
#
|
||
# ❯ pre-commit run --all-files isort
|
||
# isort....................................................................Passed
|
||
|
||
repos:
|
||
- repo: local
|
||
hooks:
|
||
- id: isort
|
||
name: isort
|
||
stages: [commit, push, manual]
|
||
language: system
|
||
entry: isort
|
||
args:
|
||
- "--length-sort"
|
||
- "--profile"
|
||
- "black"
|
||
- "--line-length=120"
|
||
- "--skip-glob"
|
||
- "*_pb2.py"
|
||
- "capa/"
|
||
- "scripts/"
|
||
- "tests/"
|
||
- "web/rules/scripts/"
|
||
always_run: true
|
||
pass_filenames: false
|
||
|
||
- repo: local
|
||
hooks:
|
||
- id: black
|
||
name: black
|
||
stages: [commit, push, manual]
|
||
language: system
|
||
entry: black
|
||
args:
|
||
- "--line-length=120"
|
||
- "--extend-exclude"
|
||
- ".*_pb2.py"
|
||
- "capa/"
|
||
- "scripts/"
|
||
- "tests/"
|
||
- "web/rules/scripts/"
|
||
always_run: true
|
||
pass_filenames: false
|
||
|
||
- repo: local
|
||
hooks:
|
||
- id: ruff
|
||
name: ruff
|
||
stages: [commit, push, manual]
|
||
language: system
|
||
entry: ruff
|
||
args:
|
||
- "check"
|
||
- "--config"
|
||
- ".github/ruff.toml"
|
||
- "capa/"
|
||
- "scripts/"
|
||
- "tests/"
|
||
- "web/rules/scripts/"
|
||
always_run: true
|
||
pass_filenames: false
|
||
|
||
- repo: local
|
||
hooks:
|
||
- id: flake8
|
||
name: flake8
|
||
stages: [push, manual]
|
||
language: system
|
||
entry: flake8
|
||
args:
|
||
- "--config"
|
||
- ".github/flake8.ini"
|
||
- "--extend-exclude"
|
||
- "capa/render/proto/capa_pb2.py"
|
||
- "capa/"
|
||
- "scripts/"
|
||
- "tests/"
|
||
- "web/rules/scripts/"
|
||
always_run: true
|
||
pass_filenames: false
|
||
|
||
- repo: local
|
||
hooks:
|
||
- id: mypy
|
||
name: mypy
|
||
stages: [push, manual]
|
||
language: system
|
||
entry: mypy
|
||
args:
|
||
- "--check-untyped-defs"
|
||
- "--ignore-missing-imports"
|
||
- "--config-file=.github/mypy/mypy.ini"
|
||
- "capa/"
|
||
- "scripts/"
|
||
- "tests/"
|
||
- "web/rules/scripts/"
|
||
always_run: true
|
||
pass_filenames: false
|
||
|
||
- repo: local
|
||
hooks:
|
||
- id: deptry
|
||
name: deptry
|
||
stages: [push, manual]
|
||
language: system
|
||
entry: deptry .
|
||
always_run: true
|
||
pass_filenames: false
|
||
|
||
- repo: local
|
||
hooks:
|
||
- id: pytest-fast
|
||
name: pytest (fast)
|
||
stages: [manual]
|
||
language: system
|
||
entry: pytest
|
||
args:
|
||
- "tests/"
|
||
- "--ignore=tests/test_binja_features.py"
|
||
- "--ignore=tests/test_ghidra_features.py"
|
||
- "--ignore=tests/test_ida_features.py"
|
||
- "--ignore=tests/test_viv_features.py"
|
||
- "--ignore=tests/test_main.py"
|
||
- "--ignore=tests/test_scripts.py"
|
||
always_run: true
|
||
pass_filenames: false
|
||
|