pybinaryedge

Python 3 Wrapper for the BinaryEdge API https://www.binaryedge.io/. See the APIv2 documentation for more information, or the documentation for this library on Read the Docs.

Installation

To install this tool, it is recommended to use virtual environments.

You can install it directly from pypi with pip install pybinaryedge.

You can Then you can install it directly from sources :

git clone https://github.com/Te-k/pybinaryedge.git
cd pybinaryedge
pip install .

If you use pipenv, you can run instead :

git clone https://github.com/Te-k/pybinaryedge.git
cd pybinaryedge
pipenv install

You need to have an account on the Binary Edge platform, create an API key, and configure the CLI tool to use it with binaryedge config --key KEY

API

See the documentation on Read the Docs.

Example :

from pybinaryedge import BinaryEdge

be = BinaryEdge(API_KEY)
# Iterate over the first page of IPs having specific ssh configuration
search = 'ssh.algorithms.encryption.keyword:"aes256-cbc" ssh.banner.keyword:"SSH-2.0-OpenSSH_LeadSec"'
results = be.host_search(search)
for ip in results['events']:
    print("%s" %(ip['target']['ip']))

List of functions implemented :

• host(IP) : Details about an Host
• host_historical(IP) : Details about an Host, with data up to 6 months
• host_search(QUERY, PAGE) : List of recent events for the given query
• host_score(IP) : IP Scoring of an host.
• host_vulnerabilities(IP) : list of CVE vulnerabilities that may affect a host
• image_ip(IP) : Details about Remote Desktops found on an Host
• image_search(QUERY, PAGE) : Remote Desktops based on a Query
• image_tags() : Get the list of possible tags for the images
• torrent_ip(IP) : Details about torrents transferred by an Host
• torrent_historical_ip(IP) : Details about torrents transferred by an Host, with data up to 6 months
• dataleaks_email(EMAIL) : Verify which dataleaks affect the target email
• dataleaks_organization(DOMAIN) : Verify how many emails are affected by dataleaks for a specific domain
• dataleaks_info() : Get the list of dataleaks our platform keeps track.
• domain_subdomains(DOMAIN, PAGE) : Return list of subdomains known from the target domain
• domain_dns(DOMAIN, PAGE) : Return list of dns results known from the target domain.
• domain_search(QUERY, PAGE): List of Domains/DNS data based on a Query
• domain_ip(IP, PAGE): Return records that have the specified IP in their A or AAAA records.
• sensor_ip(TARGET): Details about an Scanner. List of recent events form the specified host, including details of scanned ports, payloads and tags.
• sensor_search(QUERY, PAGE): Events based on a Query.
• sensor_search_status(QUERY, TYPE, DAYS): Statistics of events for the given query. : stats(QUERY, TYPE, PAGE): Statistics of recent events for the given query.

CLI

This library also implements a CLI binaryedge tool :

usage: binaryedge [-h] {config,ip,search,dataleaks} ...

Request BinaryEdge API

positional arguments:
  {config,ip,search,dataleaks}
                        Commands
    config              Configure pybinary edge
    ip                  Query an IP address
    search              Search in the database
    dataleaks           Search in the leaks database
    domains             Search information on a domain

optional arguments:
  -h, --help            show this help message and exit

Example :

$ binaryedge config --key KEY
$ binaryedge ip -i 149.202.178[.]130
{
    "events": [
        {
            "port": 27017,
            "results": [
                {
                    "origin": {
                        "country": "sg",
                        "ip": "172.104.173.35",
                        "module": "grabber",
                        "ts": 1536782325059,
                        "type": "service-simple"
[SNIP]

Changelog

• 0.5 : fix bugs in the doc and code. Add support for host_vulnerabilities
• 0.4: Add support for BinaryEdge sensors

License

This code is published under MIT license