Skip to content

Commit

Permalink
TheHive-Project#803 include documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jeromeleonard committed Aug 12, 2020
1 parent 6c9d3e2 commit 44392c6
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions responders/Velociraptor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
### Velociraptor
This responder can be used to run a flow for a Velociraptor artifact. This could include gathering data, or performing initial response, as the artifact (or artifact "pack") could encompass any number of actions. The responder can be run on an observable type of `ip`, `fqdn`, or `other`, and will look for a matching client via the Velociraptor server. If a client match is found for the last seen IP, or the hostname, the responder will kick off the flow, the results will be returned, and the client ID will be added as a tag to the case and the observable.

#### Requirements
The following options are required in the Velociraptor Responder configuration:

- `velociraptor_client_config`: The path to the Velociraptor API client config.
(See the following for generating an API client config: https://www.velocidex.com/docs/user-interface/api/, and ensure the appropriate ACLs are granted to the API user).
- `velociraptor_artifact`: The name artifact you which to collect (as you would see it in the Velociraptor GUI)

0 comments on commit 44392c6

Please sign in to comment.