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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

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

File metadata

  • Download URL: ciris_verify-0.6.12.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.12.tar.gz
Algorithm Hash digest
SHA256 f34b88b3a89277e952741d9b5a0ecb3834c88623464b23b85ee122e353b7ffd3
MD5 c438df1aaf94b7a762145b04a36b83c6
BLAKE2b-256 fc28b7d363bfce8539e3371dc24336a612a6406e4c6def4a1720f30a6a741ed0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.12-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 fa2796917affa7b925042a736dcf172ce679e423f35bcb37a449ebee707c4596
MD5 365e6080c089895873e9d2762d0a7304
BLAKE2b-256 9310986ff64b2dfb70d607964ce7d29d62f9d97897b430891c2d3bfb6f6d9983

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.12-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 8405e1fbdb05010b73b14c8c1eec01474668cd1fc57f8bb433a4c26b246b4ac3
MD5 c14135713f9fa577b7273f953ac7b02f
BLAKE2b-256 24095d823ebff662fe2edca78ad0e7b1eb74b87996bf50a3df15a61c9cec7197

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.12-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 c1f8712382eccdd39e76cd7211e95522b4764c3d33d66599df62e20a498d5321
MD5 4f294857e66defe4d89eea39924c55ff
BLAKE2b-256 091de1f4ca40518d08f90f41302da3264a7339d542fa8212a09d3f0b77962156

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.12-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cdbfe48c804bc10b4997be940e03b5e5593698a0686667210f6f9e3732bf5165
MD5 059c299b6ea812556b5f8542f980dc7f
BLAKE2b-256 45077f981853647f0e69d5f1b9a6a0fa7d3c3fc3764afb1db42f10c84d9cf67a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.12-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 85d9984dc3c01a871e48a14202ee57cd877dbafb753bf1881feef138edad087f
MD5 93a3ff741a62bf6a070279d12c481e8b
BLAKE2b-256 db3f7f9e89f681df5e09059249d570a13c379f6ca83d6d89cb1d98c80247a40e

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