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.8.0.tar.gz (24.3 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.8.0-py3-none-win_amd64.whl (3.5 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-0.8.0-py3-none-manylinux_2_17_x86_64.whl (4.0 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.8.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.0 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.8.0-py3-none-manylinux_2_17_aarch64.whl (3.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-0.8.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (3.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-0.8.0-py3-none-macosx_11_0_arm64.whl (3.4 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.8.0-py3-none-macosx_10_12_x86_64.whl (3.6 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file ciris_verify-0.8.0.tar.gz.

File metadata

  • Download URL: ciris_verify-0.8.0.tar.gz
  • Upload date:
  • Size: 24.3 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.8.0.tar.gz
Algorithm Hash digest
SHA256 faf141b359f289816b1c111713e0efa88cf7d7d1944bad3651e2192fd731101a
MD5 9e4ac0697989635aaabf781babfeed55
BLAKE2b-256 bc1642dfe58279dfce3b2c24a92115cf66ff949b15afef691854530dcf1a85fc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.8.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 3.5 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.8.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 40890e6c7d02e443cd8f1781ccf8113cf376dc97e1ebdca87d056003a012f466
MD5 6f32267f4a366f5afe8db1b2c4948a1b
BLAKE2b-256 8bf9545ba9aed15ec2324b3632414c036ca36117b71e50a2cbda34665d911fa0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.0-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 2578364c0dd9cc5250415f2508222ad6872e360230c0685aee759a621ca17cd5
MD5 09533b1975ee23853ca20d21eec20dc7
BLAKE2b-256 1db37112e48d1ccc83ce488827321f6f16e4ad5d16127c09c0e67c50522c19dd

See more details on using hashes here.

File details

Details for the file ciris_verify-0.8.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ciris_verify-0.8.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 8d5632746f1ee5e4722db99c27286c8113388a442add39d61579b8ed989e0f38
MD5 ec6203f2258cdf89c20a7ff02f564c7a
BLAKE2b-256 5fc3c83d1913c97c2fb47e1f6ef07118e35862a02a0e70b3f9ca8eaf1418be78

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-0.8.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.0-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 09b1f66a21790fb646564994d4284ceb99f6620dfea014b7aff2507572b68227
MD5 cd76e4c51b5d8d4a9613e31bea10347c
BLAKE2b-256 bb6fba7a0174779a9f8fed8717a24bbd21506d7ab545265fdd95668fb9f3f94f

See more details on using hashes here.

File details

Details for the file ciris_verify-0.8.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for ciris_verify-0.8.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 96bd875bfde0388294ea2449bc13825c4d4c67bd0af7d5e839e6a303590ecf9b
MD5 9cd9989e7d7d15daed420050c4a970ae
BLAKE2b-256 32a2d39a24dc44fc02bb2e31ded39941e32b1e9feb21075ebf490c0df6935127

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-0.8.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 bc976a9ad092e4b64f076623c1d373b80fd493284b1b0f0e772645fa9bf5eba3
MD5 dc781bce1889e5b1947f459eb9b85172
BLAKE2b-256 57674a199223ca81856d8d5c9c04a86cd57d66b9caafd1a64260913087891fae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.0-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 92e69dd232ebd6b132c6d5a1d24334c4d67d1844733bbcef2991cc916d9b3b55
MD5 0e3066fd39165c8f8d1458d5d628a211
BLAKE2b-256 3f309c7db6805e4f6cf7d79f729a12eb7127a188246cb57a2ccca3eee7101fae

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