mirror of
https://github.com/binaricat/Netcatty.git
synced 2026-11-21 07:32:54 +00:00
* feat: add web search and URL fetch tools for AI agent Add web_search and url_fetch tools to Catty Agent, allowing the AI to search the internet for current information and fetch webpage content. - Support 5 search providers: Tavily, Exa, Bocha, Zhipu, SearXNG - Settings UI with provider selection, API key encryption, and config - web_search is conditional on config; url_fetch is always available - Both tools are read-only and work in all permission modes (incl. observer) - aiFetch skipHostCheck for AI tool requests to arbitrary URLs - System prompt guidelines for when to use search/fetch - i18n support (en + zh-CN) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address code review findings (SSRF, key exposure, state race) - P1: Restore SSRF protection when skipHostCheck is true — still block localhost, RFC1918, link-local, and cloud metadata endpoints; only skip the domain allowlist for public HTTPS hosts - P2: Move web search API key decryption to main process via dedicated IPC handler, matching the existing provider key security model - P2: Use configRef to avoid stale closure in async settings callbacks that could overwrite newer user changes Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address second review — DNS rebinding, url_fetch approval, maxResults - P1: url_fetch now requires approval in confirm mode (outbound GET is a side effect that could exfiltrate data via query strings) - P1: Add DNS resolution check when skipHostCheck is set — resolve hostname and reject if any IP is private/loopback/link-local, blocking DNS rebinding attacks against internal services - P2: Slice search results after provider call to enforce maxResults consistently (Zhipu and SearXNG ignore the limit parameter) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address third review — localhost/IPv6 SSRF, API key blur race - P1: Block localhost/loopback when skipHostCheck is enabled — restructure isAllowedFetchUrl to check private hosts first in the skipHostCheck path, preventing access to local services on allowlisted ports - P1: Handle IPv6 private ranges (fc00::/7, fe80::/10, ::ffff: mapped), strip brackets from URL.hostname, block [::1] and fd00:: addresses - P2: Guard handleApiKeyBlur against provider change during async encryption — skip stale write if provider switched while encrypting Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address fourth review — main-process key isolation, SearXNG compat - P1: Replace aiWebSearchDecryptKey IPC with __WEB_SEARCH_KEY__ placeholder pattern — renderer never sees plaintext keys; main process replaces placeholder in headers before HTTP request, matching provider key flow - P1: Search API requests use normal allowlist path (not skipHostCheck), so SearXNG on localhost/HTTP/private networks works via aiSyncWebSearch; only url_fetch uses skipHostCheck for arbitrary public HTTPS URLs - P2: Remove needsApproval from url_fetch — treat as read-only like sftp_read_file, consistent with observer mode allowlist Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address fifth review — private LAN providers, maxResults default - P1: Allow private-IP hosts that are explicitly in the provider/search allowlist (e.g. https://192.168.x.x model providers or SearXNG) - P2: Remove .default(5) from web_search maxResults schema so the user's configured maxResults setting is used when the model omits the param Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address sixth review — HTTPS scope, config gate, redirects - P2: Scope HTTP exception to private/LAN IPs only — remote allowlisted hosts still require HTTPS to protect API keys in transit - P2: Gate web_search tool on complete config (API key for providers that require it, apiHost for SearXNG) to avoid advertising a broken tool - P2: Add redirect following (up to 5 hops) to aiFetch for url_fetch — handles 301/302/307 for short links, www canonicalization, etc. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address seventh review — redirect SSRF, decrypt race, HTTPS-only - P1: Revalidate each redirect hop against SSRF guards (allowlist check + DNS resolution) before following, preventing open-redirect SSRF - P2: Add sequence counter to API key decryption effect — stale promise results from a previous provider are discarded on provider switch - P3: Restrict url_fetch to HTTPS-only URLs, matching the skipHostCheck policy that already rejects HTTP in the bridge Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address eighth review — OS resolver, allowlisted HTTP hosts - P1: Use dns.lookup (OS resolver) instead of dns.resolve4/6 for private IP checks — matches what http.request actually connects to, respects /etc/hosts, mDNS, and other local resolver sources - P2: Allow HTTP for any explicitly allowlisted host (not just literal private IPs), so self-hosted SearXNG at http://searxng.lan works Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address ninth review — HTTP scope, blur ordering, decrypt flag - P1: Narrow HTTP exception to web search apiHost only — AI provider endpoints remain HTTPS-only to protect credentials in transit - P2: Add blur sequence counter to prevent out-of-order encryption results from overwriting newer API key saves - P2: Reset isDecrypting flag when cancelling decrypt on provider switch, preventing permanently disabled API key input Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address tenth review — DNS pinning, prompt/tool alignment - P1: Pin validated DNS result to the HTTP request via custom lookup function, preventing TOCTOU/DNS-rebinding between validation and actual connection - P2: Extract isWebSearchReady() helper and use it consistently in both tool registration and system prompt, so the model isn't told web search is available when config is incomplete Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address eleventh review — single DNS lookup, redirect pinning, CGNAT - P1: Combine DNS validation and pinning into a single lookup call, eliminating the TOCTOU window between hasPrivateResolution and pinnedLookup - P1: Pin DNS for redirect targets too — resolve/validate/pin in one step before following each redirect hop - P2: Add 100.64.0.0/10 (CGNAT) to private IP ranges for Tailscale and similar CGNAT-addressed internal services Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: address twelfth review — apiHost validation, sync on enable - P2: Validate apiHost is a well-formed URL in isWebSearchReady(), preventing tool exposure when user enters a malformed host - P2: Add webSearchConfig.enabled to sync effect deps so the main process gets updated immediately when the toggle changes Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: remove DNS-level SSRF checks that break fakedns/proxy environments DNS resolution validation (dns.lookup + IP pinning) breaks in proxy environments where fakedns resolves all domains to LAN addresses. Revert to hostname-level checks only (blocking localhost, 127.0.0.1, metadata endpoints, etc.) which are sufficient without false positives. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: resolve empty catch block lint warning Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
221 lines
8.3 KiB
TypeScript
221 lines
8.3 KiB
TypeScript
import React, { useCallback, useEffect, useMemo, useRef, useState } from "react";
|
|
import { Globe, Eye, EyeOff } from "lucide-react";
|
|
import type { WebSearchConfig, WebSearchProviderId } from "../../../../infrastructure/ai/types";
|
|
import { WEB_SEARCH_PROVIDER_PRESETS } from "../../../../infrastructure/ai/types";
|
|
import { encryptField, decryptField } from "../../../../infrastructure/persistence/secureFieldAdapter";
|
|
import { useI18n } from "../../../../application/i18n/I18nProvider";
|
|
import { Select, SettingRow } from "../../settings-ui";
|
|
|
|
const SEARCH_ICON_PATHS: Record<WebSearchProviderId, string> = {
|
|
tavily: "/ai/search/tavily.svg",
|
|
exa: "/ai/search/exa.png",
|
|
bocha: "/ai/search/bocha.webp",
|
|
zhipu: "/ai/search/zhipu.png",
|
|
searxng: "/ai/search/searxng.svg",
|
|
};
|
|
|
|
const SearchProviderIcon: React.FC<{ providerId: WebSearchProviderId }> = ({ providerId }) => (
|
|
<img
|
|
src={SEARCH_ICON_PATHS[providerId]}
|
|
alt=""
|
|
className="w-4 h-4 shrink-0"
|
|
/>
|
|
);
|
|
|
|
const PROVIDER_OPTIONS: Array<{ value: WebSearchProviderId; label: string; icon: React.ReactNode }> = Object.entries(
|
|
WEB_SEARCH_PROVIDER_PRESETS,
|
|
).map(([id, preset]) => ({
|
|
value: id as WebSearchProviderId,
|
|
label: preset.name,
|
|
icon: <SearchProviderIcon providerId={id as WebSearchProviderId} />,
|
|
}));
|
|
|
|
export const WebSearchSettings: React.FC<{
|
|
webSearchConfig: WebSearchConfig | null;
|
|
setWebSearchConfig: (config: WebSearchConfig | null) => void;
|
|
}> = ({ webSearchConfig, setWebSearchConfig }) => {
|
|
const { t } = useI18n();
|
|
const [apiKeyInput, setApiKeyInput] = useState("");
|
|
const [showApiKey, setShowApiKey] = useState(false);
|
|
const [isDecrypting, setIsDecrypting] = useState(false);
|
|
|
|
const config = useMemo(() => webSearchConfig ?? {
|
|
providerId: "tavily" as WebSearchProviderId,
|
|
enabled: false,
|
|
maxResults: 5,
|
|
}, [webSearchConfig]);
|
|
|
|
// Ref to always read the latest config in async callbacks (avoids stale closure)
|
|
const configRef = useRef(config);
|
|
configRef.current = config;
|
|
|
|
const preset = WEB_SEARCH_PROVIDER_PRESETS[config.providerId];
|
|
|
|
// Decrypt API key on mount or when provider changes (with cancellation guard)
|
|
const decryptSeqRef = useRef(0);
|
|
useEffect(() => {
|
|
if (config.apiKey) {
|
|
const seq = ++decryptSeqRef.current;
|
|
setIsDecrypting(true);
|
|
decryptField(config.apiKey)
|
|
.then((decrypted) => {
|
|
if (decryptSeqRef.current === seq) setApiKeyInput(decrypted ?? "");
|
|
})
|
|
.catch(() => {
|
|
if (decryptSeqRef.current === seq) setApiKeyInput(config.apiKey ?? "");
|
|
})
|
|
.finally(() => {
|
|
if (decryptSeqRef.current === seq) setIsDecrypting(false);
|
|
});
|
|
} else {
|
|
decryptSeqRef.current++;
|
|
setApiKeyInput("");
|
|
setIsDecrypting(false);
|
|
}
|
|
}, [config.apiKey, config.providerId]);
|
|
|
|
const updateConfig = useCallback(
|
|
(updates: Partial<WebSearchConfig>) => {
|
|
setWebSearchConfig({ ...configRef.current, ...updates });
|
|
},
|
|
[setWebSearchConfig],
|
|
);
|
|
|
|
const handleProviderChange = useCallback(
|
|
(val: string) => {
|
|
const providerId = val as WebSearchProviderId;
|
|
const newPreset = WEB_SEARCH_PROVIDER_PRESETS[providerId];
|
|
setWebSearchConfig({
|
|
...configRef.current,
|
|
providerId,
|
|
apiKey: undefined,
|
|
apiHost: newPreset.defaultApiHost || undefined,
|
|
});
|
|
setApiKeyInput("");
|
|
},
|
|
[setWebSearchConfig],
|
|
);
|
|
|
|
// Sequence counter for blur saves — prevents out-of-order encryption results
|
|
const blurSeqRef = useRef(0);
|
|
const handleApiKeyBlur = useCallback(async () => {
|
|
if (!apiKeyInput.trim()) {
|
|
blurSeqRef.current++;
|
|
updateConfig({ apiKey: undefined });
|
|
return;
|
|
}
|
|
const seq = ++blurSeqRef.current;
|
|
const providerAtBlur = configRef.current.providerId;
|
|
const encrypted = await encryptField(apiKeyInput.trim());
|
|
// Only apply if this is still the latest blur and provider hasn't changed
|
|
if (blurSeqRef.current === seq && configRef.current.providerId === providerAtBlur) {
|
|
updateConfig({ apiKey: encrypted });
|
|
}
|
|
}, [apiKeyInput, updateConfig]);
|
|
|
|
return (
|
|
<div className="space-y-4">
|
|
<div className="flex items-center gap-2">
|
|
<Globe size={18} className="text-muted-foreground" />
|
|
<h3 className="text-base font-medium">{t("ai.webSearch.title")}</h3>
|
|
</div>
|
|
|
|
<div className="bg-muted/30 rounded-lg p-4 space-y-1">
|
|
{/* Enable/Disable */}
|
|
<SettingRow
|
|
label={t("ai.webSearch.enable")}
|
|
description={t("ai.webSearch.enable.description")}
|
|
>
|
|
<label className="relative inline-flex items-center cursor-pointer">
|
|
<input
|
|
type="checkbox"
|
|
checked={config.enabled}
|
|
onChange={(e) => updateConfig({ enabled: e.target.checked })}
|
|
className="sr-only peer"
|
|
/>
|
|
<div className="w-9 h-5 bg-muted-foreground/20 peer-focus-visible:ring-2 peer-focus-visible:ring-ring rounded-full peer peer-checked:after:translate-x-full peer-checked:after:border-white after:content-[''] after:absolute after:top-[2px] after:left-[2px] after:bg-white after:border after:border-gray-300 after:rounded-full after:h-4 after:w-4 after:transition-all peer-checked:bg-primary" />
|
|
</label>
|
|
</SettingRow>
|
|
|
|
{/* Provider */}
|
|
<SettingRow
|
|
label={t("ai.webSearch.provider")}
|
|
description={t("ai.webSearch.provider.description")}
|
|
>
|
|
<Select
|
|
value={config.providerId}
|
|
options={PROVIDER_OPTIONS}
|
|
onChange={handleProviderChange}
|
|
className="w-48"
|
|
/>
|
|
</SettingRow>
|
|
|
|
{/* API Key (hidden for SearXNG) */}
|
|
{preset.requiresApiKey && (
|
|
<SettingRow
|
|
label={t("ai.webSearch.apiKey")}
|
|
description={t("ai.webSearch.apiKey.description")}
|
|
>
|
|
<div className="flex items-center gap-1.5">
|
|
<input
|
|
type={showApiKey ? "text" : "password"}
|
|
value={isDecrypting ? "" : apiKeyInput}
|
|
placeholder={isDecrypting ? t("ai.providers.apiKey.decrypting") : t("ai.webSearch.apiKey.placeholder")}
|
|
onChange={(e) => setApiKeyInput(e.target.value)}
|
|
onBlur={() => void handleApiKeyBlur()}
|
|
className="w-64 h-9 rounded-md border border-input bg-background px-3 text-sm focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring"
|
|
disabled={isDecrypting}
|
|
/>
|
|
<button
|
|
type="button"
|
|
onClick={() => setShowApiKey(!showApiKey)}
|
|
className="p-1.5 rounded hover:bg-muted text-muted-foreground"
|
|
>
|
|
{showApiKey ? <EyeOff size={14} /> : <Eye size={14} />}
|
|
</button>
|
|
</div>
|
|
</SettingRow>
|
|
)}
|
|
|
|
{/* API Host */}
|
|
<SettingRow
|
|
label={t("ai.webSearch.apiHost")}
|
|
description={
|
|
config.providerId === "searxng"
|
|
? t("ai.webSearch.apiHost.searxngDescription")
|
|
: t("ai.webSearch.apiHost.description")
|
|
}
|
|
>
|
|
<input
|
|
type="text"
|
|
value={config.apiHost ?? preset.defaultApiHost}
|
|
onChange={(e) => updateConfig({ apiHost: e.target.value || undefined })}
|
|
placeholder={preset.defaultApiHost || "https://..."}
|
|
className="w-64 h-9 rounded-md border border-input bg-background px-3 text-sm focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring"
|
|
/>
|
|
</SettingRow>
|
|
|
|
{/* Max Results */}
|
|
<SettingRow
|
|
label={t("ai.webSearch.maxResults")}
|
|
description={t("ai.webSearch.maxResults.description")}
|
|
>
|
|
<input
|
|
type="number"
|
|
value={config.maxResults ?? 5}
|
|
onChange={(e) => {
|
|
const val = parseInt(e.target.value, 10);
|
|
if (!isNaN(val) && val >= 1 && val <= 20) {
|
|
updateConfig({ maxResults: val });
|
|
}
|
|
}}
|
|
min={1}
|
|
max={20}
|
|
className="w-20 h-9 rounded-md border border-input bg-background px-3 text-sm text-right focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring"
|
|
/>
|
|
</SettingRow>
|
|
</div>
|
|
</div>
|
|
);
|
|
};
|