Skip to main content

criminalip.ctidb reader

Project description

Description

This is a Python module for reading CTI DB files.

CTI DB is a binary file format that stores data indexed by IP address subnets (IPv4 only).

Installation

To install ctidb, simply:

$ pip install ctidb

Usage

To use this module, you must first download or create a CTI DB file.

After you have obtained a database and imported the module, call CCtiReader with a path, to the database as the first argument. Optionally, you may pass a mode as the second argument. The modes are exported from ctidb. Valid modes are:

  • MODE_MEMORY - load database into memory. Pure Python.

  • MODE_AUTO - Default.

NOTE: To look up an IP address, use the get method on this object. The method will return the corresponding values for the IP address from the database (e.g., a dictionary for GeoIP2/GeoLite2 databases). If the database does not contain a record for that IP address, the method will return None.

Example

>>> import ctidb
>>>
>>> with ctidb.CCtiReader('criminalip.ctidb') as reader:
>>>
>>>     reader.get('223.26.31.75')
{'country': ... }

Exceptions

The module will return an InvalidDatabaseError if the database is corrupt or otherwise invalid. A ValueError will be thrown if you look up an invalid IP address or an IPv6 address in an IPv4 database.

Requirements

This code requires Python 3.7+. Older versions are not supported.

Versioning

Support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ctidb-1.1.1.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

ctidb-1.1.1-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file ctidb-1.1.1.tar.gz.

File metadata

  • Download URL: ctidb-1.1.1.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for ctidb-1.1.1.tar.gz
Algorithm Hash digest
SHA256 131e8417a807bb8ac63704711756edc0ef10f74bb14e49988b1d9106f15fb2cf
MD5 c961e4a15a9e4d292d0506b7987e6d68
BLAKE2b-256 3a9a34140216289d5eb17625e825fda54bd5dbf4096e229b1ee5171e9576a50b

See more details on using hashes here.

File details

Details for the file ctidb-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: ctidb-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for ctidb-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a2356af429d180825f63980ac3277bc239a5ec8d2a81c6d47a284e602c98da07
MD5 0b3dee5927302a2197f448d208a3dc0f
BLAKE2b-256 a827af085cd17581714bebb45dd8ef4d539275b09641d8af096a412a5e64ea44

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page