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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.3.5-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.5.tar.gz.

File metadata

  • Download URL: ciris_verify-0.3.5.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.5.tar.gz
Algorithm Hash digest
SHA256 a80e05bc2b3e1e1ccdb021ad6e5f693e5ad10fb42b5c0ed45745365e24a3f385
MD5 3464f218a09007ae833f39f3a9431c34
BLAKE2b-256 4667c4ed5bbd6d5d620cb1012c2ee140b9dc14c00cfbee648b7dd856013282ac

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.3.5-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.5-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 6d91076c20b3715e364863369316c8be4a1b815042ca67f964e3f9c13c052eb0
MD5 e1511afdab94b55f79ac8085f9ef7579
BLAKE2b-256 438d0fe5a5791398d21b70da93290b1f5103b27f651e543f06e444e4f587680f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.5-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 8d558a3f0bc55d7b92662d5c8b61dfa3845f57046d252c3a2ebe2dbc8472f3bc
MD5 259da7fa42920ff8c9bccb9008095dd8
BLAKE2b-256 731e1f2340169533c16a55613bacf5c366375a6d92028e2df94480440896db7a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.5-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 31bd81b3af2175b7284249569b68f1ce636e8efc50f12a80d910b0d6b745a22a
MD5 d376d24de15be040e00995551f4c720a
BLAKE2b-256 4f598deacb0a70cc773a57a07dc1cf46aff0ebe51fcc223afbcbd8a23d8ebc9c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.5-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 973384badd6537aee2908604056201c7f8e82a94b0030bf78732149b357fcf6e
MD5 8ba8dd9a70bbf2adbc3ab2d6f5a5c047
BLAKE2b-256 8da16c30561adcc71bd231a536e2d2a07b564ca9223a07c6c1a35a3576eb875c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.5-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 4e80b6cb72e89aefe347f16fd5d3fe4d79946c05d6b4c7c273b3b7266f9d3355
MD5 ae78032af1c53d91be761036352fbfa3
BLAKE2b-256 d444554a820724306d1123ef071ce1e9f37e6e42757d30aa4fe586da53609cdd

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