isolattice 0.1.0__tar.gz

isolattice-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.

isolattice-0.1.0/PKG-INFO

@@ -0,0 +1,332 @@
+Metadata-Version: 2.4
+Name: isolattice
+Version: 0.1.0
+Summary: Asynchronous, cross-platform sandbox execution framework with explicit, verified backend capabilities.
+Keywords: sandbox,isolation,containment,asyncio,podman,docker,kubernetes,appcontainer,namespaces,security
+Author: S. Muni Harish
+Author-email: S. Muni Harish <samamuniharish@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Dist: isolattice[s3,otel,fastapi,signing,remote] ; extra == 'all'
+Requires-Dist: fastapi>=0.162.2,<1 ; extra == 'fastapi'
+Requires-Dist: httpx2>=2.16.0,<3 ; extra == 'fastapi'
+Requires-Dist: opentelemetry-api>=1.45.2,<2 ; extra == 'otel'
+Requires-Dist: opentelemetry-sdk>=1.45.2,<2 ; extra == 'otel'
+Requires-Dist: aiohttp>=3.14.5,<4 ; extra == 'remote'
+Requires-Dist: aiobotocore>=3.10.0,<4 ; extra == 's3'
+Requires-Dist: cryptography>=50.0.2,<51.0.0 ; extra == 'signing'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/smuniharish/isolattice
+Project-URL: Documentation, https://isolattice.readthedocs.io/en/latest/
+Project-URL: Changelog, https://github.com/smuniharish/isolattice/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/smuniharish/isolattice/issues
+Project-URL: Repository, https://github.com/smuniharish/isolattice
+Provides-Extra: all
+Provides-Extra: fastapi
+Provides-Extra: otel
+Provides-Extra: remote
+Provides-Extra: s3
+Provides-Extra: signing
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/smuniharish/isolattice/main/docs/assets/logo.svg" alt="Isolattice logo" width="96">
+</p>
+
+<h1 align="center">Isolattice</h1>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/python-3.12%20%7C%203.13%20%7C%203.14%20%7C%203.15-blue.svg" alt="Python 3.12 | 3.13 | 3.14 | 3.15">
+  <img src="https://img.shields.io/badge/status-production--stable-brightgreen.svg" alt="Development status: production/stable">
+  <img src="https://img.shields.io/badge/typing-typed-blue.svg" alt="Typed">
+  <img src="https://img.shields.io/badge/dependencies-none-brightgreen.svg" alt="No runtime dependencies">
+  <a href="https://github.com/smuniharish/isolattice/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="License: Apache 2.0"></a>
+</p>
+
+**Asynchronous, capability-aware sandbox execution for Python.**
+
+Isolattice provides a typed API for running workloads under backend-specific
+security and resource policies. It discovers available capabilities, rejects
+required guarantees that cannot be enforced, and verifies termination against
+the owned execution boundary. The same API supports Podman, the Docker API,
+Kubernetes, Linux namespaces, macOS Seatbelt, Windows AppContainer and Windows
+Job Objects.
+
+The Production/Stable development status describes package maturity; it does
+not certify individual backends, configurations or workloads.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/smuniharish/isolattice/main/docs/assets/diagrams/architecture-overview.png" alt="Isolattice architecture" width="720">
+</p>
+
+> **Security scope:** Containers, Pods, Linux namespaces and AppContainers share
+> the host or node kernel; kernel, engine, runtime and cluster exploits are
+> outside the threat model. Windows Job Objects provide containment and resource
+> control, not a security boundary. No backend is certified for hostile
+> multi-tenant workloads, and an independent third-party security review has not
+> been completed. See the [security guarantees](https://isolattice.readthedocs.io/en/latest/security/guarantees/)
+> and [platform limitations](https://isolattice.readthedocs.io/en/latest/security/platform-limitations/).
+
+## Why Isolattice
+
+Applications that run external commands or generated code need explicit
+policies, bounded execution and reliable cleanup. Isolattice provides these
+through a common interface while preserving the differences between platforms.
+
+| Requirement | Approach |
+| --- | --- |
+| Backend-specific enforcement | Each backend reports capabilities as supported, limited or unsupported, with evidence for the configured host |
+| Required policies | Requested guarantees and budgets are enforced or rejected with `SandboxCapabilityError` |
+| Resource ownership | Execution boundaries are tracked by identity, with cleanup on completion, failure and cancellation |
+| Termination verification | An unverified stop is reported as unknown rather than successful termination |
+| Portable integration | One async API supports native, container, Kubernetes and remote backends |
+
+Isolattice does not replace a container engine, orchestrator or virtual machine.
+Applications must select a backend appropriate for their workload and threat
+model.
+
+## Highlights
+
+- **Async lifecycle.** Create, run, stream, cancel, stop and close through async
+  APIs. Pause and resume are available on supported Linux, Podman and Docker
+  configurations. Async context managers own cleanup.
+- **Fail-closed policies.** Network access, root writability, resource limits
+  and timeouts are enforced or refused according to backend capabilities.
+- **Kubernetes network policies.** Optional owned deny-all and CIDR/protocol/port
+  allowlists, with an in-Pod enforcement probe before workload release. The CNI
+  and cluster policy administration remain trusted.
+- **Capability discovery.** `Sandbox.discover()` reports capability states and
+  evidence for the configured backend.
+- **Verified termination.** Graceful and forced termination, retries and a
+  cleanup deadline; unfinished cleanup remains owned and is reported.
+- **Bounded output.** Stream stdout and stderr with per-stream limits and
+  truncation indicators.
+- **Snapshots and checkpoints.** Workspace snapshots on Podman, Docker Engine and
+  every native backend except Windows Job Objects, whole-container snapshots on
+  Podman and Docker Engine, and CRIU checkpoints on rootful Podman. SHA-256
+  manifests are verified on read; optional Ed25519 signatures authenticate
+  manifests against caller-configured trusted keys.
+- **Extensible through ABCs.** Bring your own `ArtifactStore`, `EventSink`,
+  `CommandRunner` or `Backend`. A local store is built in and an S3 store is an
+  optional extra. OpenTelemetry integrations provide lifecycle metrics and
+  tracing.
+- **Remote service.** Use authenticated, owner-scoped sessions with server-side
+  leases and crash reconciliation.
+- **Typed and lightweight.** The core has no runtime dependencies, ships type
+  hints and supports Python 3.12 to 3.15.
+
+## Backends
+
+| Backend | Boundary | Live-tested on |
+| --- | --- | --- |
+| `PodmanBackend` | One restricted container per execution; rootless by default | CI on Ubuntu: rootless, rootful runc with CRIU, and a remote engine over `ssh://`. Locally: Podman machine on Windows 11 |
+| `DockerBackend` | One restricted container per execution through the Docker Engine API | CI: Docker Engine on Ubuntu. Locally: Podman's Docker-compatible API |
+| `KubernetesBackend` | One owned Pod per execution; optional owned NetworkPolicy and in-Pod enforcement probe | Single-node kind cluster, in CI and locally |
+| `LinuxNamespaceBackend` | User, PID, mount, network, IPC and UTS namespaces, delegated cgroup v2, seccomp and Landlock | CI on Ubuntu 24.04 and WSL 2, each with a delegated systemd scope |
+| `MacOSSeatbeltBackend` | One process under a deny-default Seatbelt profile; no network or process creation; runs as the calling user | CI on macOS 15 and 26, Apple silicon and Intel |
+| `WindowsAppContainerBackend` | Less-privileged AppContainer inside nested Job Objects; no network | CI on Windows Server, and Windows 11 |
+| `WindowsJobBackend` | Job Object containment and budgets. **Not a security boundary:** files, network and registry stay reachable | CI on Windows Server, and Windows 11 |
+
+On macOS, workloads can use `MacOSSeatbeltBackend` or a container backend
+connected to a Podman machine or remote engine. The core suite and Seatbelt
+backend are tested on macOS 15 and 26, on Apple silicon and Intel.
+
+Remote execution is available through a remote container engine or the optional
+`isolattice[remote]` service. The service provides authenticated, owner-scoped
+sessions, TLS beyond loopback, leases, idempotent session creation and
+reconciliation of owned resources after a crash. It transfers checkpoints but
+does not transfer snapshots or pause requests.
+
+The [tested platforms](https://isolattice.readthedocs.io/en/latest/reference/tested-platforms/)
+page describes the configurations and evidence for each CI job. The
+[platform limitations](https://isolattice.readthedocs.io/en/latest/security/platform-limitations/)
+page documents backend-specific restrictions.
+
+## Installation
+
+Install from a local checkout:
+
+```bash
+git clone https://github.com/smuniharish/isolattice.git
+cd isolattice
+python -m pip install .             # core, no runtime dependencies
+python -m pip install ".[s3]"       # S3 artifact storage
+python -m pip install ".[otel]"     # OpenTelemetry metrics and tracing
+python -m pip install ".[fastapi]"  # FastAPI example dependencies
+python -m pip install ".[signing]"  # Ed25519 artifact signing
+python -m pip install ".[remote]"   # Remote service and client
+```
+
+Once a release is available on PyPI, the core can also be installed with
+`python -m pip install isolattice`.
+
+Podman requires its client and an explicit connection; Docker requires its
+client and an API endpoint; Kubernetes requires `kubectl` and a kubeconfig. The
+Linux namespace backend also needs a delegated cgroup v2 subtree. See the
+[installation guide](https://isolattice.readthedocs.io/en/latest/getting-started/installation/)
+for platform prerequisites.
+
+## Quickstart
+
+The following example uses a rootless Podman connection with a read-only root,
+no network and required memory and process limits. The image must already exist
+on the connection, and the memory and pids cgroup controllers must be delegated.
+Replace `podman-machine-default` with your configured connection name.
+
+```python
+import asyncio
+
+from isolattice import Capability, ExecutionRequest, PodmanBackend, Sandbox, SandboxPolicy
+
+
+async def main() -> None:
+    backend = PodmanBackend(
+        connection="podman-machine-default", image="docker.io/library/alpine:3.22"
+    )
+    policy = SandboxPolicy(
+        memory_bytes=128 * 1024 * 1024,
+        process_limit=32,
+        required_capabilities=(Capability.MEMORY_LIMIT, Capability.PROCESS_LIMIT),
+    )
+    request = ExecutionRequest(
+        argv=(
+            "/bin/sh",
+            "-c",
+            "echo hello from $(hostname); wget -q -T 2 -O- http://example.com || echo network: blocked",
+        ),
+        timeout=10,
+    )
+    async with Sandbox(backend=backend) as sandbox, await sandbox.create(policy=policy) as instance:
+        result = await instance.run(request)
+    print(result.stdout.decode(), end="")
+    print("exit code:", result.exit_code)
+    print("termination:", result.termination.state)
+
+
+asyncio.run(main())
+```
+
+Example output:
+
+```text
+hello from 33a5a6dd24ba
+network: blocked
+exit code: 0
+termination: terminated
+```
+
+If the required controllers are unavailable, the policy is rejected:
+
+```text
+isolattice.errors.SandboxCapabilityError: resource limits require delegated controllers: memory, pids
+```
+
+Isolattice does not pull images. Podman workloads receive only the environment
+provided by the caller; set `PATH` explicitly or use absolute executable paths.
+The [quickstart](https://isolattice.readthedocs.io/en/latest/getting-started/quickstart/)
+covers streaming, cancellation and additional backends.
+
+## Extensibility
+
+Extension points are abstract base classes supplied explicitly by the
+application. Plugins are not discovered or loaded implicitly.
+
+- **`ArtifactStore`** stores snapshots and checkpoints. Isolattice creates and
+  verifies their integrity manifests; `isolattice.testing.check_artifact_store`
+  checks custom stores against the contract.
+- **`EventSink`** receives typed lifecycle events without workload output or
+  secrets.
+- **`CommandRunner`** controls invocation of `podman`, `docker` and `kubectl`.
+- **`Backend`**, **`BackendSession`** and **`TerminationDriver`** provide
+  integration points for additional isolation technologies.
+
+See [custom integrations](https://isolattice.readthedocs.io/en/latest/guides/custom-integrations/)
+and [custom backends](https://isolattice.readthedocs.io/en/latest/guides/custom-backend/).
+
+## Examples
+
+The [`examples/`](https://github.com/smuniharish/isolattice/tree/main/examples)
+directory contains runnable programs exercised by live tests on configured
+backends:
+
+- [First sandbox on Podman](https://github.com/smuniharish/isolattice/blob/main/examples/01-getting-started/podman_hello.py)
+- [Resource limits and instance budgets](https://github.com/smuniharish/isolattice/tree/main/examples/04-resource-management)
+- [Streaming and cancellation](https://github.com/smuniharish/isolattice/blob/main/examples/06-async-and-cancellation/podman_stream_cancel.py)
+- [Linux namespaces and Windows AppContainer](https://github.com/smuniharish/isolattice/tree/main/examples/08-native-backends)
+- [Docker API](https://github.com/smuniharish/isolattice/blob/main/examples/09-container-integrations/docker_isolated_run.py)
+  and [Kubernetes](https://github.com/smuniharish/isolattice/blob/main/examples/10-kubernetes/kubernetes_isolated_run.py)
+- [Workspace and container snapshots](https://github.com/smuniharish/isolattice/tree/main/examples/12-snapshots)
+- [CRIU checkpoints](https://github.com/smuniharish/isolattice/blob/main/examples/13-checkpoints/podman_checkpoint.py)
+- [Failure handling](https://github.com/smuniharish/isolattice/blob/main/examples/18-failure-scenarios/podman_failures.py)
+
+## Planned enhancements
+
+The following enhancements are proposed and are not available today. No
+delivery date is committed.
+
+- **Restore into a live process:** CRIU restore creates a new process tree; it
+  does not merge checkpoint state into an already-running process. Supporting
+  this requires a different restore mechanism or backend.
+- **Rootless checkpoints:** The current Podman/CRIU path requires a rootful
+  engine. Rootless support would require a verified privilege and containment
+  model; see the [CRIU Podman guide](https://www.criu.org/Podman).
+- **Keep TCP connections on runc:** the tested runc restore path cannot
+  re-establish these connections and leaves loopback down. The option is
+  supported only on crun; runc support depends on a compatible upstream runtime
+  or a separately validated restore path.
+
+See [feature coverage](https://isolattice.readthedocs.io/en/latest/development/feature-coverage/)
+and the [architecture review](https://isolattice.readthedocs.io/en/latest/development/architecture-review/)
+for the full feature ledger, other proposed enhancements and backend limitations.
+
+## Documentation
+
+Full documentation: **[isolattice.readthedocs.io](https://isolattice.readthedocs.io/en/latest/)**
+
+- [Getting started](https://isolattice.readthedocs.io/en/latest/getting-started/)
+- [Concepts](https://isolattice.readthedocs.io/en/latest/concepts/introduction/)
+- [Backends](https://isolattice.readthedocs.io/en/latest/backends/podman/)
+- [Security model and guarantees](https://isolattice.readthedocs.io/en/latest/security/guarantees/)
+- [Architecture](https://isolattice.readthedocs.io/en/latest/architecture/02-architecture-overview/)
+- [API reference](https://isolattice.readthedocs.io/en/latest/api/)
+
+Two [Agent Skills](https://isolattice.readthedocs.io/en/latest/agent-skills/)
+provide guidance for coding agents such as Claude Code, Codex, Cursor and GitHub
+Copilot. `isolattice` covers backend execution and fail-closed policies;
+`isolattice-extend` covers custom stores, event sinks, runners and backends:
+
+```bash
+npx skills add smuniharish/isolattice
+```
+
+Changes are listed in the
+[changelog](https://github.com/smuniharish/isolattice/blob/main/CHANGELOG.md).
+
+## Contributing
+
+Contributions are welcome. See
+[CONTRIBUTING.md](https://github.com/smuniharish/isolattice/blob/main/CONTRIBUTING.md)
+for the development setup and checks, and
+[SECURITY.md](https://github.com/smuniharish/isolattice/blob/main/SECURITY.md)
+to report a vulnerability.
+
+## License
+
+Apache License 2.0. See
+[LICENSE](https://github.com/smuniharish/isolattice/blob/main/LICENSE).