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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

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

File metadata

  • Download URL: ciris_verify-0.6.13.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.13.tar.gz
Algorithm Hash digest
SHA256 161fc1b22db0c06d48913d9c95ec5b1bc76619a0f88d78bd9048407df3c30d99
MD5 945b2e33601555cdf0401629d2686782
BLAKE2b-256 88948a3b65ee2ffa992db5e959ad7ecdd402cbd64fd130071929af34fa225b5e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.13-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 a1921791e87e8a70060db7797956eb80b935ecfc1ea1883757520492ef428d41
MD5 bca6d0636b5e91c65466e1b9839e6e94
BLAKE2b-256 d83df39a39d5cabfdc65cd641cdb43299d8a777ad122e70bfdd9d11ad24c2230

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.13-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 0fb1154e219246eecb6e3cb85f25dabaf28bc0ea879c569145404ea599677538
MD5 3b3467f0dcd8e2af1dc080c396005ca6
BLAKE2b-256 2fa2e3bc208f14b031e9f710fd27938e13e33d17289d5aa20f60e3356e5a53ab

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.13-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 54f2ba3865d1c24b2b19ff4c40678c13afb82262d1d4c22c0e4d7c0e8c60e6ba
MD5 611bc55831ef650add4e36575360fcf8
BLAKE2b-256 80cb3abf77a1eaf063701f46fef6d29c7013b8f84e65d311a9ec112f4eb2f102

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.13-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 026c0b795b55d89782490ae834014bc57f33b7cc59aa283a965fa396e074cfe4
MD5 c68b940afef1bba27e1f3164dd3d948f
BLAKE2b-256 c9c38c404343fddcfbd8f675eca8003fd54b6cc86954d3e0feee031da136729c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.13-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 dd8115eefc4348ca6595249c9cd274f8b1f285d1278d3c80c9c2e2f316b9d950
MD5 f1d5fc7fb13d948376b4da5df7aaf8f2
BLAKE2b-256 a5dd1770bad3ba20ff4720cda2417563cf5abda8f531f01de3b961c0af95e020

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