Metadata-Version: 2.4
Name: veridor
Version: 0.1.0
Summary: CI-first authorization regression runner for multi-user APIs
Author: Santosh Kumar Puppala
Maintainer: Santosh Kumar Puppala
License-Expression: Apache-2.0
Project-URL: Homepage, https://veridor.org/
Project-URL: Documentation, https://docs.veridor.org/
Project-URL: Repository, https://github.com/Veridor-authz/veridor
Project-URL: Issues, https://github.com/Veridor-authz/veridor/issues
Project-URL: Changelog, https://github.com/Veridor-authz/veridor/blob/main/CHANGELOG.md
Project-URL: Security policy, https://github.com/Veridor-authz/veridor/security/policy
Keywords: security,authorization,ci,sarif
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Security
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Dynamic: license-file

# Veridor

Veridor is a CI-first **authorization regression runner**. You declare what each
identity is allowed to do; Veridor issues the same request as every declared
identity, compares what happened against what you declared, and fails the build
when the answer changes. It is not a scanner and not a pentest: it invents no
policy, discovers no routes, sends no payloads, and cannot tell you whether your
declaration is right — only whether your target still agrees with it. Read
[what a finding does and does not mean](https://github.com/Veridor-authz/veridor#what-a-veridor-finding-does-and-does-not-mean)
before you read a report. Runtime is the Python standard library only.

This page is the package description. The full documentation is the
[README in the repository](https://github.com/Veridor-authz/veridor) and
<https://docs.veridor.org/>. Each release is listed in
[CHANGELOG.md](https://github.com/Veridor-authz/veridor/blob/main/CHANGELOG.md).
The project is in early alpha: the configuration format, commands, flags and
report formats may still change between minor versions, so pin a version.

## Install

Python 3.11 or newer, no runtime dependencies. Install into a virtual
environment or with pipx; Homebrew and Debian system Pythons refuse a bare
`pip install` (PEP 668).

```bash
python3.12 -m venv .venv && . .venv/bin/activate
python -m pip install veridor
veridor --version
```

The wheel carries the `veridor` package and nothing else. The demo target and
the fixtures the quickstart uses live in the repository, so with a `pip install`
start from [your own API](https://github.com/Veridor-authz/veridor#against-your-own-api).

## The three verbs

| Verb | The question |
| --- | --- |
| [`map`](https://github.com/Veridor-authz/veridor#map-what-would-a-compromise-reach) | What don't I cover, and what would a compromise reach? |
| [`run`](https://github.com/Veridor-authz/veridor#run-does-the-boundary-hold-and-did-it-change) | Does the boundary hold, and did it change? |
| [`mutate`](https://github.com/Veridor-authz/veridor#mutate-would-my-suite-catch-a-regression) | Would my suite actually catch a regression? |

Only `run` gates on what it discovered. `map` exits `0` whatever it finds unless
you opt in to `--fail-on-drift`, and `mutate` has its own exit code. The
[exit codes](https://github.com/Veridor-authz/veridor#exit-codes) and the
[CI/CD integrations](https://github.com/Veridor-authz/veridor#cicd-integrations)
are in the README.

## Links

- [Security policy and reporting a vulnerability](https://github.com/Veridor-authz/veridor/blob/main/SECURITY.md)
- [Contributing](https://github.com/Veridor-authz/veridor/blob/main/CONTRIBUTING.md)
- [Non-goals](https://github.com/Veridor-authz/veridor#non-goals)
- [Licence: Apache-2.0](https://github.com/Veridor-authz/veridor/blob/main/LICENSE)
