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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.6.15-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.15.tar.gz.

File metadata

  • Download URL: ciris_verify-0.6.15.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.15.tar.gz
Algorithm Hash digest
SHA256 2aaea024314b488b167c1fbe774e04c011236d90237dfe9dc624e115c61fbee0
MD5 aec716eece148b6db2470c74753bf527
BLAKE2b-256 4cf7c4a35750c971c71ad76e96a16e9ae6a4b387201b18c97e2b6d4c9188fa9b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.15-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 1b2e55361f1265d110097e4fed45172beffdd8e5e108f1b3d9e6945d29e21ad3
MD5 f87f4bc13854bb6ba1d25cd20860924c
BLAKE2b-256 3e20e2b6c16f8227d6989093b7008ad7e01ded3f2221b1af8e49079fdeae0874

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.15-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 b014f735ee2cf9bc4e0bf8ccf4783ca5ee6b40f5d2cdb014b6b369b6fab85e03
MD5 93c63e5ae26c990898ded93a3b3c12fa
BLAKE2b-256 0dc0f955490452a242b015fb17d170a2451ff2932617938995b0052d255be3f5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.15-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 ac2c4194a2622f0d11d7f22dae103414e575eafbc2a939c3a498e7ea67348c89
MD5 db60b43bf8c3f5a5caca5e211293e178
BLAKE2b-256 7a079e374d56bd3e5c0cd3ccab7ad8c0ea8a7246cbbe0e8e2ada8b75dae1049c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.15-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 66efdc84e896dd31d367520947e2aff632058c29fc662da8707ca16818410b18
MD5 b0f15f14d866f5e0611fcdeab01df3b1
BLAKE2b-256 2efd9a59d05c208a264ef5db9bc5b5db634454c0b8e737ef6cb29f5f06dee987

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.15-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 17eb683972776ae1109aecb0b0ddab654b67c7d037b29d3af035e9c0fd42c43e
MD5 2e386f438f026f5c703f9b9ec756b4b2
BLAKE2b-256 b06072aa12c4770fb4b4efb17f8c575e6ea03b255425bd0ff865828241baa20e

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