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.14.tar.gz (21.4 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.14-py3-none-win_amd64.whl (2.5 MB view details)

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.6.14-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.14.tar.gz.

File metadata

  • Download URL: ciris_verify-0.6.14.tar.gz
  • Upload date:
  • Size: 21.4 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.14.tar.gz
Algorithm Hash digest
SHA256 5b28dcd0aed1fb0fa4debbc06db0e7b16fcfc5fccc32edc6adb39c99e87da1a1
MD5 20090ec0868b21a7bb8bf1eb43a07d47
BLAKE2b-256 13a9bd6cb3cc9254d309480b96c914e0237af2f057e4487a646bf76530b4e9fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.14-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 7483b827f673901464def4f58521ff88692657e0260e16402ac0d0b6f9683b86
MD5 5f6972717736822d6d8bad071a969def
BLAKE2b-256 1edb7b613811942d6dbab6e27cae8cec0434f7b879534b965ec2ded8cc8a3737

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.14-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 c8e21592a903d7fe8ea972df8a6bfe2e3fbebd35f5e951370d45e3e3e018a58a
MD5 054473018f3e439b2dcc7fb0a2216d98
BLAKE2b-256 1602b796c4fffee53cad5c0d2d6514e077f30399650f0f110812ae66c1ddfb00

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.14-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 d2537d7e669b69783f2a42008e9636a261faf0d5d1eb6b66610a23675d8d80ef
MD5 97bc5dd8e8e346f657b5d8ac58dee941
BLAKE2b-256 3cb9e89777243fcc85328f8a084625301aaec755d7f3092a1ab088c477247490

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.14-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c83242c0e3c3449156a968be5462876c3b6bda489b58363720a36afadcf6afdc
MD5 cffd15e5617ddbcb01a96e3496102530
BLAKE2b-256 df9a511e2a3d5a36e7fad92445842cc288aad009a5c01cd8f2a732937b8290b1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.14-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 0061d95cb11dd35838f42743af651116c467276eab8250adad0c232f0552aff6
MD5 5185f51f67b79784a1c81f96195f2d2e
BLAKE2b-256 c6439f08011e28536dcc20b416037989e350a899c3302c7cdbe553ced2a4c891

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