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.4.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.4-py3-none-win_amd64.whl (3.6 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-0.8.4-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.4-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.4-py3-none-manylinux_2_17_aarch64.whl (3.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

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

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-0.8.4-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.4.tar.gz.

File metadata

  • Download URL: ciris_verify-0.8.4.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.4.tar.gz
Algorithm Hash digest
SHA256 b7dce84d72f5fdfcf3574e48fe948ba717b31cec1daec0803268aa471cd39047
MD5 32176c09a1239ed803f67f84ead850b3
BLAKE2b-256 a20534b9204c0b18bbd872eb327eed1511f9bafd2d20f52e812a336be9ea25fe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ciris_verify-0.8.4-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.4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 f3f52193acada717542549f072afda1e3759bdc1953c35e1dd193fad1da61dc0
MD5 423c454206404512e5a1a8835df9be57
BLAKE2b-256 57724df12177374b7e275538fdc9444ec716dfc6695048132a7f0bebb3eb736f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.4-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 711a7714a352f2db01876ef3e74fa9d63463d148b5c04e26536e5f4be8ccbed9
MD5 ac5a7a14d444753345d7f82f8f2d5345
BLAKE2b-256 89d244755f5e25229b63d9aa6a1e4ee94e3db557ae752c53a2cb3075dee8819e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a2e8dc1a351a0b9d3b87f75b41cf6c5f42735d65afd96de3a91f9d8e44031356
MD5 6a2298bb2f8da499fcf3752a18d08373
BLAKE2b-256 b667390df0dd3afc8936ba192c6c1f76e3f03616e2a8cc2cefd7a87c88cbeeb9

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-0.8.4-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 ec6e4235433be38e1ad4ec674693e4dee5a642ec346c858c1fe641b77cbd5341
MD5 68d1092c4827f16fd9eab94842f26ab0
BLAKE2b-256 3e372163420591db3500ba9a73243913ad13990d4a635cfbf0fe3633393a1d66

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 5fef8c7e2f48ce4cae408c92cca928b06cd323a6a4f565695521df5406eaecca
MD5 c00be1db53437e7a841bbfadb28044d8
BLAKE2b-256 77f68f948ef3545f015a230f98f98c7c9efc4f7a05c25d8bd94f8f33dbac7cac

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-0.8.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1f46f7f341f00480c2ca666a507c8536e680ff2d873c8d5f623e39d6b4e752be
MD5 6b8da75a35a35827c2e731391660eca1
BLAKE2b-256 5ad3e949b4535e436207898c75b4df3ffa9d29fa89f7dff67619d38c07a0eb58

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ciris_verify-0.8.4-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 35da50b6f026077fc1719c4a66a1c85cd9b33d12fc44ea0a87e3cb0d377e1003
MD5 9c7db571be7d0db263d2e5861098ef38
BLAKE2b-256 2a3d1c79f3f39b10296beb08e18ab637f4ed5b9d2f308ee0408aa8592cfe251b

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