Agent Trufflehog

TruffleHog is a fast secret scanner.

This repository is an implementation of OXO Agent for the TruffleHog Scanner by Truffle security.

Getting Started

To perform your first scan, simply run the following command:

oxo scan run --install --agent agent/ostorlab/trufflehog file [YOUR_TARGET_FILE]

This command will download and install agent/ostorlab/trufflehog and scan upir target file for secrets. For more information, please refer to the OXO Documentation

Usage

Agent TruffleHog can be installed directly from the oxo agent store or built from this repository.

Install directly from oxo agent store

oxo agent install agent/ostorlab/trufflehog

You can then run the agent with the following command:

oxo scan run --agent agent/ostorlab/trufflehog file [YOUR_TARGET_FILE]

Build directly from the repository

To build the nuclei agent you need to have oxo installed in your machine. If you have already installed oxo, you can skip this step.

pip3 install ostorlab

Clone this repository.

git clone git@github.com:Ostorlab/agent_trufflehog.git && cd agent_trufflehog

Build the agent image using oxo cli.

oxo agent build --file=ostorlab.yaml

You can pass the optional flag --organization or -o to specify your organisation. The organization is empty by default.

Run the agent using on of the following commands:
- If you did not specify an organization when building the image:
```
oxo scan run --agent agent//trufflehog file [YOUR_TARGET_FILE]
```
- If you specified an organization when building the image:
```
oxo scan run --agent agent/[ORGANIZATION]/trufflehog file [YOUR_TARGET_FILE]
```

License

Apache