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.7.1.tar.gz (24.3 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.7.1-py3-none-win_amd64.whl (3.4 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-0.7.1-py3-none-manylinux_2_17_x86_64.whl (3.9 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.7.1-py3-none-manylinux_2_17_aarch64.whl (3.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-0.7.1-py3-none-macosx_11_0_arm64.whl (3.3 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.7.1-py3-none-macosx_10_12_x86_64.whl (3.6 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: ciris_verify-0.7.1.tar.gz
  • Upload date:
  • Size: 24.3 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.7.1.tar.gz
Algorithm Hash digest
SHA256 6138e0b7dd6eaf7eaeb5b36984a1eae390aa29f34e72f479073ed137e22a15b1
MD5 c5ec7b2863145fb20bca70b8d44daac1
BLAKE2b-256 a25fd822f296c438655e92e87f14bcd85ac508147cf4d679675cb1335ef564cc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.7.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 3.4 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.7.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 4c4c752efbddd746b9bdcea40bc49ab75d253b5ac43ba049d7691bce37b3ae6f
MD5 52f80f7e969fc562ab62c150ceb22883
BLAKE2b-256 9eec1c017bb07feec66f37733abd46bec37dd645dcf5da718990ddebf6c7960e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.7.1-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 d727c5e7d89af9db8a6204361237ed6b72f4338115d479f329dad0d1fba765e1
MD5 fe29cf212365c6ba6008eaf56856757a
BLAKE2b-256 77b9639c8878a8ace365894ea03d616e14dcc91020a5b8eb2271e745fa490e6b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.7.1-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 b3fb09456a4e7d12ec9c9aacea5814714eb150634a58c71c820c500aa91a4681
MD5 1e38443f829ddbaac46198471e4d494b
BLAKE2b-256 3a1822116ff69665274a3e4ed170c99a28ca45bfc5c16f3995e8ba944a8206b0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.7.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 dec34c0266380e9f78a69c6868f3fed2723016cf1a35afdc29e044c747d71ccf
MD5 f5c3606d181446caac9202ab8805b361
BLAKE2b-256 a1ef5be3d68e6888d0b319165eef255679016c848528f5b18d402a0b35ae9144

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.7.1-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 2336616108125fe39b429341f405daeb3b62d672c1597c2ef04b3f121baffdc3
MD5 3cd79ccce34a15a9e27fcbca1e883313
BLAKE2b-256 4a14779bb69a8792adbc31f978f405900b07b9fc64b8144cde6febf27120b140

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