{"id":20900015,"url":"https://github.com/the404hacking/wpscan","last_synced_at":"2025-05-13T01:32:04.561Z","repository":{"id":109048047,"uuid":"106019451","full_name":"The404Hacking/wpscan","owner":"The404Hacking","description":"WPScan is a black box WordPress vulnerability scanner.","archived":false,"fork":false,"pushed_at":"2017-10-06T16:06:36.000Z","size":1742,"stargazers_count":10,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-01T15:09:52.522Z","etag":null,"topics":["hacking-tool","ruby","scan","scanner","security","security-scanner","the404hacking","wordpress","wordpress-scan","wpscan"],"latest_commit_sha":null,"homepage":"https://wpscan.org","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/The404Hacking.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-06T15:19:05.000Z","updated_at":"2024-12-06T23:16:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"bcb86ec5-65ea-4c21-9973-15c80dde2df2","html_url":"https://github.com/The404Hacking/wpscan","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The404Hacking%2Fwpscan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The404Hacking%2Fwpscan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The404Hacking%2Fwpscan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The404Hacking%2Fwpscan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/The404Hacking","download_url":"https://codeload.github.com/The404Hacking/wpscan/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253854005,"owners_count":21974209,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacking-tool","ruby","scan","scanner","security","security-scanner","the404hacking","wordpress","wordpress-scan","wpscan"],"created_at":"2024-11-18T11:17:29.076Z","updated_at":"2025-05-13T01:32:04.551Z","avatar_url":"https://github.com/The404Hacking.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"![alt text](https://raw.githubusercontent.com/wpscanteam/wpscan/gh-pages/wpscan_logo_407x80.png \"WPScan - WordPress Security Scanner\")\n\n\n[![Build Status](https://travis-ci.org/wpscanteam/wpscan.svg?branch=master)](https://travis-ci.org/wpscanteam/wpscan)\n[![Code Climate](https://img.shields.io/codeclimate/github/wpscanteam/wpscan.svg)](https://codeclimate.com/github/wpscanteam/wpscan)\n[![Dependency Status](https://img.shields.io/gemnasium/wpscanteam/wpscan.svg)](https://gemnasium.com/wpscanteam/wpscan)\n[![Docker Pulls](https://img.shields.io/docker/pulls/wpscanteam/wpscan.svg)](https://hub.docker.com/r/wpscanteam/wpscan/)\n\n# LICENSE\n\n## WPScan Public Source License\n\nThe WPScan software (henceforth referred to simply as \"WPScan\") is dual-licensed - Copyright 2011-2016 WPScan Team.\n\nCases that include commercialization of WPScan require a commercial, non-free license. Otherwise, WPScan can be used without charge under the terms set out below.\n\n### 1. Definitions\n\n1.1 \"License\" means this document.\n\n1.2 \"Contributor\" means each individual or legal entity that creates, contributes to the creation of, or owns WPScan.\n\n1.3 \"WPScan Team\" means WPScan’s core developers, an updated list of whom can be found within the CREDITS file.\n\n### 2. Commercialization\n\nA commercial use is one intended for commercial advantage or monetary compensation.\n\nExample cases of commercialization are:\n\n - Using WPScan to provide commercial managed/Software-as-a-Service services.\n - Distributing WPScan as a commercial product or as part of one.\n - Using WPScan as a value added service/product.\n\nExample cases which do not require a commercial license, and thus fall under the terms set out below, include (but are not limited to):\n\n - Penetration testers (or penetration testing organizations) using WPScan as part of their assessment toolkit.\n - Penetration Testing Linux Distributions including but not limited to Kali Linux, SamuraiWTF, BackBox Linux.\n - Using WPScan to test your own systems.\n - Any non-commercial use of WPScan.\n\nIf you need to purchase a commercial license or are unsure whether you need to purchase a commercial license contact us - team@wpscan.org.\n\nWe may grant commercial licenses at no monetary cost at our own discretion if the commercial usage is deemed by the WPScan Team to significantly benefit WPScan.\n\nFree-use Terms and Conditions;\n\n### 3. Redistribution\n\nRedistribution is permitted under the following conditions:\n\n - Unmodified License is provided with WPScan.\n - Unmodified Copyright notices are provided with WPScan.\n - Does not conflict with the commercialization clause.\n\n### 4. Copying\n\nCopying is permitted so long as it does not conflict with the Redistribution clause.\n\n### 5. Modification\n\nModification is permitted so long as it does not conflict with the Redistribution clause.\n\n### 6. Contributions\n\nAny Contributions assume the Contributor grants the WPScan Team the unlimited, non-exclusive right to reuse, modify and relicense the Contributor's content.\n\n### 7. Support\n\nWPScan is provided under an AS-IS basis and without any support, updates or maintenance. Support, updates and maintenance may be given according to the sole discretion of the WPScan Team.\n\n### 8. Disclaimer of Warranty\n\nWPScan is provided under this License on an “as is” basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the WPScan is free of defects, merchantable, fit for a particular purpose or non-infringing.\n\n### 9. Limitation of Liability\n\nTo the extent permitted under Law, WPScan is provided under an AS-IS basis. The WPScan Team shall never, and without any limit, be liable for any damage, cost, expense or any other payment incurred as a result of WPScan's actions, failure, bugs and/or any other interaction between WPScan and end-equipment, computers, other software or any 3rd party, end-equipment, computer or services.\n\n### 10. Disclaimer\n\nRunning WPScan against websites without prior mutual consent may be illegal in your country. The WPScan Team accept no liability and are not responsible for any misuse or damage caused by WPScan.\n\n### 11. Trademark\n\nThe \"wpscan\" term is a registered trademark. This License does not grant the use of the \"wpscan\" trademark or the use of the WPScan logo.\n\n# INSTALL\n\nWPScan comes pre-installed on the following Linux distributions:\n\n- [BackBox Linux](http://www.backbox.org/)\n- [Kali Linux](http://www.kali.org/)\n- [Pentoo](http://www.pentoo.ch/)\n- [SamuraiWTF](http://samurai.inguardians.com/)\n- [BlackArch](http://blackarch.org/)\n\nOn macOS WPScan is packaged by [Homebrew](https://brew.sh/) as [`wpscan`](http://braumeister.org/formula/wpscan).\n\nWindows is not supported\n\nWe suggest you use our official Docker image from https://hub.docker.com/r/wpscanteam/wpscan/ to avoid installation problems.\n\n# DOCKER\nPull the repo with `docker pull wpscanteam/wpscan`\n\n## Start WPScan\n\n```\ndocker run -it --rm The404Hacking/wpscan -u https://yourblog.com [options]\n```\n\nFor the available Options, please see https://github.com/The404Hacking/wpscan#wpscan-arguments\n\nIf you run the git version of wpscan we included some binstubs in ./bin for easier start of wpscan.\n\n## Examples\n\nMount a local wordlist to the docker container and start a bruteforce attack for user admin\n\n```\ndocker run -it --rm -v ~/wordlists:/wordlists The404Hacking/wpscan --url https://yourblog.com --wordlist /wordlists/crackstation.txt --username admin\n```\n\n(This mounts the host directory `~/wordlists` to the container in the path `/wordlists`)\n\nUse logfile option\n```\n# the file must exist prior to starting the container, otherwise docker will create a directory with the filename\ntouch ~/FILENAME\ndocker run -it --rm -v ~/FILENAME:/wpscan/output.txt wpscanteam/wpscan --url https://yourblog.com --log /wpscan/output.txt\n```\n\nPublished on https://hub.docker.com/r/wpscanteam/wpscan/\n\n# Manual install\n\n## Prerequisites\n\n- Ruby \u003e= 2.1.9 - Recommended: 2.4.2\n- Curl \u003e= 7.21  - Recommended: latest - FYI the 7.29 has a segfault\n- RubyGems      - Recommended: latest\n- Git\n\n### Installing dependencies on Ubuntu\n\n    sudo apt-get install libcurl4-openssl-dev libxml2 libxml2-dev libxslt1-dev ruby-dev build-essential libgmp-dev zlib1g-dev\n\n### Installing dependencies on Debian\n\n    sudo apt-get install gcc git ruby ruby-dev libcurl4-openssl-dev make zlib1g-dev\n\n### Installing dependencies on Fedora\n\n    sudo dnf install gcc ruby-devel libxml2 libxml2-devel libxslt libxslt-devel libcurl-devel patch rpm-build\n\n### Installing dependencies on Arch Linux\n\n    pacman -Syu ruby\n    pacman -Syu libyaml\n\n### Installing dependencies on macOS\n\nApple Xcode, Command Line Tools and the libffi are needed (to be able to install the FFI gem), See [http://stackoverflow.com/questions/17775115/cant-setup-ruby-environment-installing-fii-gem-error](http://stackoverflow.com/questions/17775115/cant-setup-ruby-environment-installing-fii-gem-error)\n\n## Installing with RVM (recommended when doing a manual install)\n\nIf you are using GNOME Terminal, there are some steps required before executing the commands. See here for more information:\nhttps://rvm.io/integration/gnome-terminal#integrating-rvm-with-gnome-terminal\n\n    # Install all prerequisites for your OS (look above)\n    cd ~\n    curl -sSL https://rvm.io/mpapis.asc | gpg --import -\n    curl -sSL https://get.rvm.io | bash -s stable\n    source ~/.rvm/scripts/rvm\n    echo \"source ~/.rvm/scripts/rvm\" \u003e\u003e ~/.bashrc\n    rvm install 2.4.2\n    rvm use 2.4.2 --default\n    echo \"gem: --no-ri --no-rdoc\" \u003e ~/.gemrc\n    git clone https://github.com/The404Hacking/wpscan.git\n    cd wpscan\n    gem install bundler\n    bundle install --without test\n\n## Installing manually (not recommended)\n\n    git clone https://github.com/The404Hacking/wpscan.git\n    cd wpscan\n    sudo gem install bundler \u0026\u0026 bundle install --without test\n\n# KNOWN ISSUES\n\n  - Typhoeus segmentation fault\n\n      Update cURL to version =\u003e 7.21 (may have to install from source)\n\n  - Proxy not working\n\n      Update cURL to version =\u003e 7.21.7 (may have to install from source).\n\n      Installation from sources :\n\n        Grab the sources from http://curl.haxx.se/download.html\n        Decompress the archive\n        Open the folder with the extracted files\n        Run ./configure\n        Run make\n        Run sudo make install\n        Run sudo ldconfig\n\n\n  - cannot load such file -- readline:\n\n        sudo aptitude install libreadline5-dev libncurses5-dev\n\n      Then, open the directory of the readline gem (you have to locate it)\n\n        cd ~/.rvm/src/ruby-XXXX/ext/readline\n        ruby extconf.rb\n        make\n        make install\n\n\n      See [http://vvv.tobiassjosten.net/ruby-on-rails/fixing-readline-for-the-ruby-on-rails-console/](http://vvv.tobiassjosten.net/ruby-on-rails/fixing-readline-for-the-ruby-on-rails-console/) for more details\n\n  - no such file to load -- rubygems\n\n      ```update-alternatives --config ruby```\n\n      And select your ruby version\n\n      See [https://github.com/wpscanteam/wpscan/issues/148](https://github.com/wpscanteam/wpscan/issues/148)\n\n# WPSCAN ARGUMENTS\n\n    --update                            Update the database to the latest version.\n    --url       | -u \u003ctarget url\u003e       The WordPress URL/domain to scan.\n    --force     | -f                    Forces WPScan to not check if the remote site is running WordPress.\n    --enumerate | -e [option(s)]        Enumeration.\n      option :\n        u        usernames from id 1 to 10\n        u[10-20] usernames from id 10 to 20 (you must write [] chars)\n        p        plugins\n        vp       only vulnerable plugins\n        ap       all plugins (can take a long time)\n        tt       timthumbs\n        t        themes\n        vt       only vulnerable themes\n        at       all themes (can take a long time)\n      Multiple values are allowed : \"-e tt,p\" will enumerate timthumbs and plugins\n      If no option is supplied, the default is \"vt,tt,u,vp\"\n\n    --exclude-content-based \"\u003cregexp or string\u003e\"\n                                        Used with the enumeration option, will exclude all occurrences based on the regexp or string supplied.\n                                        You do not need to provide the regexp delimiters, but you must write the quotes (simple or double).\n    --config-file  | -c \u003cconfig file\u003e   Use the specified config file, see the example.conf.json.\n    --user-agent   | -a \u003cUser-Agent\u003e    Use the specified User-Agent.\n    --cookie \u003cstring\u003e                   String to read cookies from.\n    --random-agent | -r                 Use a random User-Agent.\n    --follow-redirection                If the target url has a redirection, it will be followed without asking if you wanted to do so or not\n    --batch                             Never ask for user input, use the default behaviour.\n    --no-color                          Do not use colors in the output.\n    --log [filename]                    Creates a log.txt file with WPScan's output if no filename is supplied. Otherwise the filename is used for logging.\n    --no-banner                         Prevents the WPScan banner from being displayed.\n    --disable-accept-header             Prevents WPScan sending the Accept HTTP header.\n    --disable-referer                   Prevents setting the Referer header.\n    --disable-tls-checks                Disables SSL/TLS certificate verification.\n    --wp-content-dir \u003cwp content dir\u003e   WPScan try to find the content directory (ie wp-content) by scanning the index page, however you can specify it.\n                                        Subdirectories are allowed.\n    --wp-plugins-dir \u003cwp plugins dir\u003e   Same thing than --wp-content-dir but for the plugins directory.\n                                        If not supplied, WPScan will use wp-content-dir/plugins. Subdirectories are allowed\n    --proxy \u003c[protocol://]host:port\u003e    Supply a proxy. HTTP, SOCKS4 SOCKS4A and SOCKS5 are supported.\n                                        If no protocol is given (format host:port), HTTP will be used.\n    --proxy-auth \u003cusername:password\u003e    Supply the proxy login credentials.\n    --basic-auth \u003cusername:password\u003e    Set the HTTP Basic authentication.\n    --wordlist | -w \u003cwordlist\u003e          Supply a wordlist for the password brute forcer.\n                                        If the \"-\" option is supplied, the wordlist is expected via STDIN.\n    --username | -U \u003cusername\u003e          Only brute force the supplied username.\n    --usernames     \u003cpath-to-file\u003e      Only brute force the usernames from the file.\n    --cache-dir       \u003ccache-directory\u003e Set the cache directory.\n    --cache-ttl       \u003ccache-ttl\u003e       Typhoeus cache TTL.\n    --request-timeout \u003crequest-timeout\u003e Request Timeout.\n    --connect-timeout \u003cconnect-timeout\u003e Connect Timeout.\n    --threads  | -t \u003cnumber of threads\u003e The number of threads to use when multi-threading requests.\n    --max-threads     \u003cmax-threads\u003e     Maximum Threads.\n    --throttle        \u003cmilliseconds\u003e    Milliseconds to wait before doing another web request. If used, the --threads should be set to 1.\n    --help     | -h                     This help screen.\n    --verbose  | -v                     Verbose output.\n    --version                           Output the current version and exit.\n\n# WPSCAN EXAMPLES\n\nDo 'non-intrusive' checks...\n\n```ruby wpscan.rb --url www.example.com```\n\nDo wordlist password brute force on enumerated users using 50 threads...\n\n```ruby wpscan.rb --url www.example.com --wordlist darkc0de.lst --threads 50```\n\nDo wordlist password brute force on enumerated users using STDIN as the wordlist...\n\n```crunch 5 13 -f charset.lst mixalpha | ruby wpscan.rb --url www.example.com --wordlist -```\n\nDo wordlist password brute force on the 'admin' username only...\n\n```ruby wpscan.rb --url www.example.com --wordlist darkc0de.lst --username admin```\n\nEnumerate installed plugins...\n\n```ruby wpscan.rb --url www.example.com --enumerate p```\n\nRun all enumeration tools...\n\n```ruby wpscan.rb --url www.example.com --enumerate```\n\nUse custom content directory...\n\n```ruby wpscan.rb -u www.example.com --wp-content-dir custom-content```\n\nUpdate WPScan's databases...\n\n```ruby wpscan.rb --update```\n\nDebug output...\n\n```ruby wpscan.rb --url www.example.com --debug-output 2\u003edebug.log```\n\n# PROJECT HOME\n\n[http://www.wpscan.org](http://www.wpscan.org)\n\n# VULNERABILITY DATABASE\n\n[https://wpvulndb.com](https://wpvulndb.com)\n\n# GIT REPOSITORY\n\n[https://github.com/The404Hacking/wpscan](https://github.com/The404Hacking/wpscan)\n\n# ISSUES\n\n[WPScan issues](https://github.com/wpscanteam/wpscan/issues)\n\n# DEVELOPER DOCUMENTATION\n\n[http://rdoc.info/github/wpscanteam/wpscan/frames](http://rdoc.info/github/wpscanteam/wpscan/frames)\n\n\n## Download and Clone\n\u003e Download: [https://github.com/The404Hacking/wpscan/archive/master.zip](https://github.com/The404Hacking/wpscan/archive/master.zip)\n\n\u003e Clone: git clone [https://github.com/The404Hacking/wpscan.git](https://github.com/The404Hacking/wpscan.git)\n\n## The404Hacking | Digital UnderGround Team\n[The404Hacking](https://T.me/The404Hacking)\n\n## Follow us !\n[The404Hacking](https://T.me/The404Hacking) - [The404Cracking](https://T.me/The404Cracking)\n\n[Instagram](https://instagram.com/The404Hacking) - [GitHub](https://github.com/The404Hacking)\n\n[YouTube](http://yon.ir/youtube404) - [Aparat](http://www.aparat.com/The404Hacking)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe404hacking%2Fwpscan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthe404hacking%2Fwpscan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe404hacking%2Fwpscan/lists"}