webvigil 1.0.0__tar.gz

webvigil-1.0.0/.gitignore

@@ -0,0 +1,62 @@
+# --- 1. PYTHON: BYTECODE, BUILD, PACKAGING ---
+# Compiled bytecode and packaging output — all regenerated by the build, never source.
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+
+# --- 2. VIRTUAL ENVIRONMENTS (uv) ---
+# `uv sync --all-extras` recreates these. uv.lock IS committed, for reproducible builds.
+.venv/
+venv/
+.uv/
+
+# --- 3. TOOLING CACHES ---
+# ruff, mypy, pytest, coverage — local speed-ups, never useful in Git.
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+
+# --- 4. SCAN ARTIFACTS ---
+# What `webvigil scan` / `webvigil report` write to disk. Ephemeral by design.
+*.sarif
+scan-*.json
+scan-*.html
+reports/
+
+# --- 5. LOCAL DATABASES ---
+# The Web API's SQLite file — created per machine, holds local scan history only.
+*.sqlite3
+*.db
+*.db-shm
+*.db-wal
+
+# --- 6. WEB UI (Next.js) ---
+# web/ has its own .gitignore; these catch its build output from the repo root too.
+web/node_modules/
+web/.next/
+web/out/
+web/.env*.local
+# Lighthouse CI reports (.github/workflows/lighthouse.yml).
+.lighthouseci/
+
+# --- 7. SECRETS AND LOCAL CONFIG ---
+# Real secrets and machine-specific overrides. There is no committed .env;
+# webvigil.example.toml is the config template.
+.env
+webvigil.local.toml
+
+# --- 8. EDITOR AND OS ---
+.idea/
+.vscode/
+.DS_Store
+Thumbs.db
+
+# --- 9. LOCAL PLANNING / SCRATCH NOTES ---
+# Superseded by specs/ once a feature is designed; never part of history.
+/*.plan.md
+.plans/

webvigil-1.0.0/CHANGELOG.md

@@ -0,0 +1,85 @@
+# Changelog
+
+All notable changes to WebVigil are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project follows
+[Semantic Versioning](https://semver.org/); what that promises is in
+[docs/stability.md](docs/stability.md).
+
+The `v0.1` to `v0.20` milestones in the README are the steps the project was built in, each
+designed as a spec under [`specs/`](specs/). None of them was released: `1.0.0` is the first
+release and contains all of them.
+
+## [Unreleased]
+
+## [1.0.0] - 2026-10-08
+
+The first release.
+
+### Added
+
+**Scanner and CLI**
+- `webvigil scan` in **Safe Mode** by default (passive: it reads and sends no crafted request),
+  `list-checks`, `report` (re-render a saved scan offline) and `version`.
+- Reports in JSON (canonical, with a `schema_version`), SARIF 2.1.0, HTML and Markdown;
+  `--fail-on` and documented exit codes for CI.
+- A `webvigil.toml` configuration file (every key can be overridden by a flag), a scope guard,
+  bounded concurrency, a request delay, a page limit and `robots.txt` handling on every scan (a warning says when it kept URLs out of the crawl, when the target stopped answering, or when the
+  entry page looks like a JavaScript application the crawler cannot see into).
+  A response body is read up to `[http] max_body_bytes` (10 MiB, after decompression) and the rest is
+  dropped with a warning, so a hostile or oversized response cannot exhaust the scanner's memory.
+
+**Passive checks**
+- Security headers and technology-disclosure headers, cookie flags, TLS and HTTPS configuration,
+  CORS misconfiguration.
+- Client-side dependency fingerprinting with known-vulnerability matching against a vendored
+  Retire.js database, and an opt-in OSV.dev lookup (`--osv-online`).
+- Information disclosure: stack traces and directory listings, plus opt-in probing for exposed
+  `.git`, `.env`, backups and debug endpoints (`--probe`).
+- Subresource Integrity, mixed content, a session identifier in a URL, a private IP in a body.
+- CSRF: forms that carry no anti-CSRF token.
+- Session security: weak or predictable session ids (`session.id.weak`), with opt-in anonymous
+  sampling (`--sample-sessions`).
+
+**Active Mode** (`--mode active --authorized-by "<name / engagement>"`, in-band, every finding
+confirmed against a per-request baseline)
+- Reflected XSS; SQL injection (error, boolean and time based); path traversal; open redirect;
+  SSRF (cloud metadata, loopback and internal hosts, `file://`); OS command injection; server-side
+  template injection; expression-language injection (SpEL, OGNL, JEXL, MVEL, Unified EL); CRLF
+  injection; host-header injection; LDAP, XPath and SSI injection; dangerous HTTP methods.
+- Opt-in, each off by default and documented as writing to the target or making a real request:
+  stored XSS (`--stored-xss`), file upload (`--file-upload`), XXE (`--xxe`), CSRF confirmation
+  (`--confirm-csrf`), POST crawling (`--submit-post-forms`), automated login (`--login-url`) and
+  the logout test (`--test-logout`).
+- Session fixation (`session.fixation`) and a logout that does not invalidate the session
+  (`session.logout.not-invalidated`), which build on the automated login.
+
+**Authenticated and API scanning**
+- Static cookies (`--cookie`) and headers (`--header`); an automated form login that keeps the
+  session and logs in again when it drops (one attempt, never another credential, the password
+  only from the environment or a prompt); OpenAPI / Swagger import (`--openapi`).
+
+**Web API and dashboard** (optional, in the repository)
+- A FastAPI service with SQLite persistence and a queued scan runner, and a Next.js dashboard for
+  it.
+  `docker compose` publishes them on `127.0.0.1` only; see [Who can reach it](docs/web-api.md#who-can-reach-it).
+  Login attempts are throttled (a wait that doubles up to 5 minutes), and changing the password signs
+  the other sessions out.
+
+**Packaging**
+- A package for PyPI: the engine, the CLI and (with the `web` extra) the Web API, published from a
+  GitHub Release with PyPI Trusted Publishing (no stored token) after a dry run on TestPyPI. The
+  dashboard stays in the repository. See [releasing](docs/releasing.md).
+- A container image for the CLI on `ghcr.io/ryanvmorais/webvigil` (`linux/amd64` and `linux/arm64`; tags
+  `X.Y.Z`, `X.Y`, `X` and `latest`), built, smoke-tested and vulnerability-scanned before it is pushed,
+  with signed build provenance and an SBOM.
+- `selectolax` is capped below 1.0: version 1.0 removed the parser the engine imports.
+
+**Quality and security of the project**
+- Strict typing, an import contract that keeps the engine independent of the CLI, the API and the
+  database, 1138 tests, a CI matrix on Python 3.12 to 3.14, Lighthouse CI for the dashboard, CodeQL
+  and Dependabot.
+- A security policy with private vulnerability reporting, a code of conduct, and the
+  [stability policy](docs/stability.md).
+
+[Unreleased]: https://github.com/ryanvmorais/webvigil/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/ryanvmorais/webvigil/releases/tag/v1.0.0

webvigil-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Ryan Morais
+
+   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.

webvigil-1.0.0/NOTICE

@@ -0,0 +1,17 @@
+WebVigil
+Copyright 2026 Ryan Morais
+
+This product includes software developed by third parties.
+
+--------------------------------------------------------------------------------
+Retire.js vulnerability database
+--------------------------------------------------------------------------------
+
+The file src/webvigil/checks/deps/data/retirejs.json is a normalised copy of the
+Retire.js community vulnerability repository:
+
+    https://github.com/RetireJS/retire.js
+
+Licensed under the Apache License, Version 2.0. Copyright the Retire.js
+contributors. The file is regenerated by scripts/update-retirejs-db.py; retrieval
+provenance is recorded in src/webvigil/checks/deps/data/PROVENANCE.json.