vipi-scanner 0.1.0__tar.gz

vipi_scanner-0.1.0/.env.example

@@ -0,0 +1,10 @@
+# Optional API keys for external detectors. Fill in only the providers you use.
+TYPESAFE_API_KEY=your-typesafe-api-key
+OPENAI_API_KEY=your-openai-api-key
+
+# Jev also accepts JEV_API_KEY as an alias for TYPESAFE_API_KEY.
+# Set only one of these two names.
+# JEV_API_KEY=
+
+# Optional: Hugging Face access for downloading restricted Prompt Guard weights.
+HF_TOKEN=your-huggingface-token

vipi_scanner-0.1.0/.gitignore

@@ -0,0 +1,224 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.DS_Store
+.env
+.envrc
+.venv
+.venv-anamorpher/
+.venv-ocr/
+models/ocr/
+models/detector/
+runs/
+# Local research data; research code and documentation remain trackable.
+/research/datasets/data/external/
+/research/datasets/data/derived/
+/research/datasets/data/.cache/
+/research/experiments/reports/
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Temporary conversational plans; keep the directory convention visible.
+.llm-plans/*
+
+# Locally retained media that should not ship with the repository.
+.local-assets/

vipi_scanner-0.1.0/LICENSE

@@ -0,0 +1,204 @@
+Copyright 2026 Enian
+
+                                 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.

vipi_scanner-0.1.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.5
+Name: vipi-scanner
+Version: 0.1.0
+Summary: Scan images for visual indirect prompt injections
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: <3.13,>=3.12
+Requires-Dist: python-dotenv<2,>=1.2.4
+Requires-Dist: rich
+Provides-Extra: detector-local
+Requires-Dist: huggingface-hub>=1.32.0; extra == 'detector-local'
+Requires-Dist: safetensors==0.8.0; extra == 'detector-local'
+Requires-Dist: sentencepiece==0.2.1; extra == 'detector-local'
+Requires-Dist: torch==2.6.0; extra == 'detector-local'
+Requires-Dist: transformers==5.8.1; extra == 'detector-local'
+Provides-Extra: ocr
+Requires-Dist: numpy==1.26.4; extra == 'ocr'
+Requires-Dist: onnxruntime==1.23.2; extra == 'ocr'
+Requires-Dist: opencv-python==4.11.0.86; extra == 'ocr'
+Requires-Dist: pillow==11.3.0; extra == 'ocr'
+Requires-Dist: rapidocr==3.9.2; extra == 'ocr'
+Requires-Dist: tensorflow==2.19.0; extra == 'ocr'
+Requires-Dist: torch==2.6.0; extra == 'ocr'
+Provides-Extra: ocr-cuda
+Requires-Dist: numpy==1.26.4; extra == 'ocr-cuda'
+Requires-Dist: nvidia-cuda-runtime-cu12<13,>=12.8; (sys_platform == 'linux' or sys_platform == 'win32') and extra == 'ocr-cuda'
+Requires-Dist: onnxruntime-gpu[cuda,cudnn]==1.23.2; (sys_platform == 'linux' or sys_platform == 'win32') and extra == 'ocr-cuda'
+Requires-Dist: opencv-python==4.11.0.86; extra == 'ocr-cuda'
+Requires-Dist: pillow==11.3.0; extra == 'ocr-cuda'
+Requires-Dist: rapidocr==3.9.2; extra == 'ocr-cuda'
+Requires-Dist: tensorflow==2.19.0; extra == 'ocr-cuda'
+Requires-Dist: torch==2.6.0; extra == 'ocr-cuda'
+Provides-Extra: research
+Requires-Dist: flask==3.1.2; extra == 'research'
+Requires-Dist: huggingface-hub>=1.32.0; extra == 'research'
+Requires-Dist: jsonschema>=4.26.0; extra == 'research'
+Provides-Extra: test
+Requires-Dist: pytest==8.4.2; extra == 'test'
+Requires-Dist: ruff==0.14.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# VIPI
+
+<p align="center">
+  <img src="assets/motion/vipi-reveal.gif" alt="Animated VIPI logo reveal" width="720">
+</p>
+
+<p align="center">
+  Scan images for visual indirect prompt injections.
+</p>
+
+<p align="center">
+  <a href="pyproject.toml"><img alt="Python 3.12" src="https://img.shields.io/badge/Python-3.12-3776AB?logo=python&logoColor=white"></a>
+  <a href="docs/cli.md#platform-validation-status"><img alt="macOS smoke-tested" src="https://img.shields.io/badge/macOS-smoke--tested-2ea44f"></a>
+  <a href="docs/cli.md#platform-validation-status"><img alt="Linux and Windows not tested" src="https://img.shields.io/badge/Linux%20%2F%20Windows-not%20tested-lightgrey"></a>
+</p>
+
+VIPI transforms each image through a multi-view OCR pipeline, then checks the
+final recognized text with Jev, OpenAI Decisions or the local Prompt Guard model.
+The public interface is a small command-line tool that can scan files,
+directories and committed image changes.
+
+## Quick start
+
+VIPI requires Python 3.12 and [uv](https://docs.astral.sh/uv/). Install the OCR
+extra, prepare the pinned PP-OCRv6 models once, then provide a Jev API key and
+scan an image. Set `TYPESAFE_API_KEY` in the environment, or copy
+[`.env.example`](.env.example) to `.env` and fill in the key before scanning:
+
+`uv venv` creates the project environment in `.venv`. `uv sync --extra ocr`
+installs VIPI and its OCR dependencies into that environment. Commands run with
+`uv run` use `.venv` automatically, so you do not need to activate it yourself.
+
+```bash
+git clone https://github.com/EnXan/VIPI.git
+cd VIPI
+uv venv
+uv sync --extra ocr
+uv run vipi setup
+uv run vipi scan image.png
+```
+
+Jev also accepts `JEV_API_KEY`. Model setup downloads and verifies the pinned
+OCR files; scanning does not download models.
+
+## Usage
+
+```bash
+# Scan one or more images
+uv run vipi scan label.png screenshot.jpg
+
+# Scan a directory recursively and save a JSON report
+uv run vipi scan ./images --output report.json
+
+# Choose a speed/quality mode or a specific supported model
+uv run vipi scan ./images --ocr-mode fast
+uv run vipi scan ./images --ocr-mode balanced
+uv run vipi scan ./images --ocr-model ppocr-v6-medium
+
+# Scan committed images added or modified on a branch
+uv run vipi scan . --diff origin/main --output report.json
+
+# Choose a detector and adjust the finding threshold
+uv run vipi scan image.png --detector openai --threshold 90
+```
+
+The interface has two commands, `vipi setup` and `vipi scan`. OCR modes map
+`fast` to PP-OCRv6 Tiny, `balanced` to Small and `quality` to Medium. `quality`
+is the default to preserve the previous Medium behavior. `--ocr-model` selects a
+supported model ID directly and overrides the mode. `vipi setup` prepares all
+three models by default. The default detector is Jev with a threshold of 80 on a
+0–100 score scale. A score at the threshold counts as a finding; it is not a
+calibrated probability of an attack.
+
+For local Prompt Guard, install its optional dependencies and prepare its model:
+
+```bash
+uv sync --extra ocr --extra detector-local
+uv run vipi setup --detector prompt-guard
+uv run vipi scan image.png --detector prompt-guard
+```
+
+OpenAI uses `OPENAI_API_KEY`. Prompt Guard runs locally and requires authorized
+access to its model weights. See the [CLI guide](docs/cli.md) for provider setup,
+GitHub Actions examples, branch-diff behavior, cache paths and report details.
+
+## Results and automation
+
+Exit codes support CI use:
+
+| Code | Meaning |
+| --- | --- |
+| `0` | Scan completed without detections, or no images were selected |
+| `1` | At least one image was detected |
+| `2` | An error or incomplete scan occurred; errors take precedence |
+
+VIPI provides the CLI for GitHub Actions workflows; this repository does not
+currently include a packaged GitHub Action. See the [PR scan example](docs/cli.md#branch-and-pr-scans).
+
+## Documentation
+
+- [CLI usage and platform validation](docs/cli.md)
+- [Package architecture](docs/architecture.md)
+- [Development setup and checks](docs/development.md)
+- [Research workbench and datasets](research/README.md)
+- [Decision records](adr-code/README.md)
+
+A built wheel contains the `vipi` package. Research tools, datasets, model
+weights and run artifacts remain outside the runtime package.
+
+## License
+
+VIPI's original code, documentation and project assets are licensed under the
+[Apache License, Version 2.0](LICENSE). Third-party models, dependencies,
+datasets and other third-party material retain their own license terms; see
+their respective notices and source projects.