composer-scan

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 12 Open GitHub ↗

ARCHIVED: Scans your composer.lock file to find vulnerable WordPress plugins and themes using the https://wpvulndb.com API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# WordPress Composer Scan

> Scans your composer.lock file to find vulnerable WordPress plugins and themes using the [WPScan Vulnerability Database](https://wpvulndb.com) API

[![Support Level](https://img.shields.io/badge/support-archived-red.svg)](https://raw.githubusercontent.com/10up/composer-scan/develop/) [![MIT License](https://img.shields.io/github/license/10up/composer-scan.svg)](https://github.com/10up/composer-scan/blob/master/LICENSE.md)

> [!CAUTION]
> As of 12 April 2024, this project is archived and no longer being actively maintained.

## Requirements

- API key from the [WPScan Vulnerability Database](https://wpvulndb.com)
- Supports most major Python versions since 2.7, see [`tox.ini`](https://github.com/10up/composer-scan/blob/update/docs/tox.ini) for tested versions
- Required Python packages (will automatically be installed by setup.py):

```:text
requests
click
```

## Installation

Clone this repo and install with pip:

```:bash
git clone https://github.com/10up/composer-scan.git composer-scan
cd composer-scan
pip install .   ## installs the python package in the current directory
```

## Usage

```:bash
> composer-scan --help
Usage: composer-scan [OPTIONS]

Console script for composer_scan.

Options:
  -f PATH       composer.lock file to scan, defaults to file in current
                directory
  -v            Verbose output, show status of all plugins, if not set only
                outputs found vulnerabilities
  --no-fail     even if vulnerabilities are found, exit 0 (emergency option to
                not fail CI pipelines)
  --token TEXT  WPVulnDB API token or set as envrionment variable:
                WPVULNDB_API_TOKEN  [required]
  --help        Show this message and exit.
```

The WPScan Vulnerability Database API key can be specified on the command line in an envrionment variable `WPVULNDB_API_TOKEN`. `-f` can be used to specify the file to scan, if not used `composer.lock` in the currnet directory will be used.

```:bash
> export WPVULNDB_API_TOKEN="api_token"
> composer-scan -f ~/wp-local-docker-sites/mysite/wordpress/wp-content/composer.lock
```

## Support Level

**Archived:** This project is no longer maintained by 10up. We are no longer responding to Issues or Pull Requests unless they relate to security concerns. We encourage interested developers to fork this project and make it their own!

## Contributing

Please read [CODE_OF_CONDUCT.md](https://github.com/10up/classifai/blob/develop/CODE_OF_CONDUCT.md) for details on our code of conduct and [CONTRIBUTING.md](https://github.com/10up/classifai/blob/develop/CONTRIBUTING.md) for details on the process for submitting pull requests to us.

## Like what you see?

composer-scan

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README