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-1.0.4.tar.gz (27.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-1.0.4-py3-none-win_amd64.whl (3.7 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-1.0.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-1.0.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (3.8 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-1.0.4-py3-none-macosx_11_0_arm64.whl (3.5 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-1.0.4-py3-none-macosx_10_12_x86_64.whl (3.9 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: ciris_verify-1.0.4.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ciris_verify-1.0.4.tar.gz
Algorithm Hash digest
SHA256 bdf39f912f21ea30007ffc820657c1ad22c1e6203896d25baa3d3ba318c0360c
MD5 e40eb5b57dbcc198ca8c08158b6d657f
BLAKE2b-256 00eb0792518829fcefbb86452de2c4f9f2dabfae9d7c94e3736bb7cd548547ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-1.0.4.tar.gz:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: ciris_verify-1.0.4-py3-none-win_amd64.whl
  • Upload date:
  • Size: 3.7 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ciris_verify-1.0.4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 4e5178b4a432ac077d04c302015605c605f73260ba29ed64ee842ac3518e855f
MD5 21358d513d9feb696ce91589d9fe2b14
BLAKE2b-256 66ef02e10f0630ca00615619adfff1c009c60dd7dd8a2f14410ede76b48e5215

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-1.0.4-py3-none-win_amd64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ciris_verify-1.0.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ciris_verify-1.0.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 939ba61e597085ba01aaf7bb1e3436cbee9be6f565ce3633fa82694968eaf16e
MD5 27d261bf5194b41d8030a58739b05265
BLAKE2b-256 f51a2d660db854ea94d26acfe380de23c0ef24a2d07e48268a03dc0478b73c68

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-1.0.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ciris_verify-1.0.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for ciris_verify-1.0.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 d7cb72c55638a8ade1006dd63e9f4ed2dbd31f3a14ed5415199dc52a81c5d03e
MD5 e99bb438fafca0f07eb58f8b54ccbb38
BLAKE2b-256 6690152cff3ca54d662bb6f919e9fdb288b5d7be0f391a658af74c3eb3033d59

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-1.0.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for ciris_verify-1.0.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 8461b0f6380794445392a97f0cf6d0f9ae7bb782df5ae410423be31ad50f3000
MD5 b9656948e299563e7878877e7c9c9295
BLAKE2b-256 8489d9a68e8810ba843a92a4c8a3c579b29b8c7755e9a15a98cb903496f811a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-1.0.4-py3-none-macosx_11_0_arm64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for ciris_verify-1.0.4-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 f9df26574cdf2f18df9fc52978d64480975db1fbc456df9f2df680e78b8d59c0
MD5 8f9517b474bd6cb284846e2a3fe8cf58
BLAKE2b-256 f5ff3233f80ce660f3c5dad509c790648f2e2f304a9a4ece3741c13b6b8a06ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-1.0.4-py3-none-macosx_10_12_x86_64.whl:

Publisher: release.yml on CIRISAI/CIRISVerify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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