README

注意，由于wpvulndb的API限制，构建状态可能为“红色”

什么是wp-sec？

wp-sec是wp-cli的扩展，用于在wpvulndb.com检查Wordpress的CVE安全问题。可以检查和监控所有已安装的核心、插件和主题版本，以便您知道何时更新Wordpress安装。

使用

以下概要应足以让您开始

NAME

  wp wp-sec

DESCRIPTION

  Check for CVE security issues at wpvulndb.com

SYNOPSIS

  wp wp-sec <command>

SUBCOMMANDS

  check      Checks for core, plugins and themes
  version    Returns current version


CHECK PARAMETERS

  --type=[core|plugins|themes|all]
      Check for a specific part, or use all to check all parts
      Default: all

  --output=[user|nagios|json]
      Controls the output
      Default: user

  --cached
      Lets you cache the resuls of wpvulndb, to prevent hammering at their servers. Be nice to them, it's a free service

  --ttl=[integer]
      Cache control of above --cached setting. If omitted a default of 8 hours is used. This setting will give
      you fine grained control. Value is entered in seconds

  --api=[v2|v3]
      The WPvulnDB API version to be used. Currently there is no functional difference between these API's. Except for logging in with a token on API v3

  --token=[<your token>] 
      Your user token to be used @ wpvulndb.com. Only needed for API v3

  --lowercase
      Converts themes and plugin names to lowercase to submit to wpvulndb. This is due to an issue at wpvulndb. https://github.com/markri/wp-sec/issues/14 As of october 2018 (tested) it doesn't seem to be needed anymore

GLOBAL PARAMETERS

  All global wp cli parameters are inherited

安装

安装此包需要WP-CLI v0.23.0或更高版本。按照此处的说明安装全新的wp-cli，或者使用wp cli update更新到最新稳定版本。

不幸的是，wp-cli satis存储库更新得并不多。因此，安装wp-sec包的最简单方法是从此处下载最新的zipball，并使用wp package install <version>.zip在本地上安装。

贡献

我们非常感谢您主动为这个项目做出贡献。

贡献不仅限于代码。我们鼓励您以最适合您能力的方式做出贡献，比如编写教程、在当地Meetup上进行演示、帮助其他用户解决支持问题或修订我们的文档。

开发

要为代码贡献设置开发环境，请按照以下说明操作。扩展的执行是在docker化环境中完成的（仅在Linux下进行过测试）。编辑可以在docker外部完成，因为当前目录已挂载到docker环境中。

将wp-cli二进制文件放在bin文件夹中。根据WP-CLI的当前文档，您可能想这样做

cd bin 
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
chmod +x wp-cli.phar
mv wp-cli.phar wp

创建一个docker环境，并像这样启动它

docker-compose up -d

进入您的开发环境，创建一个新的Wordpress安装以进行测试

docker exec -ti wpsec-phpcli /bin/bash
mkdir testsite && cd testsite
wp core download
wp core config --dbname=wpsec --dbuser=wpsec --dbpass=wpsec --dbhost=wpsec-mariadb
wp core install --url=https:// --title=testsite --admin_user=admin --admin_password=admin --admin_email=mail@mail.com --skip-email

运行（从/home/wp/testsite）

wp wp-sec check

准备测试套件（从/home/wp）

composer install
mysql -h wpsec-mariadb -e 'CREATE DATABASE IF NOT EXISTS wp_cli_test;' -uroot -pwpsec

运行测试套件

vendor/bin/behat --strict

报告错误

你认为你找到了一个错误？我们很乐意你帮助我们将其修复。

在创建新问题之前，您应该搜索现有问题，以查看是否已有对此问题的现有解决方案，或者它是否已在较新版本中修复。

一旦您进行了一些搜索，发现没有针对您错误的开放或已修复的问题，请创建一个新问题，包含以下内容

您正在做什么（例如：“当我运行wp post list”）。
您看到了什么（例如：“我看到一个关于类未定义的致命错误。”）。
您期望看到什么（例如：“我期望看到文章列表。”）

尽可能包含尽可能多的详细信息，并在可能的情况下提供重现步骤。

创建pull request

想要贡献一个新功能？请先创建一个新的问题，讨论这个功能是否适合项目。

一旦你决定投入时间将你的pull request完成，请遵循我们创建pull request的指南，以确保这是一个愉快的体验。

为每个贡献创建一个功能分支。
尽早提交你的pull request以获取反馈。
将功能测试包含在你的更改中。阅读WP-CLI文档以获取简介。
遵循PSR-2编码标准。

markri/ wp-sec

维护者

详细信息

README

什么是wp-sec？

使用

安装

贡献

开发

报告错误

创建pull request