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.3.8.tar.gz (20.1 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.3.8-py3-none-win_amd64.whl (2.1 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-0.3.8-py3-none-manylinux_2_17_x86_64.whl (2.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.3.8-py3-none-macosx_10_12_x86_64.whl (2.1 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: ciris_verify-0.3.8.tar.gz
  • Upload date:
  • Size: 20.1 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.3.8.tar.gz
Algorithm Hash digest
SHA256 0492d3946f31908d5318dcd47b4fb916e652085541dd09da00a04864ca0c6036
MD5 4630fcd4630a834c3e7fcc218ecceba7
BLAKE2b-256 141429aa18cf4ac385eed9a5a0a50210c6985a96eaa881e8dbcb28721abb444c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.3.8-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.3.8-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 f835f7000beabd71622be9f8b6d3ff60840c207ea504b58b90054b659f1a0320
MD5 aab70b8f91d9264bfc3d188c9e381aed
BLAKE2b-256 07eccac76290bb5d2b1364dc827918c8ffd37589a20a9e1c306b26a3a2509e66

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.8-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 10a669a6ed40a9f8bebc231bcf1c85be7cbdd19104c9a15c9559d22bb118b824
MD5 89683fa4d4942c77889f32a215e5ae3b
BLAKE2b-256 8e628ec84d8083384c23b26784bdd4dc244dd530e4d2f7a9477da025216df31b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.8-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 055956d2cda04e3c519307cfadc6e5d8df5e69dccd6971328f1125eea543c302
MD5 8e278c1866cf4f54536a3d92f6cf70c9
BLAKE2b-256 d9dc5b81549aa07e8f1e4ccf8c592a9aa64cf5f30118e47b29f490a61ffecce1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.8-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d3e2eeed23ab50bd1af17433adda58e7a131c803bf79acb6f76212173e40925a
MD5 b16929d78a12f93ca95e30be275b17cd
BLAKE2b-256 54bc7e4eb16a2db2dfba9c30a0baa832958fe81338880293bf1cec27f1bd91c5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.3.8-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 77bb95f1b429a52f2ebc7e40d602d3bbe7e5d79af8bd335f97758292afed7ace
MD5 c5a0ded3c76b8c8c089be90ca9575663
BLAKE2b-256 c1af67eb66aa19b8bf045e5304115afa7ebe5d72af3ce97a4be94ed95f15be1b

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