Heist

Heist creates network tunnels for distributing and managing agents. While it has been originally built to deploy and manage Salt Minions, it can be used to distribute and manage other agents or plugins if extended to do so.

Using Heist is very easy, Start by downloading Heist. Just install via pip:

pip install heist

Heist Manager

In order to run Heist you will need to specify a Heist manager. An example of a heist manager is salt.minion but this will require a user to install the heist-salt project:

pip install heist-salt

Making Your Roster

A Roster is a file used by Heist to map login information to the systems in your environment. This file can be very simple and just needs to tell Heist where your systems are and how to log into them via ssh. Open a file called roster.cfg and add the data needed to connect to a remote system via ssh:

system_name:
  host: 192.168.4.4
  username: fred
  password: freds_password

The roster files typically all live inside of a roster directory. But to get started we will execute a single roster file with Heist using the salt.minion Heist manager:

heist salt.minion -R roster.cfg

Assuming your roster is correct, heist will now connect to the remote system and deploy the salt.minion binary.

Tear Down

Heist is able to automatically clean up as well! Just soft kill your heist application and it will reach out to all connections, tell them to remove the deployed artifacts from the target systems and stop the service! Like a proper heist these should be no evidence left behind!

Using Heist to Deploy Salt Minions

If you want to use Heist to deploy and manage Salt, you will need to install heist-salt.

Additional Documentation

If you want to read more about how to use Heist and its internals please take a look at Heist’s documentation here: https://heist.readthedocs.io/en/latest/

Metadata

Release files for heist 6.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for heist 6.3.3
File	Size	Uploaded
heist-6.3.3.tar.gz	25.2 kB	Oct 31, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for heist 6.3.3
File	Interpreter	ABI	Platform	Reset
heist-6.3.3-py3-none-any.whl 29.8 kB Oct 31, 2023	Python 3	none	any	Details

Total release size: 55.0 kB

Release files / heist-6.3.3.tar.gz

Download URL	heist-6.3.3.tar.gz
Size	25.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`808f19bffc2596dfb37e9116634421838c2d55819236a5ba6f571415402d9ea6`
BLAKE2b-256 checksum How to use checksums	`14904bc19f1632cdb6fafc203ea9138902d85aa1b31d3be565a227c1faa49570`
Upload date	Oct 31, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.8.18`

Release files / heist-6.3.3-py3-none-any.whl

Download URL	heist-6.3.3-py3-none-any.whl
Size	29.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c9c9746c14cf1c213f98711d2296b9a62ee98c53cb64b7692f9f1ba8159686bb`
BLAKE2b-256 checksum How to use checksums	`ee9d14f8d71f1e61ef90a3c05759fe95735fef5feb8cbbff9a45f8708d7b017d`
Upload date	Oct 31, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.8.18`