pymfp 0.1.0__tar.gz

pymfp-0.1.0/CHANGELOG.md

@@ -0,0 +1,125 @@
+# Changelog
+
+All notable changes to the Mirror Frame Protocol (MFP) will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+**Security & Hardening**
+- Configuration validator with YAML schema validation (`mfp/config/validator.py`)
+- Input validation module for security-critical operations (`mfp/core/validation.py`)
+- Frame depth bounds enforcement (MIN=2, MAX=32)
+- Step counter overflow detection (warn at 2^60, halt at 2^62)
+- Master key validation (32 bytes, no weak keys)
+- Error message sanitization (redact internal details)
+- Configuration warnings on server startup
+
+### Changed
+
+**BREAKING: Secure Defaults**
+- `RuntimeConfig.validation_failure_threshold`: 3 → 5
+- `RuntimeConfig.max_message_rate`: 0 (unlimited) → 1000 msg/sec
+- `RuntimeConfig.max_payload_size`: 0 (unlimited) → 1 MB
+- `StorageConfig.encrypt_at_rest`: False → True (requires master key)
+
+**Migration Required:**
+Existing deployments must either:
+1. Generate 32-byte master key: `dd if=/dev/urandom of=master.key bs=32 count=1`
+2. Explicitly disable encryption in config: `storage: {encrypt_at_rest: false}`
+
+### Security
+
+- All configuration validated at startup with actionable error messages
+- Insecure configs (unbounded limits, missing keys) now emit warnings
+- Production deployments protected by secure defaults
+
+---
+
+## [0.1.0] - 2026-03-10
+
+### Added
+
+**Core Protocol**
+- Symmetric mirror frame construction and validation
+- ChaCha20-Poly1305 AEAD encryption for payloads
+- Temporal ratchet for replay attack prevention
+- HMAC-SHA256 based frame derivation
+- Forward-secure ratchet state evolution
+
+**Runtime & Agent Lifecycle**
+- `Runtime` coordinator for agent management
+- `bind()` / `unbind()` agent lifecycle functions
+- `AgentHandle` interface for agent operations
+- Agent state machine (BOUND → ACTIVE → QUARANTINED → UNBOUND)
+- Quarantine system with rate limiting and size constraints
+- Retry logic with configurable policies
+
+**Storage**
+- SQLite-based persistence engine
+- Transactional operations for ratchet state
+- Optional at-rest encryption with master key
+- WAL mode support for concurrent access
+- Message queuing (FIFO per channel)
+
+**Federation**
+- Bilateral channel establishment between runtimes
+- Deterministic and ceremonial bootstrap modes
+- X25519 Diffie-Hellman key exchange
+- TCP transport server and client
+- Recovery protocol for state divergence detection
+- Wire protocol with routing headers
+
+**Protocol Tools**
+- `mfp_send()` — send encrypted messages
+- `mfp_channels()` — list agent channels
+- `mfp_status()` — query agent status
+
+**Standalone Server**
+- YAML-based configuration
+- CLI with `mfp-server` command
+- Support for `python -m mfp` invocation
+- Graceful shutdown on SIGINT/SIGTERM
+
+**Testing**
+- 604 tests across unit, integration, and e2e suites
+- ~95% code coverage
+- Property-based tests for frame symmetry
+- Federation and recovery protocol tests
+
+**Documentation**
+- Comprehensive README with quickstart
+- API reference (hand-written)
+- Server configuration guide
+- Architecture deep-dive
+- Security model and threat analysis
+- Contributing guidelines
+- Protocol design specifications
+
+**Packaging**
+- PEP 621 compliant `pyproject.toml`
+- pip installable (`pip install pymfp`)
+- Type annotations with `py.typed` marker
+- Apache 2.0 license
+- Python 3.11+ support
+
+### Notes
+
+This is the initial alpha release. All 5 implementation phases complete, with 19 specifications implemented across 25 modules. The protocol is functional and ready for experimental use.
+
+**Not yet production-ready:** This release is for evaluation and testing. Production hardening, audit, and performance optimization are planned for future releases.
+
+---
+
+## Versioning Policy
+
+- **Major (X.0.0)**: Breaking API changes, protocol changes
+- **Minor (0.X.0)**: New features, backward-compatible
+- **Patch (0.0.X)**: Bug fixes, documentation updates
+
+---
+
+[0.1.0]: https://github.com/Madahub-dev/MFP/releases/tag/v0.1.0

pymfp-0.1.0/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Akil Abderrahim
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pymfp-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE
+include NOTICE
+include CHANGELOG.md
+recursive-include mfp *.py py.typed
+recursive-include docs *.md
+recursive-exclude tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

pymfp-0.1.0/NOTICE

@@ -0,0 +1,5 @@
+Mirror Frame Protocol (MFP)
+Copyright 2026 Akil Abderrahim
+
+This product includes software developed at
+madahub (https://madahub.org).

pymfp-0.1.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: pymfp
+Version: 0.1.0
+Summary: Mirror Frame Protocol — symmetric frame envelope for LLM agent communication
+Author: Akil Abderrahim
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://madahub.org
+Project-URL: Repository, https://github.com/Madahub-dev/MFP
+Keywords: llm,agents,protocol,communication,e2ee
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: cryptography>=42.0.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.7.0; extra == "dev"
+Dynamic: license-file
+
+# Mirror Frame Protocol (MFP)
+
+**Symmetric frame envelope for LLM agent communication**
+
+MFP is a protocol and runtime for secure, peer-to-peer communication between autonomous agents. It provides end-to-end encrypted channels, federated message transport, and a minimal API for agent lifecycle management.
+
+## Features
+
+- **Symmetric design** — no client/server distinction, all agents are peers
+- **End-to-end encryption** — ChaCha20-Poly1305 AEAD with X25519 key exchange
+- **Federation-ready** — bilateral channels, recovery protocols, TCP transport
+- **Production hardening** — circuit breakers, timeouts, health checks, metrics
+- **High performance** — Merkle tree for O(log N) global state updates
+- **Library-first** — runtime embeds in any Python process
+- **Standalone server** — YAML-configured process for managing agents
+- **Type-safe** — full type annotations with `py.typed` marker
+
+## Installation
+
+```bash
+pip install pymfp
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/Madahub-dev/MFP.git
+cd MFP
+pip install -e .
+```
+
+## Quickstart
+
+**5-minute hello world between two agents:**
+
+```python
+from mfp import Runtime, RuntimeConfig, bind, mfp_send, mfp_channels
+
+# Create a runtime
+config = RuntimeConfig()
+runtime = Runtime(config)
+
+# Define two simple agent callables
+def alice(channel_id, message):
+    print(f"Alice received: {message.decode()}")
+    return {"status": "ok"}
+
+def bob(channel_id, message):
+    print(f"Bob received: {message.decode()}")
+    return {"status": "ok"}
+
+# Bind agents to the runtime
+alice_handle = bind(runtime, alice)
+bob_handle = bind(runtime, bob)
+
+# Establish a channel between them
+alice_handle.establish_channel(bob_handle.agent_id, symmetric_key=None)
+
+# Send a message from Alice to Bob
+channels = mfp_channels(alice_handle)
+channel_id = channels[0].channel_id
+
+receipt = mfp_send(
+    alice_handle,
+    channel_id=channel_id,
+    plaintext=b"Hello from Alice!"
+)
+
+print(f"Message sent, receipt: {receipt.message_id.hex()[:16]}...")
+
+# Shutdown
+runtime.shutdown()
+```
+
+Run this script to see agents communicate through MFP channels.
+
+## Architecture
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│                        Application                          │
+└─────────────────────────────────────────────────────────────┘
+                            │
+                            ▼
+┌─────────────────────────────────────────────────────────────┐
+│  Public API: Runtime, bind/unbind, mfp_send/channels/status │
+└─────────────────────────────────────────────────────────────┘
+                            │
+        ┌───────────────────┼───────────────────┐
+        ▼                   ▼                   ▼
+   ┌─────────┐         ┌─────────┐        ┌──────────┐
+   │ Runtime │◄────────┤  Agent  │◄───────┤ Storage  │
+   │ Pipeline│         │Lifecycle│        │  Engine  │
+   └─────────┘         └─────────┘        └──────────┘
+        │                                       │
+        ▼                                       ▼
+   ┌─────────┐                            ┌──────────┐
+   │  Core:  │                            │Federation│
+   │ Crypto, │                            │Transport │
+   │ Frames  │                            └──────────┘
+   └─────────┘
+```
+
+**Layers:**
+- **Core** — cryptographic primitives, frame construction/validation
+- **Runtime** — agent callable pipeline, hooks, error handling
+- **Agent** — lifecycle management (bind/unbind), tool interface
+- **Storage** — persistent state, message queues, channel records
+- **Federation** — bilateral channels, recovery, wire protocol, TCP server
+
+## Documentation
+
+- [Quickstart Guide](docs/quickstart.md) — step-by-step tutorial
+- [Production Guide](docs/production-guide.md) — deployment and operations
+- [API Reference](docs/api-reference.md) — library interface documentation
+- [Server Guide](docs/server-guide.md) — standalone server configuration
+- [Architecture](docs/architecture.md) — design deep-dive
+- [Security Model](docs/security.md) — threat model and guarantees
+- [Contributing](docs/contributing.md) — development setup and guidelines
+
+## CLI Usage
+
+Launch the standalone server:
+
+```bash
+mfp-server --config runtime.yaml
+```
+
+Or using Python module syntax:
+
+```bash
+python -m mfp --config runtime.yaml
+```
+
+## Development
+
+Set up development environment:
+
+```bash
+# Clone and install with dev dependencies
+git clone https://github.com/Madahub-dev/MFP.git
+cd MFP
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run tests with coverage
+pytest --cov=mfp --cov-report=term-missing
+```
+
+## Project Status
+
+**Version:** 0.4.0 (Production Ready)
+
+All implementation phases complete including production hardening:
+- ✅ P0: Critical Security
+- ✅ P1: Operational Robustness (logging, health checks, metrics, limits)
+- ✅ P2: Performance Optimization (Merkle tree, circuit breakers, timeouts, pooling)
+- ✅ P3: Advanced Hardening (frame caching, key rotation, deduplication)
+
+**Test Coverage:** 813 tests passing (591 unit, 191 integration, 27 E2E, 4 benchmark)
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE) for details.
+
+## Credits
+
+**MFP** — authored by Akil Abderrahim and Claude Sonnet 4.5
+
+---
+
+For protocol design documentation, see [design/](design/).