Skip to main content

Pluggable ephemeral software tunneling and delivery system

Project description

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/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

heist-7.0.1.tar.gz (25.4 kB view details)

Uploaded Source

Built Distribution

heist-7.0.1-py3-none-any.whl (29.9 kB view details)

Uploaded Python 3

File details

Details for the file heist-7.0.1.tar.gz.

File metadata

  • Download URL: heist-7.0.1.tar.gz
  • Upload date:
  • Size: 25.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/41.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.5 tqdm/4.66.1 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.18

File hashes

Hashes for heist-7.0.1.tar.gz
Algorithm Hash digest
SHA256 7fd1deb2d6e62ca747a5bb8dd087b47d37a0db30d0a85b2280878dc9e2eb7f1d
MD5 efa3eb2d21a68386b33726943cc18bf8
BLAKE2b-256 a35ed197d8126dfc34a99bc13b27fa84ac3843d655930c7f731b5c570a06ea8d

See more details on using hashes here.

File details

Details for the file heist-7.0.1-py3-none-any.whl.

File metadata

  • Download URL: heist-7.0.1-py3-none-any.whl
  • Upload date:
  • Size: 29.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/41.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.5 tqdm/4.66.1 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.18

File hashes

Hashes for heist-7.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 39323fd84442beebc14554c4b0c96d833efaa1cf8d692673eba3e393bb800480
MD5 e1f85f6ba7e7848286453546ce35b174
BLAKE2b-256 a921d68a32d7b0c2d5354684f20ea301d0c5e17d28f986b39e325d14030959cf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page