Skip to main content

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. By default the salt.minion heist manager is available when installing heist. Another 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, deploy a 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`.

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-5.0.0.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

heist-5.0.0-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: heist-5.0.0.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.6.8

File hashes

Hashes for heist-5.0.0.tar.gz
Algorithm Hash digest
SHA256 3fbf2e2dd8c7381d22f5e346ab923e20f9cc07ad4ba4ee1df25552db7d8c93ac
MD5 ff9cb8c114a2da583cf44ca422c66252
BLAKE2b-256 c99054503ede70cb880f4a07e43dce3e8a377ad3d9959ff9d7f1a3839180b307

See more details on using hashes here.

File details

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

File metadata

  • Download URL: heist-5.0.0-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.6.8

File hashes

Hashes for heist-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 46f637c8a267a99891303b9599a3c8cf2dd7d0b3dcb5d2230b0962aca16b809e
MD5 98fb6d4d66e54416c0bbe8b754cec42e
BLAKE2b-256 a4f133e1c72e96576901aaacd11ab01185de39b9c5ab9d2337042f86cd11ca11

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