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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

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

File metadata

  • Download URL: ciris_verify-0.6.4.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.4.tar.gz
Algorithm Hash digest
SHA256 c378610de75edfabba2cf8a9511dc9f585e421630eee373af73449597b0be67b
MD5 26d62a1b9c89edb2983def63e17122c7
BLAKE2b-256 52addb6438a8683b0200e2219dfb364150e32f2540f079b19f42250459abbe65

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.6.4-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.4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 9832d1446c75bcb3d327b4ef3733a24e984adaddd4e92636508179d801c49a75
MD5 84d30e236a8ecbb391ad68868fdeac22
BLAKE2b-256 7981d0114be03269b93fd93d423a2657a3fa74d6b3442cb7618720556411a52a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.4-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 ecb92bce48afc40345d74127b336cbf9f4d0a4143aa5cf5fb463e7a3b50ba803
MD5 3192b4a4eae0330a88768cdd971157c1
BLAKE2b-256 41936be66afe1dc5af08ee3b0cec197d532fb44f006e5416ab44976428a6f46c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.4-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 aab331c9c72c58a35c0ea9b8ce55b161f0ddb16bc5988ba12c989c15ef83a574
MD5 b0e895049fa3cb3c9d9fb335be81b47e
BLAKE2b-256 599809da51c331b7b16f41979b0483668d5b759a7fc6e66a1ccedc7d96fe500f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 fbbb38ab56236f7aa8f0102778ba81eda0ac4bf10f1f18efebcd212622dfc4bf
MD5 cc26fac382d3b8fe06cf56d49ece82a1
BLAKE2b-256 64ce7d805798cb6d9fdad132e300c909574b9f41b077d7c87e95a8d737cb3627

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.4-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d39690d1ea170ca47fe870c6428716cfd90ed04cec5d1e2a6b0c48ab40db718d
MD5 0d4c865f6273f5b55e33d5e6eecd8e92
BLAKE2b-256 6b2af3ccd1f109b4ae4eeab94208c87f25757f57e02b6cc9b05c7a91036957b1

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