Robust Python SDK and CLI for IntelOwl's API
Project description
PyIntelOwl
Robust Python SDK and Command Line Client for interacting with IntelOwl's API.
Features
- Easy one-time configuration with self documented help and hints along the way.
- Request new analysis for observables and files.
- Select which analyzers you want to run for every analysis you perform.
- Choose whether you want to HTTP poll for the analysis to finish or not.
- List all jobs or view one job in a prettified tabular form.
- List all tags or view one tag in a prettified tabular form.
- Tabular view of the
analyzer_config.json
andconnector_config.json
from IntelOwl with RegEx matching capabilities.
Demo
Installation
$ pip3 install pyintelowl
For development/testing, pip3 install pyintelowl[dev]
Quickstart
As Command Line Client
On successful installation, The pyintelowl
entryscript should be directly invokable. For example,
$ pyintelowl
Usage: pyintelowl [OPTIONS] COMMAND [ARGS]...
Options:
-d, --debug Set log level to DEBUG
--version Show the version and exit.
-h, --help Show this message and exit.
Commands:
analyse Send new analysis request
analyzer-healthcheck Send healthcheck request for an analyzer...
config Set or view config variables
connector-healthcheck Send healthcheck request for a connector
get-analyzer-config Get current state of `analyzer_config.json` from...
get-connector-config Get current state of `connector_config.json` from...
jobs Manage Jobs
tags Manage tags
As a library / SDK
from pyintelowl import IntelOwl
obj = IntelOwl("<your_api_key>", "<your_intelowl_instance_url>", "optional<path_to_pem_file>", "optional<proxies>")
For more comprehensive documentation, please see https://pyintelowl.readthedocs.io/.
Changelog
View CHANGELOG.md.
FAQ
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.
Incompatibility after version 3.0
We did a complete rewrite of the PyIntelOwl client and CLI both for the version 3.0.0
. We very much recommend you to update to the latest version to enjoy all new features.
(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.
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-5.0.0rc0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb72443be1bf58e4e64f9bf41d628690f834579d1309cea08a010e9b4aebe120 |
|
MD5 | 40f9d91bbde280526583ef8f7f4c5249 |
|
BLAKE2b-256 | 5082d544fec03039832ae2660041e837cf7f87a1dd66f27cc70561ebee324f1c |