-
Notifications
You must be signed in to change notification settings - Fork 2
/
readme.txt
134 lines (90 loc) · 5.6 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
=== Prevent XSS Vulnerability ===
Contributors: sasiddiqui
Tags: attack, cross-site scripting, security, vulnerability, xss, self-xss
Requires at least: 3.5
Tested up to: 6.5
Stable tag: 2.0.1
License: GPLv3
License URI: https://www.gnu.org/licenses/gpl-3.0.html
== Description ==
This plugin provides the functionality for `Reflected XSS` and `Self-XSS`.
For Reflected XSS, it checks the URL and redirects it if you enabled the `Enable Blocking` option and URL contains any Vulnerable code in it. It only block some parameters which are not allowed in URL and shown Block Parameters section. You can skip some of the parameters from it if you still like them to be used.
To provide more security, this plugin also escape the HTML in the `$_GET` parameter which is commonly used to get parameters in PHP from the URL and print them in the HTML. This way, HTML properties will not work if anyone provided it in the URL.
There are many ways by which the plugin can be tested but it may varies for different sites according to their structure and development functionality.
=== Block Parameters ===
This plugin block the following parameters in the URL if enabled from the Plugin Settings page.
* Opening Round Bracket `(`
* Closing Round Bracket `)`
* Less than Sign `<`
* Greater than Sign `>`
* Opening Square Bracket `[`
* Closing Square Bracket `]`
* Opening Curly Bracket `{`
* Pipe or Vertical Bar `|`
* Closing Curly Bracket `}`
You can exclude any of the pre-defined parameter(s) or include any other parameter(s) from the Plugin Settings page.
=== Encode Parameters ===
This plugin encode the following parameters in the URL if enabled from the Plugin Settings page.
* Exclamation Mark `!`
* Double Quotation `"`
* Single Quotation `'`
* Opening Round Bracket `(`
* Closing Round Bracket `)`
* Asterisk Sign `*`
* Less than Sign `<`
* Greater than Sign `>`
* Grave Accent <code>`</code>
* Cap Sign `^`
* Opening Square Bracket `[`
* Closing Square Bracket `]`
* Opening Curly Bracket `{`
* Pipe or Vertical Bar `|`
* Closing Curly Bracket `}`
You can exclude any of the pre-defined parameter(s) to being encoded from the Plugin Settings page.
=== Escape HTML in `$_GET` Variable ===
This plugin escape HTML in `$_GET` variable. `$_GET` variable is mostly used to put the values in HTML from the URL. This Check is quite useful if your site using/getting anything from the URL and printing it in HTML. It secures your Search and other sections as per your site functionality.
> NOTE: Make sure to check your forms after activating the plugin and if you have woocommerce site then please also check the cart and checkout process.
=== Bug reports ===
Bug reports for `Prevent XSS Vulnerability` are [welcomed on GitHub](https://github.com/yasglobal/prevent-xss-vulnerability). Please note GitHub is not a support forum, and issues that aren't properly qualified as bugs will be closed.
== Installation ==
This process defines you the steps to follow either you are installing through WordPress or Manually from FTP.
**From within WordPress**
1. Visit 'Plugins > Add New'
2. Search for Prevent XSS Vulnerability
3. Activate Prevent XSS Vulnerability from your Plugins page.
4. Go to "after activation" below.
**Manually**
1. Upload the `prevent-xss-vulnerability` folder to the `/wp-content/plugins/` directory
2. Activate Prevent XSS Vulnerability through the 'Plugins' menu in WordPress
3. Go to "after activation" below.
**After activation**
1. Navigate to the `Prevent XSS Vulnerability` page from the Admin Dashboard
2. Make the changes as per your site functionality
3. You're done!
== Screenshots ==
* It removes the parameters from the URL which are used in XSS Attack and redirects the user (Recommended).
* It encodes the parameters from the URL which are used in XSS Attack.
* It escapes the HTML from the `$_GET` PHP variable which is mostly used to read the data from the URL (Recommended).
* Add the message in developer console for the user to alert about the XSS attack.
* Show message in developer console to alert user about the Self-XSS attack. This message can be customized from the settings page.
== Frequently Asked Questions ==
= Q. Why should I install this plugin? =
A. Installing this plugin is the easiest way to prevent your site from XSS Vulnerability.
= Q. Does this plugin escape HTML in printing search? =
A. Yes, this plugin escape HTML in `$_GET` variable which is mostly use to print the data from the URL to HTML. If your site is using `$_GET` then it is safe and the HTML will be escaped otherwise you need to check.
= Q. Does this plugin has any conflict with any other plugin? =
A. No, this plugin doesn't have any conflict with any plugin.
== Changelog ==
= 2.0.1 - Aug 19, 22 =
* Bug
* [Please fix Notices for use in WP_DEBUG mode](https://wordpress.org/support/topic/please-fix-notices-for-use-in-wp_debug-mode/)
= 2.0.0 - Jul 14, 21 =
* Bug
* [Unable to execute bulk actions of WooCommerce orders when this plugin is enabled](https://wordpress.org/support/topic/unable-to-execute-bulk-actions-of-woocommerce-orders-when-this-plugin-is-enabled/)
* [Bulk actions dont work (ie bulk delete pages, images)](https://wordpress.org/support/topic/bulk-actions-dont-work-ie-bulk-delete-pages-images/)
* [Facing conflict issue while perform bulk delete option on post](https://wordpress.org/support/topic/facing-conflict-issue-while-perform-bulk-delete-option-on-post/)
* Enhancements
* [Include other/extra parameters](https://github.com/samiahmedsiddiqui/prevent-xss-vulnerability/issues/3)
* Fixed WPCS issues
= Earlier versions =
* For the changelog of earlier versions, please refer to the separate changelog.txt file.