Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 2.18 KB

README.md

File metadata and controls

60 lines (35 loc) · 2.18 KB

pyintelowl

PyPI version Language grade: Python CodeFactor

Simple Client for the Intel Owl Project

2 ways to use it:

  • as a library
  • as a command line script

You can select which analyzers you want to run for every analysis you perform.

Note: To use this, you need a valid API token to interact with the IntelOwl server. Token should be created from the admin interface of IntelOwl and paste it into api_token.txt.

For additional help, we suggest to check the "How to use pyintelowl" Youtube Video by Kostas.

Library

pip3 install pyintelowl

from pyintelowl.pyintelowl import IntelOwl

Endpoints

ask_analysis_availability -> search for already available analysis

send_file_analysis_request -> send a file to be analyzed

send_observable_analysis_request -> send an observable to be analyzed

ask_analysis_result -> request analysis result by job ID

get_analyzer_configs -> get the analyzers configuration

Command line Client

Help

python3 intel_owl_client.py -h

Analyze

2 Submodules: file and observable

Sample

Example:

python3 intel_owl_client.py -k <api_token_file> -i <url> -a PE_Info -a File_Info file -f <path_to_file>

Run all available analyzers (some of them could fail if you did not implemented the required configuration in the IntelOwl server):

python3 intel_owl_client.py -k <api_token_file> -i <url> -aa file -f <path_to_file>

Observable

Example:

python3 intel_owl_client.py -k <api_token_file> -i <url> -a AbuseIPDB -a OTXQuery observable -v google.com

Get Analyzers Configuration

python3 intel_owl_client.py -k <api_token_file> -i <url> -gc