Metadata-Version: 2.4
Name: coreason_enclave
Version: 0.2.1
Summary: coreason-enclave
License: # The Prosperity Public License 3.0.0
         
         Contributor: CoReason, Inc.
         
         Source Code: https://github.com/CoReason-AI/coreason_enclave
         
         ## Purpose
         
         This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
         
         ## Agreement
         
         In order to receive this license, you have to agree to its rules.  Those rules are both obligations under that agreement and conditions to your license.  Don't do anything with this software that triggers a rule you can't or won't follow.
         
         ## Notices
         
         Make sure everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license and the contributor and source code lines above.
         
         ## Commercial Trial
         
         Limit your use of this software for commercial purposes to a thirty-day trial period.  If you use this software for work, your company gets one trial period for all personnel, not one trial per person.
         
         ## Contributions Back
         
         Developing feedback, changes, or additions that you contribute back to the contributor on the terms of a standardized public software license such as [the Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0), [the Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), [the MIT license](https://spdx.org/licenses/MIT.html), or [the two-clause BSD license](https://spdx.org/licenses/BSD-2-Clause.html) doesn't count as use for a commercial purpose.
         
         ## Personal Uses
         
         Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn't count as use for a commercial purpose.
         
         ## Noncommercial Organizations
         
         Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution doesn't count as use for a commercial purpose regardless of the source of funding or obligations resulting from the funding.
         
         ## Defense
         
         Don't make any legal claim against anyone accusing this software, with or without changes, alone or with other technology, of infringing any patent.
         
         ## Copyright
         
         The contributor licenses you to do everything with this software that would otherwise infringe their copyright in it.
         
         ## Patent
         
         The contributor licenses you to do everything with this software that would otherwise infringe any patents they can license or become able to license.
         
         ## Reliability
         
         The contributor can't revoke this license.
         
         ## Excuse
         
         You're excused for unknowingly breaking [Notices](#notices) if you take all practical steps to comply within thirty days of learning you broke the rule.
         
         ## No Liability
         
         ***As far as the law allows, this software comes as is, without any warranty or condition, and the contributor won't be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***
License-File: LICENSE
License-File: NOTICE
Author: Gowtham A Rao
Author-email: gowtham.rao@coreason.ai
Requires-Python: >=3.11
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Requires-Dist: aiofiles (>=25.1.0,<26.0.0)
Requires-Dist: anyio (>=4.12.1,<5.0.0)
Requires-Dist: coreason-identity (>=0.4.2,<0.5.0)
Requires-Dist: httpx (>=0.28.1,<0.29.0)
Requires-Dist: loguru (>=0.7.2,<0.8.0)
Requires-Dist: nvflare (>=2.7.1,<3.0.0)
Requires-Dist: opacus (>=1.5.4,<2.0.0)
Requires-Dist: pandas (>=3.0.0,<4.0.0)
Requires-Dist: pydantic (>=2.12.5,<3.0.0)
Requires-Dist: torch (>=2.10.0,<3.0.0)
Project-URL: Documentation, https://github.com/CoReason-AI/coreason_enclave
Project-URL: Homepage, https://github.com/CoReason-AI/coreason_enclave
Project-URL: Repository, https://github.com/CoReason-AI/coreason_enclave
Description-Content-Type: text/markdown

# coreason-enclave

[![License: Prosperity 3.0](https://img.shields.io/badge/license-Prosperity%203.0-blue)](https://github.com/CoReason-AI/coreason-enclave)
[![CI Status](https://github.com/CoReason-AI/coreason-enclave/actions/workflows/ci.yml/badge.svg)](https://github.com/CoReason-AI/coreason-enclave/actions)
[![Code Style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/CoReason-AI/coreason-enclave)
[![Documentation](https://img.shields.io/badge/docs-PRD-informational)](docs/product_requirements.md)

**Privacy-Preserving Compute Layer for Federated Learning**

**coreason-enclave** is the "Embassy" / Secure Compute Wrapper of the CoReason AI ecosystem. It acts as the privacy-preserving compute layer, allowing orchestration of training jobs across distributed nodes (e.g., multiple hospitals or partner pharma companies) without accessing their raw data. It combines Federated Learning, Confidential Computing (TEEs), and Differential Privacy to ensure a mathematical guarantee of privacy.

> **Core Philosophy:** "Move the Model to the Data. Never move the Data. Encrypt the RAM."

---

## 🚀 Features

*   **Federated Learning (FL):** Orchestrate training across distributed nodes using **NVIDIA FLARE**. Only weight updates (gradients) are shared, never raw data. Supports FedAvg, FedProx, and SCAFFOLD strategies.
*   **Confidential Computing:** Designed to run inside hardware-encrypted **Trusted Execution Environments (TEEs)** (e.g., NVIDIA H100 Confidential Compute, Intel SGX). This ensures memory is encrypted at the CPU level, protecting against cloud provider inspection. Includes **Remote Attestation** to cryptographically prove code integrity.
*   **Differential Privacy (DP):** Integrated with **Opacus** to inject Gaussian noise into gradients, strictly enforcing a privacy budget ($\epsilon$).
*   **The "Sightless" Surgeon:** The AI learns from data it never "sees."
*   **Data Sentry:** An "Airlock" mechanism that validates input data and strictly sanitizes output, ensuring no sensitive information leaks via logs or return payloads.

## 🛠️ Installation

```bash
pip install coreason-enclave
```

## 💻 Usage

The `coreason-enclave` agent typically runs as a service managed by an orchestrator, but can be invoked directly or integrated into custom workflows.

### Basic Initialization

```python
from coreason_enclave.federation.executor import CoreasonExecutor
from coreason_enclave.schemas import FederationJob

# Initialize the Executor
executor = CoreasonExecutor(
    training_task_name="train",
    aggregation_task_name="aggregate"
)

# Note: In production, this is handled automatically by the NVFlare runtime.
# The executor listens for tasks from the Federation Overseer.
```

### Running the Agent (CLI)

To start the agent as a standalone client connecting to a federation:

```bash
# Secure Mode (Requires TEE Hardware)
python -m coreason_enclave.main \
    --workspace /tmp/workspace \
    --conf config/client_config.json

# Simulation Mode (For Development/Testing)
python -m coreason_enclave.main \
    --workspace /tmp/workspace \
    --conf config/client_config.json \
    --simulation
```

For more detailed requirements and architecture, please refer to the [Product Requirements Document](docs/product_requirements.md).

## 📜 License

This project is licensed under the **Prosperity Public License 3.0**.
See the [LICENSE](LICENSE) file for details.

