airlock-llm 0.1.1__tar.gz

airlock_llm-0.1.1/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.

airlock_llm-0.1.1/PKG-INFO

@@ -0,0 +1,348 @@
+Metadata-Version: 2.4
+Name: airlock-llm
+Version: 0.1.1
+Summary: Enterprise LLM proxy built on LiteLLM — logging, guardrails, and unified access for AI coding tools.
+Author: Corey Thompson
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/coreyt/airlock
+Project-URL: Repository, https://github.com/coreyt/airlock
+Project-URL: Issues, https://github.com/coreyt/airlock/issues
+Project-URL: Changelog, https://github.com/coreyt/airlock/blob/main/CHANGELOG.md
+Keywords: llm,proxy,litellm,guardrails,pii,observability,ai,openai,anthropic,mcp
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: Proxy Servers
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: litellm[proxy]!=1.82.7,!=1.82.8,>=1.55.0
+Requires-Dist: presidio-analyzer>=2.2.0
+Requires-Dist: presidio-anonymizer>=2.2.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: textual>=6.2.1
+Provides-Extra: s3
+Requires-Dist: boto3>=1.34.0; extra == "s3"
+Provides-Extra: sql
+Requires-Dist: sqlalchemy>=2.0.0; extra == "sql"
+Provides-Extra: metrics
+Requires-Dist: prometheus-client>=0.20.0; extra == "metrics"
+Provides-Extra: tui
+Requires-Dist: textual>=0.40.0; extra == "tui"
+Provides-Extra: search
+Requires-Dist: tavily-python>=0.5.0; extra == "search"
+Requires-Dist: newscatcher-catchall-sdk>=1.0.0; extra == "search"
+Provides-Extra: tracing
+Requires-Dist: opentelemetry-api>=1.20.0; extra == "tracing"
+Requires-Dist: opentelemetry-sdk>=1.20.0; extra == "tracing"
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Requires-Dist: pytest-asyncio>=0.23; extra == "test"
+Requires-Dist: pytest-cov>=5.0; extra == "test"
+Requires-Dist: fastapi>=0.100.0; extra == "test"
+Requires-Dist: prometheus-client>=0.20.0; extra == "test"
+Dynamic: license-file
+
+# Airlock
+
+Enterprise LLM proxy built on [LiteLLM](https://github.com/BerriAI/litellm) — unified access, logging, and guardrails for AI coding tools.
+
+Airlock sits between your developers and LLM providers, giving you visibility and control without slowing anyone down.
+
+```
+  ┌──────────┐   ┌──────────┐   ┌──────────┐
+  │  Cursor   │   │  Claude  │   │  Copilot  │
+  │           │   │   Code   │   │           │
+  └─────┬─────┘   └─────┬────┘   └─────┬─────┘
+        │               │              │
+        └───────────┬───┘──────────────┘
+                    │
+              ┌─────▼──────┐
+              │   AIRLOCK   │  ← logging, PII guard, keyword guard
+              │  (LiteLLM)  │
+              └──────┬──────┘
+                     │
+           ┌─────────┼──────────┐
+           │         │          │
+      ┌────▼───┐ ┌───▼────┐ ┌──▼──────┐
+      │Anthropic│ │ OpenAI │ │ Internal│
+      │  API    │ │  API   │ │  RAG    │
+      └────────┘ └────────┘ └─────────┘
+```
+
+## What it does
+
+| Concern | How Airlock handles it |
+|---|---|
+| **Unified access** | Single OpenAI-compatible endpoint for all providers |
+| **Logging** | Every request/response logged as structured JSONL |
+| **PII stripping** | Microsoft Presidio scrubs credit cards, SSNs, emails, etc. before they leave the network |
+| **Keyword blocking** | Custom blocklist prevents restricted project names or terms from leaking |
+| **Budget control** | Per-user/per-team spend limits via LiteLLM virtual keys |
+| **Multi-tool support** | Works with Cursor, Claude Code, GitHub Copilot, and any OpenAI-compatible client |
+| **Self-hosted models** | Route to local vLLM, Ollama, or any OpenAI-compatible endpoint alongside cloud providers |
+| **Interactive testing** | Built-in Basic Chat screen to test LLM connectivity and inspect full request/response cycles |
+
+## Getting started
+
+### Install from PyPI
+
+```bash
+pip install airlock-llm
+python -m spacy download en_core_web_lg   # required for PII redaction
+airlock init
+```
+
+`airlock init` generates `config.yaml`, `.env`, and a `logs/` directory in the
+current working directory.
+
+### Install from source (quick setup)
+
+```bash
+git clone https://github.com/coreyt/airlock && cd airlock
+./scripts/setup.sh
+```
+
+This installs Airlock and its dependencies, downloads the spaCy model for PII
+redaction, and runs `airlock init`. Pass `--pip` to use pip instead of uv.
+
+### Developer setup
+
+```bash
+git clone https://github.com/coreyt/airlock && cd airlock
+./scripts/setup-dev.sh
+```
+
+Everything in the standard setup, plus all optional extras (test, metrics,
+tracing, search, s3, sql), install verification, and a test suite run. Pass
+`--pip` to use pip instead of uv.
+
+### Add your API keys
+
+Edit the generated `.env` file and fill in your provider keys:
+
+```bash
+# .env
+ANTHROPIC_API_KEY=sk-ant-...
+OPENAI_API_KEY=sk-...
+```
+
+You only need keys for the providers you plan to use. If you only use Anthropic models, you can leave `OPENAI_API_KEY` blank.
+
+### Start the proxy
+
+```bash
+# Option A: TUI dashboard with built-in proxy (recommended)
+uv run airlock tui --start
+
+# Option B: proxy only (headless)
+uv run airlock start
+```
+
+Airlock listens on `http://localhost:4000` by default. Change the port with `AIRLOCK_PORT` in `.env`.
+
+### Test it
+
+```bash
+curl http://localhost:4000/v1/chat/completions \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer sk-airlock-change-me" \
+  -d '{
+    "model": "claude-sonnet",
+    "messages": [{"role": "user", "content": "Hello!"}]
+  }'
+```
+
+Or use the TUI's **Basic Chat** screen (press `0`) to interactively test any configured model and inspect the full request/response headers and body.
+
+### Alternative: Docker
+
+```bash
+docker compose up --build
+```
+
+## Connecting AI tools
+
+Point any OpenAI-compatible client at `http://localhost:4000` (or your deployed Airlock URL).
+
+### Claude Code
+
+```bash
+# Install client-side hooks and route traffic through the proxy
+airlock hooks install
+eval $(airlock dogfood)
+claude
+```
+
+Every request now flows through PII redaction, keyword blocking, and JSONL logging. Open `airlock tui` in another terminal to watch traffic in real time.
+
+See [dev/dogfooding.md](dev/dogfooding.md) for the full setup guide.
+
+### Cursor / Windsurf
+
+In settings, set:
+- **OpenAI Base URL**: `http://localhost:4000/v1`
+- **API Key**: your Airlock master key (from `.env`)
+
+### GitHub Copilot
+
+In VS Code `settings.json`:
+```json
+{
+  "github.copilot.advanced": {
+    "debug.overrideProxyUrl": "http://localhost:4000/v1"
+  }
+}
+```
+
+## Configuration
+
+### config.yaml
+
+The main configuration file defines models, callbacks, and guardrails. See the inline comments in `config.yaml` for details.
+
+Key sections:
+- **`model_list`** — which LLM providers/models to expose
+- **`litellm_settings`** — callbacks, timeouts, budgets
+- **`router_settings`** — routing strategy, fallbacks, provider budgets
+- **`guardrails`** — PII and keyword guards
+- **`mcp_servers`** — MCP tool servers (Armada, ADO, etc.) accessible via the proxy
+- **`general_settings`** — master key, host/port
+
+### Self-hosted / local models
+
+Airlock supports any OpenAI-compatible endpoint (vLLM, Ollama, LocalAI, etc.) using the `openai/` prefix with a custom `api_base`:
+
+```yaml
+# config.yaml — add to model_list
+- model_name: gemma-4
+  litellm_params:
+    model: openai/gemma4-31b          # model ID as reported by the server
+    api_base: http://your-host:8000/v1
+    api_key: os.environ/VLLM_API_KEY  # use "dummy-key" if server has no auth
+```
+
+```bash
+# .env
+VLLM_API_KEY=dummy-key
+```
+
+The model will appear in the TUI Basic Chat screen for interactive testing and can be used by any connected client via `model: "gemma-4"`.
+
+### Environment variables
+
+| Variable | Description | Default |
+|---|---|---|
+| `ANTHROPIC_API_KEY` | Anthropic API key | — |
+| `OPENAI_API_KEY` | OpenAI API key | — |
+| `AIRLOCK_MASTER_KEY` | Master key for admin endpoints | — |
+| `AIRLOCK_HOST` | Bind address (set to `0.0.0.0` to expose externally) | `127.0.0.1` |
+| `AIRLOCK_PORT` | Listen port | `4000` |
+| `AIRLOCK_LOG_DIR` | Directory for JSONL log files | `./logs` |
+| `AIRLOCK_MAX_LOG_DAYS` | Days to retain log files before cleanup | `30` |
+| `AIRLOCK_MAX_LOG_SIZE_MB` | Max log file size before rotation | `500` |
+| `AIRLOCK_BLOCKED_KEYWORDS` | Comma-separated restricted phrases | — |
+| `AIRLOCK_PII_ENTITIES` | Presidio entity types to redact | `CREDIT_CARD,US_SSN,EMAIL_ADDRESS,PHONE_NUMBER` |
+
+## Adding MCP servers
+
+Airlock can proxy MCP tool servers alongside LLM providers. Add entries to `mcp_servers` in `config.yaml`. LiteLLM spawns stdio servers from the proxy's working directory, so command resolution matters.
+
+### Command resolution patterns
+
+**Module via `python -m`** — cwd-independent, requires package installed in the proxy's venv:
+```yaml
+mcp_servers:
+  ado_mcp:
+    command: uv
+    args: ["run", "python", "-m", "ado_mcp.mcp.server"]
+    env:
+      ADO_ORG_URL: os.environ/ADO_ORG_URL
+      ADO_PAT: os.environ/ADO_PAT
+```
+
+**Installed script via `uv run`** — cwd-independent, resolves from PATH/venv:
+```yaml
+  armada:
+    command: uv
+    args: ["run", "armada-mcp"]
+    env:
+      ARMADA_PROFILE: essential
+```
+
+**Script file** — must use an absolute path (relative paths resolve against the proxy's cwd, not the server's project directory):
+```yaml
+  mono_tui:
+    command: python3
+    args: ["/home/user/projects/my-mcp-server/server.py"]
+```
+
+**Other runtimes:**
+```yaml
+  # Node.js
+  my_node_server:
+    command: node
+    args: ["/path/to/server.js"]
+
+  # npx (installed package)
+  my_npx_server:
+    command: npx
+    args: ["my-mcp-server"]
+
+  # Bun
+  my_bun_server:
+    command: bun
+    args: ["run", "/path/to/server.ts"]
+
+  # Poetry
+  my_poetry_server:
+    command: poetry
+    args: ["run", "python", "-m", "my_server"]
+```
+
+### Environment variables
+
+Use `os.environ/VAR_NAME` to pass environment variables from Airlock's `.env` to the MCP server. Airlock validates these references at startup and gives clear error messages for missing values.
+
+### Guardrail coverage
+
+All MCP tool calls flow through the same guardrail pipeline as LLM requests (PII redaction, keyword blocking, threat detection). MCP-specific guards add tool allowlist/blocklist and argument sanitization. No extra configuration needed — guardrails apply automatically.
+
+## Project structure
+
+```
+airlock/
+├── proxy.py              # Entry point — launches LiteLLM subprocess
+├── callbacks/            # JSONL logger, S3, SQL, Prometheus, OpenTelemetry
+├── guardrails/           # PII redaction, keyword blocking, semantic, adaptive
+├── fast/                 # Real-time: threat detection, circuit breaker, priority
+├── slow/                 # Offline: log analysis, trend detection, tuning
+├── hooks/                # Claude Code client-side hooks (session, prompt, audit)
+├── cli/                  # Unified CLI: init, start, status, tui, analyze, hooks
+└── tui/                  # Textual terminal dashboard (10 screens, proxy control)
+scripts/
+├── setup.sh              # Standard setup (install + init + spaCy model)
+└── setup-dev.sh          # Developer setup (all extras + tests)
+```
+
+## Production deployment
+
+See [docs/operations.md](docs/operations.md) for deployment guides (Docker, Kubernetes, bare metal), monitoring, security checklist, and upgrade procedures.
+
+See [docs/troubleshooting.md](docs/troubleshooting.md) for common issues and debugging.
+
+## License
+
+Apache 2.0