|
1 | 1 | ### PowerSploit is a collection of Microsoft PowerShell modules that can be used to aid penetration testers during all phases of an assessment. PowerSploit is comprised of the following modules and scripts:
|
2 | 2 |
|
3 |
| -### Note: All reverse engineering components of PowerSploit now reside in the [PowerShellArsenal](https://github.com/mattifestation/PowerShellArsenal). |
4 |
| - |
5 | 3 | ## CodeExecution
|
6 | 4 |
|
7 | 5 | **Execute code on a target machine.**
|
@@ -92,7 +90,7 @@ Copies a file from an NTFS partitioned volume by reading the raw volume and pars
|
92 | 90 |
|
93 | 91 | #### `Invoke-Mimikatz`
|
94 | 92 |
|
95 |
| -Reflectively loads Mimikatz 1.0 in memory using PowerShell. Can be used to dump credentials without writing anything to disk. Can be used for any functionality provided with Mimikatz. |
| 93 | +Reflectively loads Mimikatz 2.0 in memory using PowerShell. Can be used to dump credentials without writing anything to disk. Can be used for any functionality provided with Mimikatz. |
96 | 94 |
|
97 | 95 | #### `Get-Keystrokes`
|
98 | 96 |
|
@@ -197,6 +195,15 @@ For help on each individual command, Get-Help is your friend.
|
197 | 195 |
|
198 | 196 | Note: The tools contained within this module were all designed such that they can be run individually. Including them in a module simply lends itself to increased portability.
|
199 | 197 |
|
| 198 | +## Contribution Rules |
| 199 | + |
| 200 | +We need contributions! If you have a great idea for PowerSploit, we'd love to add it. New additions will require the following: |
| 201 | + |
| 202 | +* The script must adhere to the style guide. Any exceptions to the guide line would need an explicit, valid reason. |
| 203 | +* The module manifest needs to be updated to reflect the new function being added. |
| 204 | +* A brief description of the function should be added to this README.md |
| 205 | +* Pester tests must accompany all new functions. See the Tests folder for examples but we are looking for tests that at least cover the basics by testing for expected/unexpected input/output and that the function exhibits desired functionality. Make sure the function is passing all tests (preferably in mutiple OSes) prior to submitting a pull request. Thanks! |
| 206 | + |
200 | 207 | ## Script Style Guide
|
201 | 208 |
|
202 | 209 | **For all contributors and future contributors to PowerSploit, I ask that you follow this style guide when writing your scripts/modules.**
|
@@ -238,4 +245,4 @@ Note: The tools contained within this module were all designed such that they ca
|
238 | 245 |
|
239 | 246 | * Use default values for your parameters when it makes sense. Ideally, you want a script that will work without requiring any parameters.
|
240 | 247 |
|
241 |
| -* If a script creates complex custom objects, include a ps1xml file that will properly format the object's output. |
| 248 | +* If a script creates complex custom objects, include a ps1xml file that will properly format the object's output. |
0 commit comments