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

Uploaded Python 3Windows x86-64

ciris_verify-0.5.3-py3-none-manylinux_2_17_x86_64.whl (2.5 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.5.3-py3-none-manylinux_2_17_aarch64.whl (2.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.5.3-py3-none-macosx_10_12_x86_64.whl (2.2 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: ciris_verify-0.5.3.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.3.tar.gz
Algorithm Hash digest
SHA256 7e44a085a829d08cacfb662e797d5255223d904338896ea3c1accf9979bb6948
MD5 db5a90bf99f876eb82a42c7cbb75336b
BLAKE2b-256 209c7d655383a848b58e5a47e42f166d5f8be5c961d341634c02eeabb27701c5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.5.3-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.5.3-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 708abd72bbc361802ac989e7fb9e39900f8b6b3c8f289559adbdc39a38a3c918
MD5 1a4feda98236b146cbe6de0bfb4960a7
BLAKE2b-256 54b46b8dfc446c4f24fc0968f95c77edf89890a2f39beaaab66a7e0c51f73b1a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.3-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 f2edd40c5d6ce9e181dd56ca405a77ade69cb4e8f585c63b28074f17a8770c95
MD5 2ef3684cfa6ae7aa0ba18ff4246363ba
BLAKE2b-256 11fa2e7cc4cb48d7bed599f8c7d0df887782b102cd9fd9bc089bb7f767e7c551

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.3-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 3e32a4d378a2f96159acb39600749e2905113ef7108c69e2cccfff0d66cfadc7
MD5 48c4d5eae5b7b7a4da852d78a6fffa89
BLAKE2b-256 1bee4cebaf799d7340159db4adcbf128fb155b7dd38472adcdb66519b2189e18

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.3-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0fb6e4352c127b32ddd78ab9a88814404dea502cbe033224f71bd793dc14b15c
MD5 65aec383083701fa83e1c2a5171a1faf
BLAKE2b-256 994e56c4d9b2e174d3c4718cdd8f9a355f745647b987a0264e9dbecc69797cf5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.3-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 ee762617286f3b7d8c6e45e9e1a5e8ba68d4860f79776821cd72aa8f5a96cfac
MD5 8fcf811d23fe0e264326569f5565d06d
BLAKE2b-256 4b54f67427f6ca8365728efbe9872f80f93087dd8585655277b42b613b1822a7

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