diff --git a/.wakatime-project b/.wakatime-project new file mode 100644 index 0000000..eb69258 --- /dev/null +++ b/.wakatime-project @@ -0,0 +1 @@ +Steep Glade 13 \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..c7366d9 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,15 @@ +FROM python:3.7 + +RUN apt update -y + +RUN apt -y install libxml2-dev libxslt-dev git vim + +WORKDIR /harpoon + +ADD . . + +RUN pip3 install . + +RUN mkdir -p ~/.config/harpoon + +RUN mv harpoon/data/harpoon_keys.conf ~/.config/harpoon/config \ No newline at end of file diff --git a/README.md b/README.md index 34513cf..6535c58 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,17 @@ pip3 install . You may want to install [harpoontools](https://github.com/Te-k/harpoontools) to have additional commands using harpoon features. +### Running as a Docker container +If you would like to run harpoon as a Docker container: + +``` +git clone https://github.com/Te-k/harpoon.git +cd harpoon +docker build -t harpoon:latest . +docker run -it harpoon:latest /bin/bash +``` +You can add your API keys in `harpoon/data/harpoon_keys.conf` so that you don't have to add the keys every time you run the docker container. + ## Configuration To configure harpoon, run `harpoon config` and fill in the needed API keys. diff --git a/harpoon/data/harpoon_keys.conf b/harpoon/data/harpoon_keys.conf new file mode 100644 index 0000000..11f77d4 --- /dev/null +++ b/harpoon/data/harpoon_keys.conf @@ -0,0 +1,149 @@ +[BinaryEdge] +key: +intel: true + +[Googl] +token: + +[Circl] +user: +pass: +intel: true + +[Twitter] +consumer_key: +consumer_secret: +access_token: +access_token_secret: + +[PassiveTotal] +username: +key: +intel: true + +[Shodan] +key: +intel: true + +[FullContact] +key: + +[Hunter] +key: + +[Censys] +id: +secret: +intel: true + +[SafeBrowsing] +key: + +[SpyOnWeb] +token: + +[Telegram] +id: +hash: +phone: + +[VirusTotal] +key: +type: public +intel: true + +[Misp] +url: +key: +intel: true + +[AlienVaultOtx] +key: +intel: true + +[TotalHash] +user: +key: +intel: true + +[HybridAnalysis] +key: +secret: +intel: false + +[MalShare] +key: +intel: true + +[ThreatGrid] +key: +intel: true + +[ThreatCrowd] +intel: true + +[CertSpotter] +id: +key: + +[Permacc] +key: + +[IPInfo] +token: + +[OpenCage] +key: + +[Dnsdb] +key: +intel: true + +[SecurityTrails] +key: +intel: true + +[NumVerify] +key: + +[UrlHaus] +key: +intel: true + +[Zetalytics] +token: +intel: true + +[Xforce] +key: +password: + +[GreyNoise] +key: +## provide a value of community or enterprise, pending on key type +api_type: community +intel: true + +[UrlScan] +intel: true +key: + +[RobTex] +intel: true + +[ThreatMiner] +intel: true + +[Quad9] +intel: true + +[Tor] +intel: true + +[PulseDive] +key: +intel: true + +[Koodous] +token: +intel: true