Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hakluke/hakq

A basic golang server/client for distributing tasks over multiple systems.
https://github.com/hakluke/hakq

Last synced: about 1 month ago
JSON representation

A basic golang server/client for distributing tasks over multiple systems.

Awesome Lists containing this project

README 

        
# hakq

A basic golang server/client for distributing shell commands to run over multiple systems.



# Note

This is **not ready for production use**. It's an absolute bare-bones implementation of what I'm trying to achieve, and it's probably full of bugs. I'm hoping that opening this up to the community will mean that the project can be worked on by many, making it more secure, stable and feature-rich over time.



# What is hakq?

The ultimate goal of this project is to provide a very simple way to distribute many shell commands quickly and easily over many different systems. This has many different uses, but I started designing it with large scale infrastructure scanning in mind. For example, let's say you wrote a python script that scans for a particular vulnerability, and the usage looks like this:

```

python3 vulnscan.py 

```



And you also have a list of hosts in `hosts.txt`. You want to scan all of the hosts in `hosts.txt` with the python script. There are a few ways to do this, firstly you could use a bash loop:

```

cat hosts.txt | while read host; do python3 vulnscan.py $host; done

```



The problem is, this is super slow and single threaded. Another option is to use a threading wrapper like interlace or GNU parallel:

```

cat hosts.txt | parallel -j 50 "python3 vulnscan.py"

OR 

interlace -tL ./hosts.txt -threads 50 -c "python3 vulnscan.py _target_"

```



Now you're running at 50 threads, but if you're scanning millions of hosts it will still be very slow, because you are still throttled by the internet connection on the machine that it's running on. 



To resolve this, you can use hakq to distribute the commands over multiple machines.



# Installation



At present, this repo just contains two golang files, you need to build them:



```

git clone https://github.com/hakluke/hakq

cd hakq

go build client.go

go build server.go

```



You should now have two binary files, `client` and `server`.



# Usage



First you will need to create a certificate:

```

openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout key.pem -out cert.pem

```

Note that as this cert is self-signed, you will need to use the `--insecure` flag on the client. As an alternative, you can actually create a signed certificate and use this securely.



## SECURITY WARNING

Running these scripts on your machine in an insecure way (i.e. using the --insecure flag, or using a bad password) is the equivalent to providing someone RCE on your machine. Be careful! Use a strong password, avoid the `--insecure` flag, and segment your network.



To get things running, you will need a server and a client. They can even be the same computer.



On the server:

```

./server --port 1234 --password 

```



On the client:

```

./client --server :1234 --password 

```

Note: if your cert is self-signed, you will need to also add `--insecure`, which is a bad idea.



# Contributions

Please contribute to this project - it needs many features and bug fixes. Check the issues tab for some ideas!

Contributions should be made by forking this project, adding your code to the fork, and then doing a pull request.



# Found a bug?

- Firstly, make sure you're using the most up to date code. If not, update and see if it has been fixed.

- Secondly, make sure you're using the latest golang. The most common thing I see people do it install a LTS version of Ubuntu, and then install the "latest" golang from the apt repos, which isn't actually the latest. Currently the latest is 1.14.5.

- If you're sure there's a bug in the latest code, create a issue on this repo. Even better, if you can fix it, make a PR!



# Setting up TLS

You will need to generate a key pair so that your comms between the server/client are encrypted. In order to do so, on the server, create a key pair in the current directory. You can achieve this using the following command (or just use --insecure if you're feeling lucky):



```

openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout key.pem -out cert.pem

```