Praetorian CLI and SDK

🔗 Chariot Platform 📖 Documentation 🔖 PyPI

Table of Contents

• Description
• Getting started
  • Prerequisites
  • Installation
  • Signing up
• Using the CLI
• Using scripts
• Developers
• Contributing
• Support
• License

Description

Praetorian CLI and SDK are open-source tools for interacting with our products and services. Currently, they support access to Chariot, our offensive security platform.
The SDK exposes the full set of APIs that the Chariot UI uses.
The CLI is a fully-featured companion to the Chariot UI.

Getting Started

Prerequisites

• Python v3.9 or above
• pip v23.0 or above

Installation

Install the Python package using this command:

pip install praetorian-cli

Signing up and configuration

1. Register for an account for Chariot using the instructions in our documentation.
2. Run praetorian configure and follow the prompts.
3. It creates ~/.praetorian/keychain.ini, which should read like this:

[United States]
name = chariot
client_id = 795dnnr45so7m17cppta0b295o
api = https://d0qcl2e18h.execute-api.us-east-2.amazonaws.com/chariot
username = [email protected]
password = 8epu9bQ2kqb8qwd.GR

For more advanced configuration options, as well as SSO. See the documentation on configuration.

Using the CLI

The CLI is a command and option utility for access to the full suite of Chariot API. See documentation for commands using the help option:

praetorian chariot --help

As an example, run the following command to retrieve the list of all assets in your account:

praetorian chariot list assets

To get detailed information about a specific asset, run:

praetorian chariot get asset <ASSET_KEY>

Using scripts

The CLI has a scripting engine for implementing more complex workflows. They add end-to-end functions as commands grouped under script. To see a list of them:

praetorian chariot script --help

For example the following command is used to ingest scan results from Nessus XML export files:

praetorian chariot script nessus-xml

You can find the list of scripts that comes with the CLI in this directory

Loading more extension scripts

In addition to scripts that are packaged with the CLI, you can point CLI to directories with scripts to further extend the CLI with those scripts. Set the PRAETORIAN_SCRIPTS_PATH environment to point to directories where you store additional extension scripts.

Developers

Both CLI and SDK is open-source in this repository. The SDK is installed along with the praetorian-cli package. You can extend Chariot by creating scripts using the SDK.

SDK

Integrate the SDK into your own Python application with the following steps:

1. Include the dependency praetorian-cli in your project.
2. Import the Chariot class from praetorian_cli.sdk.chariot import Chariot.
3. Import the Keychain class from praetorian_cli.sdk.keychain import Keychain.
4. Call any function of the Chariot class, which expose the full backend API. See example below:

from praetorian_cli.sdk.chariot import Chariot
from praetorian_cli.sdk.keychain import Keychain

chariot = Chariot(Keychain())
chariot.add('asset', dict(name='example.com', dns='example.com'))

The best place to explore the SDK is the code of the CLI, especially the handlers of the CLI

You can inspect the handler code to see how each CLI command is implemented with the SDK.

Developing scripts

If you want to take advantage of the scaffolding of the CLI, you can write fully fledged functions using the scripting engine. For developing scripts, you can refer to this readme file.

Contributing

We welcome contributions from the community, from scripts, to the core CLI and SDK. To contribute, fork this repository and following the GitHub instructions to create pull requests.

By contributing, you agree to our Code of Conduct.

Support

If you have any questions or need support, please open an issue here or reach out via [email protected].

License

This project is licensed under the MIT License - see the LICENSE file for details.