attackmap-analyzer-python 0.2.0__py3-none-any.whl

attackmap_analyzer_python-0.2.0.dist-info/METADATA

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: attackmap-analyzer-python
+Version: 0.2.0
+Summary: Comprehensive Python ecosystem analyzer plugin for AttackMap (Django, Starlette, AIOHTTP, Sanic, Litestar, DRF; SQLAlchemy/asyncpg/motor; passlib/PyJWT/authlib; httpx/aiohttp).
+Author: AttackMap Contributors
+Author-email: Matthew Davis <mlaify@mlaify.io>
+Maintainer-email: Matthew Davis <mlaify@mlaify.io>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/mlaify/attackmap-analyzer-python
+Project-URL: Repository, https://github.com/mlaify/attackmap-analyzer-python
+Project-URL: Issues, https://github.com/mlaify/attackmap-analyzer-python/issues
+Project-URL: Changelog, https://github.com/mlaify/attackmap-analyzer-python/blob/main/CHANGELOG.md
+Project-URL: AttackMap core, https://github.com/mlaify/AttackMap
+Keywords: security,static-analysis,appsec,defensive-security,attackmap,attackmap-plugin
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.7.0
+Provides-Extra: core
+Requires-Dist: attackmap>=0.6.0; extra == "core"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: build>=1.2.0; extra == "dev"
+Requires-Dist: attackmap>=0.6.0; extra == "dev"
+Dynamic: license-file
+
+# attackmap-analyzer-python
+
+> [!IMPORTANT]
+> **Active development, slow pace.** AttackMap is under active development, but
+> progress may be slow until more contributors or co-maintainers join. Help is
+> very welcome with the core engine, an analyzer, the macOS app, or the docs —
+> see [CONTRIBUTING.md](CONTRIBUTING.md) or open an issue on
+> [mlaify/AttackMap](https://github.com/mlaify/AttackMap/issues) to say hello.
+> Security reports are still welcome at [security@mlaify.io](mailto:security@mlaify.io).
+
+Comprehensive Python ecosystem analyzer for [AttackMap](https://github.com/mlaify/AttackMap).
+
+This plugin is **additive** over AttackMap's built-in `python-web` analyzer. The built-in handles FastAPI / Flask routes via the core scanner; this plugin adds everything else.
+
+- **Web frameworks** —
+  - **Django** routing (`path("users/", ...)`, `path("", ...)` → `/`, `re_path(r"^api/...$", ...)`, legacy `url(...)` / `patterns(...)`) gated by `urlpatterns =` in the file, with the **`include()` graph** resolved repo-wide: `include("app.urls")`, `include(module)`, `include((patterns, "app"))`, `include([...])` and local pattern lists join their prefix onto every child route (`path("api/", include("shop.api_urls"))` + `orders/<int:pk>/` → `/api/orders/<int:pk>/`)
+  - **Django REST Framework** routers (`router.register(r'users', UserViewSet)`, any `*Router()`), mounted under their `include(router.urls)` / `urlpatterns = router.urls` prefix, and `@api_view(['GET', 'POST'])` decorators
+  - **Starlette** `Route("/x", endpoint=h, methods=["GET", "POST"])` and `WebSocketRoute("/ws/...")`
+  - **AIOHTTP** `app.router.add_get/post/...`, `add_route("POST", ...)`, `add_view`, `web.get/post/view(...)` helpers and `web.RouteTableDef()` decorators (`@routes.get("/x")`, `@routes.view`, `@routes.route("PATCH", ...)`) (gated by aiohttp import)
+  - **Sanic** `@app.get("/x")`, `@app.post("/x")`, `@app.route("/x", methods=[...])`, `@app.websocket("/ws")` (gated by sanic import)
+  - **Litestar** (and legacy Starlite) handlers at any indentation (`@get()`, `@post(path="/x")`, `@route(http_method=[...])`, `@websocket`), `Controller` classes (`path = "/users"` joined onto each handler) and `Router(path=..., route_handlers=[...])` prefixes, including nested routers across files (decorators must be imported from litestar/starlite). `guards=[...]` on the handler/controller/router sets the route's auth to `required`; `exclude_from_auth=True` sets it to `anonymous`
+  - **Tornado** `Application([(r"/x", Handler), url(r"/y", H)])` URL specs paired with the handler class's `get`/`post`/... methods (a `WebSocketHandler` is `WS`); `@tornado.web.authenticated` on a method sets its auth to `required`
+  - **Flask** `app.add_url_rule("/x", view_func=...)` (additive — built-in covers `@app.route`)
+- **Databases** —
+  - **SQLAlchemy** `create_engine("postgresql://...")` with dialect-aware kind inference (postgresql / mysql / mariadb / sqlite / oracle / sqlserver)
+  - **asyncpg** / **psycopg2-3** / **pymysql** / **motor.motor_asyncio** / **pymongo** / **redis.asyncio** / **aioredis** / **sqlmodel** / **tortoise**
+  - **boto3 resources/clients** for `dynamodb` and `s3`
+  - **Django** `DATABASES` dict in `settings.py` — `ENGINE` value parsed for the kind
+- **Auth packages** —
+  - **passlib** `CryptContext`, `passlib.hash.argon2/bcrypt/scrypt`
+  - **bcrypt** standalone (`bcrypt.hashpw`, `bcrypt.checkpw`)
+  - **argon2-cffi** (`from argon2 import PasswordHasher`)
+  - **PyJWT** / **python-jose** (`jwt.encode`, `jwt.decode`, `jose.jwt`)
+  - **authlib** (`OAuth(...)`, `OAuth2Session(...)`)
+  - **fastapi-users** (`BearerTransport`, `JWTStrategy`)
+  - **flask-jwt-extended** (`@jwt_required`, `create_access_token`)
+  - **django.contrib.auth** (`authenticate`, `make_password`)
+  - **casbin** (`Enforcer`)
+- **HTTP clients (external calls)** — **httpx** sync + async, **aiohttp.ClientSession**, **urllib.request.urlopen**
+- **Secrets** —
+  - `os.environ.get("X")` and `os.environ["X"]` with secret-shaped names (built-in only covers `os.getenv`)
+  - **pydantic-settings** `BaseSettings` field-name extraction (`jwt_secret: str = ...`)
+  - `dotenv_values(...)` accessors with secret-shaped keys
+- **Service hints** — `[project] name` from `pyproject.toml`, `[tool.poetry] name`, `name="..."` from `setup.py`, `[metadata] name` from `setup.cfg`, presence of `manage.py` → `framework:django`, Django `INSTALLED_APPS` third-party / local apps
+
+All emissions populate AttackMap's Signal v2 fields (line numbers, evidence snippets, confidence) so downstream insights can cite `path/to/module.py:NN`.
+
+## Install
+
+```bash
+uv tool install attackmap --with attackmap-analyzer-python \
+  --index mlaify=https://pkg.mlaify.io/pypi/simple/ --index-strategy first-index
+# or from source:
+pip install git+https://github.com/mlaify/attackmap-analyzer-python.git
+```
+
+The analyzer is auto-discovered by AttackMap via the `attackmap.analyzers` entry-point group.
+
+## Usage with AttackMap
+
+```bash
+# Auto-discovered when installed:
+attackmap analyze /path/to/python/repo
+
+# Or invoke explicitly:
+attackmap analyze /path/to/python/repo --module python
+```
+
+## Detection
+
+`detect()` returns true when any of the following are present, ignoring `.venv/`, `venv/`, `env/`, `.tox/`, `__pycache__/`, `.pytest_cache/`, `dist/`, `build/`, `node_modules/`, `.git/`, `.mypy_cache/`, `.ruff_cache/`, and `site-packages/`:
+
+- A `pyproject.toml`, `setup.py`, `setup.cfg`, `manage.py`, or `Pipfile` at the root
+- Any `.py` file in the tree
+
+## Coverage notes
+
+- **Framework-gated extraction**: route extractors for AIOHTTP, Sanic, Litestar, and Starlette only fire when the file imports the corresponding framework. This prevents mis-attributing generic `@get(...)` / `web.get(...)` / `app.get(...)` calls to a framework when they're really custom decorators or method calls.
+- **Django routing requires `urlpatterns =`** to be in the file. A bare `path("/x", ...)` in any other context (e.g., `pathlib.Path("/x")` is well-behaved, but a project that also has `from django.urls import path; path("/x", view)` outside a urls.py won't fire — by design).
+- **Django settings extraction**: gated by presence of one of `INSTALLED_APPS`, `DATABASES`, `MIDDLEWARE`, or `ROOT_URLCONF`. Built-in Django apps (`django.*`) are filtered out of the INSTALLED_APPS service hints to keep signal high.
+- **DRF `@api_view(['GET', 'POST'])`**: emits framework hints (`drf_api_view:GET`, `drf_api_view:POST`) rather than routes — the actual path is in `urls.py`, which is extracted separately.
+- **Django `include()` resolution**: a module reference resolves only to a URLconf inside the repo (tried from each `manage.py` directory, the repo root, then the including file's ancestors). A resolved `include()` line is a prefix, not an endpoint, so it isn't a route. An include that can't be resolved (a third-party app, `include(get_model_urls(...))`) is still emitted as its prefix (`/accounts/`). A pattern list or router nothing mounts keeps the unprefixed emission. A non-literal route (`path(settings.BASE_PATH, include(...))`) joins as an empty prefix. Regex anchors are stripped when joining, so `re_path(r"^users/$")` is `/users/`. A pattern list is the union of everything assigned to it (reassignments, if/else and try/except branches, `urlpatterns = wrap(urlpatterns)`), so no branch's routes are dropped. The resolver is bounded (5k entries per list, 20k per file, 5k registrations per router, 12 include levels, 64 mounts per list, 200k steps including router registrations, 50k routes) and cycles stop.
+- **Parsing**: URLconfs, Litestar, Tornado and Sanic files are read with `ast` (never executed). A file `ast` can't parse (Python 2, over 1 MB) falls back to the per-file regex extractors.
+- **Not yet**: DRF nested routers' parent prefix, zulip-style custom `rest_path(...)` wrappers, Sanic `Blueprint(url_prefix=...)` joins (core doesn't join them either, so joining here would duplicate routes), and Django route auth decided at the view (`@login_required` on the view function, `LoginRequiredMixin`, DRF `permission_classes`) — see the issue tracker. Auth wrappers applied in the URLconf itself (`login_required(views.x)`, `permission_required("p")(View.as_view())`, `staff_member_required`, `user_passes_test`) do set the route's auth to `required`, and Django 5.1's `login_not_required(...)` sets it to `anonymous`.
+- **pydantic-settings** field extraction matches any class field whose name contains `secret`, `token`, `key`, `password`, `pass`, or `pwd`. False positives are possible (e.g., a non-secret `signing_key` config). Confidence is the standard 0.85.
+
+## Coexistence with the built-in `python-web` analyzer
+
+AttackMap ships with a `python-web` built-in that handles FastAPI / Flask via the core scanner. When this plugin is installed, both analyzers run on every Python repo. AttackMap's overlay deduplication merges their output so users see a single unified set of findings — no double-counting.
+
+This plugin runs at `priority=10`. AttackMap runs analyzers in `(priority, name)` order across built-ins and plugins and merges first-seen-wins, so this plugin runs before the built-in (`priority=20`) and its richer output wins where they overlap.
+
+## License
+
+MIT

attackmap_analyzer_python-0.2.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+attackmap_analyzer_python/__init__.py,sha256=sDkhPmEkGNZOqEPM-UJqpTaH8a04aTHGtwF5-Qw-sEU,67
+attackmap_analyzer_python/_pyast.py,sha256=TmTFWErz0cXnyS4KYJCncLvg-r2lV_7djZyAk__ZKWA,3042
+attackmap_analyzer_python/analyzer.py,sha256=i7xy9jNrRjG1TIw8HXE0MVtSh111ABibGvSLJc7FDJg,35387
+attackmap_analyzer_python/django_urls.py,sha256=XCIhYfRNnUesDRDYrRAHk_IeC9m_TJuDFR9RkXXxrCY,29180
+attackmap_analyzer_python/litestar_routes.py,sha256=InMRNLWsfMHPBHpH-Ku1COnSvbUwhV_jV_mrYcjtRKY,14454
+attackmap_analyzer_python/sanic_routes.py,sha256=QXcu0T27R8NXHZBRHl3pY5-56IYECMKCwOme_gpK3Zw,2909
+attackmap_analyzer_python/tornado_routes.py,sha256=2TTypLjxgqmg8GulnTIR6bK8LNy2gA9rNENMGVawRFU,6670
+attackmap_analyzer_python-0.2.0.dist-info/licenses/LICENSE,sha256=vtPQVGUyxq359j0JmD3_eJaXyHmaHyjzaMOtaLwJc88,1097
+attackmap_analyzer_python-0.2.0.dist-info/METADATA,sha256=dCPD89gRzqhZpMxnxTKQ-Vh6P1hVoov4GWLV9roB8sI,11170
+attackmap_analyzer_python-0.2.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+attackmap_analyzer_python-0.2.0.dist-info/entry_points.txt,sha256=_5AKUyJJuZslwL4pj-YwxB1QHw6__V-Nc02x0u-2ffc,72
+attackmap_analyzer_python-0.2.0.dist-info/top_level.txt,sha256=ETsHPjZJDHv7lRzckg-JQrnhRo3lrsXtR2AQ0AM7mho,26
+attackmap_analyzer_python-0.2.0.dist-info/RECORD,,

attackmap_analyzer_python-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

attackmap_analyzer_python-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[attackmap.analyzers]
+python = attackmap_analyzer_python:PythonAnalyzer

attackmap_analyzer_python-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Matthew Davis and AttackMap Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

attackmap_analyzer_python-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+attackmap_analyzer_python