Skip to content

Commit

Permalink
Update analyzer_requirements.md
Browse files Browse the repository at this point in the history
  • Loading branch information
megan201296 authored Aug 25, 2017
1 parent 783dba8 commit 48e0dd0
Showing 1 changed file with 121 additions and 3 deletions.
124 changes: 121 additions & 3 deletions analyzer_requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,116 @@ This document outlines the different information that needs to be provided for e
**Configuration Paramenters**: None

### CuckooSandbox
**Configuration Paramenters**: <fill in>
**Configuration Paramenters**: Url

The CuckooSandbox analyzer requires you to have a local instance of Cuckoo Sandbox deployed. It is an open-source tool that is free for use but needs to be manually deployed in your environment. More information on setting up Cuckoo Sandbox can be found [here](https://cuckoosandbox.org/).

### File_Info
**Configuration Paramenters**: None

### FireHOL Blocklist
**Configuration Paramenters**: Path to FireHOL blocklists

FireHOL blocklists can be downloaded from [here](https://iplists.firehol.org)

### Fortiguard
**Configuration Paramenters**: None

### Google SafeBrowsing
**Configuration Paramenters**: API Key

An account with Google is required to get an API key.

### Hippocampe
**Configuration Paramenters**: Url

The Hippocampe analyzer requires you to have a local instance of Hippocampe deployed/configured. It is an open-source tool that is free for use but needs to be manually deployed in your environment. More information on setting up Hippocampe can be found [here](https://github.com/CERT-BDF/Hippocampe).

### JoeSandbox
**Configuration Paramenters**: _TBD_

JoeSandbox has both a free and a paid version.

### MISP
**Configuration Paramenters**: Url, API key

The MISP analyzer requires you to have a local instance of MISP deployed/configured. It is an open-source tool that is free for use but needs to be manually deployed in your environment. More information on setting up MISP can be found [here](http://www.misp-project.org/).

### Msg_Parser
**Configuration Paramenters**: None

### OTXQuery
**Configuration Paramenters**: API Key

An account with AlienVault OTX is required to get an API key. You can sign up for an account [here](https://otx.alienvault.com).

### PassiveTotal
**Configuration Paramenters**: Username, API Key

An account with PassiveTotal is required to get an API key. You can sign up for an account [here](https://community.riskiq.com/registration).

### PhishTank
**Configuration Paramenters**: API Key

An account with PhishTank is required to get an API key. You can sign up for an account [here](https://www.phishtank.com/index.php).

### Phishing Intiative
**Configuration Paramenters**: API Key

An account with Phishing Intiative is required to get an API key. You can sign up for an account [here](https://phishing-initiative.fr/register).

### VirusTotal
**Configuration Paramenters**: API Key

An account with VirusTotal is required to get an API key. You can sign up for an account [here](https://www.virustotal.com/en/).

### Virusshare
**Configuration Paramenters**: Path to Virusshare hash lists

Virusshare hash lists can be downloaded using the `download_hashes.py` program in the Virusshare analyzer directory.

### WOT
**Configuration Paramenters**: API Key

An account with Web of Trust is required to get an API key. You can sign up for an account [here](https://www.mywot.com/en/signup?destination=profile/api).

### Yara
**Configuration Paramenters**: Path to Yara rules

You have to have Yara rules downloaded in order to use this analyzer.

### YETI
**Configuration Paramenters**: Url

The YETI analyzer requires you to have a local instance of YETI deployed/configured. It is an open-source tool that is free for use but needs to be manually deployed in your environment. More information on setting up YETI can be found [here](https://yeti-platform.github.io/).

## Paid
### DNSDB
**Configuration Paramenters**: Server name, API key

This is a paid service that can be purchased from [here](https://www.farsightsecurity.com/order-services/).

### DomainTools
**Configuration Paramenters**: Username, API key

This is a paid service that can be purchased from [here](https://www.domaintools.com/products/api-integration/). There is also a free API that can be used (needs to be set to free in analyzer config) and does not require a username/API key.

### MaxMind
**Configuration Paramenters**: _TBD_

This is a paid service that can be purchased from [here](https://www.maxmind.com/en/home).

### Nessus
**Configuration Paramenters**: Url, login, password, policy

This is a paid service that can be purchased from [here](https://www.tenable.com/products/nessus-vulnerability-scanner).

### VMRay
**Configuration Paramenters**: Url, API key

This is a paid service that can be purchased from [here](https://www.vmray.com/).



## Special Access

Expand All @@ -27,7 +132,20 @@ command to perform the pDNS requests.
```

### CIRCLPassiveDNS
**Configuration Paramenters**:
**Configuration Paramenters**: Username, Password

From [CIRCL](https://www.circl.lu/services/passive-dns/)
```
Access to CIRCL Passive DNS is only allowed to trusted partners in Luxembourg and abroad.
Contact us if you would like access. Include your affiliation and the foreseen use of the
Passive DNS data.
```

### CIRCLPassiveSSL
**Configuration Paramenters**:
**Configuration Paramenters**: Username, Password

From [CIRCL](https://www.circl.lu/services/passive-ssl/)
```
Access to CIRCL Passive SSL is allowed to partners including security researchers or
incident analysts worldwide. Contact us if you would like to obtain access.
```

0 comments on commit 48e0dd0

Please sign in to comment.