Skip to main content

A Python wrapper for the Qualys API.

Project description

QualysPy

A Python wrapper for the Qualys API. Qualys data can be interacted with using a Python model, loaded into a PostgreSQL database, and queryed from that database with the same model.

The Python models are intended to be a 1:1 mapping of the objects returned by the Qualys API.

This is a work in progress. The currently supported API calls are:

  • VMDR
    • host_list_detection

Requirements

  • Python >= 3.10
  • A supported version of Linux (tested on Ubuntu 22.04)
  • A supported version of PostgreSQL, if you want to use the ORM features.

Installation

python -m venv .venv
source .venv/bin/activate
pip install qualyspy

Then, create a config file to indicate the Qualys API URLS and credentials and, optionally, PostgreSQL database information. See .qualyspy-example for an example configuration file. By default, QualysPy will search for this file at ~/.qualyspy, but a different file path can be supplied.

Usage

Documentation is located at https://qualyspy.readthedocs.io.

Each Qualys API has class subclassed from QualysAPIBase. For example, to connect to the VMDR API:

from qualyspy.vmdr import VmdrAPI

api = VmdrAPI()

The API object has methods corresponding to the Qualys API's endpoints.

host_vulns = api.host_list_detection(ids=12345)

To load the data into a database, use the ORM class corresponding to the API endpoint. For the host_list_detection endpoint:

from qualyspy.vmdr import HostListDetectionORM
# Tip: You can pass echo=True to an ORM class to write the SQL commands to stdout
orm = HostListDetectionORM()
orm.load() # This may take some time, depending on how much data there is to load.

Finally, the data can be queryed and will be outputted in the same form as with VmdrAPI.

from qualyspy.models.vmdr.host_list_vm_detection_orm import Host

# Get all hosts from the database
with orm.Session(vmdr_orm.engine) as session:
    stmt = session.query(Host)
    host_list = vmdr_orm.query(stmt)[0]
    host = host_list.host[0]

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

qualyspy-0.5.8.1.tar.gz (39.5 kB view details)

Uploaded Source

Built Distribution

qualyspy-0.5.8.1-py3-none-any.whl (45.5 kB view details)

Uploaded Python 3

File details

Details for the file qualyspy-0.5.8.1.tar.gz.

File metadata

  • Download URL: qualyspy-0.5.8.1.tar.gz
  • Upload date:
  • Size: 39.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for qualyspy-0.5.8.1.tar.gz
Algorithm Hash digest
SHA256 f320c0f2d0d688142a9eb79878fd914f88979b5a082093f7ee3235714eff1b0e
MD5 36efb1934f40be47f58471536fd57c60
BLAKE2b-256 bcc94e5cd7586fbfb967be2ecfb83fb247b079d58aa2f1552c2ecb095f5ced2f

See more details on using hashes here.

File details

Details for the file qualyspy-0.5.8.1-py3-none-any.whl.

File metadata

  • Download URL: qualyspy-0.5.8.1-py3-none-any.whl
  • Upload date:
  • Size: 45.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for qualyspy-0.5.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f2527a271aecce38b87c0689dc0d809232db0d7d83dc5fb07636efb7cc34acaa
MD5 9c79c4a0743797410c9323e708690593
BLAKE2b-256 bb8d5fbdce60b3a44fb86be94431d00077b7e42d59e695e1b60d22ec01b0c8c5

See more details on using hashes here.

Supported by

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