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.6.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.6-py3-none-win_amd64.whl (2.5 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-0.6.6-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.6-py3-none-manylinux_2_17_aarch64.whl (2.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.6.6-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.6.tar.gz.

File metadata

  • Download URL: ciris_verify-0.6.6.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.6.tar.gz
Algorithm Hash digest
SHA256 6890c9d26c4deb47816f9542911019337c2f6e1eff973f6dac7cd632b577ba54
MD5 6c8f9d7925e7d90b462551d0182e4153
BLAKE2b-256 3c561119dc38022dc26cbdeaf630b58775803c685a2ac95fc7422f9482be6349

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.6.6-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.6-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 9353d410d050d920670486884bb6b8bfbcd8bd10c307f695451790094be7a773
MD5 fb96c2ae152d390d9008716f29536ae4
BLAKE2b-256 fcff26eedc7b1ae2183c8faa1d6c2fa7be62902241d6e52fe3cc1bec667d390f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.6-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 8e95102ee1d16039475fd2f3f42f135287d7986e45ca0f61cb316d648b95c475
MD5 0979a8799c36c43f51169547bd33b655
BLAKE2b-256 92c251919efa37adf2971dbf5fac46536520bbbeae8f1ea60cf23ef1e32ffb14

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.6-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 2c3e601a49560ea625e714ac9a746bc852618c1ad1a62796a48c01eaca9f5077
MD5 1316e6467379a400f12e3f3839c11a18
BLAKE2b-256 50643e918e6c6d5f32eff49cb0e5657d211b2e665bb2ba93df954d2f9a23050f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.6-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7bc4e7881bbf987dfacd1564f30c5e06beceb0e4afb1e75b98bc02387a566423
MD5 74e69fae6efe42b0a90e50bf1fb86841
BLAKE2b-256 a59564a307f93b5c8c53a7632a7edfea9e7add82b8ef9d2df77aa93d1538308b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.6-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 471d7eacbd1f5af8c17979499de7fc0dacbb11b5c0335de37d6bf273b22c9c73
MD5 60b196b6f4c80272f5b8e544209201bc
BLAKE2b-256 55bc575b56eeb82e07fbcefce55f8dffa3374c89558321600ffb850305d097be

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