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.7.0.tar.gz (24.3 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.7.0-py3-none-win_amd64.whl (3.4 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-0.7.0-py3-none-manylinux_2_17_x86_64.whl (3.9 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.7.0-py3-none-manylinux_2_17_aarch64.whl (3.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-0.7.0-py3-none-macosx_11_0_arm64.whl (3.3 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.7.0-py3-none-macosx_10_12_x86_64.whl (3.5 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: ciris_verify-0.7.0.tar.gz
  • Upload date:
  • Size: 24.3 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.7.0.tar.gz
Algorithm Hash digest
SHA256 8b4b24dd9e822844b984de617098f6e980cbeef195e2544a40439333cfa8a14a
MD5 993e45c358af6b53fb15ea26fe826504
BLAKE2b-256 2758b7137b68b62d14f1d9f475c6cc95be22386cf6982cf9fd52a12f45c212c4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.7.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 3.4 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.7.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 0fb594ce0545f17f6bf20c80204dc6fa3034840b5dcede7168ccf2c6420512ed
MD5 69878587c454800ae0c885505f72756f
BLAKE2b-256 0bf12ed3cc8a27352ac4f789bdaef7732a527f7a252ecae0cef8bb2bd9330567

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.7.0-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 d2a3a3f84b44c62aed2b96991a34b70fc6684ce202ef4c433fc27e6bed1b4d0e
MD5 e8eb15240ae21c4ee48bfba0607bd626
BLAKE2b-256 52bab2fd2716acdafbd00a03cb810f6c0c6a40416bc2cbd74ea66e8d10bcd60c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.7.0-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 079c91b0337727d7a6481ae9ebcd00cdd3bda300dac144a6f7d51a174fa3942e
MD5 4def9129a2e059d0bbc30e2e6f7e1052
BLAKE2b-256 972bb3d63b4d346e20c6771b4b5a4d484598cc61e4b2a6d7759c5321b340e9fb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.7.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a1330e832424bb209da155cba8824c1bbc1c921bb56923033baed418cc5ef74f
MD5 686dc80511b721b707bc57ae8b7da26f
BLAKE2b-256 249c1030990f99f599dcb2cc01caa1232e3fd4e6faa376ba53b0d2ea58acb3e5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.7.0-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d82dc987a76523cb7ed010203110b557df95625d8a20bfadf69fd236e5774635
MD5 c8c69866f5238c045d8aab678e32c984
BLAKE2b-256 7f8324047fb48e81e6da8bf064707e6e2f07ad155470c644f39ac10cae5220b5

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