For interacting with the Chariot API
Project description
Praetorian CLI and SDK
:link: Chariot Platform :book: Documentation :bookmark: PyPI :computer: Chariot UI
Table of Contents
- Description
- Getting Started
- Using the CLI
- Developer SDK
- Extending the CLI with script plugins
- Contributing
- Support
- License
Description
Praetorian CLI and SDK are open-source tools for interacting with our products and services. Currently, they support command line and developer access to Chariot, our offensive security platform. The SDK exposes the full set of API that the Chariot UI uses. The CLI is a fully-featured companion to the Chariot UI.
Getting Started
Prerequisites
- Python v3.8 or above
pip
v23.0 or above
Installation
Install the Python package using this command:
pip install praetorian-cli
Signing up
- Register for an account for Chariot using the instructions in our documentation.
- Download the keychain file using this link.
- Place the keychain file at
~/.praetorian/keychain.ini
. - Add your username and password to the keychain file. Your file should read like this:
[United States]
name = chariot
client_id = 795dnnr45so7m17cppta0b295o
api = https://d0qcl2e18h.execute-api.us-east-2.amazonaws.com/chariot
username = lara.lynch@acme.com
password = 8epu9bQ2kqb8qwd.GR
Using the CLI
The CLI is a command and option utility for access to the full suite of Chariot API. Get quick help
with the help
command:
praetorian chariot --help
As an example, run the following command to retrieve the list of all seeds in your account:
praetorian chariot list seeds
To get detailed information about a specific seed, run:
praetorian chariot get seed <SEED_KEY>
To try one of our plugin scripts, run:
praetorian chariot get assets --script example
See the Contributing section for more information on how to add your own plugin scripts.
For more examples, visit our documentation.
Developer SDK
The Praetorian SDK is installed along with the praetorian-cli
package. Integrate the SDK into your
own Python application with the following steps:
- Include the dependency
praetorian-cli
in your project. - Import the Chariot class
from praetorian_cli.sdk.chariot import Chariot
. - Import the Keychain class
from praetorian_cli.sdk.keychain import Keychain
. - 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('seed', dict(dns='example.com', status='AS'))
You can see example usages of the SDK in the handlers of the CLI
For more examples and API documentation, visit our documentation.
Extending the CLI with script plugins
The CLI has a plugin system for you to extend the CLI without changing its internals. Your script is imported to the CLI context so it has full and authenticated access to the SDK.
To write a script, first clone this repoository:
$ git clone git@github.com:praetorian-inc/praetorian-cli.git
Place your scripts in the praetorian-cli/scripts/
directory in the cloned repository. There are also example
scripts in the directory.
Your script need to implement a process
function that takes 4 arguments. They are:
controller
: This object holds the authentication context and provide functions for accessing the Chariot backend APIcmd
: This dictionary holds the information of what CLI command is executed. It tells you the product, action, and type of the CLI command. For example, you can use this to find out whether it is alist
command onassets
.cli_kwargs
: This dictionary contains the additional options the user provided to the CLI, such as--details
,--term
,--page
,ASSET_KEY
, etc.output
: This is the raw output of the CLI.
Try out the hello-world
script to have a concrete look at the content of those arguments, using the following command at the root directory
of your cloned repository:
praetorian chariot list risks --details --script hello-world
A typical script use the arguments in the following manners:
- Check for input correctness using information in
cmd
andcli_kwargs
. - Parse the CLI
output
to extract relevant data. - Use the authenticated session in
controller
to further issue API calls to operate on the data.
See this in action in the
list-assets.py
and
validate-secrets.py
scripts.
Contributing
We welcome contributions from the community, from plugin 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 or reach out via support@praetorian.com.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for praetorian_cli-0.17.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82ebf65202145a3f3e00d6ff5da5e256f8ff90fb7db321acbd7a2d147b3bb400 |
|
MD5 | a416e98b210d0119ee67da6f32af94d5 |
|
BLAKE2b-256 | 9385ba1414b063fceac2e6c3c42c659e25c5f884073a21b0b16fcdfe8a2cd4b5 |