Artifact Exchange

Documentation

Artifacts

Artifact Exchange

The Velociraptor artifact exchange is a place for sharing community-contributed artifacts. You can use the Search function on this page to see if anyone has contributed an artifact that might address your need.

Security of the exchange

The exchange is not officially supported by the Velociraptor team and contains community contributions, so the quality and security of its artifacts are not guaranteed. Some artifacts fetch external binaries and run them on your endpoints, and those binaries are not reviewed or endorsed by the Velociraptor team or Rapid7.

Collecting any exchange artifact is purely at your own risk. Review artifacts carefully before deploying them on your network.

How to use the Exchange

[click to expand]

Importing the artifact exchange

You can import the entire content of the artifact exchange into your server’s artifact repository by running the built-in Server.Import.Extras artifact (which is also linked on the Velociraptor Welcome screen). This artifact allows you to choose to import additional artifacts from several external projects.

Alternatively, you can download the exchange artifacts in the form of a zipped artifact pack, that you can manually import via the Velocirator GUI (navigate to View Artifacts and click the Upload Artifact Pack button, as explained here).

Importing individual artifacts

Be aware that a bulk import of the exchange will add several hundred artifacts of which many will likely be inapplicable to your particular environment, so if you’re just looking for something specific then you might prefer to copy individual artifacts definitions and paste them into new artifacts using the GUI’s artifact editor.

Sharing your own artifact

The artifact exchange is a central place for you to share your own artifacts with the Velociraptor community, and to search for artifacts you can use in your own work.

Exchange artifacts are held to a lower bar than built-in artifacts: for example, they usually have no tests. A contribution may therefore break at any time or not work as described. Responsibility for maintaining it rests with its author.

If you want to contribute, the contribution guidelines explain how to fork this repository and add your artifact to it.

Clicking “Contribute” below opens a new artifact file in the exchange repository. Choose a clear name for the yaml file and write a good description.

You can also add tags to your artifact by adding hash tags to the description field.

Contribute

Artifact Reference