0din-litellm-shield 0.2.0__tar.gz

0din_litellm_shield-0.2.0/.env.example

@@ -0,0 +1,26 @@
+# Copy this to .env and fill in your values.
+# .env is gitignored — never commit real keys.
+
+# OpenRouter API key — used for all LLM calls (openrouter/openai/gpt-4o-mini, etc.)
+OPENROUTER_API_KEY=sk-or-...
+
+# LiteLLM proxy master key (clients use this to authenticate)
+LITELLM_MASTER_KEY=sk-1234
+
+# HuggingFace token (needed to provision the gated SusFactor model)
+HF_TOKEN=hf_...
+
+# Model cache directory (default: ~/.cache/signature-sdk/models)
+# SIGNATURE_SDK_MODEL_CACHE=/path/to/models
+
+# 0DIN Portal access token — required for backend: "hosted" (sends prompts
+# to 0DIN's hosted SusFactor API instead of running the model in-process).
+ODIN_ACCESS_TOKEN=
+
+# Hosted-backend endpoints — only needed to point at a non-prod environment.
+# ODIN_PORTAL_URL=https://0din.ai
+# ODIN_SUSFACTOR_URL=https://defense.0din.ai
+
+# Docker Compose overrides
+# MODEL_CACHE_DIR=~/.cache/signature-sdk/models
+# LITELLM_CONFIG_FILE=./examples/config-flag.yaml

0din_litellm_shield-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches: ["main", "sgolub/*"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  test:
+    name: Lint + Type + Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        # self-hosted pulls in odin-prompt-toolkit from the committed private
+        # wheel (see [tool.uv.sources]) — needed so the SdkBackend/OnnxSdkBackend
+        # tests, which exercise real odin_prompt_toolkit error types, keep running.
+        # Not available to external contributors installing from public PyPI.
+        run: uv sync --extra dev --extra self-hosted
+
+      - name: Ruff lint
+        run: uv run ruff check .
+
+      - name: Black format check
+        run: uv run black --check .
+
+      - name: Mypy type check
+        run: uv run mypy susfactor_guardrail/
+
+      - name: Pytest
+        run: uv run pytest tests/ -v
+        env:
+          # Ensure no accidental real model load in CI — tests must mock
+          SIGNATURE_SDK_MODEL_CACHE: "/tmp/no-model-cache-in-ci"

0din_litellm_shield-0.2.0/.github/workflows/code-review.yml

@@ -0,0 +1,25 @@
+name: Code Review
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  review:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.draft == false && github.actor != 'dependabot[bot]'
+    permissions:
+      id-token: write
+      contents: read
+      pull-requests: write
+      issues: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: stephengolub/code-reviewer@v1
+        with:
+          model: anthropic/claude-sonnet-4-5
+          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}

0din_litellm_shield-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,96 @@
+# Publishes 0din-litellm-shield to PyPI using Trusted Publishing (OIDC).
+#
+# No PyPI API token is stored in this repo. Authentication happens via
+# GitHub's OIDC identity (the `id-token: write` permission below) instead
+# of a `password`/token secret. This requires a one-time manual setup on
+# pypi.org: registering this repo, this workflow's filename
+# (publish.yml), and the deployment environment (if one is configured)
+# as a "trusted publisher" on the `0din-litellm-shield` PyPI project.
+# That registration is handled separately by a human with access to the
+# PyPI project — this workflow cannot perform it and publishing will
+# fail with an authentication error until it's done.
+#
+# Trigger: a human creates a tagged GitHub Release when ready to ship.
+# The version itself is derived from the release's git tag by
+# hatch-vcs (see pyproject.toml) — nothing here computes or bumps it.
+
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Lint + Type + Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9  # v9.0.0
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        # self-hosted pulls in odin-prompt-toolkit from the committed private
+        # wheel (see [tool.uv.sources]) — needed so the SdkBackend/OnnxSdkBackend
+        # tests, which exercise real odin_prompt_toolkit error types, keep running.
+        run: uv sync --extra dev --extra self-hosted
+
+      - name: Ruff lint
+        run: uv run ruff check .
+
+      - name: Black format check
+        run: uv run black --check .
+
+      - name: Mypy type check
+        run: uv run mypy susfactor_guardrail/
+
+      - name: Pytest
+        run: uv run pytest tests/ -v
+        env:
+          # Ensure no accidental real model load in CI — tests must mock
+          SIGNATURE_SDK_MODEL_CACHE: "/tmp/no-model-cache-in-ci"
+
+  publish:
+    name: Build and publish
+    needs: test
+    runs-on: ubuntu-latest
+    # Job-level permissions fully replace (not merge with) the workflow-level
+    # default above, so contents: read must be repeated here — without it,
+    # checkout has no GITHUB_TOKEN access and fails against this private repo.
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
+        with:
+          # hatch-vcs derives the package version from git tags — a shallow
+          # checkout would leave it unable to see the release tag.
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9  # v9.0.0
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Build
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@ba38be9e461d3875417946c167d0b5f3d385a247  # v1.14.1

0din_litellm_shield-0.2.0/.gitignore

@@ -0,0 +1,57 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+*.egg-info/
+dist/
+build/
+.eggs/
+
+# uv / venv
+.venv/
+venv/
+.uv/
+
+# Model cache (never commit gated model weights)
+.cache/
+*.safetensors
+*.pt
+head.pt
+
+# Pytest
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+# Mypy
+.mypy_cache/
+
+# Ruff
+.ruff_cache/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# LiteLLM proxy config (may contain secrets)
+litellm_proxy_config.yaml
+
+# Latency report output files
+latency-report*.json
+report.json
+
+# Environment / secrets
+.env
+*.env.local
+
+# OpenCode tooling (plans are tracked separately if desired)
+.opencode/node_modules/

0din_litellm_shield-0.2.0/Dockerfile

@@ -0,0 +1,63 @@
+# litellm-shield — LiteLLM proxy with SusFactor guardrail
+#
+# Model weights are NOT baked in. Mount a pre-provisioned model cache at runtime:
+#   -v /path/to/your/model/cache:/model-cache:ro
+#
+# See scripts/provision_model.py to download the gated 0dinai/susfactor-e5-large model.
+
+FROM python:3.13-slim
+
+# ---- system deps -------------------------------------------------------
+RUN apt-get update && apt-get install -y --no-install-recommends \
+        git \
+        curl \
+    && rm -rf /var/lib/apt/lists/*
+
+# ---- uv ----------------------------------------------------------------
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
+
+WORKDIR /app
+
+# ---- install deps -------------------------------------------------------
+# odin-prompt-toolkit is a private repo — the wheel is built locally
+# (requires SSH access) and copied in; no GitHub credentials needed here.
+COPY pyproject.toml uv.lock ./
+COPY wheels/ ./wheels/
+
+# Install all Python deps:
+#   1. odin-prompt-toolkit from the pre-built local wheel
+#   2. Everything else (litellm, torch, transformers, etc.) from PyPI
+RUN uv pip install --system \
+        wheels/odin_prompt_toolkit-*.whl \
+        "litellm[proxy]>=1.0.0" \
+        "torch>=2.0.0" \
+        "transformers>=4.0.0" \
+        "onnxruntime>=1.16.0"
+
+# ---- install the guardrail package -------------------------------------
+COPY susfactor_guardrail/ ./susfactor_guardrail/
+COPY pyproject.toml ./
+RUN uv pip install --system --no-deps .
+
+# ---- LiteLLM proxy config + guardrail shim -----------------------------
+# LiteLLM resolves custom guardrails by looking for a .py file next to the
+# config file. The shim re-exports from the installed package.
+COPY susfactor_guardrail.py ./susfactor_guardrail.py
+COPY examples/config-flag.yaml ./config.yaml
+
+# ---- model cache mount point -------------------------------------------
+# The gated 0dinai/susfactor-e5-large model is mounted here at runtime.
+# Layout expected:
+#   /model-cache/susfactor-v1/encoder/config.json
+#   /model-cache/susfactor-v1/encoder/model.safetensors
+#   /model-cache/susfactor-v1/encoder/tokenizer.json
+#   /model-cache/susfactor-v1/head.pt
+ENV SIGNATURE_SDK_MODEL_CACHE=/model-cache
+
+# ---- runtime -----------------------------------------------------------
+EXPOSE 4000
+
+# LiteLLM proxy entrypoint. Config can be overridden via LITELLM_CONFIG env var.
+ENV LITELLM_CONFIG=/app/config.yaml
+
+CMD ["litellm", "--config", "/app/config.yaml", "--port", "4000"]

0din_litellm_shield-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+                                 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 [2026] [Mozilla 0din.ai]
+
+   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.
+

0din_litellm_shield-0.2.0/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: 0din-litellm-shield
+Version: 0.2.0
+Summary: SusFactor jailbreak/prompt-injection guardrail for LiteLLM
+Project-URL: Repository, https://github.com/0din-ai/litellm-shield
+Author: 0DIN Team
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: guardrail,jailbreak,litellm,prompt-injection,susfactor
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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 :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Security
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: litellm[proxy]>=1.0.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.5.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: self-hosted
+Requires-Dist: odin-prompt-toolkit[onnx,susfactor]; extra == 'self-hosted'