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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

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

File metadata

  • Download URL: ciris_verify-0.6.7.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.7.tar.gz
Algorithm Hash digest
SHA256 e59b38ab16d66f40678dfc1e83f050a5688ae54f6fd01731138638ffe2488e95
MD5 82d3766c71ec0882b1345837f9219af7
BLAKE2b-256 2529e852f62daf35133136b17f2bbcbbd17e78ab7bb2b469046f4ad29ac19d43

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.6.7-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.7-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 7de2d6e96bb1b8ee6e4503b36db5b4c7e66574a37f4f7e4d337750ade11ae70c
MD5 68464f4d38a03beef299cbf68283b7a6
BLAKE2b-256 4d3fb0a39063a12cdf1d257e27fe3caf22d79273cbf4a1b1a34859f2a21a48cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.7-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 8b23259dcdf3abfd76722d24dac43c0235c027e3c8070f4dcf5c09b9a7145fc2
MD5 f364a4dea275b1866984ed21786f9bdb
BLAKE2b-256 08111952286ac5be677ed836499925e2528ef48bac4b88dc0b5dafad44130af2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.7-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 f72be5d9811305efdbac69186789eb75e8608db1db4e80d2f06e57cac75d2487
MD5 fba257e5d21f15e8393ff75c3b972f9a
BLAKE2b-256 519a92d34158d06dfe7e9de0e0b5ff0b4726f64a3283e798349c682ca68bc4ec

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.7-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b2f5f9e1c2a870bfaf2c09c2f66b8fcc182dfae83e12845b6e93086282941869
MD5 4a4455c53948ec6e793e946813585963
BLAKE2b-256 26aaf08fb5eaff1857b1df6b17ffa2028d023801a000fd2af3fda503d39bad54

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.7-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 935e7fd724ad94837f35ef2a88918bf9aa33f4947ea7df62d1785c891b650911
MD5 76c950499468dca81a1ab724c2f7664f
BLAKE2b-256 7bfdda9c5c6146faff8a95e35109b17922e5abeda7613bf51c7f1f332eceaacd

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