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.1.tar.gz (21.2 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.1-py3-none-win_amd64.whl (2.6 MB view details)

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

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

File metadata

  • Download URL: ciris_verify-0.6.1.tar.gz
  • Upload date:
  • Size: 21.2 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.1.tar.gz
Algorithm Hash digest
SHA256 9dd7e221e6620ad7400c05665aac83974599dbb89bb3eb4827ecd8c5563fe55b
MD5 642fb9a6fa9353e6eedb01fa482e29ad
BLAKE2b-256 a0248ae8b3044546e2c02328e49f8eb1c9e0321afcf4b34ee4d75ec1ed50e135

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.6.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 2.6 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.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 d97f3d4363a51a17a65c56c6e491287b33207ca69d4bb0467f7043dc28563e58
MD5 6c4929d9bd6c2a4b7233b4b8e2c5a660
BLAKE2b-256 a2160145dc0f42db5651990e8a0b98f3afa5e75461390780b3b7cad86f7a96d1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.1-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 671f27eb2d566857ccfc78e59beb673ac0a8d31d59aa3bccc339807f166e00c8
MD5 46a180de6e11aab9669e61308a98c54e
BLAKE2b-256 8d08f8846e6b9364cd4a8995707965f80f4712896be0fd710a316a986704c11f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.1-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 0cb0a4f87ee6a0b821628f350b3400780ac38c3f7f33d29450a8021ebea26295
MD5 59bd3f87541a3380d7be903290fb7ff5
BLAKE2b-256 dbea9b54bbd3e8073c498055e606c47998c2773bdc48050b93005826dcc7c2cb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 47ae10d7e0d2ad270c7863c37f29bd1929dac9d0d1030a8c42592e123df882a1
MD5 7b88e9102ce11fd5f081fcb5db5c8e04
BLAKE2b-256 c06826315e3e053246881299f813c7d14e6ef5b1d1f0481273dc9b13038edb3d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.1-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 99ed0456e4571ce82be1dac008bf566cc71b099f421e8a3d7408731d88d89a1f
MD5 0c4940c6814794412c7b150877a12749
BLAKE2b-256 b9ec077fa4aba7335da28df757ebcb179c3467fd88cef705950ad4ecb8352607

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