Skip to content

Commit

Permalink
Exapnd readme
Browse files Browse the repository at this point in the history
  • Loading branch information
UniformlyRandom committed Jun 6, 2024
1 parent 0f62c90 commit 3e9cf2c
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,42 @@
# MiniShell
A reverse shell for Windows systems that brings some convenience features.
Among them are:
+ file transfer
+ automatic reconnection attempt on connection loss
+ easy duplication of established shells
+ easy choice between cmd and powershell command interpreter
+ features can be chosen at build time (can be stripped down to a minimal shell without extra features)


# Build
+ using Visual Studio 2022

## .NET executable
+ preferably leave target framework at net46 since this should work most Windows 10 and newer system out of the box

### Build relese version
+ smaller than debug
+ debug output disabled (doesn't matter much for regula use)
```
MSBuild.exe .\MiniShell.sln /p:Configuration=Release
```
### Build debug version
```
MSBuild.exe .\MiniShell.sln /p:Configuration=Debug
```

## Native executable
+ should work on older Windows systems
+ uses the ahead-of-time compilation feature of .NET 7+ (https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/?tabs=net7%2Cwindows)
+ binaries are much larger than .NET binaries, but should work on Windows systems without .NET runtime

### Build release version
+ recommended since it saves about half in size
```
dotnet publish -r win-x64 -c Release -f net8 -p:PublishAot=true --self-contained
```

### Build debug version
```
dotnet publish -r win-x64 -c Debug -f net8 -p:PublishAot=true --self-contained
```

0 comments on commit 3e9cf2c

Please sign in to comment.