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

Uploaded Python 3Windows x86-64

ciris_verify-0.8.14-py3-none-manylinux_2_17_x86_64.whl (4.1 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-0.8.14-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.1 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-0.8.14-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.14-py3-none-macosx_11_0_arm64.whl (3.4 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.8.14-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.14.tar.gz.

File metadata

  • Download URL: ciris_verify-0.8.14.tar.gz
  • Upload date:
  • Size: 25.5 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.14.tar.gz
Algorithm Hash digest
SHA256 f4865c91a9483ff8ea01e4a808f7cb4a88ce7a24f1f64e7e27972ba14f8fdee2
MD5 d65919fc5b7628fb7788c34ef934243d
BLAKE2b-256 e2845824f2c7e0487ffe1e4fba8c48621b715a612a3fff44682d6f14093f9404

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.14-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 0cad14860c24b3f44b5e2c1acf7f103e66b6c76a78fc1d21fb41d425ec3da4b8
MD5 340997ab7a3620d4c9ef21e8b14cc5cf
BLAKE2b-256 1da666dc40b07fdf8cf113499b211b0f5162784d4d9918d3670b37844657ede6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.14-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 4d359b5c4c635068c4afd200d35bfd7828be106054de731a98c95012214db4f5
MD5 625c45f73718786e8f49cf6b8da0e07d
BLAKE2b-256 9f1c3c69d5c2178560157b39ce29916d9c7add50672b7df66c12055ebb41564a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.14-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9896f9d89a60b6099a62d883e01910e0cecc5dcc52eea98ff60332e4a254faa2
MD5 81d9ce859a0ed66a0a497cb2b31a3c2e
BLAKE2b-256 529a4f1fc49a26c5882575122ca2fdf335e8cf4b3129652462dbc3a9c86f34eb

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-0.8.14-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 b2283b10b619d0bf8c09969dbe18436417a229603936d188a2af1d99876b993b
MD5 a5c071b1b4a9ca4e50a15d8c9f6e930c
BLAKE2b-256 9fb2a1c8084b4b31feeac3524da1f022a19df8540cfa8b56e608c93eea450a89

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.14-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 6b785980a0c97a24aa44bd620907e625302f122d30e2ae7e69d4c0a61a6f40b5
MD5 6f26215a0df68f7e58aee826ea638f30
BLAKE2b-256 b9b97b9bf239af86bad7f81e920c66adddbe28e94221477b112ee4ff8baa4826

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-0.8.14-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 75375a5a9a307bc5b25fb7b9b410162101cf6a3e10aadc0478b142ec66fcb888
MD5 61b29063790e1b6e050f8a8d4d1b8d60
BLAKE2b-256 238c8cc0837e539674c56742fc8712cd54238e0d8792ada3d23714becea82255

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.14-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 e5771b53772b07aecfaaacfd280eb77a3178a2b0bf26853211e234ff8000ec53
MD5 3b336ceb73fc94a2c8587baf3f0a0f0a
BLAKE2b-256 a35266718684314cb67e200d17a14950867e301babdacaf2c546cd2c64b7bd04

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