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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.6.11-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.11.tar.gz.

File metadata

  • Download URL: ciris_verify-0.6.11.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.11.tar.gz
Algorithm Hash digest
SHA256 aace89d830a0c4872c02d06587a7305f554f2074754f9ed3d6b1149b3e28a108
MD5 6ce5900ca405a4167a0ddf1d561f04a1
BLAKE2b-256 ac2b2972b83d56c4449f7070b6d15cb62572f76ede63a123ae4d93f8397f0f22

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.11-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 00ff9e1ae03fae96360169e38e49bca0d13baae841b241fb376a19e2fc294dbe
MD5 68eaca109b093f4ad33e0cf8f879fcde
BLAKE2b-256 84ef2420ddbdcca44f3030338b9db7390a81b0cac9c878c8b3eca11c8e38df1b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.11-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 ed224dc8f195f43e25320673e59c631992ee5e7b9c9a04b3247fd19af8fc345a
MD5 fc83c094dfc8d90a66b60f84f9b24687
BLAKE2b-256 f9a18540489df18db1b78fb5e95faac8b25927769508efadd4acc9de415fe739

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.11-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 2ad4b55c72de2e1a6e075d6cf65d6b5724eb387e0e0751ba3981ffa3d7979326
MD5 224a85ed9c6410d75b207bba02dfb7fe
BLAKE2b-256 cc145e055ebc7fea88c066d9ba9977f8b3ccb9cce98824b89f45ab29654561ed

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.11-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 49c0ff4df2f9a8549c17d475dc7a45a916f89af137e372469e40667a94371187
MD5 074cafc574dff0fa57b25cd033fc328f
BLAKE2b-256 4db7235c398bac5013f413fcec2ca83a997deb0b48360acdf87d4c34c0b7e5c9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.11-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 b8eb2f4a59ab84baf154290e80b67358eef160b4bcc3af4a2cdd1253518a7926
MD5 ddd8650869784f9636f9bcef84604e4c
BLAKE2b-256 b9ed3a10f52234bf7ce3a4bcd5ff35d5f6316b57f0525d2b4ec56b9dda5cf163

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