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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.6.16-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.6.16.tar.gz.

File metadata

  • Download URL: ciris_verify-0.6.16.tar.gz
  • Upload date:
  • Size: 22.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.16.tar.gz
Algorithm Hash digest
SHA256 2bee8dc983e946b8db31cca04b485e0b808f3cbf08b68333b5de92463964fbce
MD5 fffcb86afb2a72e6fea7f34e6a7ee861
BLAKE2b-256 872c1f217c0aed2c574303c09126cd91258b397bf6cdf6945885d44b3fb9483f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.16-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 e289fd34619cd03048ce9a129759a73413fd585ce7f4f96f88b93ee7662c0835
MD5 849280d607d0212c736188a9e1666ffb
BLAKE2b-256 1bb3a2093da8785dadc1e017081e00dd4551e8d4fe092d5449ed804bd75417e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.16-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 2044b0260b4460a2ab890b03ac86f03c1725ff80094e1dd22e91f9997b16e797
MD5 61df8108a123d3f7d7fc36968a59a273
BLAKE2b-256 fbbf190abc34183ff6d8c55257e621f0b477663b9336d1444ddbc11da5b6b65f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.16-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 c9e17ad0fb993d24a546f208578cb10905dc97db2ff88dafb0e4561a7b0dd101
MD5 37c081eba85cd690ab98cda5543bec41
BLAKE2b-256 f14dbae95fc8c89259d9971dbf1a8e1342f80ef6ed8381108628fc7bf0725cae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.16-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 5f8abde6307c4971aedb1724c91bf2ba42f60bd41de13c163db928e229666e80
MD5 cc1c9a88e4dbee92142544591b7e2dd6
BLAKE2b-256 327d09623d14b67bd17bc460648e48f2d8075d6608ebbb3475b20d31eab73624

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.16-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 b6a80d61019362943631653e562fd8cf733aff0c5eda3a6d905e26a716962966
MD5 0c5fca4197c71f3c1634aa363b4ce439
BLAKE2b-256 8b4fb595ba401c99d07820c52385a0e51f9705ef4b280424331146b7a4963fbb

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