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-5.7.0.tar.gz (72.4 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-5.7.0-py3-none-win_amd64.whl (6.3 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-5.7.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.3 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-5.7.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (5.8 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-5.7.0-py3-none-macosx_11_0_arm64.whl (5.3 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-5.7.0-py3-none-macosx_10_12_x86_64.whl (5.8 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for ciris_verify-5.7.0.tar.gz
Algorithm Hash digest
SHA256 a732aa191c5e19f6276da4247d4f36ee22e2927d5928f8ce108690095839218f
MD5 124f9a322ad7b4201655ecc9ec5da7d0
BLAKE2b-256 bf27ae274fb00464de76ff69a8cb2064c1546314dfe5c99af83285bea870d5e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.7.0.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-5.7.0-py3-none-win_amd64.whl.

File metadata

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

File hashes

Hashes for ciris_verify-5.7.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 a5b7ef39a90009d4df0d68c528047cb28f34386b60b1cce2e9122e8f07afe80a
MD5 bf480ff5bd3041fdd7caa62620276b65
BLAKE2b-256 aaae4ee5e3ef1d3954e2b6c88e49a7c9da32ee296316577f1681acac612bed1b

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.7.0-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-5.7.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for ciris_verify-5.7.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 8ba1babc73a90ba642100e448a22e4dcf2b9866c58b94edabea1a692d17476c4
MD5 c932f062f9fc452f0dee7b07d9bd561d
BLAKE2b-256 46a77980014d24d3e4d49c44e7c1872b732c49ae6d6ef2a5158799ff219b5006

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.7.0-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-5.7.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for ciris_verify-5.7.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 2723795fcaf8850a71fdf9c4809a45e5a979a927412bf1385a588677dc33d21a
MD5 21dad6af7b6994b9a227c11442a5c94f
BLAKE2b-256 8bd12997c4336836047157d87d7ffe2dc2a86f71e9d27c6219149ecf07aaad75

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.7.0-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-5.7.0-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for ciris_verify-5.7.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 91ab9003abe3f7eecd428aa3a9365ec0c87f94cb856541719af7aa5f890625cf
MD5 754519d324b46200c1b7e0ee5ce95249
BLAKE2b-256 da9ae5704ff673ad3ead79dcf5bbcf5d5036a335b4514a9718ba98dddea45d96

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.7.0-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-5.7.0-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for ciris_verify-5.7.0-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 0fac012e36987f12d5ff68a54ce45589ac435315cce18f9eb94051480747e07f
MD5 bc2adb8b7ce3511869afcbbb0471c5b4
BLAKE2b-256 cfac9d5a7800b2de2d6594c6db674de1269537eec55e9f5fef40b1719cca2725

See more details on using hashes here.

Provenance

The following attestation bundles were made for ciris_verify-5.7.0-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