๐Ÿ”ฌ
Vigil: Documentation
GitHub Repo
  • ๐Ÿ›ก๏ธVigil
  • Overview
    • ๐Ÿ—๏ธRelease Blog
    • ๐Ÿ› ๏ธInstall Vigil
      • ๐Ÿ”ฅInstall PyTorch (optional)
    • ๐ŸงชUse Vigil
      • โš™๏ธConfiguration
        • ๐Ÿ”„Auto-updating vector database
      • ๐Ÿ—„๏ธLoad Datasets
      • ๐ŸŒWeb server
        • ๐ŸคAPI Endpoints
        • ๐ŸชWeb UI playground
      • ๐ŸPython library
      • ๐ŸŽฏScanners
        • ๐Ÿค—Transformer
        • โ•YARA / Heuristics
        • ๐Ÿ“‘Prompt-response Similarity
        • ๐Ÿ’พVector database
        • ๐ŸคCanary Tokens
    • ๐Ÿ›ก๏ธCustomize Detections
      • ๐ŸŒŸAdd custom YARA signatures
      • ๐Ÿ”ขAdd embeddings
      • ๐ŸCustom scanners
    • ๐Ÿช„Sample scan results
Powered by GitBook
On this page
  1. Overview
  2. Customize Detections

Add custom YARA signatures

Custom YARA signatures can be saved to the data/yara directory. Any valid YARA rule saved here will be loaded when the yara scanner loads.

Vigil returns the following information when a prompt matches a YARA signature:

  • Rule name

  • Rule tags

  • Rule category

    • "category" metadata field

Sample Rule Template

rule MyRule_custom: customTag
{
    meta:
        category = "Prompt Injection"
        description = "Detects prompts that contain some custom strings"
    strings:
        ...
    condition:
        ...
}
PreviousCustomize DetectionsNextAdd embeddings

Last updated 1 year ago

๐Ÿ›ก๏ธ
๐ŸŒŸ