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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

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

File metadata

  • Download URL: ciris_verify-0.6.5.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.5.tar.gz
Algorithm Hash digest
SHA256 fee39d469b75eca4bfe4ffdbdef65d001546227e7d4430cb0b6b85468b744a8f
MD5 d31d6c4e80d3059c083ab1ea2a2f4b6b
BLAKE2b-256 17d932f3b83e953cc90faad009c1c6d9cfd45d012a40c6ba59d5945cfe5b73d5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.6.5-py3-none-win_amd64.whl
  • Upload date:
  • Size: 2.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.6.5-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 d52ffe53e44dfee1010c7614b2268d539f72e2650f1dcf6ec6b74bc74fa723aa
MD5 078836ed4422e2150f34cb966778b97f
BLAKE2b-256 63fc11e5c3c5deaf4aab12c7c249e743a2c80fb82d52ff2aba03728fb924959f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.5-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 9d5dd664bf62ac6f71d44ef5b64f524e70a9e70b36ad3da835af5a10045ce8ab
MD5 362684d6432ec1cbfaed671e41868105
BLAKE2b-256 6cbe89a795f856a1b2fd2e6d6efbdcb7d26656969aa7625eabe229a0672c7e5b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.5-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 5dbaabe46a4f3b39d485a174016227fed30e9ccb42a7c14c2f6a3169e0214048
MD5 71dbff514c5d774204b696334e94dc73
BLAKE2b-256 fc3f60e2dd75cd41de1300258294004893a3141735c017eeafbccbd1b677a208

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.5-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d39030b44acd0ba209831110b7a33f082e87fbcf3836b4a604666eb7fef4954b
MD5 a92187e1334ac001912dc52e68c9dd07
BLAKE2b-256 6a9dd05890efcbe4aa38c6fe0f015917b7ddd6a080b10ef07b664644e3771e84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.5-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 44d543872b82916ccdc554af912968cfbe0773225cc45e5c7632941b18289c14
MD5 0b20dea6ee592da0d9d960310ea16600
BLAKE2b-256 98103f0b5976a4f259e9baa499b6963d0036f938e92066428c5495923d17ea4b

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