/intrigue-core

Discover your attack surface!

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Welcome!

Intrigue-core is a framework for automated attack surface discovery, written in Ruby.

If you'd like assistance getting started or have development-related questions, see the Getting Started documentation and/or join us in the chat.

Developer Setup

To get started setting up a development environment, follow the instructions below!

Setting up a development environment

Follow the appropriate setup guide:

Now that you have a working environment, browse to the web interface.

Using the web interface

To use the web interface, browse to http://127.0.0.1:7777. Once you're able to connect, you can follow the instructions here: https://intrigue.io/2017/03/07/using-intrigue-core-with-docker/

Configuring the system

Many modules require API keys. To set them up, browse to the "Configure" tab and click on the name of the module. You will be taken to the relevant signup page where you can provision an API key.

API usage via core-cli:

A command line utility has been added for convenience, core-cli.

List all available tasks:

$ bundle exec ./core-cli.rb list

Start a task:

$ bundle exec ./core-cli.rb background Default dns_brute_sub DnsRecord#intrigue.io 1 
Got entity: {"type"=>"DnsRecord", "name"=>"intrigue.io", "details"=>{"name"=>"intrigue.io"}}
Task Result: {"result_id":66103}

API usage via curl:

You can use curl to drive the framework. See the example below:

$ curl -s -X POST -H "Content-Type: application/json" -d '{ "task": "example", "entity": { "type": "String", "attributes": { "name": "8.8.8.8" } }, "options": {} }' http://127.0.0.1:7777/results

Ruby gem for the API:

Gem Version