Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mschwager/route-detect
Find authentication (authn) and authorization (authz) security bugs in web application routes.
https://github.com/mschwager/route-detect
authentication authorization http-server routes security static-analysis
Last synced: 1 day ago
JSON representation
Find authentication (authn) and authorization (authz) security bugs in web application routes.
- Host: GitHub
- URL: https://github.com/mschwager/route-detect
- Owner: mschwager
- License: bsd-3-clause
- Created: 2023-01-25T14:40:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T16:32:15.000Z (9 months ago)
- Last Synced: 2024-04-25T17:00:21.401Z (9 months ago)
- Topics: authentication, authorization, http-server, routes, security, static-analysis
- Language: Python
- Homepage:
- Size: 2.81 MB
- Stars: 226
- Watchers: 2
- Forks: 13
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# route-detect
[](https://github.com/mschwager/route-detect/actions/workflows/ci.yml)
[](https://pypi.org/project/route-detect/)
[](https://pypi.org/project/route-detect/)
Find authentication (authn) and authorization (authz) security bugs in web application routes:
Routes from koel streaming server
Web application HTTP route authn and authz bugs are some of the most common security issues found today. These industry standard resources highlight the severity of the issue:
- 2021 OWASP Top 10 #1 - [Broken Access Control](https://owasp.org/Top10/A01_2021-Broken_Access_Control/)
- 2021 OWASP Top 10 #7 - [Identification and Authentication Failures](https://owasp.org/Top10/A07_2021-Identification_and_Authentication_Failures/) (formerly Broken Authentication)
- 2023 OWASP API Top 10 #1 - [Broken Object Level Authorization](https://owasp.org/API-Security/editions/2023/en/0xa1-broken-object-level-authorization/)
- 2023 OWASP API Top 10 #2 - [Broken Authentication](https://owasp.org/API-Security/editions/2023/en/0xa2-broken-authentication/)
- 2023 OWASP API Top 10 #5 - [Broken Function Level Authorization](https://owasp.org/API-Security/editions/2023/en/0xa5-broken-function-level-authorization/)
- 2023 CWE Top 25 #11 - [CWE-862: Missing Authorization](https://cwe.mitre.org/top25/archive/2023/2023_top25_list.html)
- 2023 CWE Top 25 #13 - [CWE-287: Improper Authentication](https://cwe.mitre.org/top25/archive/2023/2023_top25_list.html)
- 2023 CWE Top 25 #20 - [CWE-306: Missing Authentication for Critical Function](https://cwe.mitre.org/top25/archive/2023/2023_top25_list.html)
- 2023 CWE Top 25 #24 - [CWE-863: Incorrect Authorization](https://cwe.mitre.org/top25/archive/2023/2023_top25_list.html)
Supported web frameworks (`route-detect` IDs in parentheses):
- Python: Django (`django`, `django-rest-framework`), Flask (`flask`), Sanic (`sanic`), FastAPI (`fastapi`)
- PHP: Laravel (`laravel`), Symfony (`symfony`), CakePHP (`cakephp`)
- Ruby: Rails\* (`rails`), Grape (`grape`)
- Java: JAX-RS (`jax-rs`), Spring (`spring`)
- Go: Gorilla (`gorilla`), Gin (`gin`), Chi (`chi`)
- JavaScript/TypeScript: Express (`express`), React (`react`), Angular (`angular`)
\*_Rails support is limited. Please see [this issue](https://github.com/mschwager/route-detect/issues/8) for more information._
# Installing
Use `pip` to install `route-detect`:
```
$ python -m pip install --upgrade route-detect
```
You can check that `route-detect` is installed correctly with the following command:
```
$ echo 'print(1 == 1)' | semgrep --config $(routes which test-route-detect) -
Scanning 1 file.
Findings:
/tmp/stdin
routes.rules.test-route-detect
Found '1 == 1', your route-detect installation is working correctly
1┆ print(1 == 1)
Ran 1 rule on 1 file: 1 finding.
```
# Using
`route-detect` provides the `routes` CLI command and uses [`semgrep`](https://github.com/returntocorp/semgrep) to search for routes.
Use the `which` subcommand to point `semgrep` at the correct web application rules:
```
$ semgrep --config $(routes which django) path/to/django/code
```
Use the `viz` subcommand to visualize route information in your browser:
```
$ semgrep --json --config $(routes which django) --output routes.json path/to/django/code
$ routes viz --browser routes.json
```
If you're not sure which framework to look for, you can use the special `all` ID to check everything:
```
$ semgrep --json --config $(routes which all) --output routes.json path/to/code
```
If you have custom authn or authz logic, you can copy `route-detect`'s rules:
```
$ cp $(routes which django) my-django.yml
```
Then you can modify the rule as necessary and run it like above:
```
$ semgrep --json --config my-django.yml --output routes.json path/to/django/code
$ routes viz --browser routes.json
```
# Contributing
`route-detect` uses [`poetry`](https://python-poetry.org/) for dependency and configuration management.
Before proceeding, install project dependencies with the following command:
```
$ poetry install --with dev
```
## Linting
Lint all project files with the following command:
```
$ poetry run pre-commit run --all-files
```
## Testing
Run Python tests with the following command:
```
$ poetry run pytest --cov
```
Run Semgrep rule tests with the following command:
```
$ poetry run semgrep --test --config routes/rules/ tests/test_rules/
```