Python SDK for the Attestd security risk API
Project description
attestd
Attestd checks whether a dependency version has exploitable CVEs or a confirmed supply-chain compromise. One API call returns a structured risk response.
Get a free API key · Full docs
Requires Python 3.10+.
Install
pip install attestd
Quick start
import os
import attestd
client = attestd.Client(api_key=os.environ["ATTESTD_API_KEY"])
result = client.check("nginx", "1.20.0")
print(result.risk_state) # "high"
print(result.cve_ids) # ["CVE-2021-23017", ...]
Batch check
Check up to 100 packages in one request. Each item costs one API call. A 429 rejects the entire batch before billing.
results = client.batch_check([
("litellm", "1.82.7"),
("nginx", "1.25.3"),
])
# results[i] is RiskResult | None — None means outside coverage
Async:
results = await client.batch_check([("litellm", "1.82.7"), ("nginx", "1.25.3")])
Catalog and quota
Three additional endpoints for product discovery, CVE lookup, and quota monitoring. All require a valid API key.
Products catalog
catalog = client.products()
print(catalog.total)
print(catalog.cve_products[0].slug)
print(catalog.supply_chain_packages[0].package)
Returns ProductsResult with cve_products, supply_chain_packages, and total. Maps to GET /v1/products.
CVE detail
try:
detail = client.cve("CVE-2021-44228")
print(detail.cvss_score, detail.epss_score)
except attestd.AttestdAPIError as e:
if e.status_code == 404:
print("CVE not in database")
Returns CveDetail with CVSS, EPSS, KEV status, and affected products. Raises AttestdAPIError(status_code=404) when the CVE is not in Attestd's database.
Usage quota
usage = client.usage()
print(usage.tier)
print(usage.key_calls_this_month, "/", usage.included_calls)
print(usage.billing_period_end)
Returns UsageResult with calls used this month, included cap, billing period, and overage estimate. Use for quota monitoring in CI or agent loops.
Supply chain check
Attestd monitors select PyPI and npm packages for known malicious publishes.
result = client.check("litellm", "1.82.7")
if result.supply_chain:
print(result.supply_chain.compromised) # True
Error handling
AttestdUnsupportedProductError means the product is outside Attestd coverage. That is unknown risk, not a safety signal.
try:
result = client.check(product, version)
except attestd.AttestdUnsupportedProductError:
raise RuntimeError(f"{product} is outside Attestd coverage")
See Outside coverage below for policy options.
Async
import asyncio
import os
import attestd
async def main():
async with attestd.AsyncClient(api_key=os.environ["ATTESTD_API_KEY"]) as client:
result = await client.check("log4j", "2.14.1")
if result.risk_state in ("critical", "high"):
raise RuntimeError(f"Vulnerable dependency: {result.cve_ids}")
asyncio.run(main())
CI/CD deployment gate
import os
import attestd
DEPENDENCIES = [
("nginx", "1.20.0"),
("log4j", "2.17.1"),
("openssh", "9.2p1"),
]
with attestd.Client(api_key=os.environ["ATTESTD_API_KEY"]) as client:
for product, version in DEPENDENCIES:
try:
result = client.check(product, version)
except attestd.AttestdUnsupportedProductError:
continue
if result.risk_state in ("critical", "high"):
print(f"BLOCK: {product} {version} ({result.risk_state})")
print(f" CVEs: {', '.join(result.cve_ids)}")
print(f" Fix: upgrade to {result.fixed_version}")
exit(1)
AI agent tool
import os
import attestd
client = attestd.Client(api_key=os.environ["ATTESTD_API_KEY"])
def check_dependency_risk(product: str, version: str) -> dict:
"""Return risk_state, CVE IDs, and fixed version for a dependency."""
try:
result = client.check(product, version)
return {
"supported": True,
"risk_state": result.risk_state,
"actively_exploited": result.actively_exploited,
"fixed_version": result.fixed_version,
"cve_ids": result.cve_ids,
}
except attestd.AttestdUnsupportedProductError:
return {"supported": False}
Full error handling
import os
import time
import attestd
with attestd.Client(api_key=os.environ["ATTESTD_API_KEY"]) as client:
try:
result = client.check("nginx", "1.20.0")
except attestd.AttestdUnsupportedProductError:
pass
except attestd.AttestdRateLimitError as e:
time.sleep(e.retry_after or 60)
except attestd.AttestdAuthError:
raise
except attestd.AttestdAPIError as e:
print(f"API error: {e.status_code}")
except attestd.AttestdError:
pass
Outside coverage: not a safety signal
AttestdUnsupportedProductError means Attestd has no vulnerability data for this product, not that the product is free of vulnerabilities. An agent that catches the exception and treats it as safe to proceed is making a dangerous inference.
Recommended handling:
try:
result = client.check(product, version)
except attestd.AttestdUnsupportedProductError as e:
raise RuntimeError(
f"{e.product} is outside Attestd's coverage. "
"Manual security review required before deploying."
)
RiskResult fields
| Field | Type | Description |
|---|---|---|
product |
str |
Product name |
version |
str |
Version queried |
risk_state |
str |
One of critical, high, elevated, low, none |
risk_factors |
list[str] |
Machine-readable factors (see below) |
actively_exploited |
bool |
On the CISA KEV list |
remote_exploitable |
bool |
Remotely exploitable |
authentication_required |
bool |
True only if ALL CVEs require auth |
patch_available |
bool |
A fixed version is known |
fixed_version |
str | None |
Earliest version that resolves all CVEs |
confidence |
float |
Synthesis confidence (0.0-1.0) |
cve_ids |
list[str] |
CVE IDs in this assessment |
last_updated |
datetime |
UTC timestamp of last synthesis run |
supply_chain |
SupplyChainSignal | None |
PyPI/npm supply chain signal when monitored; None for CVE-only products |
typosquat |
TyposquatSignal | None |
Present when the package name resembles a known product |
TyposquatSignal: detected, resembles, confidence, ecosystem
Risk states
| State | Meaning |
|---|---|
critical |
Actively exploited in the wild (CISA KEV) |
high |
Remote unauthenticated exploitation possible |
elevated |
Remote exploitation requires authentication |
low |
Local-only or low-impact vulnerability |
none |
No known vulnerabilities affecting this version |
Risk factors
| Factor | Meaning |
|---|---|
active_exploitation |
CVE on CISA KEV list |
remote_code_execution |
Remote exploitation possible |
no_authentication_required |
Remote + no auth required |
internet_exposed_service |
Remote + no auth (surface area flag) |
patch_available |
A fix is available |
Catalog and quota types
| Type | Key fields |
|---|---|
ProductEntry |
slug, display_name |
SupplyChainEntry |
package, ecosystem, display_name |
ProductsResult |
cve_products, supply_chain_packages, total |
CveDetail |
cve_id, description, cvss_score, cvss_vector, actively_exploited, remote_exploitable, authentication_required, affected_products, epss_score, epss_percentile, source_published_at, last_checked_at |
UsageResult |
tier, key_calls_this_month, account_calls_this_month, included_calls, billing_period_start, billing_period_end, overage_calls, estimated_overage_usd |
Configuration
client = attestd.Client(
api_key=os.environ.get("ATTESTD_API_KEY"),
base_url="https://api.attestd.io",
timeout=10.0,
max_retries=3,
retry_delay=1.0,
)
Set ATTESTD_API_KEY in your environment from the portal. Then omit api_key in the constructor:
with attestd.Client() as client:
result = client.check("nginx", "1.20.0")
The SDK retries on transient 5xx responses and connection failures with exponential backoff (1s, 2s, 4s between attempts). 401 and 429 are surfaced immediately without retry.
Supported products
See attestd.io/docs/products for the full list. Each product page documents the API slug, version format, and notable CVEs. Querying an unsupported product raises AttestdUnsupportedProductError.
Testing your integration
The SDK ships an attestd.testing module with httpx transports for injecting controlled API responses. No local Attestd instance required.
import attestd
from attestd.testing import (
MockTransport,
MockAsyncTransport,
SequentialMockTransport,
SequentialMockAsyncTransport,
NGINX_SAFE,
NGINX_VULNERABLE,
LOG4J_CRITICAL,
UNSUPPORTED,
LITELLM_SAFE,
LITELLM_COMPROMISED,
PRODUCTS_RESPONSE,
CVE_LOG4SHELL,
USAGE_SOLO,
)
Test a deployment gate
from attestd.testing import MockTransport, LOG4J_CRITICAL
def test_deployment_blocked_on_critical():
client = attestd.Client(
api_key="test",
transport=MockTransport(200, LOG4J_CRITICAL),
)
with pytest.raises(DeploymentBlockedError):
run_deployment_gate(client, "log4j", "2.14.1")
Test retry behaviour
from attestd.testing import SequentialMockTransport, NGINX_SAFE
def test_retry_succeeds_on_second_attempt():
transport = SequentialMockTransport([
(503, {}),
(200, NGINX_SAFE),
])
client = attestd.Client(api_key="test", transport=transport, max_retries=1)
result = client.check("nginx", "1.27.4")
assert result.risk_state == "none"
assert transport.call_count == 2
Test the outside coverage policy branch
from attestd.testing import MockTransport, UNSUPPORTED
def test_outside_coverage_is_blocked_not_allowed():
client = attestd.Client(api_key="test", transport=MockTransport(200, UNSUPPORTED))
with pytest.raises(attestd.AttestdUnsupportedProductError):
run_check(client, "unknownproduct", "1.0.0")
Custom response bodies
All ready-made bodies (NGINX_SAFE, etc.) are plain dicts. Merge in overrides:
from attestd.testing import MockTransport, NGINX_VULNERABLE
body = {**NGINX_VULNERABLE, "actively_exploited": True, "risk_state": "critical"}
client = attestd.Client(api_key="test", transport=MockTransport(200, body))
License
MIT
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file attestd-0.5.0.tar.gz.
File metadata
- Download URL: attestd-0.5.0.tar.gz
- Upload date:
- Size: 23.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
86722d75f6fdd0edd491b835994000e929bf17bfc87e6ade7bdb7036ad7623d6
|
|
| MD5 |
bf31904b5fcb8c1fbde92b32622681c4
|
|
| BLAKE2b-256 |
78d5e7cdc8dc20efde1050f34d38f3ee53745bee26bd4ba4ef956649c7fe4fb5
|
Provenance
The following attestation bundles were made for attestd-0.5.0.tar.gz:
Publisher:
publish.yml on attestd-io/attestd-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
attestd-0.5.0.tar.gz -
Subject digest:
86722d75f6fdd0edd491b835994000e929bf17bfc87e6ade7bdb7036ad7623d6 - Sigstore transparency entry: 2118911325
- Sigstore integration time:
-
Permalink:
attestd-io/attestd-python@ee5ac10993c5b9999018d663f92745ab6f3edfe1 -
Branch / Tag:
refs/tags/v0.5.0 - Owner: https://github.com/attestd-io
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ee5ac10993c5b9999018d663f92745ab6f3edfe1 -
Trigger Event:
push
-
Statement type:
File details
Details for the file attestd-0.5.0-py3-none-any.whl.
File metadata
- Download URL: attestd-0.5.0-py3-none-any.whl
- Upload date:
- Size: 22.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6ce9c18d163516ec17ec4cea031cb86604d75a5fe1244c888a64fc6008b99bf5
|
|
| MD5 |
63b2078d93f2d4c1c456913a2e6132db
|
|
| BLAKE2b-256 |
d7bcbc7811c3a3b41d9d3ed388ddf16b6b11074f9f521902dc10c208faafd71b
|
Provenance
The following attestation bundles were made for attestd-0.5.0-py3-none-any.whl:
Publisher:
publish.yml on attestd-io/attestd-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
attestd-0.5.0-py3-none-any.whl -
Subject digest:
6ce9c18d163516ec17ec4cea031cb86604d75a5fe1244c888a64fc6008b99bf5 - Sigstore transparency entry: 2118911377
- Sigstore integration time:
-
Permalink:
attestd-io/attestd-python@ee5ac10993c5b9999018d663f92745ab6f3edfe1 -
Branch / Tag:
refs/tags/v0.5.0 - Owner: https://github.com/attestd-io
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ee5ac10993c5b9999018d663f92745ab6f3edfe1 -
Trigger Event:
push
-
Statement type: