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-0.6.9.tar.gz (21.4 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-0.6.9-py3-none-win_amd64.whl (2.5 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-0.6.9-py3-none-manylinux_2_17_x86_64.whl (2.9 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.6.9-py3-none-manylinux_2_17_aarch64.whl (2.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-0.6.9-py3-none-macosx_11_0_arm64.whl (2.4 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.6.9-py3-none-macosx_10_12_x86_64.whl (2.6 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: ciris_verify-0.6.9.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for ciris_verify-0.6.9.tar.gz
Algorithm Hash digest
SHA256 acef12b885f32961b80c41bfbab6ceaba25852112635fafeba3aae3394b29861
MD5 1e233ddfd5828b65fe2245ddcf2168b1
BLAKE2b-256 9ff2182daa2fb2c3efe8e182f2feca277111e4f77dc5aa06bacdcaee0d39b00f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.6.9-py3-none-win_amd64.whl
  • Upload date:
  • Size: 2.5 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for ciris_verify-0.6.9-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 dc182fc7f5decf41153c046b460bedf4cf3ba1016cd4cc0456db70549a4d23dd
MD5 de1baca2e990c959916275c0daed0995
BLAKE2b-256 9108fbcda03843821fc9c573ac0b4c60e175459b4a3df336c7dd2913d17ab0b8

See more details on using hashes here.

File details

Details for the file ciris_verify-0.6.9-py3-none-manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for ciris_verify-0.6.9-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 74424e61af0740ab81b52dbabcb3e7ea046d17a17b3a272d81ec55b961be5040
MD5 455e6fd679f76dd10e987a7b23247a25
BLAKE2b-256 bf5755583b2164d959a1a92c0d3388c08ec759845bbabfd398a0a2fe51d842b5

See more details on using hashes here.

File details

Details for the file ciris_verify-0.6.9-py3-none-manylinux_2_17_aarch64.whl.

File metadata

File hashes

Hashes for ciris_verify-0.6.9-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 9be80895341777b007579d4444a535a70d1db1605b2a487d4499a3e1f9bffdb3
MD5 b313ac570757617770ed6331049ae961
BLAKE2b-256 63e72115994f91ac26328a5afc68f9247565560690e89bc0268bd11937ad4075

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.9-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 224e4b4a409dfc3ccc9bb4c664441d9870c6f8b8c8a64ddb1abc04b3429aaf9c
MD5 2ca27fd69038c24b204cc643204002f0
BLAKE2b-256 60aff8b4736536ce954daa3efce4edfbb85b64ab25af7d80be783c9618229670

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.9-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 6aff512d5310a1ab17015d84da67115ae015204d853a14ad6f3efb299d050c58
MD5 fc7a86c661a58f39c98a07af1e892d4a
BLAKE2b-256 8d381a6109daafe408c6b4cf19d609c6be7e23fa301126ff44db987fcdfd7cdd

See more details on using hashes here.

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