WPScan User Documentation
This is a copy of the WPScan User Documentation. Please refer to the Github Wiki version for the most up to date information.
WPScan is a free, for non-commercial use, black box WordPress security scanner written for security professionals and blog maintainers to test the security of their sites.
WPScan is written in the Ruby programming language. The first version of WPScan was released on the 16th of June 2011.
What can WPScan check for?
- The version of WordPress installed and any associated vulnerabilities
- What plugins are installed and any associated vulnerabilities
- What themes are installed and any associated vulnerabilities
- Username enumeration
- Users with weak passwords via password brute forcing
- Backed up and publicly accessible wp-config.php files
- Database dumps that may be publicly accessible
- If error logs are exposed by plugins
- Media file enumeration
- Vulnerable Timthumb files
- If the WordPress readme file is present
- If WP-Cron is enabled
- If user registration is enabled
- Full Path Disclose
- Upload directory listing
- And much more…
WPScan is not Open Source software. WPScan is licensed with a custom license that requires a fee to be paid if used commercially. Please find the full license terms here.
WPScan is shipped as a Ruby gem, and can be installed with the following command:
gem install wpscan
We also support Docker. Pull the repo with:
docker pull wpscanteam/wpscan
Example Docker command to enumerate usernames:
docker run -it --rm wpscanteam/wpscan --url https://example.com/ --enumerate u
brew install wpscan
To update the WPScan software:
gem update wpscan
To update WPScan in Kali Linux:
apt-get update && apt-get upgrade
WPScan keeps a local database of metadata that is used to output useful information, such as the latest version of a plugin. The local database can be updated with the following command:
Please note that this data does not include the vulnerability data. See Vulnerability Database for information on the vulnerability data.
When enumerating the WordPress version, installed plugins or installed themes, you can use three different “modes”, which are:
If you want the most results use the “mixed” mode. However, if you are worried that the server may not be able to handle a large number of requests, use the “passive” mode. The default mode is “mixed”, with the exception of plugin enumeration, which is “passive”. You will need to manually override the plugin detection mode, if you want to use anything other than the default, with the
WPScan can enumerate various things from a remote WordPress application, such as plugins, themes, usernames, backed up files wp-config.php files, Timthumb files, database exports and more. To use WPScan’s enumeration capabilities supply the
The following enumeration options exist:
u(User IDs range. e.g: u1-5)
m(Media IDs range. e.g m1-15)
If no option is supplied to the
-e flag, then the default will be:
Here we have put together a bunch of common commands that will help you get started quickly.
NOTE: Get your API token from wpvulndb.com if you also want the vulnerabilities associated with the detected plugin displaying.
- For all plugins with known vulnerabilities:
wpscan --url example.com -e vp --plugins-detection mixed --api-token YOUR_TOKEN
- For all plugins in our database (could take a very long time):
wpscan --url example.com -e ap --plugins-detection mixed --api-token YOUR_TOKEN
- Password brute force attack
wpscan --url example.com -e u --passwords /path/to/password_file.txt
Docker Cheat Sheet
- Pull the Docker repository
docker pull wpscanteam/wpscan
- Run WPScan and enumerate usernames
docker run -it --rm wpscanteam/wpscan --url https://target.tld/ --enumerate u
- When using
--outputflag along with the WPScan Docker image, a bind mount must be used. Otherwise, the file is written inside the Docker container, which is then thrown away.
mkdir ~/docker-bind docker run --rm --mount type=bind,source=$HOME/docker-bind,target=/output wpscanteam/wpscan:latest -o /output/wpscan-output.txt --url 'https://example.com'
wpscan-output.txt file now exists on the host machine at
WPScan uses the WordPress Vulnerability Database API in real time to retrieve known vulnerabilities that affect WordPress core, plugins and themes.
For the vulnerability information to be shown within WPScan you will need to supply an API token with the
--api-token YOUR_TOKEN option. Alternatively, you can supply the API token from a WPScan configuration file.
A free API token is available, as well as paid plans, depending on your usage needs.
If you do not supply an API token, WPScan will work as normal, with the exception that when a WordPress version, plugin or theme is detected, the associated known vulnerabilities will not be displayed.
Bypassing Simple WAFs
To bypass some simple WAFs you can try the
If WPScan is not working as expected, you can use the
--proxy option, and use a web proxy to inspect WPScan’s HTTP requests, and the remote server’s HTTP responses. This is useful when you do not know why you are getting false positives, or false negatives.
We blog here – https://blog.wpscan.com/
We tweet here – https://twitter.com/_wpscan_