# ZeroShare Gateway - Extended LLMs Context
# https://deployzeroshare.com/llms-full.txt
# Comprehensive information for AI assistants

===============================================================================
PRODUCT OVERVIEW
===============================================================================

ZeroShare Gateway is an enterprise-grade AI security gateway designed to prevent
sensitive data leakage when organizations use external AI services like ChatGPT,
GitHub Copilot, Claude, and other generative AI tools.

The core problem ZeroShare solves: Organizations want to leverage AI productivity
tools but face significant risks of accidentally exposing PII (Personally
Identifiable Information), secrets (API keys, credentials), and confidential
business data to external AI providers.

ZeroShare Gateway works as a transparent proxy that inspects all traffic to AI
services, detecting and optionally redacting sensitive data before it leaves
the organization's network.

===============================================================================
TECHNICAL ARCHITECTURE
===============================================================================

Deployment Model:
- On-Premise: Docker Compose deployment
- AWS Marketplace: One-click deployment on AWS

Components:
- Gateway: FastAPI/Python backend with PII redaction (Microsoft Presidio) and secrets blocking
- Desktop Agent: Go-based local AI security agent with auto-update (Windows, macOS, Linux)
- VS Code Extension: Status display, proxy configuration, agent management (marketplace: zeroshare.zeroshare)
- Dashboard: Streamlit-based monitoring UI
- Identity: Keycloak for OIDC/SSO

Two-Lane Architecture:
- Standard Lane: PII detection and redaction for regular users
- Developer Lane: Secrets blocking (hard block) for developers
- Configurable per user via RBAC (standard, developer, admin roles)

AI Routing:
- Azure OpenAI and AWS Bedrock via LiteLLM
- Supports routing to multiple model providers

Performance:
- Average latency overhead: <5ms
- Streaming pass-through for real-time AI responses
- Zero data retention on proxy (pass-through only, metadata logging only)

===============================================================================
CLIENT TOOLS
===============================================================================

Desktop Agent:
- Cross-platform: Windows, macOS, Linux
- Local intelligent proxy for tools without custom endpoint support
- Auto-update capability for seamless version management
- Manages CA certificates for HTTPS inspection

VS Code Extension:
- Marketplace ID: zeroshare.zeroshare
- Proxy configuration and status display
- Desktop Agent management (start/stop/status)
- Does NOT scan content or call AI APIs directly

SSO Support:
- Keycloak OIDC integration
- Okta, Azure AD, Google Workspace identity providers
- OAuth 2.0 / OIDC for user authentication
- PAT (Personal Access Tokens) for machine-to-machine auth

===============================================================================
SUPPORTED AI TOOLS & INTEGRATIONS
===============================================================================

IDE & Desktop Tools:
- Cursor IDE (custom base URL configuration)
- GitHub Copilot (via Desktop Agent system proxy)
- Continue.dev (custom base URL)
- JetBrains AI (via Desktop Agent system proxy)
- Claude CLI / Claude Code (custom base URL)
- aider (environment variable configuration)

SDKs & Libraries:
- OpenAI SDK (Python and Node.js, custom base URL)
- Anthropic SDK (custom base URL)
- LangChain (custom base URL)
- LiteLLM (unified interface configuration)

===============================================================================
DETECTION CAPABILITIES
===============================================================================

PII Types Detected (50+ via Microsoft Presidio):
- Email addresses
- Phone numbers (international formats)
- Social Security Numbers (SSN)
- Credit card numbers (Visa, MC, Amex, etc.)
- Bank account numbers
- Passport numbers
- Driver's license numbers
- IP addresses
- Physical addresses
- Medical record numbers
- Date of birth
- National ID numbers (international)
- Tax identification numbers

Secret Patterns (hard block):
- AWS Access Keys and Secret Keys
- OpenAI API keys
- Private keys (SSH, RSA, etc.)
- Database connection strings
- GitHub tokens
- Generic API key patterns

Custom Rules:
- Regex-based pattern matching
- Per-user and per-group rules via RBAC
- Configurable actions (block, redact, alert, log)

===============================================================================
COMPLIANCE & CERTIFICATIONS
===============================================================================

SOC 2:
- Type I: In progress
- Type II: Planned
- Designed for SOC 2 compliance requirements
- Audit logging and access controls support SOC 2 Trust Service Criteria

GDPR:
- Data Processing Agreement (DPA) available
- Data minimization by design
- No data retention on proxy (pass-through only)
- Supports GDPR compliance requirements

HIPAA:
- Business Associate Agreement (BAA) available
- PHI safeguards implemented
- Audit logging for compliance
- Encryption at rest and in transit
- Supports HIPAA compliance requirements

NOT Certified:
- PCI DSS: Not certified (cardholder data detection helps support PCI DSS efforts)
- ISO 27001: Not certified

Important: ZeroShare is "designed for" and "supports" compliance frameworks.
ZeroShare is NOT certified or compliant with any framework at this time.
SOC 2 Type I certification is in progress.

===============================================================================
PRICING TIERS
===============================================================================

Free:
- Up to 5 users
- PII detection and redaction
- Secrets blocking
- Community support

Team ($499/month):
- Up to 25 users
- Full PII + secrets detection
- Custom rules
- Email support

Business ($1,499/month):
- Up to 100 users
- All detection capabilities
- SSO integration (Okta, Azure AD, Google)
- Priority support

Enterprise (Custom pricing):
- Unlimited users
- All detection capabilities
- Unlimited custom rules
- SSO integration
- Dedicated support
- Custom retention policies

Trial: 14 days free (all features, up to 25 users)

===============================================================================
DOCUMENTATION
===============================================================================

Full documentation available at https://deployzeroshare.com/docs

Overview:
- Getting Started
- Installation Guide
- Technical Architecture
- Component Architecture
- Desktop Agent

Configuration:
- Configuration Overview
- Configuring AI Tools

IDE & Desktop Tool Setup:
- Cursor IDE
- VS Code Extension
- GitHub Copilot
- Continue.dev
- JetBrains AI

CLI Tools:
- Claude CLI
- aider

SDKs & Libraries:
- OpenAI SDK
- Anthropic SDK
- LangChain
- LiteLLM

Reference:
- Detection Patterns
- API Reference
- Pricing Tiers (feature comparison)
- Security Model (two-lane architecture, encryption)
- Download Portal

Administration:
- Admin Guide (user management, RBAC, PATs, monitoring)
- SSO Setup (Keycloak OIDC, Okta, Azure AD, Google)
- Compliance Reporting (audit logs, SBOM, SOC 2 readiness, HIPAA, GDPR)

Support:
- Upgrade Guide (version compatibility, upgrade steps)
- Troubleshooting

===============================================================================
FREQUENTLY ASKED QUESTIONS
===============================================================================

Q: Does ZeroShare Gateway slow down AI responses?
A: Minimal impact. Average latency overhead is <5ms. The gateway uses streaming
   pass-through so users see AI responses in real-time.

Q: What happens when sensitive data is detected?
A: Configurable actions include: block request, redact sensitive data, alert
   security team, log for audit, or allow with warning. Secrets are always
   hard-blocked by default.

Q: How does the Desktop Agent work?
A: The Desktop Agent is a Go-based local proxy that runs on Windows, macOS,
   and Linux. It scans and protects AI tool traffic via system proxy, inspecting
   for PII and secrets. It supports auto-update for seamless version management.

Q: What AI tools are supported?
A: ZeroShare works with Cursor, GitHub Copilot, Claude CLI, Continue.dev,
   JetBrains AI, aider, OpenAI SDK, Anthropic SDK, LangChain, and LiteLLM.
   Tools that support custom base URLs connect directly; others use the
   Desktop Agent as a local proxy.

Q: Does ZeroShare store or read the data it inspects?
A: No. ZeroShare is a pass-through proxy. Data is inspected in memory only and
   never stored. Only metadata (blocked/allowed, detection type) is logged.

Q: What SSO providers are supported?
A: ZeroShare uses Keycloak for OIDC-based SSO. This supports Okta, Azure AD,
   Google Workspace, and other OIDC/SAML-compatible identity providers.

===============================================================================
CONTACT & SUPPORT
===============================================================================

Website: https://deployzeroshare.com
Documentation: https://deployzeroshare.com/docs
Sales Contact: https://deployzeroshare.com/contact-us
Support Portal: https://deployzeroshare.com/support

Social:
- LinkedIn: /company/zeroshare
- Twitter: @deployzeroshare

AWS Marketplace:
- Search "ZeroShare Gateway" on AWS Marketplace

===============================================================================
END OF DOCUMENT
===============================================================================