Skip to main content

EPSS API Python Client

Project description

https://badge.fury.io/py/epss-api.svg https://img.shields.io/pypi/dw/epss-api?style=flat https://github.com/kannkyo/epss-api/actions/workflows/python-ci.yml/badge.svg https://codecov.io/gh/kannkyo/epss-api/branch/main/graph/badge.svg?token=R40FT0KITO https://github.com/kannkyo/epss-api/actions/workflows/scorecards.yml/badge.svg

EPSS(Exploit Prediction Scoring System) API client.

EPSS is the one of famous vulnerability score developed by FIRST (the Forum of Incident Response and Security Teams).

EPSS’s definition:

The Exploit Prediction Scoring System (EPSS) is an open, data-driven effort for estimating the likelihood (probability) that a software vulnerability will be exploited in the wild. Our goal is to assist network defenders to better prioritize vulnerability remediation efforts. While other industry standards have been useful for capturing innate characteristics of a vulnerability and provide measures of severity, they are limited in their ability to assess threat. EPSS fills that gap because it uses current threat information from CVE and real-world exploit data. The EPSS model produces a probability score between 0 and 1 (0 and 100%). The higher the score, the greater the probability that a vulnerability will be exploited.

https://www.first.org/epss/

This package is most easiest and efficient EPSS api client.

Usage

EPSS has some methods.

from epss_api import EPSS

client = EPSS()

value = client.scores()
# value = [
#   {'cve': 'CVE-2022-39952', 'epss': '0.09029', 'percentile': '0.94031'},
#   {'cve': 'CVE-2023-0669', 'epss': '0.78437', 'percentile': '0.99452'},
#  ...
# ]

value = client.epss_lt(0.5)
# value = [
#   {'cve': 'CVE-2022-39952', 'epss': '0.09029', 'percentile': '0.24031'},
#   {'cve': 'CVE-2023-0669', 'epss': '0.18437', 'percentile': '0.19452'},
#  ...
# ]

value = client.percentile_lt(0.5)
# value = [
#   {'cve': 'CVE-2022-39952', 'epss': '0.09029', 'percentile': '0.24031'},
#   {'cve': 'CVE-2023-0669', 'epss': '0.78437', 'percentile': '0.19452'},
#  ...
# ]

value = client.epss_gt(0.5)
# value = [
#   {'cve': 'CVE-2022-39952', 'epss': '0.59029', 'percentile': '0.94031'},
#   {'cve': 'CVE-2023-0669', 'epss': '0.78437', 'percentile': '0.99452'},
#  ...
# ]

value = client.percentile_gt(0.5)
# value = [
#   {'cve': 'CVE-2022-39952', 'epss': '0.59029', 'percentile': '0.94031'},
#   {'cve': 'CVE-2023-0669', 'epss': '0.78437', 'percentile': '0.99452'},
#  ...
# ]

value = client.score(cve_id='CVE-2022-0669')
# value = {'cve': 'CVE-2022-39952', 'epss': 0.0095, 'percentile': 0.32069}

value = client.epss(cve_id='CVE-2022-0669')
# value == 0.0095

value = client.percentile(cve_id='CVE-2022-0669')
# value == 0.32069

If you call either one method, EPSS client cache all CVE’s score in memory. After caching, you can get all data very fast.

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

epss_api-1.1.3.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

epss_api-1.1.3-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file epss_api-1.1.3.tar.gz.

File metadata

  • Download URL: epss_api-1.1.3.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for epss_api-1.1.3.tar.gz
Algorithm Hash digest
SHA256 e9bf61dd16261e4d6fb06744f207bea8872e386c50c351b13b7d841ece653981
MD5 d0ba0d34d031536e94b73874b6f4c561
BLAKE2b-256 d179bc9ef2699e3bb02ca214d57366b5ac50c54834b7f4d75c628dc17fdc5854

See more details on using hashes here.

File details

Details for the file epss_api-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: epss_api-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for epss_api-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2bd8a194b9a0992362eb6a1b461817bfed05ecdec43773a861bba614e09bccc7
MD5 c4f1900abd2e2750260a12f83d3adb0b
BLAKE2b-256 c407ac009de55c6a77ff2d2d9d37e16627c55a9469585c979910e02f2a5724e7

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