yangbh / Spark

✨Spark is a web-based, cross-platform and full-featured Remote Administration Tool (RAT) written in Go that allows you control all your devices anywhere. Spark是一个Go编写的，网页UI、跨平台以及多功能的远程控制和监控工具，你可以随时随地监控和控制所有设备。

Spark

Spark is a free, safe, open-source, web-based, cross-platform and full-featured RAT (Remote Administration Tool) that allow you to control all your devices via browser anywhere.

We won't collect any data, thus the server will never self-upgrade. Your clients will only communicate with your server forever.

[English] [中文] [API Document] [API文档]

---

---

Disclaimer

THIS PROJECT, ITS SOURCE CODE, AND ITS RELEASES SHOULD ONLY BE USED FOR EDUCATIONAL PURPOSES.
YOU SHALL USE THIS PROJECT AT YOUR OWN RISK.
THE AUTHORS AND DEVELOPERS ARE NOT RESPONSIBLE FOR ANY DAMAGE CAUSED BY YOUR MISUSE OF THIS PROJECT.

YOUR DATA IS PRICELESS. THINK TWICE BEFORE YOU CLICK ANY BUTTON OR ENTER ANY COMMAND.

---

Quick start

Only local installation are available yet.

Local installation

• Get prebuilt executable file from Releases page.

• Extract all files and do not delete built directory.

• Create a configuration file named Config.json and set your own salt.

  {
      "listen": ":8000",
      "salt": "some random string",
      "auth": {
          "username": "password"
      }
  }

• Run it and browse the address:port you've just set, for example: http://localhost:8000/.

• Generate client online and execute it on your device.

• Now you can control your device.

---

Features

Feature/OS	Windows	Linux	MacOS
Process manager	✔	✔	✔
Kill process	✔	✔	✔
Network traffic	✔	✔	✔
File explorer	✔	✔	✔
File transfer	✔	✔	✔
File editor	✔	✔	✔
Code highlight	✔	✔	✔
Delete file	✔	✔	✔
OS info	✔	✔	✔
Terminal	✔	✔	✔
Screenshot	✔	✔	✔
* Shutdown	✔	✔	✔
* Reboot	✔	✔	✔
* Hibernate	✔	❌	❌
* Sleep	✔	❌	❌
* Log off	✔	❌	❌
* Lock screen	✔	❌	❌

• Blank cell means the situation is not tested yet.
• The Star symbol means the function may need administration or root privilege.

---

Screenshots

---

Development

note

There are three components in this project, so you have to build them all.

Go to Quick start if you don't want to make yourself boring.

• Client
• Server
• Front-end

If you want to make client support OS except linux and windows, you should install some additional C compiler.

For example, to support android, you have to install Android NDK.

tutorial

# Clone this repository.
$ git clone https://github.com/XZB-1248/Spark
$ cd ./Spark


# Here we're going to build front-end pages.
$ cd ./web
# Install all dependencies and build.
$ npm install
$ npm run build-prod


# Embed all static resources into one single file by using statik.
$ cd ..
$ go install github.com/rakyll/statik
$ statik -m -src="./web/dist" -f -dest="./server/embed" -p web -ns web


# Now we should build client.
# When you're using unix-like OS, you can use this.
$ mkdir ./built
$ go mod tidy
$ go mod download
$ ./scripts/build.client.sh


# Finally we're compiling the server side.
$ mkdir ./releases
$ ./scripts/build.server.sh

Then create a new directory with a name you like.
Copy executable file inside releases to that directory.
Copy the whole built directory to that new directory.
Copy configuration file mentioned above to that new directory.
Finally, run the executable file in that directory.

---

Dependencies

Spark contains many third-party open-source projects.

Lists of dependencies can be found at go.mod and package.json.

Some major dependencies are listed below.

Back-end

• Go (License)

• gin-gonic/gin (MIT License)

• imroc/req (MIT License)

• kbinani/screenshot (MIT License)

• shirou/gopsutil (License)

• gorilla/websocket (BSD-2-Clause License)

• orcaman/concurrent-map (MIT License)

Front-end

• React (MIT License)

• Ant-Design (MIT License)

• axios (MIT License)

• xterm.js (MIT License)

• crypto-js (MIT License)

---

Stargazers over time

---

License

BSD-2 License