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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.6.8-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.8.tar.gz.

File metadata

  • Download URL: ciris_verify-0.6.8.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.8.tar.gz
Algorithm Hash digest
SHA256 49dc7d4e69941bade9bb7bd7e58bade1893ecd4af0c6dd04528f3e16dc56af3a
MD5 22c6647b530f99809288d4c56e8a8aa6
BLAKE2b-256 b40634d3cb8ce8883619753f94115821df8e10c7131b6b1c8815a05ee963145e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.6.8-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.8-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 5e5dc3a96cf589d56d13a16b73f16b9d32419a703e2fb310603b632e12a4478a
MD5 56588473bfd0e8e888ed18dea756a499
BLAKE2b-256 1c0490f99c339c29d33500fedb15cd688649915c354481bf16c85cfb919e6318

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.8-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 331b27595913dc837081a91a290fca163c1766506462bcb47a6973833ca89032
MD5 6345833a8c0b2ed2a7bbfefccf277587
BLAKE2b-256 f307e80a30ad01d8bba0dc58aa1fe93ee5db5e634afdad119a70bcf27feb7163

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.8-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 020e6515d3e87c7c4c0133359a25a7bea3ff088aac8638fcd17125fe994f4199
MD5 c0b52ff5ef4d3bf242598056a4538f26
BLAKE2b-256 2e045380bba07b996881d44dd5c3bb062e2ba044849dbe58459b02964e4337d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.8-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1e61b473e1a101fd614da391a651809d345677a8eb26b8c65ca6318a0e132834
MD5 1050f5513e1125ce9a5cb41bd4b5d617
BLAKE2b-256 cbb6b42631bc34fe16362189eeafb52bc4645b92c3f986696281c36cb3018113

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.8-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 120273fc79418c249a35c0c2f93249adc70cc21120922d5163ded1b31c271a67
MD5 03dd4b060c4d096ec3093ebc86378da4
BLAKE2b-256 68ec37e42e723c0e6ae105e02e8fbaba8b4e1a06ff100387a9560bc1b0d7efeb

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