Skip to content

Commit 535ba7f

Browse files
committed
Readme update
1 parent 746bf70 commit 535ba7f

File tree

1 file changed

+56
-3
lines changed

1 file changed

+56
-3
lines changed

README.md

Lines changed: 56 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,67 @@ Exercise caution if you decide to use this project in a production environment;
1010

1111
## Usage
1212

13-
### Server
13+
### Server (Broadcast the Shell)
1414

1515
`SharpShellPipe.exe`
1616

1717
This is the computer you wish to access to.
1818

19-
### Client
19+
#### Options
20+
21+
| Parameter | Type | Default | Description |
22+
|---------------------|------------------|------------|--------------|
23+
| --passphrase (`-p`) | String | None | A passphrase that will enable and encrypt all traffic between the server and the client is highly recommended. |
24+
| --username | String | None | An existing Microsoft Windows local user account. |
25+
| --password | String | None | Password of specified user account. |
26+
| --domain | String | None | specify the domain of the user account under which the new process is to be started. |
27+
28+
#### Examples
29+
30+
Start the named pipe server as the current user with traffic encryption enabled:
31+
32+
```powershell
33+
SharpShellPipe.exe -p "myp4ssw0rd!"
34+
```
35+
36+
Start the named pipe server as another user (`darkcodersc`) without traffic encryption:
37+
38+
```powershell
39+
SharpShellPipe.exe --username "darkcodersc" --password "winpwd"
40+
```
41+
42+
### Client (Receive the Shell)
2043

2144
`SharpShellPipe.exe --client`
2245

23-
You will be prompted to enter the name of the computer you wish to connect to the one hosting the **SharpShellPipe** Server. To connect to the local machine, you can either enter `.` or simply press the Enter key.
46+
#### Options
47+
48+
| Parameter | Type | Default | Description |
49+
|---------------------|------------------|------------|--------------|
50+
| --client (*) | String | None | Enable client mode; server mode is the default setting. |
51+
| --name (`-n`) | String | "." | Specify the target machine name where the named pipe server is waiting for connections. By default, the connection attempt is made to the local machine. |
52+
| --passphrase (`-p`) | String | None | A passphrase that will enable and encrypt all traffic between the server and the client is highly recommended. |
53+
54+
`*` = Mandatory Options
55+
56+
#### Examples
57+
58+
Connect to the named pipe server on the local machine with traffic encryption enabled:
59+
60+
```powershell
61+
SharpShellPipe.exe --client -p "myp4ssw0rd!"
62+
```
63+
64+
Connect to the named pipe server on `Phrozen` machine without traffic encryption:
65+
66+
```powershell
67+
SharpShellPipe.exe --client --name "Phrozen"
68+
```
69+
70+
## Changelog
71+
72+
### (2025/02/21) V2.0
73+
74+
- Implement command line argument parsing instead of prompting the user.
75+
- Make several improvements and fix glitches.
76+
- It is now possible to spawn a shell as a different Windows user using RunAs.

0 commit comments

Comments
 (0)