You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 22, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,13 @@
1
1
# How to contribute
2
2
Contributions are always welcome, however, to keep things consistent, please review the following guidelines.
3
3
4
+
## Setting up your environment
5
+
Ensure that you have Ruby >= 2.4.4 installed on your system and then install all required dependencies by opening a command prompt / terminal in the WPXF folder and running ```bundle install```.
6
+
7
+
If bundler is not present on your system, you can install it by running ```gem install bundler```.
8
+
4
9
## Update unit tests
5
-
If you change a core piece of functionality (i.e. in ```lib/wpxf/*```) then ensure the corresponding unit tests in the ```spec``` folder are updated.
10
+
If you change a core piece of functionality (i.e. in ```lib/*```) then ensure the corresponding unit tests in the ```spec``` folder are updated.
6
11
7
12
For more information on writing unit tests with RSpec, see https://relishapp.com/rspec
Ensure that you have Ruby >= 2.4.3 installed on your system and then install all required dependencies by opening a command prompt / terminal in the WPXF folder and running ```bundle install```.
8
+
<palign="center">
9
+
A Ruby framework designed to aid in the penetration testing of WordPress systems.
10
+
</p>
11
+
12
+
<hr>
13
+
14
+
### Installation
15
+
To install the latest stable build, run `gem install wpxf`.
8
16
9
-
If bundler is not present on your system, you can install it by running ```gem install bundler```.
17
+
After installation, you can launch the WordPress Exploit Framework console by running `wpxf`.
18
+
19
+
### What do I need to run it?
20
+
Ruby >= 2.4.4 is required to run WordPress Exploit Framework.
If you are experiencing errors that indicate that ```libcurl.dll``` could not be loaded, you will need to ensure the latest libcurl binary is included in your Ruby bin folder, or any other folder that is in your environment's PATH variable.
37
+
If you are experiencing errors that indicate that `libcurl.dll` could not be loaded, you will need to ensure the latest libcurl binary is included in your Ruby bin folder, or any other folder that is in your environment's PATH variable.
27
38
28
-
The latest version can be downloaded from http://curl.haxx.se/download.html. As of 16/05/2016, the latest release is marked as ```Win32 2000/XP zip 7.40.0 libcurl SSL```. After downloading the archive, extract the contents of the bin directory into your Ruby bin directory (if prompted, don't overwrite any existing DLLs).
39
+
The latest version can be downloaded from http://curl.haxx.se/download.html. As of 16/05/2016, the latest release is marked as `Win32 2000/XP zip 7.40.0 libcurl SSL`. After downloading the archive, extract the contents of the bin directory into your Ruby bin directory (if prompted, don't overwrite any existing DLLs).
29
40
30
41
### How do I use it?
31
-
Open a command prompt / terminal in the directory that you have downloaded WordPress Exploit Framework to, and start it by running ```ruby wpxf.rb```.
42
+
Start the WordPress Exploit Framework console by running `wpxf`.
32
43
33
-
Once loaded, you'll be presented with the wpxf prompt, from here you can search for modules using the ```search``` command or load a module using the ```use``` command.
44
+
Once loaded, you'll be presented with the wpxf prompt, from here you can search for modules using the `search` command or load a module using the `use` command.
34
45
35
-
Loading a module into your environment will allow you to set options with the ```set``` command and view information about the module using ```info```.
46
+
Loading a module into your environment will allow you to set options with the `set` command and view information about the module using `info`.
36
47
37
48
Below is an example of how one would load the symposium_shell_upload exploit module, set the module and payload options and run the exploit against the target.
38
49
@@ -81,7 +92,7 @@ Exploit modules require you to specify a payload which subsequently gets execute
81
92
***exec:** runs a shell command on the remote server and returns the output to the WPXF session.
82
93
***reverse_tcp:** uploads a script that will establish a reverse TCP shell.
83
94
84
-
All these payloads, with the exception of ```custom``` and the Meterpreter payloads, will delete themselves after they have been executed, to avoid leaving them lying around on the target machine after use or in the event that they are being used to establish a shell which fails.
95
+
All these payloads, with the exception of `custom` and the Meterpreter payloads, will delete themselves after they have been executed, to avoid leaving them lying around on the target machine after use or in the event that they are being used to establish a shell which fails.
85
96
86
97
### How can I write my own modules and payloads?
87
98
Guides on writing modules and payloads can be found on [The Wiki](https://github.com/rastating/wordpress-exploit-framework/wiki) and full documentation of the API can be found at http://www.getwpxf.com/.
0 commit comments