Skip to main content

A Python library for language security

Project description

LangGuard 🛡️

Python Version License: MIT PyPI Version

LangGuard is a Python library that acts as a security layer for LLM (Large Language Model) agent pipelines. It screens and validates language inputs before they reach your AI agents, helping prevent prompt injection, jailbreaking attempts, and ensuring compliance with your security specifications.

Features

  • 🤖🛡️ GuardAgent: Agent that serves as a circuit-breaker against prompt injection, jailbreaking, and data lifting attacks.

Installation

Install LangGuard using pip:

pip install langguard

Quick Start

Basic Usage - Plug and Play

from langguard import GuardAgent

# Initialize GuardAgent with built-in security rules
guard = GuardAgent(llm="openai")

# Screen a user prompt with default protection
prompt = "How do I write a for loop in Python?"
response = guard.screen(prompt)

if response["safe"]:
    print(f"Prompt is safe: {response['reason']}")
    # Proceed with your LLM agent pipeline
else:
    print(f"Prompt blocked: {response['reason']}")
    # Handle the blocked prompt

The default specification blocks:

  • Jailbreak attempts and prompt injections
  • Requests for harmful or illegal content
  • SQL/command injection attempts
  • Personal information requests
  • Malicious content generation
  • System information extraction

Adding Custom Rules

# Add additional rules to the default specification
guard = GuardAgent(llm="openai")

# Add domain-specific rules while keeping default protection
response = guard.screen(
    "Tell me about Python decorators",
    specification="Only allow Python and JavaScript questions"
)
# This adds your rules to the default security rules

Overriding Default Rules

# Completely replace default rules with custom specification
response = guard.screen(
    "What is a SQL injection?",
    specification="Only allow cybersecurity educational content",
    override=True  # This replaces ALL default rules
)

Simple Boolean Validation

# For simple pass/fail checks
is_safe = agent.is_safe(
    "Tell me about Python decorators",
    "Only allow programming questions"
)

if is_safe:
    # Process the prompt
    pass

🔧 Configuration

Environment Variables

LangGuard can be configured using environment variables:

# LLM Provider Configuration
export GUARD_LLM_PROVIDER="openai"        # Options: "openai", or None for test mode
export GUARD_LLM_MODEL="gpt-4o-mini"      # OpenAI model to use
export GUARD_LLM_API_KEY="your-api-key"   # Your OpenAI API key
export LLM_TEMPERATURE="0.1"              # Temperature for LLM generation (0-1)

Programmatic Configuration

from langguard import GuardAgent

# Configure via code
agent = GuardAgent(
    llm="openai",  # or None for test mode
    config={
        "default_specification": "Your default security rules here"
    }
)

🛠️ Advanced Usage

Advanced Usage

from langguard import GuardAgent

# Create a guard agent
agent = GuardAgent(llm="openai")

# Use the simple boolean check
if agent.is_safe("DROP TABLE users;"):
    print("Prompt is safe")
else:
    print("Prompt blocked")

# With custom rules added to defaults
is_safe = agent.is_safe(
    "How do I implement a binary search tree?",
    specification="Must be about data structures"
)

# With complete rule override
is_safe = agent.is_safe(
    "What's the recipe for chocolate cake?",
    specification="Only allow cooking questions",
    override=True
)

Response Structure

LangGuard returns a GuardResponse dictionary with:

{
    "safe": bool,    # True if prompt is safe, False otherwise
    "reason": str    # Explanation of the decision
}

Default Protection

GuardAgent comes with built-in protection against:

  • Jailbreak Attempts: Prompts trying to bypass safety guidelines
  • Injection Attacks: SQL, command, and code injection attempts
  • Data Extraction: Attempts to extract system information or credentials
  • Harmful Content: Requests for illegal, unethical, or dangerous content
  • Personal Information: Requests for SSN, passwords, or private data
  • Malicious Generation: Phishing emails, malware, or exploit code
  • Prompt Manipulation: Instructions to ignore previous rules or reveal system prompts

🧪 Testing

The library includes comprehensive test coverage for various security scenarios:

# Run the OpenAI integration test
cd scripts
python test_openai.py

# Run unit tests
pytest tests/

Example Security Scenarios

LangGuard can detect and prevent:

  • SQL Injection Attempts: Blocks malicious database queries
  • System Command Execution: Prevents file system access attempts
  • Personal Information Requests: Blocks requests for PII
  • Jailbreak Attempts: Detects attempts to bypass AI safety guidelines
  • Phishing Content Generation: Prevents creation of deceptive content
  • Medical Advice: Filters out specific medical diagnosis requests
  • Harmful Content: Blocks requests for dangerous information

🏗️ Architecture

LangGuard follows a modular architecture:

langguard/
├── core.py       # Minimal core file (kept for potential future use)
├── agent.py      # GuardAgent implementation with LLM logic
├── models.py     # LLM provider implementations (OpenAI, Test)
└── __init__.py   # Package exports

Components

  • GuardAgent: Primary agent that screens prompts using LLMs
  • LLM Providers: Pluggable LLM backends (OpenAI with structured output support)
  • GuardResponse: Typed response structure with pass/fail status and reasoning

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔗 Links


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

langguard-0.3.0.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

langguard-0.3.0-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file langguard-0.3.0.tar.gz.

File metadata

  • Download URL: langguard-0.3.0.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for langguard-0.3.0.tar.gz
Algorithm Hash digest
SHA256 7cfe1a4c9bc96a0baf59d2d0651e81a4a69b97317dd0339308b987b0b97505c8
MD5 d5b38cfdea370e7ce95fc3bea0c1a1be
BLAKE2b-256 db82573495ed06ed00b1e9c40ccf434d5a2bb7cc2db3f275a62e173f7ce2f54e

See more details on using hashes here.

Provenance

The following attestation bundles were made for langguard-0.3.0.tar.gz:

Publisher: cd.yml on langguard/langguard-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file langguard-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: langguard-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for langguard-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ee58a13b681e8394d630902a06a6000672339fdca232d264dcb0e071f0ddcce
MD5 a2095db25b0d7b0a8f83c8f92f5596d8
BLAKE2b-256 d9b2d1792fad770a2c0fc5b09b39160102b7f7c491179da92b15d224b2bd2f16

See more details on using hashes here.

Provenance

The following attestation bundles were made for langguard-0.3.0-py3-none-any.whl:

Publisher: cd.yml on langguard/langguard-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page