keynetra 0.1.0__tar.gz

keynetra-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

keynetra-0.1.0/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: keynetra
+Version: 0.1.0
+Requires-Python: >=3.11
+License-File: LICENSE
+Requires-Dist: fastapi>=0.115
+Requires-Dist: uvicorn[standard]>=0.30
+Requires-Dist: gunicorn>=22.0
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pydantic-settings>=2.3
+Requires-Dist: python-jose[cryptography]>=3.3
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: typer>=0.12
+Requires-Dist: rich>=13.7
+Requires-Dist: pyfiglet>=1.0.2
+Requires-Dist: prometheus-client>=0.21
+Requires-Dist: prometheus-fastapi-instrumentator>=7.0
+Requires-Dist: opentelemetry-api>=1.25
+Requires-Dist: opentelemetry-sdk>=1.25
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.46b0
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: alembic>=1.13
+Requires-Dist: psycopg[binary]>=3.1
+Requires-Dist: redis>=5.0
+Requires-Dist: httpx>=0.27
+Dynamic: license-file

keynetra-0.1.0/README.md

@@ -0,0 +1,238 @@
+<p align="center">
+  <img src="./data/imgs/logo.png" alt="KeyNetra Logo" width="220" />
+</p>
+<p align="center">
+  <img src="https://readme-typing-svg.demolab.com?font=Fira+Code&size=25&pause=1100&center=true&vCenter=true&width=900&lines=Deterministic+Authorization+Control+Plane;RBAC+%2B+ACL+%2B+ReBAC+for+modern+apps;FastAPI+API%2C+CLI%2C+Caching%2C+Observability" alt="KeyNetra animated typing banner" />
+</p>
+<div align="center">
+
+[![CI](https://github.com/keynetra/keynetra/actions/workflows/ci.yml/badge.svg)](https://github.com/keynetra/keynetra/actions/workflows/ci.yml)
+[![Release](https://github.com/keynetra/keynetra/actions/workflows/release.yml/badge.svg)](https://github.com/keynetra/keynetra/actions/workflows/release.yml)
+[![Docker Hub](https://img.shields.io/docker/pulls/keynetra/keynetra?label=docker%20pulls)](https://hub.docker.com/r/keynetra/keynetra)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](./pyproject.toml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-green)](./LICENSE)
+[![OpenAPI](https://img.shields.io/badge/OpenAPI-3.1-orange)](./contracts/openapi/openapi.json)
+
+</div>
+
+# KeyNetra
+
+Policy-driven authorization control plane for applications that need deterministic, explainable access decisions across RBAC, ACL, and ReBAC.
+
+## What KeyNetra Provides
+
+- Authorization engine with deterministic evaluation and explain traces
+- FastAPI API server and operational CLI
+- Multi-tenant policy evaluation with strict tenancy controls
+- Policy lifecycle operations (validation, compile, simulation, impact analysis)
+- Caching and access indexing for low-latency checks
+- Structured logging, metrics, and dashboard-ready monitoring
+- Deployment assets for Docker, Kubernetes, and Helm
+
+## Architecture
+
+Layering is enforced through import contracts:
+
+- `keynetra.api` -> transport only
+- `keynetra.services` -> orchestration and runtime flow
+- `keynetra.engine` -> pure policy decision logic
+- `keynetra.domain` -> shared models/schemas
+- `keynetra.infrastructure` -> repositories, storage, cache adapters
+- `keynetra.config` -> configuration loading and guardrails
+
+Detailed architecture notes: [`ARCHITECTURE.md`](./ARCHITECTURE.md)
+
+## Quick Start (Local)
+
+### 1) Setup
+
+```bash
+python3.11 -m venv .venv
+source .venv/bin/activate
+pip install --upgrade pip
+pip install -r requirements.txt -r requirements-dev.txt
+pip install -e .
+cp .env.example .env
+```
+
+### 2) Run API
+
+```bash
+keynetra serve --host 0.0.0.0 --port 8080
+```
+
+### 3) Health and Docs
+
+```bash
+curl -i http://localhost:8080/health/ready
+open http://localhost:8080/docs
+```
+
+### 4) First Authorization Check
+
+```bash
+curl -s -X POST http://localhost:8080/check-access \
+  -H "Content-Type: application/json" \
+  -H "X-API-Key: devkey" \
+  -H "X-Tenant-Id: acme" \
+  -d '{
+    "user": {"id": "u1", "role": "admin"},
+    "action": "read",
+    "resource": {"resource_type": "document", "resource_id": "doc-1"},
+    "context": {}
+  }'
+```
+
+## CLI Usage
+
+Entrypoint is standardized to `keynetra`:
+
+```bash
+keynetra --help
+keynetra check-openapi
+keynetra migrate --confirm-destructive
+keynetra doctor --service core
+```
+
+## API Surface (Core)
+
+- `POST /check-access`
+- `POST /check-access-batch`
+- `POST /simulate`
+- `POST /simulate-policy`
+- `POST /impact-analysis`
+- `GET /health`, `GET /health/ready`, `GET /metrics`
+
+OpenAPI contracts:
+
+- [`contracts/openapi/openapi.json`](./contracts/openapi/openapi.json)
+- [`contracts/openapi/keynetra-v0.1.0.yaml`](./contracts/openapi/keynetra-v0.1.0.yaml)
+
+## Multi-Tenant and Security
+
+- Tenant-aware request flow and storage isolation
+- Strict tenancy mode available via `KEYNETRA_STRICT_TENANCY=true`
+- API key and JWT auth support
+- Admin auth flow for privileged operations
+- Rate limiting and request correlation IDs
+
+See [`SECURITY.md`](./SECURITY.md) for security policy and reporting.
+
+## Observability and Monitoring
+
+KeyNetra exposes Prometheus metrics at `GET /metrics` including:
+
+- HTTP request count/latency/error metrics
+- Authorization decision and stage latency metrics
+- Cache hit/miss metrics
+- DB query latency metrics
+- Tenant activity dimensions
+
+Monitoring assets:
+
+- Prometheus config: [`monitoring/prometheus/prometheus.yml`](./monitoring/prometheus/prometheus.yml)
+- Grafana dashboard: [`monitoring/grafana/dashboards/keynetra-overview.json`](./monitoring/grafana/dashboards/keynetra-overview.json)
+- Grafana provisioning: [`monitoring/grafana/provisioning`](./monitoring/grafana/provisioning)
+
+## Deployment
+
+### Docker
+
+```bash
+docker build -t keynetra:test .
+docker run --rm -p 8080:8080 --env-file .env keynetra:test
+```
+
+### Docker Compose (Full Dev/Obs Stack)
+
+```bash
+docker compose up --build
+```
+
+Includes:
+
+- KeyNetra API
+- PostgreSQL
+- Redis
+- Prometheus
+- Grafana
+- node-exporter
+- Loki
+
+### Kubernetes
+
+```bash
+kubectl apply -f deploy/kubernetes/
+```
+
+### Helm
+
+```bash
+helm install keynetra ./deploy/helm/keynetra
+```
+
+More deployment detail: [`DEPLOYMENT.md`](./DEPLOYMENT.md)
+
+## SDKs
+
+SDKs are maintained separately from this engine repository.
+
+- Python SDK package: `keynetra-client`
+- SDK guide: [`SDK_GUIDE.md`](./SDK_GUIDE.md)
+
+Example (Python SDK):
+
+```python
+from keynetra_client import KeyNetraClient
+
+client = KeyNetraClient("http://localhost:8080")
+decision = client.check_access(
+    user={"id": "alice"},
+    action="read",
+    resource={"type": "document", "id": "doc-1"},
+)
+print(decision.allowed)
+```
+
+## Developer Workflow
+
+```bash
+ruff check .
+black --check .
+pytest
+lint-imports --config .importlinter
+```
+
+Convenience commands are available in [`Makefile`](./Makefile).
+
+## Documentation Index
+
+- [`ARCHITECTURE.md`](./ARCHITECTURE.md)
+- [`DEPLOYMENT.md`](./DEPLOYMENT.md)
+- [`SDK_GUIDE.md`](./SDK_GUIDE.md)
+- [`CONTRIBUTING.md`](./CONTRIBUTING.md)
+- [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md)
+- [`SECURITY.md`](./SECURITY.md)
+- [`CHANGELOG.md`](./CHANGELOG.md)
+- [`docs/README.md`](./docs/README.md)
+
+## Contributing
+
+Contributions are welcome. Start with [`CONTRIBUTING.md`](./CONTRIBUTING.md) and [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md).
+
+## License
+
+Apache-2.0. See [`LICENSE`](./LICENSE).
+
+## Citation
+
+```bibtex
+@software{keynetra_2026,
+  title   = {KeyNetra},
+  author  = {KeyNetra Community},
+  year    = {2026},
+  version = {0.1.0-beta},
+  url     = {https://github.com/keynetra/keynetra}
+}
+```
+<p align="center">Made with love ❤️ for KeyNetra Community. </p>

keynetra-0.1.0/integrations/__init__.py

@@ -0,0 +1 @@
+"""External integration adapters for KeyNetra policy ecosystem."""

keynetra-0.1.0/integrations/interfaces.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Protocol
+
+
+@dataclass(frozen=True)
+class TupleRecord:
+    subject: str
+    relation: str
+    object: str
+
+
+class TupleStoreAdapter(Protocol):
+    def import_tuples(self, tuples: list[TupleRecord]) -> int: ...
+
+    def export_tuples(self) -> list[TupleRecord]: ...
+
+
+class PolicyAdapter(Protocol):
+    def import_policies(self, payload: str) -> int: ...
+
+    def export_policies(self) -> str: ...
+
+
+class TerraformResourceAdapter(Protocol):
+    def plan(self) -> dict[str, object]: ...
+
+    def apply(self) -> dict[str, object]: ...

keynetra-0.1.0/integrations/opa_rego_adapter.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from integrations.interfaces import PolicyAdapter
+
+
+@dataclass
+class OPARegoPolicyAdapter(PolicyAdapter):
+    """Minimal OPA/Rego policy adapter scaffold."""
+
+    _rego: str = ""
+
+    def import_policies(self, payload: str) -> int:
+        self._rego = payload
+        return len(payload.splitlines()) if payload else 0
+
+    def export_policies(self) -> str:
+        return self._rego

keynetra-0.1.0/integrations/openfga_adapter.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from integrations.interfaces import TupleRecord, TupleStoreAdapter
+
+
+@dataclass
+class InMemoryOpenFGATupleAdapter(TupleStoreAdapter):
+    """Starter adapter for OpenFGA tuple import/export workflows."""
+
+    tuples: list[TupleRecord] = field(default_factory=list)
+
+    def import_tuples(self, tuples: list[TupleRecord]) -> int:
+        self.tuples.extend(tuples)
+        return len(tuples)
+
+    def export_tuples(self) -> list[TupleRecord]:
+        return list(self.tuples)

keynetra-0.1.0/integrations/terraform_provider.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from integrations.interfaces import TerraformResourceAdapter
+
+
+@dataclass
+class TerraformPolicyResourceAdapter(TerraformResourceAdapter):
+    """Placeholder adapter boundary for Terraform-managed policy resources."""
+
+    policy_count: int = 0
+
+    def plan(self) -> dict[str, object]:
+        return {"changes": self.policy_count, "resource": "keynetra_policy"}
+
+    def apply(self) -> dict[str, object]:
+        return {"applied": True, "resource_count": self.policy_count}

keynetra-0.1.0/keynetra/__init__.py

@@ -0,0 +1,5 @@
+"""keynetra top-level package."""
+
+from keynetra.headless import KeyNetra
+
+__all__ = ["KeyNetra"]

keynetra-0.1.0/keynetra/api/__init__.py

@@ -0,0 +1 @@
+"""API routes package."""