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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.2.1-py3-none-manylinux_2_17_aarch64.whl (2.1 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-0.2.1-py3-none-macosx_11_0_arm64.whl (1.9 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.2.1-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.2.1.tar.gz.

File metadata

  • Download URL: ciris_verify-0.2.1.tar.gz
  • Upload date:
  • Size: 18.6 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.2.1.tar.gz
Algorithm Hash digest
SHA256 93b0d346ff09899a286969dca421b9e23904b85edc2664223d468599b26b2c2b
MD5 ac97df90bc4cf086cc8fb8965c7cb70f
BLAKE2b-256 ba37f89636e42018158ff5fcc28507920f8bae3ff780522cd99b6e0242099508

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.2.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 2.0 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.2.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 4cbfea58070d5d9671a52b0b1136a25b852389ea1cab28e949ec77592811c6ac
MD5 6254fc10a5be9754f1ca4429357d4f22
BLAKE2b-256 4b6a9cbe7e41aab9fcc6223ab2664dc4ae6ca872ea966e48d0f50ccef811cbe2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.2.1-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 5b25f0cd5c7df50926ad86afa1ee9c82ee69db103e53d63b72bfada498047988
MD5 607e041e910c68977612238eed987046
BLAKE2b-256 32a12433f864511d5ceec6cc3b2a213828730853ccfdd97cddcfa7b1974044d2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.2.1-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 c3198042cda69aa94c4879bfbf45a187a2980668ce6cf3e0a06e01460efc3528
MD5 7ab2ca9501431891f6f83d13466ec987
BLAKE2b-256 b15c6ef33caa35fc0c9d1795103036dc3b0ddd0b8adcc529c2c5cf87a6e1f42e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.2.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4f09187855640d2889d99fc59efaf69776e98f305c3f5bb4663a286597186dd5
MD5 9e3163a46b3e949995c6fcbb8f4b4e86
BLAKE2b-256 c3a2fb9ed5c6f0517e99b5c844c36f0f15ae925abd72752cfee4ed5b0d2e98f4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.2.1-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 c7a2b4ed361991a7f31ad3fe29766c2084d4596b0f86bda6160dae2438587c99
MD5 e1b51e91a78be2ed9a88e041602ec295
BLAKE2b-256 746a5014597450b89da9229366de6fe45702cef0054046e334bb70430e0822e0

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