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.3.7.tar.gz (20.1 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.3.7-py3-none-win_amd64.whl (2.1 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-0.3.7-py3-none-manylinux_2_17_x86_64.whl (2.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.3.7-py3-none-manylinux_2_17_aarch64.whl (2.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-0.3.7-py3-none-macosx_11_0_arm64.whl (2.0 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.3.7-py3-none-macosx_10_12_x86_64.whl (2.1 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file ciris_verify-0.3.7.tar.gz.

File metadata

  • Download URL: ciris_verify-0.3.7.tar.gz
  • Upload date:
  • Size: 20.1 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.3.7.tar.gz
Algorithm Hash digest
SHA256 9caba722510c4d09f5d5ce6d379b48ae942ac4ad9a4cfadf0862b3f5246309e0
MD5 24fcbcec3c39a5d52090865a75ce652c
BLAKE2b-256 7d802bc2546bc3857b9302f22fb50a6e3b737e8e20d7d8f5fc626188e019a773

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.3.7-py3-none-win_amd64.whl
  • Upload date:
  • Size: 2.1 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.3.7-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 c4e67d996e80671fc32bdfe11e752ea1b9c97594789564f05b184588827ab53e
MD5 9e917f60e68ac89b7309dfe56fdfb67f
BLAKE2b-256 98e0e7d77547ceab05eb4a701b89667dfaa62e800bc2882b9da3d632149ad32a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.7-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 643dfd789b22e6dc465d606023d0e41c43c794d0f839701c88435fafe2410568
MD5 92872dd169fe07d2a73ed85e3d5213fa
BLAKE2b-256 0ee124c801d5799c8600984156b75fac2c1b603f1e7fcf45b8b5b8440ac6272c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.7-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 6685848f0120edb377fb491133bf95e6f79cf88dd3cc791fe3c33f7340afff20
MD5 a08ff60435a0073fd18765c02718a557
BLAKE2b-256 9b43e41c4433b73e35abbac0c35e0496c7ea6e6b97f331f8cb1f76187d221464

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.7-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 03df216ef16948f5f91c480280c94a4ec65c6a1dbee16df3fddd3179f01ad174
MD5 0271a957d25ced9d68c91382901f1d6e
BLAKE2b-256 2f1d9243236130ea3e793868448bee41580a1a50918a8efeb64321f3202f3c3c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.7-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d57f7d4661e0c91448a5db83fcc78cfdb52c757000986a6e98b0defc98e0d9b5
MD5 4800af912ce83c53a8df281fb1c578fc
BLAKE2b-256 9760df1c9b0834730488f43911a9ebf3aa24f9c4acd5731011881f0d8c35c5a3

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