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

Uploaded Python 3Windows x86-64

ciris_verify-0.6.3-py3-none-manylinux_2_17_x86_64.whl (3.0 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.6.3-py3-none-macosx_10_12_x86_64.whl (2.7 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: ciris_verify-0.6.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.6.3.tar.gz
Algorithm Hash digest
SHA256 1e45bc693619d8ed963f2f2f2afa8dafc514c944d48b17ff0cd459dc05fd3440
MD5 d46b2610795f18415e480a2a31c2940d
BLAKE2b-256 687f6a7e3867e73dc8ff65e4cece0eface99a41ca8b26056726f1776e253c3df

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.6.3-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.3-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 3929e59c11abc1f5559eb6fdf063dad79dd626653bbcecc9bdf9944838469a43
MD5 f95d4f2a50fc3c3ab90fde8db441a064
BLAKE2b-256 8ba2522d54acc1b817afbb2245e069f0ae467770deb4e31138b4078057e93fed

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.3-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 46bd963778c52866788c55770f13aaf65cdce92c56fd53975b27ccb095a5f902
MD5 d8d01acc52913736c9df405a25febcb1
BLAKE2b-256 3393c2a69a9243e5d8779d582922aad76ab71d6cfd5f6b5acb341e3205f0fc9d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.3-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 586ac00111d1d265752652594891f3230ff4c37e9cbf8f7e6296ce7c9d2d1e80
MD5 48faed35e1966fd548567d353629d176
BLAKE2b-256 dbe349615429fdfe4a7663ea84566dd868984d281101a6e86261d6f8870e0f8d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.3-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4cb359a54be34b0c71d0cc0e7abdbe9f1fd6cb3d3d043450004db091506e3908
MD5 13dc2d26863171e8e9b06109eab9813c
BLAKE2b-256 dedac4aa1ecc5fa1204c848f4f944eead42ceb2d33fc3152025010dcb5aecd96

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.6.3-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 a7b990abf390aad86d0b4cc3e1d3ed1ad7e82c824862ca7533754b2c689871f8
MD5 2c502fdc9ffb0b2cd471a359476a44d2
BLAKE2b-256 37739a6f25e1a3259e561ea54be0389c14ea5e3086a1ba7954316830e9e8b060

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