Expand description
KindlyGuard Server Library
Exposes the scanner functionality for use by the CLI and other tools
Re-exports§
pub use auth::AuthContext;pub use auth::AuthManager;pub use component_selector::ComponentManager;pub use component_selector::ComponentSelector;pub use config::Config;pub use config::ScannerConfig;pub use error::KindlyError;pub use error::KindlyResult;pub use error::ResultExt;pub use metrics::MetricsRegistry;pub use neutralizer::create_neutralizer;pub use neutralizer::create_neutralizer_with_telemetry;pub use neutralizer::NeutralizationConfig;pub use neutralizer::NeutralizationMode;pub use neutralizer::NeutralizeResult;pub use neutralizer::ThreatNeutralizer;pub use scanner::Location;pub use scanner::SecurityScanner;pub use scanner::Severity;pub use scanner::Threat;pub use scanner::ThreatType;pub use server::McpServer;pub use shield::Shield;pub use traits::CorrelationEngine;pub use traits::EnhancedScanner;pub use traits::RateLimiter;pub use traits::SecurityEventProcessor;
Modules§
- audit
- Audit logging system for compliance and security monitoring
- auth
- Authentication and authorization for MCP server Implements OAuth 2.0 with Resource Indicators (RFC 8707)
- cli
- CLI command interface for
KindlyGuard - component_
selector - Component selector for choosing between standard and enhanced implementations This provides the abstraction layer that hides the implementation details
- config
- Configuration for
KindlyGuard - daemon
- Daemon mode support with signal handling Provides proper daemon functionality including signal handling, PID file management, and graceful shutdown
- error
- Error handling and recovery mechanisms for production resilience
- logging
- Enhanced logging with semantic fields for stealth operation This module provides structured logging that hides implementation details
- metrics
- Metrics collection and export for monitoring Provides trait-based abstraction for different implementations
- neutralizer
- Threat neutralization system
- permissions
- Tool-level permission system with trait-based architecture Enables fine-grained control over tool access
- plugins
- Plugin system for extensible security scanning
- protocol
- MCP Protocol implementation with Claude Code extensions
- rate_
limit - Rate limiting for MCP server requests Implements token bucket algorithm with per-client and per-operation limits
- resilience
- Resilience patterns for production reliability
- scanner
- Security scanner module for threat detection
- security
- Security modules for
KindlyGuard - server
- MCP Server implementation with full protocol compliance
- setup
- Setup utilities for KindlyGuard MCP server
- shield
- Shield display module for security status visualization
- signing
- Message signing and verification for secure MCP communication Implements HMAC-SHA256 for message integrity and Ed25519 for authenticity
- standard_
impl - Standard implementations of security component traits These provide baseline functionality without enhanced optimizations
- storage
- Storage abstraction layer for persistence
- telemetry
- Telemetry module for
KindlyGuardProvides observability through OpenTelemetry with trait-based architecture - traits
- Core trait abstractions for security components Enables clean separation between standard and enhanced implementations
- transport
- Transport layer abstraction for multiple communication protocols
- versioning
- API versioning for
KindlyGuardProvides version management and stability guarantees - web
- Web dashboard module for
KindlyGuard
Macros§
- log_
performance - Log performance metrics without revealing internals
- log_
request_ complete - Log request completion with metrics
- log_
security_ event - Log security events with semantic fields
- request_
span - Create a request span with tracking information
Functions§
- create_
audit_ logger - Create an audit logger based on configuration
- create_
rate_ limiter - Create a rate limiter based on configuration
- create_
scanner - Create a security scanner instance based on configuration
- create_
storage - Create a storage provider based on configuration
- create_
telemetry - Create a telemetry provider based on configuration
- create_
transport - Create a transport based on configuration