Skip to main content

Python bindings for CIRISVerify hardware-rooted license verification

Project description

CIRISVerify Python Bindings

Python bindings for CIRISVerify, the hardware-rooted license verification module for the CIRIS ecosystem.

Installation

pip install ciris-verify

Note: The CIRISVerify binary must be installed separately. See the CIRISVerify documentation for installation instructions.

Quick Start

import os
from ciris_verify import CIRISVerify, LicenseStatus

# Initialize the verifier
verifier = CIRISVerify()

# Get license status with a fresh nonce
status = await verifier.get_license_status(
    challenge_nonce=os.urandom(32)
)

# Check if professional capabilities are available
if status.allows_licensed_operation():
    print("Professional license verified!")
    print(f"Tier: {status.license.tier}")
    print(f"Capabilities: {status.license.capabilities}")
else:
    print("Running in community mode")

# IMPORTANT: Always display the mandatory disclosure
print(status.mandatory_disclosure.text)

Mandatory Disclosure

Per the CIRIS ecosystem rules, agents MUST display the mandatory_disclosure.text to users. This ensures transparency about the agent's capabilities and licensing status.

# The disclosure MUST be shown to users
disclosure = status.mandatory_disclosure
print(f"[{disclosure.severity.upper()}] {disclosure.text}")

Capability Checking

For frequent capability checks, use the fast path:

result = await verifier.check_capability("medical:diagnosis")
if result.allowed:
    # Capability is available
    pass
else:
    print(f"Capability denied: {result.reason}")

Testing

For testing without the actual binary, use MockCIRISVerify:

from ciris_verify import MockCIRISVerify, LicenseStatus

# Create a mock that returns community mode
verifier = MockCIRISVerify(
    mock_status=LicenseStatus.UNLICENSED_COMMUNITY
)

# Use exactly like the real client
status = await verifier.get_license_status(os.urandom(32))
assert status.status == LicenseStatus.UNLICENSED_COMMUNITY

Error Handling

from ciris_verify import (
    CIRISVerifyError,
    BinaryNotFoundError,
    BinaryTamperedError,
    VerificationFailedError,
)

try:
    verifier = CIRISVerify()
    status = await verifier.get_license_status(os.urandom(32))
except BinaryNotFoundError as e:
    # Binary not installed
    print(f"CIRISVerify not found: {e.path}")
except BinaryTamperedError:
    # CRITICAL: Binary has been modified
    # Halt all operations immediately
    raise SystemExit("SECURITY ALERT: Binary integrity compromised")
except VerificationFailedError as e:
    # Verification failed - operate in restricted mode
    print(f"Verification failed: {e}")

License Status Codes

Status Code Description
LICENSED_PROFESSIONAL 100 Full professional license active
LICENSED_PROFESSIONAL_GRACE 101 License valid, in offline grace period
UNLICENSED_COMMUNITY 200 Community mode, no professional capabilities
RESTRICTED_* 300-399 Restricted mode due to verification issues
ERROR_* 400-499 Error states (revoked, expired, etc.)
LOCKDOWN_* 500+ Critical security failure, halt operations

Thread Safety

The client is thread-safe and can be used from multiple threads or async tasks concurrently.

License

AGPL-3.0-or-later - See LICENSE file in the CIRISVerify repository.

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

ciris_verify-5.5.0.tar.gz (72.1 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

ciris_verify-5.5.0-py3-none-win_amd64.whl (6.3 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-5.5.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-5.5.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (5.8 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-5.5.0-py3-none-macosx_11_0_arm64.whl (5.3 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-5.5.0-py3-none-macosx_10_12_x86_64.whl (5.7 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file ciris_verify-5.5.0.tar.gz.

File metadata

  • Download URL: ciris_verify-5.5.0.tar.gz
  • Upload date:
  • Size: 72.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ciris_verify-5.5.0.tar.gz
Algorithm Hash digest
SHA256 217ce4236b3802e5de392b04b729899664d23b25caf54d50d1fdacb3cd43b104
MD5 fe5b24e78aeda9d35dc1adde8cd3586f
BLAKE2b-256 44eb85bd9ad6f36be9a54e9c138f7b61137f517c14c4c8a133b0da5887f67c22

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.5.0.tar.gz:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ciris_verify-5.5.0-py3-none-win_amd64.whl.

File metadata

  • Download URL: ciris_verify-5.5.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 6.3 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ciris_verify-5.5.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 1c059862e3401fcca3faf35545d0ec21ecc21b98ffef2e2e490d8eebe9db044b
MD5 3600b4171c4646a1ce233fc9b41c45c7
BLAKE2b-256 0a99c41e55acdd689f71d75dd8b2cbfa35f28c1549dd9d63c19efb8df3642616

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.5.0-py3-none-win_amd64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ciris_verify-5.5.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ciris_verify-5.5.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b99d0132bf3b1825d8999e9910bd11e7b55afd7639bdd1db8b85364b99e9355d
MD5 ed9e83544f0ca7b9b0d2dc33e5708010
BLAKE2b-256 a519ee11acece916c94a47db2e0002144fc3242a4cc2ac35f3f66d226dab9e00

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.5.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ciris_verify-5.5.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for ciris_verify-5.5.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 4d1e87d40595158e578285ba43df0ab81dfa3681c33cab1342258cbcfa363820
MD5 ffce42f9b7e285ab91ef818176067f83
BLAKE2b-256 71a19b8b645ce85b74ce94f740d38250a959ed928e861143cd3115ce89dce86b

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.5.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ciris_verify-5.5.0-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for ciris_verify-5.5.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 af38d7f80ef2fa5688784b6c6d9c9bb3088448b63d127d110c1cb08a5139d5d0
MD5 237d8235e15360d48f9987976123e68f
BLAKE2b-256 0efd295f1fd7b777b32c752608021db4c8badec913ae1e9c7fa427cf21c12f03

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.5.0-py3-none-macosx_11_0_arm64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ciris_verify-5.5.0-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for ciris_verify-5.5.0-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 6325f699d4bedb8113bc44e38cc59db9d7c6b9af059caf3423f6f74ad224bf6a
MD5 a415d5b0aad284f4b897f36cf058505e
BLAKE2b-256 2b555c4d8bff066e9cfff5f6e24f606158587492398f2194dee90cae875cc1d7

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.5.0-py3-none-macosx_10_12_x86_64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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