Quasar/README.md

# QuasarRAT

[![Build status](https://ci.appveyor.com/api/projects/status/5857hfy6r1ltb5f2?svg=true)](https://ci.appveyor.com/project/MaxXor/quasarrat) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)

**Free, Open-Source Remote Administration Tool for Windows**

Quasar is a fast and light-weight remote administration tool coded in C#. Providing high stability and an easy-to-use user interface, Quasar is the perfect remote administration solution for you.

## Features
* TCP network stream (IPv4 & IPv6 support)
* Fast network serialization (NetSerializer)
* Compressed (QuickLZ) & Encrypted (AES-128) communication
* Multi-Threaded
* UPnP Support
* No-Ip.com Support
* Visit Website (hidden & visible)
* Show Messagebox
* Task Manager
* File Manager
* Startup Manager
* Remote Desktop
* Remote Webcam
* Remote Shell
* Download & Execute
* Upload & Execute
* System Information
* Computer Commands (Restart, Shutdown, Standby)
* Keylogger (Unicode Support)
* Reverse Proxy (SOCKS5)
* Password Recovery (Common Browsers and FTP Clients)
* Registry Editor

## Requirements
* .NET Framework 4.0 Client Profile ([Download](https://www.microsoft.com/en-us/download/details.aspx?id=24872))
* Supported Operating Systems (32- and 64-bit)
  * Windows XP SP3
  * Windows Server 2003
  * Windows Vista
  * Windows Server 2008
  * Windows 7
  * Windows Server 2012
  * Windows 8/8.1
  * Windows 10

## Compiling
Open the project in Visual Studio and click build, or use one of the batch files included in the root directory.

| Batch file        | Description
| ----------------- |:-------------
| build-debug.bat   | Builds the application using the debug configuration (for testing)
| build-release.bat | Builds the application using the release configuration  (for publishing)

## Building a client
| Build configuration         | Description
| ----------------------------|:-------------
| debug configuration         | The pre-defined [Settings.cs](/Client/Config/Settings.cs) will be used. The client builder does not work in this configuration. You can execute the client directly with the specified settings.
| release configuration       | Use the client builder to build your client otherwise it is going to crash.

## ToDo
* [Open Issues](https://github.com/quasar/QuasarRAT/issues)

## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)

## Roadmap
See [ROADMAP.md](ROADMAP.md)

## License
See [LICENSE](LICENSE)

## Third-party libraries
NetSerializer  
Copyright (c) 2015 Tomi Valkeinen  
https://github.com/tomba/netserializer

ResourceLib  
Copyright (c) 2008-2013 Daniel Doubrovkine, Vestris Inc.  
https://github.com/dblock/resourcelib

GlobalMouseKeyHook  
Copyright (c) 2004-2015 George Mamaladze  
https://github.com/gmamaladze/globalmousekeyhook

Mono.Cecil  
Copyright (c) 2008 - 2015 Jb Evain  
Copyright (c) 2008 - 2011 Novell, Inc.  
https://github.com/jbevain/cecil

Mono.Nat  
Copyright (c) 2006 Alan McGovern  
Copyright (c) 2007 Ben Motmans  
https://github.com/nterry/Mono.Nat

## Thank you!
I really appreciate all kinds of feedback and contributions. Thanks for using and supporting Quasar!
Added Roadmap 2018-07-03 18:02:25 +00:00			`# QuasarRAT`

			`[![Build status](https://ci.appveyor.com/api/projects/status/5857hfy6r1ltb5f2?svg=true)](https://ci.appveyor.com/project/MaxXor/quasarrat) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)`
AppVeyor CI Integration closes #86 2015-05-06 13:45:48 +00:00
Begin renaming xRAT to Quasar 2015-08-19 18:01:23 +00:00			`Free, Open-Source Remote Administration Tool for Windows`
Initial commit 2014-07-08 12:27:59 +00:00
Begin renaming xRAT to Quasar 2015-08-19 18:01:23 +00:00			`Quasar is a fast and light-weight remote administration tool coded in C#. Providing high stability and an easy-to-use user interface, Quasar is the perfect remote administration solution for you.`
Edited Readme 2015-05-04 15:02:32 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## Features`
Updated README.md 2016-07-07 21:22:53 +00:00			`* TCP network stream (IPv4 & IPv6 support)`
Edited Readme 2015-08-08 16:21:40 +00:00			`* Fast network serialization (NetSerializer)`
Edited README 2015-04-21 18:28:14 +00:00			`* Compressed (QuickLZ) & Encrypted (AES-128) communication`
Initial commit with everything else 2014-07-08 12:58:53 +00:00			`* Multi-Threaded`
Updated README.md 2014-07-31 19:07:52 +00:00			`* UPnP Support`
Improved No-Ip.com Updater - Removed getting own WANIP before sending the No-Ip update request, it will either way take the connecting WANIP according to https://www.noip.com/integrate/response 2015-07-10 17:50:41 +00:00			`* No-Ip.com Support`
Initial commit with everything else 2014-07-08 12:58:53 +00:00			`* Visit Website (hidden & visible)`
			`* Show Messagebox`
			`* Task Manager`
			`* File Manager`
Forogt to add Startup Manager to features in README 2015-03-08 17:09:31 +00:00			`* Startup Manager`
Initial commit with everything else 2014-07-08 12:58:53 +00:00			`* Remote Desktop`
Added Remote Webcam as feature in readme.md 2016-06-14 09:59:26 +00:00			`* Remote Webcam`
Updated README.md 2014-07-23 21:34:52 +00:00			`* Remote Shell`
Initial commit with everything else 2014-07-08 12:58:53 +00:00			`* Download & Execute`
Updated README.md 2014-07-31 18:52:00 +00:00			`* Upload & Execute`
Initial commit with everything else 2014-07-08 12:58:53 +00:00			`* System Information`
Added Computer Commands: Restart, Shutdown, Standby Updated Readme 2014-07-22 19:52:07 +00:00			`* Computer Commands (Restart, Shutdown, Standby)`
Edited Readme 2015-08-08 16:21:40 +00:00			`* Keylogger (Unicode Support)`
			`* Reverse Proxy (SOCKS5)`
Added FileZilla Password Recovery (thx to SandPox) #329 2015-08-17 11:26:09 +00:00			`* Password Recovery (Common Browsers and FTP Clients)`
Updated Readme 2016-02-09 17:26:31 +00:00			`* Registry Editor`
Initial commit with everything else 2014-07-08 12:58:53 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## Requirements`
Updated Readme 2015-08-26 13:54:43 +00:00			`* .NET Framework 4.0 Client Profile ([Download](https://www.microsoft.com/en-us/download/details.aspx?id=24872))`
Edited Readme 2015-06-20 19:24:03 +00:00			`* Supported Operating Systems (32- and 64-bit)`
Updated Readme 2015-08-26 13:54:43 +00:00			`* Windows XP SP3`
Edited Readme 2015-06-20 19:24:03 +00:00			`* Windows Server 2003`
			`* Windows Vista`
			`* Windows Server 2008`
			`* Windows 7`
			`* Windows Server 2012`
			`* Windows 8/8.1`
Edited Readme 2015-07-31 19:50:01 +00:00			`* Windows 10`
Edited Readme 2015-06-20 19:24:03 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## Compiling`
Updated README.md 2015-03-12 10:03:33 +00:00			`Open the project in Visual Studio and click build, or use one of the batch files included in the root directory.`

			`\| Batch file \| Description`
			`\| ----------------- \|:-------------`
			`\| build-debug.bat \| Builds the application using the debug configuration (for testing)`
			`\| build-release.bat \| Builds the application using the release configuration (for publishing)`

Added Roadmap 2018-07-03 18:02:25 +00:00			`## Building a client`
Updated README.md 2015-03-12 10:03:33 +00:00			`\| Build configuration \| Description`
			`\| ----------------------------\|:-------------`
			`\| debug configuration \| The pre-defined [Settings.cs](/Client/Config/Settings.cs) will be used. The client builder does not work in this configuration. You can execute the client directly with the specified settings.`
			`\| release configuration \| Use the client builder to build your client otherwise it is going to crash.`

Added Roadmap 2018-07-03 18:02:25 +00:00			`## ToDo`
Updated Readme 2015-08-25 19:16:32 +00:00			`* [Open Issues](https://github.com/quasar/QuasarRAT/issues)`
Initial commit with everything else 2014-07-08 12:58:53 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## Contributing`
			`See [CONTRIBUTING.md](CONTRIBUTING.md)`
Edited Readme 2015-05-04 15:02:32 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## Roadmap`
			`See [ROADMAP.md](ROADMAP.md)`
Initial commit with everything else 2014-07-08 12:58:53 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## License`
			`See [LICENSE](LICENSE)`
Initial commit with everything else 2014-07-08 12:58:53 +00:00
Added Roadmap 2018-07-03 18:02:25 +00:00			`## Third-party libraries`
Switched from ProtoBuff to NetSerializer NetSerializer should be slightly faster than Protocol Buffers 2015-08-08 14:21:09 +00:00			`NetSerializer`
			`Copyright (c) 2015 Tomi Valkeinen`
			`https://github.com/tomba/netserializer`
Added changeable Assembly Information to Builder - Made xml settings more robust - Added ResourceLib - Changed Version displaying 2014-07-24 13:23:44 +00:00
Fixed new lines 2015-07-10 18:41:20 +00:00			`ResourceLib`
Switched from ProtoBuff to NetSerializer NetSerializer should be slightly faster than Protocol Buffers 2015-08-08 14:21:09 +00:00			`Copyright (c) 2008-2013 Daniel Doubrovkine, Vestris Inc.`
Added changeable Assembly Information to Builder - Made xml settings more robust - Added ResourceLib - Changed Version displaying 2014-07-24 13:23:44 +00:00			`https://github.com/dblock/resourcelib`
Edited Readme 2015-05-04 15:02:32 +00:00
Fixed new lines 2015-07-10 18:41:20 +00:00			`GlobalMouseKeyHook`
Switched from ProtoBuff to NetSerializer NetSerializer should be slightly faster than Protocol Buffers 2015-08-08 14:21:09 +00:00			`Copyright (c) 2004-2015 George Mamaladze`
Updated README to reflect changes Updated README to reflect the usage of George Mamaladze's work. 2015-05-21 04:38:26 +00:00			`https://github.com/gmamaladze/globalmousekeyhook`

Updated Credits in Readme 2015-07-15 17:17:43 +00:00			`Mono.Cecil`
Added Roadmap 2018-07-03 18:02:25 +00:00			`Copyright (c) 2008 - 2015 Jb Evain`
			`Copyright (c) 2008 - 2011 Novell, Inc.`
Edited Readme 2015-07-10 18:39:23 +00:00			`https://github.com/jbevain/cecil`

Updated Credits in Readme 2015-07-15 17:17:43 +00:00			`Mono.Nat`
Added Roadmap 2018-07-03 18:02:25 +00:00			`Copyright (c) 2006 Alan McGovern`
			`Copyright (c) 2007 Ben Motmans`
Updated Credits in Readme 2015-07-15 17:17:43 +00:00			`https://github.com/nterry/Mono.Nat`

Added Roadmap 2018-07-03 18:02:25 +00:00			`## Thank you!`
Begin renaming xRAT to Quasar 2015-08-19 18:01:23 +00:00			`I really appreciate all kinds of feedback and contributions. Thanks for using and supporting Quasar!`