Merge pull request #59 from chapinb/issue-38

VirusTotal Resolver Support
chapinb · Aug 1, 2020 · 0a470ef · 0a470ef
2 parents e08db4f + 7727472
commit 0a470ef
Show file tree

Hide file tree

Showing 46 changed files with 1,522 additions and 12,360 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 List of new features
 
 * Added support to extract IP addresses from Windows Event logs (evtx files.)
+* Support for querying VirusTotal [Issue-38](https://github.com/chapinb/chickadee/issues/38)
 
 ### Fixed
 
@@ -21,11 +22,17 @@ Modifications to existing functionality
 
 * Increased unit test coverage. Leverage mocking for API requests.
 * Improved code per Deepsource, PyCharm, and Sourcery recommendations.
+* Created function to flatten complex objects for ease of review in CSV files.
+* Renamed `backends` to `resolvers` for clarity
+* Allowed the specification of multiple resolver API keys in config file, and to choose a resolver with the CLI
+* Relocated field handling from chickadee.py to resolver files
 
 ### Removed
 
 Features removed
 
+* Depreciated ability to specify CHICKADEE_API_KEY environment variable in favor of config files
+
 ## 20200407.2
 
 This release includes:

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 Yet another IP address enrichment tool.
 
-```
+```text
          _          _
         ('<        >')
        \(_)________( \
@@ -25,10 +25,11 @@ Yet another IP address enrichment tool.
 [![PyPi downloads](https://pypip.in/d/chickadee/badge.png)](https://pypistats.org/packages/chickadee)
 [![DeepSource](https://static.deepsource.io/deepsource-badge-light-mini.svg)](https://deepsource.io/gh/chapinb/chickadee/?ref=repository-badge)
 
-Supported GeoIP back-ends:
+Supported IP address resolvers:
 
-* http://ip-api.com/ - Free to query up to 45 requests per minute. Unlimited
+* https://ip-api.com/ - Free to query up to 45 requests per minute. Unlimited
   API keys available for purchase.
+* https://virustotal.com/ - API key needed to query. Rate limited to 4 requests per minute.
 
 ## Documentation
 
@@ -41,7 +42,7 @@ Specific documentation:
 * [Using chickadee](https://chapinb.com/chickadee/utilities.html#usage)
 * [Examples](https://chapinb.com/chickadee/utilities.html#chickadee-examples)
 * [Contributing](https://chapinb.com/chickadee/index.html#contribution)
-* [Backend resolution documentation](https://chapinb.com/chickadee/backends.html)
+* [Resolver documentation](https://chapinb.com/chickadee/resolvers.html)
 * [File parser documentation](https://chapinb.com/chickadee/parsers.html)
 
 ## Known bugs

diff --git a/devscripts/build.bat b/devscripts/build.bat
@@ -0,0 +1 @@
+python setup.py sdist bdist_wheel
diff --git a/doc_src/Makefile b/doc_src/Makefile
@@ -18,3 +18,5 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	rm -rf ../docs/_sources ../docs/_static
+	mv build/html/* ../docs
diff --git a/doc_src/source/backends.rst b/doc_src/source/backends.rst
diff --git a/doc_src/source/conf.py b/doc_src/source/conf.py
@@ -22,7 +22,7 @@
 author = 'Chapin Bryce'
 
 # The full version, including alpha/beta/rc tags
-release = '20200202'
+release = '20200801-rc1'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/doc_src/source/index.rst b/doc_src/source/index.rst
@@ -7,7 +7,7 @@ Chickadee Documentation
 
    utilities
    parsers
-   backends
+   resolvers
 
 .. automodule:: libchickadee
    :members:

diff --git a/doc_src/source/resolvers.rst b/doc_src/source/resolvers.rst
@@ -0,0 +1,18 @@
+Resolvers
+*********
+
+.. automodule:: libchickadee.resolvers
+   :members:
+
+.. automodule:: libchickadee.resolvers.ipapi
+   :members:
+
+.. automodule:: libchickadee.resolvers.virustotal
+   :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_sources/backends.rst.txt b/docs/_sources/backends.rst.txt
diff --git a/docs/_sources/chickadee.rst.txt b/docs/_sources/chickadee.rst.txt
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -7,7 +7,7 @@ Chickadee Documentation
 
    utilities
    parsers
-   backends
+   resolvers
 
 .. automodule:: libchickadee
    :members:

diff --git a/docs/_sources/parsers.rst.txt b/docs/_sources/parsers.rst.txt
@@ -7,7 +7,8 @@ Parsers
    :members:
 .. automodule:: libchickadee.parsers.xlsx
    :members:
-
+.. automodule:: libchickadee.parsers.evtx
+   :members:
 
 Indices and tables
 ==================

diff --git a/docs/_sources/resolvers.rst.txt b/docs/_sources/resolvers.rst.txt
@@ -0,0 +1,18 @@
+Resolvers
+*********
+
+.. automodule:: libchickadee.resolvers
+   :members:
+
+.. automodule:: libchickadee.resolvers.ipapi
+   :members:
+
+.. automodule:: libchickadee.resolvers.virustotal
+   :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`