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.5.4.tar.gz (21.2 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.5.4-py3-none-win_amd64.whl (2.6 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-0.5.4-py3-none-manylinux_2_17_x86_64.whl (2.9 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.5.4-py3-none-manylinux_2_17_aarch64.whl (2.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.5.4-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.5.4.tar.gz.

File metadata

  • Download URL: ciris_verify-0.5.4.tar.gz
  • Upload date:
  • Size: 21.2 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.5.4.tar.gz
Algorithm Hash digest
SHA256 b797af9216046b895bb97e58fb7dffa52d85347e4faabae4ac6f0cc3e6bf9cd3
MD5 8dbfe045776b8a38562942910b639259
BLAKE2b-256 1fb2e0c56f7819ecb6bbd178303ece64095467dcf5e1537bed68f68d0bc6e26e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.5.4-py3-none-win_amd64.whl
  • Upload date:
  • Size: 2.6 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.5.4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 a1b31080453d4f03bb901becd83cd877805abaa47c563f6615496ad83b6b19ea
MD5 fa3c1bf483741389052fbf57eefe7b9f
BLAKE2b-256 e1b896a8dcfd47d5ece19d1311dc5803ee07c87e6754a0939ce2ad1c2c7114db

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.4-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 c31e3f6a70d15d49683272eea5385095d0c5979aaee055aad79c76b2105c763a
MD5 4a91812014411b95eb7ab3e46aeb9a13
BLAKE2b-256 f618582e433e43ad8828a2475b7c9d3489202dc32a314721ae13de7abfc90996

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.4-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 9d9cb8efbca9ae68177f2972b1241f0353120b8ab6a3efc3bfc6cd9301f188ad
MD5 4b6b10dde8324dcc47152a6317f30db8
BLAKE2b-256 32ce18ee702ef406c5d74c993964354035ec649541d7afe859312ae103ff3256

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a687823f07a639f62024a5ca098823fd98720d7bfd2c736551423493a614141e
MD5 b2955e84285a9a0d2446f89b7775db02
BLAKE2b-256 d68a71d48b09c41d0321fc8270578e93ea985fbdd519e6a4a1f50f94f931a51f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.4-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 1687ee916c8be8347e771742b3def0a2fad36d2dabc6d06853681736bc27cdd4
MD5 cb3b4b6285ee8c3e1cb8a21e95268819
BLAKE2b-256 7442b169c95d7ad99ea1e737769bf9cec28c61cba7344838d1a09b0ddf933b87

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