Welcome!

Intrigue-core is a framework for automated attack surface discovery. There are a number of use cases:

• Application and Infrastructure (Asset) Discovery
• Security Research and Vulnerability Discovery
• Malware Campaign Research & Indicator Enrichment
• Exploratory OSINT Research

If you'd like assistance getting started or have development-related questions, feel free to join us in the chat.

Users

If you just want to get started and play around with an instance, have a look at the Getting Started Guide

Developers

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

Setting up a development environment

Follow the appropriate setup guide:

• Vagrant (preferred) - http://intrigue.io/getting-started-with-intrigue-core-on-vagrant-virtualbox/
• Docker - https://intrigue.io/2017/03/07/using-intrigue-core-with-docker/

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: http://intrigue.io/up-and-running/

Configuring the system

Many tasks work via external APIs and thus require configuration of 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. These keys are ultimately stored in the file: config/config.json.

The API

Intrigue-core is built API-first, allowing all functions in the UI to be easily automated. The following methods for automation are provided.

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:

## core-cli.rb start [Project Name] [Task] [Type#Entity] [Depth] [Option1=Value1#...#...] [Handlers] [Strategy Name] [Auto Enrich]
$ bundle exec ./core-cli.rb start new_project create_entity DnsRecord#intrigue.io 3
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": "create_entity", "entity": { "type": "DnsRecord", "attributes": { "name": "intrigue.io" } }, "options": {} }' http://127.0.0.1:7777/results

API Client (Ruby Gem)

A Ruby gem is provided for your convenience: