From b04c2d2932f6a8b4786a77a8465ceb09d5fd2364 Mon Sep 17 00:00:00 2001 From: Cx01N Date: Mon, 31 May 2021 19:36:17 -0400 Subject: [PATCH] updated readme --- README.md | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 5768850..8c19b1e 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,29 @@ # SharpChisel-Plugin The SharpChisel Plugin runs the Chisel server for Invoke-SharpChisel. The Powershell script loads SharpChisel which has the embeded Golang Chisel binary -- client only to save space. This plugin is entirely contained in [Empire](https://github.com/BC-SECURITY/Empire/) -and runs in the background. - -`sharpchisel [port]` - -![image](https://user-images.githubusercontent.com/20302208/97376340-5a00a300-187a-11eb-902d-ec9b75389beb.png) - -Use command `chiselserver start` to configure and start the Chisel Server. You can shutdown -the socks proxy by running the command `chiselserver stop` or by exiting Empire. Check out the original [Chisel project](https://github.com/jpillora/chisel) +and runs in the background. Use command `start` to configure and start the Chisel Server. You can shutdown +the socks proxy by running the command `stop` or by exiting Empire. Check out the original [Chisel project](https://github.com/jpillora/chisel) and [SharpChisel](https://github.com/shantanu561993/SharpChisel). - ## Getting Started * To run the plugin, you can download it fom the releases [Releases](https://github.com/BC-SECURITY/ChiselServer-Plugin/releases) page. ## Install Prerequisites: -- Empire 3.6.0+ - -1. Add ChiselServer.py and binaries to the plugins folder of Empire. Make sure to put your compiled chisel binary in the data/misc directory, calling it chiselserver_mac or chiselserver_linux depending on your platform +- Empire >= 4.0.0 +1. Add chiselserver.py to plugins folder of Empire. -![image](https://user-images.githubusercontent.com/20302208/95636534-49f85f00-0a44-11eb-87c1-754a2368febb.png) +![image](https://user-images.githubusercontent.com/20302208/120246969-b4098280-c226-11eb-9345-4ff994ee5312.png) +2. Add [Chisel binaries](https://github.com/jpillora/chisel/releases) to the /empire/server/data/misc folder. Files must be labeled as chiselserver_mac or chiselserver_linux + depending on your platform. -2. Plugins are automatically loaded into Empire as of 3.4.0, otherwise run ```plugin ChiselServer``` +![image](https://user-images.githubusercontent.com/20302208/120248850-a277a900-c22d-11eb-87e6-df3220089444.png) -![image](https://user-images.githubusercontent.com/20302208/95636737-b5dac780-0a44-11eb-9f82-34dcb66c24fe.png) +## Usage +### Client +![image](https://user-images.githubusercontent.com/20302208/120249004-3c3f5600-c22e-11eb-962c-c9107c77b624.gif) ## Contributions Plugin created by [Kevin Clark](https://gitlab.com/KevinJClark/invoke-sharpchisel/)