zeph_tools/
lib.rs

1// SPDX-FileCopyrightText: 2026 Andrei G <bug-ops>
2// SPDX-License-Identifier: MIT OR Apache-2.0
3
4//! Tool execution abstraction, shell backend, web scraping, and audit logging for Zeph.
5//!
6//! This crate provides the [`ToolExecutor`] trait and its concrete implementations:
7//!
8//! - [`ShellExecutor`] — executes bash blocks from LLM responses with sandboxing, blocklists,
9//!   output filtering, transactional rollback, and audit logging.
10//! - [`WebScrapeExecutor`] — fetches and scrapes web pages via CSS selectors, with SSRF
11//!   protection and domain policies.
12//! - [`CompositeExecutor`] — chains two executors with first-match-wins dispatch.
13//! - [`FileExecutor`] — reads and writes local files within a sandbox.
14//! - [`DiagnosticsExecutor`] — exposes agent self-diagnostics as a tool.
15//!
16//! # Architecture
17//!
18//! The primary abstraction is [`ToolExecutor`], an async trait implemented by every backend.
19//! When dynamic dispatch is needed (e.g., storing heterogeneous executors in a `Vec`), use
20//! [`ErasedToolExecutor`] or wrap with [`DynExecutor`].
21//!
22//! Tool calls originate from two paths:
23//!
24//! 1. **Fenced code blocks** — legacy LLM responses containing ` ```bash ` or ` ```scrape `
25//!    blocks dispatched via [`ToolExecutor::execute`].
26//! 2. **Structured tool calls** — modern JSON tool calls dispatched via
27//!    [`ToolExecutor::execute_tool_call`].
28//!
29//! # Security
30//!
31//! Every executor enforces security controls before execution:
32//!
33//! - [`ShellExecutor`] checks the command against a blocklist, validates paths against an
34//!   allowlist sandbox, and optionally requires user confirmation for destructive patterns.
35//! - [`WebScrapeExecutor`] validates the URL scheme (HTTPS only), resolves DNS, and rejects
36//!   private-network addresses (SSRF protection).
37//! - [`AuditLogger`] writes a structured JSONL entry for every tool invocation.
38//!
39//! # Example
40//!
41//! ```rust,no_run
42//! use zeph_tools::{ShellExecutor, ToolExecutor, config::ShellConfig};
43//!
44//! # async fn example() {
45//! let config = ShellConfig::default();
46//! let executor = ShellExecutor::new(&config);
47//!
48//! // Execute a fenced bash block from an LLM response.
49//! let response = "```bash\necho hello\n```";
50//! if let Ok(Some(output)) = executor.execute(response).await {
51//!     println!("{}", output.summary);
52//! }
53//! # }
54//! ```
55pub mod adversarial_gate;
56pub mod adversarial_policy;
57pub mod anomaly;
58pub mod audit;
59pub mod cache;
60pub mod composite;
61pub mod config;
62pub mod cwd;
63pub mod diagnostics;
64pub mod domain_match;
65pub mod error_taxonomy;
66pub mod executor;
67pub mod file;
68pub mod filter;
69pub mod net;
70pub mod patterns;
71pub mod permissions;
72pub mod policy;
73pub mod policy_gate;
74pub mod registry;
75pub mod sandbox;
76pub mod schema_filter;
77pub mod scrape;
78pub mod search_code;
79pub mod shell;
80pub mod tool_filter;
81pub mod trust_gate;
82pub mod trust_level;
83pub mod utility;
84pub mod verifier;
85pub use adversarial_gate::AdversarialPolicyGateExecutor;
86pub use adversarial_policy::{
87    PolicyDecision as AdversarialPolicyDecision, PolicyLlmClient, PolicyMessage, PolicyRole,
88    PolicyValidator, parse_policy_lines,
89};
90pub use anomaly::{AnomalyDetector, AnomalySeverity, is_reasoning_model};
91pub use audit::{
92    AuditEntry, AuditLogger, AuditResult, EgressEvent, VigilRiskLevel, chrono_now,
93    log_tool_risk_summary,
94};
95pub use cache::{CacheKey, ToolResultCache, is_cacheable};
96pub use composite::CompositeExecutor;
97pub use config::AdversarialPolicyConfig;
98pub use config::{
99    AnomalyConfig, AuditConfig, AuthorizationConfig, DependencyConfig, EgressConfig, FileConfig,
100    OverflowConfig, ResultCacheConfig, RetryConfig, SandboxConfig, ScrapeConfig, ShellConfig,
101    TafcConfig, ToolDependency, ToolsConfig, UtilityScoringConfig,
102};
103pub use cwd::SetCwdExecutor;
104pub use diagnostics::DiagnosticsExecutor;
105pub use error_taxonomy::{
106    ErrorDomain, ToolErrorCategory, ToolErrorFeedback, ToolInvocationPhase, classify_http_status,
107    classify_io_error,
108};
109pub use executor::{
110    ClaimSource, DiffData, DynExecutor, ErasedToolExecutor, ErrorKind, FilterStats,
111    MAX_TOOL_OUTPUT_CHARS, TOOL_EVENT_CHANNEL_CAP, ToolCall, ToolError, ToolEvent, ToolEventRx,
112    ToolEventTx, ToolExecutor, ToolOutput, truncate_tool_output, truncate_tool_output_at,
113};
114pub use file::FileExecutor;
115pub use filter::{
116    CommandMatcher, FilterConfidence, FilterConfig, FilterMetrics, FilterResult, OutputFilter,
117    OutputFilterRegistry, sanitize_output, strip_ansi,
118};
119pub use net::is_private_ip;
120pub use permissions::{
121    AutonomyLevel, PermissionAction, PermissionPolicy, PermissionRule, PermissionsConfig,
122};
123pub use policy::{
124    DefaultEffect, PolicyCompileError, PolicyConfig, PolicyContext, PolicyDecision, PolicyEffect,
125    PolicyEnforcer, PolicyRuleConfig,
126};
127pub use policy_gate::PolicyGateExecutor;
128pub use registry::ToolRegistry;
129#[cfg(target_os = "macos")]
130pub use sandbox::MacosSandbox;
131pub use sandbox::{
132    NoopSandbox, Sandbox, SandboxError, SandboxPolicy, SandboxProfile, build_sandbox,
133    build_sandbox_with_policy,
134};
135pub use schema_filter::{
136    DependencyExclusion, InclusionReason, ToolDependencyGraph, ToolEmbedding, ToolFilterResult,
137    ToolSchemaFilter,
138};
139pub use scrape::WebScrapeExecutor;
140pub use search_code::{
141    LspSearchBackend, SearchCodeExecutor, SearchCodeHit, SearchCodeSource, SemanticSearchBackend,
142};
143pub use shell::background::{BackgroundCompletion, RunId};
144pub use shell::{
145    DEFAULT_BLOCKED_COMMANDS, SHELL_INTERPRETERS, ShellExecutor, ShellOutputEnvelope,
146    ShellPolicyHandle, check_blocklist, effective_shell_command,
147};
148pub use tool_filter::ToolFilter;
149pub use trust_gate::TrustGateExecutor;
150pub use trust_level::SkillTrustLevel;
151pub use utility::{
152    UtilityAction, UtilityContext, UtilityScore, UtilityScorer, has_explicit_tool_request,
153};
154pub use verifier::{
155    DestructiveCommandVerifier, DestructiveVerifierConfig, FirewallVerifier,
156    FirewallVerifierConfig, InjectionPatternVerifier, InjectionVerifierConfig,
157    PreExecutionVerifier, PreExecutionVerifierConfig, UrlGroundingVerifier,
158    UrlGroundingVerifierConfig, VerificationResult,
159};
160pub use zeph_common::ToolName;
zeph_tools/lib.rs

zeph_tools/
lib.rs
