Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thehappydinoa committed Oct 12, 2023
1 parent fe81005 commit 728df59
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

Threatfox Censys is a tool to query [Censys Search](https://search.censys.io/) for IP addresses and domains and then parses the JSON and submits the results to Threatfox.

## Features

- Create dynamic fingerprints for various IoCs
- Fingerprint file: [`fingerprints.yaml`](fingerprints.yaml)
- Uses the Censys Search API
- Submit IoCs to ThreatFox
- Links Censys Search in ThreatFox IoC reference
- Tags IoCs with `censys` and the autonomous system name
- Uses a PostgreSQL database to store the IoCs submitted to ThreatFox

## Installation

### Prerequisites
Expand Down Expand Up @@ -82,4 +92,5 @@ Threatfox Censys is licensed under the [MIT](https://choosealicense.com/licenses
- [ ] Add more tests.
- [ ] Add more documentation.
- [ ] Add better error handling.
- [ ] Use redis for caching.
<!-- Add your idea here -->

0 comments on commit 728df59

Please sign in to comment.