Client and Library for Intel Owl
Project description
pyintelowl
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.
For additional help, we suggest to check the "How to use pyintelowl" Youtube Video by Kostas.
Generate API key
You need a valid API key to interact with the IntelOwl server.
Keys should be created from the admin interface of IntelOwl: you have to go in the Durin section (click on Auth tokens
) and generate a key there.
You can use the with the parameter -k <api_key>
from CLI
(old auth method) JWT Token Authentication
this auth was available in IntelOwl versions <1.8.0 and pyintelowl versions <2.0.0
From the admin interface of IntelOwl, you have to go in the Outstanding tokens section and generate a token there.
You can use it by pasting it into the file api_token.txt.
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> -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> -i <url> -aa file -f <path_to_file>
Observable
Example:
python3 intel_owl_client.py -k <api_token> -i <url> -a AbuseIPDB -a OTXQuery observable -v google.com
Get Analyzers Configuration
python3 intel_owl_client.py -k <api_token> -i <url> -gc
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyintelowl-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da86235ec7ee4cb5311569f8acd5e58c50005803b4da6de1c5028d0c0382391f |
|
MD5 | 11d409ba87b20ce7c7ce57c834c1bd7a |
|
BLAKE2b-256 | 271455630e7798fa3dd67fafe7f40606485f25b238287d8b97aa77b4a03f56c0 |