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.2.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.6.2-py3-none-win_amd64.whl (2.6 MB view details)

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.6.2-py3-none-manylinux_2_17_aarch64.whl (2.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.6.2-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.6.2.tar.gz.

File metadata

  • Download URL: ciris_verify-0.6.2.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.6.2.tar.gz
Algorithm Hash digest
SHA256 b88db606247b6066178684e18b730ee079ab780c8b57bab89a444e151923a1db
MD5 57c06976b591444e963978a21f38ff9d
BLAKE2b-256 537e2c62b1ef442b409f327e538aecc147ac7264daca12602ab3a6897ff7baca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.6.2-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.6.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 c70fcc4dd4631dd2275b8afd5bf60071f6192970451598d7c2a0a5ebd8b7447c
MD5 3c430a0e8ebb7191b288be6e460701ac
BLAKE2b-256 8e52058676a1546445f7d45a0c64bf27970bf71a346c944167ca7028f08bc87e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.2-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 11d19b99c706a4db4c47cf89c71b2cfaa0f65084dffa0f9304ef1abc4df2072e
MD5 a78a17d0637694bafd7e694435b23a2a
BLAKE2b-256 db8be60c9d6072a3f37b0fbc1e49e8c0bc2c81d2ac8c83c7bf4eccc1d9c061ee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.2-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 45122625b0992f525299ad4f1052da098db8e2cf82209bbb35b0ae17ed86ade8
MD5 73ecb687a3506615ef5fd259c5d15ab6
BLAKE2b-256 15f9300d22541873d0660d5e307b6b48f7e301457cb2604c54e3ad09acda6492

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 6b02e18cd6f996ceb9493144e8a8d70315fcb95b880eccb5c788c1925c4817bc
MD5 7a3bb6ed4ea4ad52a2047c93006f96c3
BLAKE2b-256 9a216e9c71665a97134263bec6f864f61477e991ded0aeb9d952a0982d68be27

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.2-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 2527833d077dde744856f8e85eaab914c0f53062018fb3ecbed6529f15981bf5
MD5 e5c345a4196161dd319101a69029c1d8
BLAKE2b-256 569827d0111486b7c1ea03cf36d50e873f910c86623bb5d636df12c79f0efad2

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