-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathreadme.txt
252 lines (168 loc) · 8.65 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
=== WPVulnerability ===
Contributors: javiercasares, davidperez, lbonomo, alexclassroom
Tags: security, vulnerability, site-health
Requires at least: 4.1
Tested up to: 6.7
Stable tag: 4.0.3
Requires PHP: 5.6
Version: 4.0.3
License: GPL-2.0-or-later
License URI: https://spdx.org/licenses/GPL-2.0-or-later.html
Get WordPress vulnerability alerts from the [WPVulnerability Database API](https://www.wpvulnerability.com/).
== Description ==
This plugin integrates with the WPVulnerability API to provide real-time vulnerability assessments for your WordPress core, plugins, themes, PHP version, Apache HTTPD, nginx, MariaDB, MySQL, ImageMagick, curl, memcached, Redis, and SQLite.
It delivers detailed reports directly within your WordPress dashboard, helping you stay aware of potential security risks. Configure the plugin to send periodic notifications about your site's security status, ensuring you remain informed without being overwhelmed. Designed for ease of use, it supports proactive security measures without storing or retrieving any personal data from your site.
= Data reliability =
The information provided by the information database comes from different sources that have been reviewed by third parties. There is no liability of any kind for the information. Act at your own risk.
== Using the plugin ==
= WP-CLI =
You can use the following WP-CLI commands to manage and check vulnerabilities:
* Core: `wp wpvulnerability core`
* Plugins: `wp wpvulnerability plugins`
* Themes: `wp wpvulnerability themes`
* PHP: `wp wpvulnerability php`
* Apache HTTPD: `wp wpvulnerability apache`
* nginx: `wp wpvulnerability nginx`
* MariaDB: `wp wpvulnerability mariadb`
* MySQL: `wp wpvulnerability mysql`
* ImageMagick: `wp wpvulnerability imagemagick`
* curl: `wp wpvulnerability curl`
* memcached: `wp wpvulnerability memcached`
* Redis: `wp wpvulnerability redis`
* SQLite: `wp wpvulnerability sqlite`
All commands support the `--format` option to specify the output format:
* `--format=table`: Displays the results in a table format (default).
* `--format=json`: Displays the results in JSON format.
Need help?
* `wp wpvulnerability --help`: Displays help information for WPVulnerability commands.
* `wp wpvulnerability [command] --help`: Displays help information for a WPVulnerability command.
= REST API =
The WPVulnerability plugin provides several **REST API endpoints** to fetch vulnerability information for different components of your WordPress site.
* Core: `/wpvulnerability/v1/core`
* Plugins: `/wpvulnerability/v1/plugins`
* Themes: `/wpvulnerability/v1/themes`
* PHP: `/wpvulnerability/v1/php`
* Apache HTTPD: `/wpvulnerability/v1/apache`
* nginx: `/wpvulnerability/v1/nginx`
* MariaDB: `/wpvulnerability/v1/mariadb`
* MySQL: `/wpvulnerability/v1/mysql`
* ImageMagick: `/wpvulnerability/v1/imagemagick`
* curl: `/wpvulnerability/v1/curl`
* memcached: `/wpvulnerability/v1/memcached`
* Redis: `/wpvulnerability/v1/redis`
* SQLite: `/wpvulnerability/v1/sqlite`
The WPVulnerability REST API uses **Application Passwords** for authentication. You need to include a valid Application Password in the Authorization header of your requests.
Example Request with Authentication
`curl -X GET https://example.com/wp-json/wpvulnerability/v1/plugins -u username:application_password`
Replace username with your WordPress `username` and `application_password` with your [Application Password](https://make.wordpress.org/core/2020/11/05/application-passwords-integration-guide/).
== Extra Configurations ==
= "From:" mail (since: 3.2.2) =
If, for some reason, you need the emails sent by the plugin to have a From different from the site administrator, you can change it from the `wp-config.php` by adding a constant:
`define( 'WPVULNERABILITY_MAIL', '[email protected]' );`
If the constant is active, it will be visible in the configuration screen.
== Installation ==
= Automatic download =
Visit the plugin section in your WordPress, search for [wpvulnerability]; download and install the plugin.
= Manual download =
Extract the contents of the ZIP and upload the contents to the `/wp-content/plugins/wpvulnerability/` directory. Once uploaded, it will appear in your plugin list.
== Frequently Asked Questions ==
= Where does the vulnerability information come from? =
The origin is in the WPVulnerability.com API. The vulnerabilities that appear in this API come from different sources, such as CVEs.
= Is data from my site sent anywhere? =
No. Never. Your privacy is very important to us. We do not commercialize with your data.
= What vulnerabilities will I find? =
Vulnerabilities in WordPress Core, Plugins, Themes, PHP, Apache HTTPD, nginx, MariaDB, MySQL, ImageMagick, curl, memcached, Redis, and SQLite are documented.
= What do I do if my site has a vulnerability? =
First of all, peace of mind. Investigate what the vulnerability is and, above all, check that you have the latest version of the compromised element. We actively recommend that you keep all your WordPress and its plugins up to date. Contact your hosting provider to patch non-WordPress vulnerabilities (like web server, databases, and other software).
== Screenshots ==
1. WP-Admin Dashboard widget.
2. Vulnerability list at Plugins list.
3. Vulnerability list at Site Health.
== Compatibility ==
* WordPress: 4.1 - 6.7
* PHP: 5.6 - 8.4
* WP-CLI: 2.3.0 - 2.11.0
== Changelog ==
= [4.0.3] - 2024-10-28 =
* Recreation of the 4.0.2 version. Something did not created the 4.0.2 version.
= [4.0.2] - 2024-10-25 =
**Fixed**
* ImageMagick: it crashes in some cases where the hosting does not have ImageMagick.
**Compatibility**
* WordPress: 4.1 - 6.7
* PHP: 5.6 - 8.4
* WP-CLI: 2.3.0 - 2.11.0
**Tests**
* PHP Coding Standards: 3.10.3
* WordPress Coding Standards: 3.1.0
* Plugin Check (PCP): 1.1.0
* SonarCloud Code Review
= [4.0.1] - 2024-10-04 =
**Fixed**
* API endpoints: some API endpoints were failing.
* CLI endpoints: some CLI endpoints were failing.
**Compatibility**
* WordPress: 4.1 - 6.7
* PHP: 5.6 - 8.4
* WP-CLI: 2.3.0 - 2.11.0
**Tests**
* PHP Coding Standards: 3.10.3
* WordPress Coding Standards: 3.1.0
* Plugin Check (PCP): 1.1.0
* SonarCloud Code Review
= [4.0.0] - 2024-10-01 =
**Added**
* ImageMagic vulnerabilities (Site Health + WP-CLI + API + mail).
* curl vulnerabilities (Site Health + WP-CLI + API + mail).
* memcached vulnerabilities (Site Health + WP-CLI + API + mail).
* Redis vulnerabilities (Site Health + WP-CLI + API + mail).
* SQLite vulnerabilities (Site Health + WP-CLI + API + mail).
**Fixed**
* Test email without email.
* Improved MariaDB 11.x detection.
* Improved versions detection (major-minor.patch-build).
* WordPress < 5.3: use of wp_date().
* WordPress < 5.0: locale detection.
* Dashboard widget only for users with capabilities.
* WordPress < 5.2: link to Site Health
**Changed**
* Big refactory.
* Less files, less size, improved code quality.
**Compatibility**
* WordPress: 4.1 - 6.7
* PHP: 5.6 - 8.4
* WP-CLI: 2.3.0 - 2.11.0
**Tests**
* Manual Testing:
* WordPress 6.7 / PHP 8.4
* WordPress 6.6 / PHP 8.3
* WordPress 6.4 / PHP 8.2
* WordPress 6.1 / PHP 8.1
* WordPress 5.8 / PHP 8.0
* WordPress 5.5 / PHP 7.4
* WordPress 5.3 / PHP 7.3
* WordPress 4.9 / PHP 7.2
* WordPress 4.8 / PHP 7.1
* WordPress 4.6 / PHP 7.0
* WordPress 4.1 / PHP 5.6
* PHP Coding Standards: 3.10.3
* WordPress Coding Standards: 3.1.0
* Plugin Check (PCP): 1.1.0
* SonarCloud Code Review
= Previous versions =
If you want to see the full changelog, visit the [changelog.txt](https://plugins.trac.wordpress.org/browser/wpvulnerability/trunk/changelog.txt) file.
== Security ==
This plugin adheres to the following security measures and review protocols for each version:
* [WordPress Plugin Handbook](https://developer.wordpress.org/plugins/)
* [WordPress Plugin Security](https://developer.wordpress.org/plugins/wordpress-org/plugin-security/)
* [WordPress APIs Security](https://developer.wordpress.org/apis/security/)
* [WordPress Coding Standards](https://github.com/WordPress/WordPress-Coding-Standards)
* [Plugin Check (PCP)](https://wordpress.org/plugins/plugin-check/)
* [SonarCloud Code Review](https://www.sonarsource.com/products/sonarcloud/)
== Privacy ==
* This plugin or the WordPress Vulnerability Database API does not collect any information about your site, your identity, the plugins, themes or content the site has.
== Vulnerabilities ==
* No vulnerabilities have been published up to version 4.0.2.
Found a security vulnerability? Please report it to us privately at the [WPVulnerability GitHub repository](https://github.com/javiercasares/wpvulnerability/security/advisories/new).
== Contributors ==
You can contribute to this plugin at the [WPVulnerability GitHub repository](https://github.com/javiercasares/wpvulnerability).