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

Uploaded Python 3Windows x86-64

ciris_verify-0.5.0-py3-none-manylinux_2_17_x86_64.whl (2.4 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.5.0-py3-none-macosx_10_12_x86_64.whl (2.2 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: ciris_verify-0.5.0.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.5.0.tar.gz
Algorithm Hash digest
SHA256 20fde7fe314554ed89f283b8de9a9cac6aace616f15d9b599ec436063c18aabd
MD5 ede0a35cb65408cc0475ce541d4e2957
BLAKE2b-256 d5e1ddf3a174b4e027d98f3a75e682ff9f6ab4f084bd3f110731101007ff6788

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.5.0-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.5.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 0ff4aa97b1158b4f5732cb93c5104a9978e7a6fedea14fb317d06e85ff4f34f8
MD5 343e571536c3ea66ad24e370eb4e7bff
BLAKE2b-256 c82f8dfc7a9cd64bdee3604ffaacd4e18de108f91b7c6f681b31310c5fca33e8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.0-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 ae99c232f0fb8991c4588e7982a7a89af5511a8d65d3269d42d271b22e75eac9
MD5 859b46b515c7f713fbb0c47f56687590
BLAKE2b-256 7d15157e0c14d3807043f67ad103b10b0488485f7fa956ff1a0a08c15ec9acb4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.0-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 c37ccd53a0e9343ba00e595684f08a8b60842e7020e929e25114d0c17dd9586c
MD5 01c326d17af13942054857f7d241c015
BLAKE2b-256 4adafae69862a260be4faf0e63b11117d83e1f9077f68d4da9a688852c36fb4c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b4ce12c9051ded11a92291aa898ea3189219b071207fa536a6be69be959c8dd9
MD5 ee2168959426d0ccb080c451887d3a5e
BLAKE2b-256 2093a4ea281bdd297af94cbb895f8e167334b0e655d43d042024b7fd7b5e2178

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.5.0-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 7d971e8cd534d2fe914d28f637d8466570f1a0e5e6738e8e791f6ec86c8722c6
MD5 97b3059869b34960968eb19f2e6202f3
BLAKE2b-256 8dbf7a77face6f7e44cbc86df3d59320fd058a9857104dfa555740ba6787ecf7

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