# XZB-1248/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、跨平台以及多功 能的远程控制和监控工具，你可以随时随地监控和控制所有设 备。

**github.com/XZB-1248/Spark**

XZB-1248

**[English]** **[[中文]](https://github.com/XZB-1248/Spark/blob/master/README.ZH.md)** **[[API Document]](https://github.com/XZB-1248/Spark/blob/master/API.md)** **[[API文档]](https://github.com/XZB-1248/Spark/blob/master/API.ZH.md)**

## 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.

[repo size 29.8 MB](https://camo.githubusercontent.com/16c134fe81af67b93c8998dca47bb97f500ae1b2069ab005327a1b2f7ca75470/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f7265706f2d73697a652f4447502d53747564696f2f536e61702e47656e7368696e3f7374796c653d666c61742d737175617265) [issues 16 open](https://camo.githubusercontent.com/afa14fef15fd64662526514014e1f9c847f94e3aa88504e1feb7adaff1f39708/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f585a422d313234382f537061726b3f7374796c653d666c61742d737175617265) [issues 28 closed](https://camo.githubusercontent.com/01e852e3eb1fbdc16f93fdeb9adc4c0b8ae63d8cd1fe2ae7f698fa72e17c2d2d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732d636c6f7365642f585a422d313234382f537061726b3f7374796c653d666c61742d737175617265)

[downloads 4.1k](https://github.com/XZB-1248/Spark/releases) [downloads@latest 1.4k](https://github.com/XZB-1248/Spark/releases/latest)

## Disclaimer

**THIS PROJECT, ITS SOURCE CODE, AND ITS RELEASES SHOULD ONLY BE USED**
**FOR EDUCATIONAL PURPOSES.**

**ALL ILLEGAL USAGE IS PROHIBITED!**

**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


-----

### binary

[Download executable from releases.](https://github.com/XZB-1248/Spark/releases)
Following this to complete configuration.
Run executable and browse to http://IP:Port to access the web interface.
Generate a client and run it on your target device.
Enjoy!

## Configuration

Configuration file config.json should be placed in the same directory as the executable file.
Example:
```
{

  "listen": ":8000",

  "salt": "123456abcdefg",

  "auth": {

    "username": "password"

  },

  "log": {

    "level": "info",

    "path": "./logs",

    "days": 7

  }

}
   listen required, format: IP:Port
   salt required, length <= 24

```
after modification, you need to re-generate all clients
```
   auth optional, format: username:password

```
hashed-password is highly recommended
format: $algorithm$hashed-password, example: $sha256$123456abcdefg
supported algorithms: sha256, sha512, bcrypt
if you don't follow the format, password will be treated as plain-text
```
   log optional
      level optional, possible value: disable, fatal, error, warn, info, debug
      path optional, default: ./logs
      days optional, default: 7

## Features

```

-----

**Feature/OS** **Windows** **Linux** **MacOS**

Process manager ✔ ✔ ✔

Kill process ✔ ✔ ✔

Network traffic ✔ ✔ ✔

File explorer ✔ ✔ ✔

File transfer ✔ ✔ ✔

File editor ✔ ✔ ✔

Delete file ✔ ✔ ✔

Code highlight ✔ ✔ ✔

Desktop monitor ✔ ✔ ✔

Screenshot ✔ ✔ ✔

OS info ✔ ✔ ✔

Terminal ✔ ✔ ✔

 - Shutdown ✔ ✔ ✔

 - Reboot ✔ ✔ ✔

 - Log off ✔ ❌ ✔

 - Sleep ✔ ❌ ✔

 - Hibernate ✔ ❌ ❌

 - 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.](https://developer.android.com/ndk/downloads)

### 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)](https://github.com/golang/go)

[gin-gonic/gin (MIT License)](https://github.com/gin-gonic/gin)


-----

[imroc/req (MIT License)](https://github.com/imroc/req)

[kbinani/screenshot (MIT License)](https://github.com/kbinani/screenshot)

[shirou/gopsutil (License)](https://github.com/shirou/gopsutil)

[gorilla/websocket (BSD-2-Clause License)](https://github.com/gorilla/websocket)

[orcaman/concurrent-map (MIT License)](https://github.com/orcaman/concurrent-map)

### Front-end

[React (MIT License)](https://github.com/facebook/react)

[Ant-Design (MIT License)](https://github.com/ant-design/ant-design)

[axios (MIT License)](https://github.com/axios/axios)

[xterm.js (MIT License)](https://github.com/xtermjs/xterm.js)

[crypto-js (MIT License)](https://github.com/brix/crypto-js)

### Acknowledgements

[natpass (MIT License)](https://github.com/lwch/natpass)
Image difference algorithm inspired by natpass.

### Stargazers over time

rate limited, please try again later

## License

[BSD-2 License](https://github.com/XZB-1248/Spark/blob/master/LICENSE)


-----