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.5.1.tar.gz (35.7 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.5.1-py3-none-win_amd64.whl (3.9 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-1.5.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.5 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-1.5.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (4.1 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-1.5.1-py3-none-macosx_11_0_arm64.whl (3.7 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-1.5.1-py3-none-macosx_10_12_x86_64.whl (4.1 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for ciris_verify-1.5.1.tar.gz
Algorithm Hash digest
SHA256 8152ea900b4fd36bed2d34a3d874b69ff535ed8b7032342d8d1b8f857a0a1ac3
MD5 01a1cf6ba11d964740d536de49270d68
BLAKE2b-256 b949db5b5324981cdc73a3336a72fac7236416a0ce6fc048b2be1b8865d635d1

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: ciris_verify-1.5.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 3.9 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-1.5.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 85cc09e19dc07f6b5385a3a7a4247685abb9618d1df71b05da70bf65c6f06316
MD5 ab587afa2903d189822624ffbdf54811
BLAKE2b-256 0cbbb5992ae3feb4d9cd8fb8e6a4c185909ff4d833b01565c0ec091dfdfeef6a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-1.5.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 404943ff1321d78480d56d88d70a4a50af35edcbccb324308dc2941cce419171
MD5 f46b5b8db60636d6ad1b717a0b54bf84
BLAKE2b-256 626a25eb81523e563f2c3205039f484296785f3d861307db33133b7c4c74a8e3

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-1.5.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 0abb036d341bc914877f3dfd2bfc05a8c7bcbfc7ef658a0e13213329bba5b499
MD5 ee0e47a8360fa71458128ee8b3d50302
BLAKE2b-256 4efc970110b86f5dfab8356eafaca6bc918a885cf38bf1d5e0d4b24ff14756c6

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-1.5.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0b680b12d4841e9daa10fb15911f36a3bdfb379e3bb42266d577d19efe0e0344
MD5 0c137b8c66401024ce215f2e74db4f55
BLAKE2b-256 087123329cb40c3ec2e1f5bb3b1b6bfffba287c53876ceaf026cbafc772d5637

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-1.5.1-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 ecdf97b8d35da874062dc63e5ae2da41f693e8f2d2b07a12f6f77fb25966a7d4
MD5 5178b10a48380c26dc2535e795ab5eea
BLAKE2b-256 0c602c314fda9b48fc4d787847b34db6b9a1d7e07464519f117248d60fcc2f76

See more details on using hashes here.

Provenance

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