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

Uploaded Python 3Windows x86-64

ciris_verify-0.3.6-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.6-py3-none-manylinux_2_17_aarch64.whl (2.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.3.6-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.6.tar.gz.

File metadata

  • Download URL: ciris_verify-0.3.6.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.6.tar.gz
Algorithm Hash digest
SHA256 ce70d2ea92dea49b47c6581983338edb1947feb5b51842332d91998e7f7d8e47
MD5 7ba8afa7ee941a05fd410e54988bb82a
BLAKE2b-256 d1f7ac63fb6558791d9924ea3967e7578ff80eb91a571041e2823f44ca5a377d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.3.6-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.6-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 6c5f493b078b917cd0961c039b08d1b8d0fa499e1f985e8100a86c07dcfe3938
MD5 d322fb7267225693c28acf20ab5bc1f8
BLAKE2b-256 5960e316361fb946f784340bfba4924a2f9de908b894aabac237c5107eff004e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.6-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 4f18c9807e5ab5076f40198d5d59303c1e47e77397185afb042c53e0f406a737
MD5 930379254d29921774bbfe127b5c606c
BLAKE2b-256 a137b68ea56799bce0dee6c948370b385b848f56026166ef38dfc0e370cd6a6b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.6-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 e376156903a7444abce974cccf94a8cfd5c376f12d47b72f70ea30cbebc9946f
MD5 c037dca84d4b2252b0bd78275340b335
BLAKE2b-256 f44bc4deacd914d398eeb61cdce1c917823875dc27b870e6c9bde7bca4290911

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.6-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ce2e3467e3ac0776dff273f0c5126403db46c96b4ff031f57272e0866aea15a0
MD5 a6b43c6036bd95325be1dc8ed8e7235c
BLAKE2b-256 42eb22de22067b6bef96f54f699e5fb3d61e100a29e2e2607a49e40c7aaea007

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.6-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 5136b384bbe957bc3486a97ba05af7a201f7fcb0d2dad53d5c31aa10aefa9627
MD5 68b7be42259479476d83734c046b8c91
BLAKE2b-256 39d6e2a7e26c1146acf970862b9ff7deda21ab3faf1d151fca409fd38e73e263

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