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

Uploaded Python 3Windows x86-64

ciris_verify-0.6.17-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.17-py3-none-manylinux_2_17_aarch64.whl (3.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.6.17-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.17.tar.gz.

File metadata

  • Download URL: ciris_verify-0.6.17.tar.gz
  • Upload date:
  • Size: 22.7 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.17.tar.gz
Algorithm Hash digest
SHA256 8013b233230a6b82c10b09ac9e3c504b3e9ce084463df2a976c9b3959fcc9983
MD5 f84bb6132330e423ad99cc17c331365d
BLAKE2b-256 cbf746b41cd778e4baf80b9df75f63245798e629e480a108021120a39ace0528

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.17-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 c983fe386b0927ff483f32b74af80ee7cb2f83a52c2c7b65941713616a440558
MD5 9f61d52bec7bb615f0d8a1db493a8e50
BLAKE2b-256 6a1ac930496073047fc867bd5e38145035b308b98f6c99d3a0277d1bd10eaf61

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.17-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 b1fe90e1b5ba7082efecd3bbf9fc0c3625f7212fdefbec64ae065ecea9e2214a
MD5 baabe4bae938e460b00fff9acdef7a55
BLAKE2b-256 ece80b2bec758108950dbf9378bc35266e67f4450453044c75bb5ce0c5a2ac9c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.17-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 256174c3d7b85ab365497016794aaa73b3ae01df7bab88110ea8a6e3fe0a5cf1
MD5 cf9ff1166f794c06136234c64b8b359a
BLAKE2b-256 4c6fad551f2a4bd68fd7c32820c0b3d8fa4e912ff754594a14e0bf308c5e5811

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.17-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 96d6d32471fbc78e88035e80b8ceee79ed9af4d5117f9f476d89c7235d3ce96a
MD5 ad3a54d969b9d5f6e501912692e367d3
BLAKE2b-256 37371b9fe574b9aa234d7d274b152d9f9b2ba563600622d12d23ae0bf3ef14ba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.17-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 a411f5352990ad6884c70ae08c8222afad1b8eac9c90d5e12c4fe25aa322c5db
MD5 c1dabb61548ebf49081e3fae6927a0d9
BLAKE2b-256 aa2f25cd97d10775b215a97a35e6de3867d7e2aa848674372de49efbf2e855c5

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