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.8.2.tar.gz (25.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.8.2-py3-none-win_amd64.whl (3.6 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-0.8.2-py3-none-manylinux_2_17_x86_64.whl (4.0 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.8.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.0 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.8.2-py3-none-manylinux_2_17_aarch64.whl (3.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-0.8.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (3.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-0.8.2-py3-none-macosx_11_0_arm64.whl (3.4 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.8.2-py3-none-macosx_10_12_x86_64.whl (3.7 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: ciris_verify-0.8.2.tar.gz
  • Upload date:
  • Size: 25.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.8.2.tar.gz
Algorithm Hash digest
SHA256 bf8791fb3e578a8b1bade6a4550fc2e7bf2e4d7b463667f59e329c1abc71ffd5
MD5 16a839836cbcfbbe13ac53159cd50281
BLAKE2b-256 b7a49571467909e3c1aeb4e817428ac90ce72a00a1c7885112f5853a0b491811

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.8.2-py3-none-win_amd64.whl
  • Upload date:
  • Size: 3.6 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.8.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 8b15841f76b306fd6166641e2fa8dc2260933a85e32a2c0b83ed3e1bd56a3cbe
MD5 6c9bc9f027333afc550f8879a6e4e825
BLAKE2b-256 938219ddc4eb56b36f0d795b1e19df0b2f64e01261c7d05c69d0ade38dfd9da2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.2-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 0a419f19e64605aba16984090cda22dbf66b493da56cd9ce066cb9a9eec0011d
MD5 0639916682201af75949a7e3fbc844a4
BLAKE2b-256 d8b23acfd0af7066d0b1f79073eaf6e0f740b49ac810112fd9ba860d7bb7dea9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b075360eb1dbd05275d9fae15e1aeeb8a95475dd4fa1915ea35f8e020c167fbe
MD5 423a7429607c9c55ef80c9e52d9f2543
BLAKE2b-256 4d6fdbcf51ac6972b669f50d675f07d547900864288adcca5ec4eceac82dbd83

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-0.8.2-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 8542392edb560f0f2550f9cecd1971ae7dc8d8b40b5851edc784b8861c0680da
MD5 8f624f3ba61198be080ea5d82d0f3d1f
BLAKE2b-256 ad18775b059634019316ca3dd82c205e69c364346d887b61802c9428a9974336

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 bcf2e7d99ebb045efc5f0496833574ba5ecf2345c14745630a7316d9a7ad7fac
MD5 c79287680f70c3dba8b9001b337743f8
BLAKE2b-256 d322518d84ceb0b2c2e1936364da336ba5a04c6ef1e2836b602559300f093014

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-0.8.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 2fb95537583e78c1da08283d55cc91d7d7f96cffb0225d11db65c6a362e42c2d
MD5 b911a5ab421ed8976fa857cdd83e22de
BLAKE2b-256 94608a03d9a7d608a44c6415439d2711e7f58223be9550e1d4a74d6d25a861c1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.2-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 7f2d2823052224170b39d4c8f08d5ba7586825a010e8654ace624a58288a2fcf
MD5 323b3a09ae3475b68d1f452a80a2b27f
BLAKE2b-256 5f9fa26620fba942f4ce79d7f9c321aefdca2758ebbd8586c443340c43d6e491

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