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-6.4.1.tar.gz (74.6 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-6.4.1-py3-none-win_amd64.whl (6.5 MB view details)

Uploaded Python 3Windows x86-64

ciris_verify-6.4.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.4 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

ciris_verify-6.4.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (5.9 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

ciris_verify-6.4.1-py3-none-macosx_11_0_arm64.whl (5.4 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

ciris_verify-6.4.1-py3-none-macosx_10_12_x86_64.whl (5.9 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

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

File hashes

Hashes for ciris_verify-6.4.1.tar.gz
Algorithm Hash digest
SHA256 a5a5bd5f0dfafb878671bb8e20f6f837729a7442a4e852f39cbbe1969eaab5b4
MD5 cc3378154810f0dcfbd01c442955735e
BLAKE2b-256 d267c69b836e7459c178bb0d68baf6ffe7c43697fe3b1785080239f7eab26fd6

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: ciris_verify-6.4.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 6.5 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-6.4.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 a92440c92e58f3a08a86e686ea5e16dbde9c97dc03e1482ce860ca695aead5e9
MD5 a5abb6964ee43cbb5d9d5d425bb78021
BLAKE2b-256 91ff4c4d225adda12d46a089e5d0b2c3dad1324e5376b0a1191a2073ba7b12ba

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-6.4.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 cfc44de833107d14a84b662dce4b5a278d08f74749149928046f8fb09a13ebf3
MD5 c4161560874b06e35a590bb4a0ed7441
BLAKE2b-256 c7e914f9ec102e8a4e81216f02c576f8a2fc72f75332c36fc9fc547eed96b0ae

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-6.4.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 0d5705fa53e10627c3cb9e0a8f18d1eea429e0c850b5fc5daa720ea50a68eb1b
MD5 82119c6cef41000c16fd783ad793aa3d
BLAKE2b-256 bbe57d8c963a6f5275a3ea3a9cb768bf423b71fc3eddb1988203cbfb1f403c61

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-6.4.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 28e041743967aefa945ff7cdc79f7d2d6d38763a4bd751c73ec135dc3122b33b
MD5 f3dc68f0971d760adbe33cb7ebdce9d4
BLAKE2b-256 a759f10749b27f558ecf7fea21854a7afbbdbcf80f8fa722074881f6088e1796

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ciris_verify-6.4.1-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 257479b0cffd5e6b02683504522529f1154365dc93d127c9d95343ab6a0e4fc0
MD5 bf1c3b3d04c60811bec2d1b84e5bc22f
BLAKE2b-256 af99c3adf7a04998c61d5da85a638c7de90db80c3e863dcd8b79e87d4e3d48dd

See more details on using hashes here.

Provenance

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