Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/workflows/scan.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: OWASP PR Scanner
on: [pull_request]
jobs:
scan:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.11'
- run: pip install -r requirements.txt
- run: python scanner/main.py tests/test_positive.py
207 changes: 207 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[codz]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py.cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# UV
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
#uv.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
#poetry.toml

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
#pdm.lock
#pdm.toml
.pdm-python
.pdm-build/

# pixi
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
#pixi.lock
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
# in the .venv directory. It is recommended not to include this directory in version control.
.pixi

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.envrc
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

# Abstra
# Abstra is an AI-powered process automation framework.
# Ignore directories containing user credentials, local state, and settings.
# Learn more at https://abstra.io/docs
.abstra/

# Visual Studio Code
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
# and can be added to the global gitignore or merged into this file. However, if you prefer,
# you could uncomment the following to ignore the entire vscode folder
# .vscode/

# Ruff stuff:
.ruff_cache/

# PyPI configuration file
.pypirc

# Cursor
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
# refer to https://docs.cursor.com/context/ignore-files
.cursorignore
.cursorindexingignore

# Marimo
marimo/_static/
marimo/_lsp/
__marimo__/
104 changes: 96 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,104 @@
# Cyber-Security
# OWASP PR Scanner

This repository is the main repository for the Cyber Security Team. Whilst general files should go here, full projects within the Cyber Security team should be split-off into their own repository within the Redback Operations company (under the Cyber team, ensure Tutors have **admin** and cyber team **write** permissions) to avoid bloat in this central repository.
This tool scans Python files for security vulnerabilities based on the **OWASP Top 10**.
It is designed for lightweight static analysis of pull requests, helping developers catch common issues early and enforce secure coding practices.

---

- Research folder contains generic research not relevant to a particular trimester.
## ✅ Current Functionality

- Otherwise, each trimester folder contains small projects / trials conducted.
The scanner detects vulnerabilities using static analysis (regex + simple heuristics).
It groups results by OWASP Top 10 category and highlights severity with colour-coded output.

- Documentation links for associated docs are scattered were relevant documentation exists.
Implemented rules:

- Some 2022 files yet to be moved over.
- **A01:2021 – Broken Access Control**
- Detects Flask routes without authentication decorators

- If you are creating documentation or a research piece, please create a .md equivalent and add to the [documentation repo](https://github.com/Redback-Operations/redback-documentation)
- **A02:2021 – Cryptographic Failures**
- Detects weak hashing algorithms (MD5, SHA1)
- Flags hardcoded secrets, API keys, and default passwords
- Warns about unsafe fallback values

- [General doc site here](https://redback-operations.github.io/redback-documentation/docs/category/cyber-security-team).
- **A03:2021 – Injection**
- Detects unparameterized SQL queries
- Flags SQL built with string concatenation or f-strings

- **A04:2021 – Insecure Design**
- Flags insecure “TODO” markers, temporary overrides, or auth bypass notes

- **A05:2021 – Security Misconfiguration**
- Detects `debug=True` in Flask apps
- Flags permissive host settings (`ALLOWED_HOSTS = ['*']`)
- Insecure cookie/CSRF flags
- Hardcoded Flask secrets

- **A06:2021 – Vulnerable and Outdated Components**
- Detects dependency pins like `flask==0.12` or `django==1.11`
- Helps identify outdated or risky components

- **A07:2021 – Identification and Authentication Failures**
- Detects default credentials (`admin`, `password`)
- Flags login routes without auth checks
- Warns about disabled TLS verification (`verify=False`)

- **A08:2021 – Software and Data Integrity Failures**
- Detects dangerous use of `eval()`
- Warns about unsafe deserialization (`pickle.load`)
- Flags subprocess calls with `shell=True`

- **A09:2021 – Security Logging and Monitoring Failures**
- Detects print statements in auth flows
- Flags bare `except:` blocks with no logging
- Warns when secrets are printed to stdout

- **A10:2021 – Server-Side Request Forgery (SSRF)**
- Detects unvalidated user input passed into `requests.get/post`

---


## 📂 Test Cases

- **`test_positive.py`**
A deliberately vulnerable file that triggers all implemented OWASP rules (A01–A10).

- **`test_negative.py`**
A safe baseline file with secure practices — should pass with **no findings**.
Used for regression testing and validation.

---

## 🎨 Output Example

- Findings are grouped by OWASP category (A01–A10)
- Severity levels are **colour-coded**:
- 🔴 High
- 🟠 Medium
- 🟢 Low

Example:
=== A01: Injection (2 findings) ===
Summary: High: 2

• Line 60 | Severity HIGH | Confidence MEDIUM
→ SQL query created via string concatenation: ...

---

## Running the Script
### 1. Navigate to your project root
cd path/to/owasp-scanner

### 2. Set PYTHONPATH so Python recognizes `scanner/` as a package
set PYTHONPATH=.

### 3. Run the script with the file to scan as an argument
python scanner/main.py tests/test_positive.py

## 👤 Author
Developed by Liana Perry (2025)
Cybersecurity SecDevOps Sub-team | Redback Operations

## 🙌 Acknowledgements
This project is inspired by the original vulnerability scanning logic created by Amir Zandieh, and extends it into a modular and OWASP-aligned security scanning tool for pull requests.
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# This file lists all dependencies needed to run the scanner.
# To install the requirements:
# pip install -r requirements.txt
Empty file added scanner/__init__.py
Empty file.
Loading
Loading