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-8.1.0.tar.gz (78.2 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-8.1.0-py3-none-win_amd64.whl (6.6 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-8.1.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.5 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-8.1.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (6.0 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-8.1.0-py3-none-macosx_11_0_arm64.whl (5.5 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-8.1.0-py3-none-macosx_10_12_x86_64.whl (6.0 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for ciris_verify-8.1.0.tar.gz
Algorithm Hash digest
SHA256 ec24e93ebc81235a5feab6fa3e2e3caab130db12f24b78db53bd905bb260ef0a
MD5 8cf9fdb90216f153db6536c18c5909e1
BLAKE2b-256 b32d31ecc8a4328ca198a1ed446236ea8c61de24abeb706453126b8e6d4bffbf

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-8.1.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-8.1.0-py3-none-win_amd64.whl.

File metadata

  • Download URL: ciris_verify-8.1.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 6.6 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-8.1.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 2813b66958a64914999f87bb0e49a01425abf4346a2bd4d1f113dfdffd3471df
MD5 130bccd18cbf8cf2f7f628267765a768
BLAKE2b-256 6523f15f5f7efa608097b7fbc9f927501fd32dafb28c99e20ae14cc2830fae83

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-8.1.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-8.1.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ciris_verify-8.1.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4c8df39a315769d4f1f7acb3b434a707e1c09834babb22e7a56ca96dc6cc271a
MD5 f8bfd5a3758d26432d77bd79f6f63bab
BLAKE2b-256 1b4dc2fdec9854e1fc90a1428fe2565efe496890157404191595f2e113173d65

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-8.1.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-8.1.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for ciris_verify-8.1.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 b1b47790899c078c16f44f05c1af87b22419f1213939bc4ac1a1d5dd538361ca
MD5 671639f246f8e06b00b3a2dbc3578ba4
BLAKE2b-256 11a1bd7ef9ce6e712aa73c21e130ca7f72bd6367e4db8c743a16a6dfaec8bef0

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-8.1.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-8.1.0-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for ciris_verify-8.1.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a63ccf02e72c8fc6aced4dd19f0063e71bb68f1c85c4d3c3fe4ac66f5b14df05
MD5 470e0cd6992383e05afc505be36a03e0
BLAKE2b-256 89682d07d0f5f0239719ef915e105ee657de62faad92147393a6893f5b8d67a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-8.1.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-8.1.0-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for ciris_verify-8.1.0-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 05bd5450ef2889393feef453901d58b91a3e80230696e75528024aacbd60542c
MD5 8bdd96c99ee1335bb007eb1918510015
BLAKE2b-256 a99c8b0fb45d148610b9ef20faf097cc8531d7b9d76eaae3281a7eba6a9ec3ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-8.1.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