shroud-privacy 2.2.7 → 2.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -256,6 +256,16 @@ Shroud distinguishes between internal and external URLs:
256
256
  | `https://secret.local/admin` | NXDOMAIN | Obfuscate |
257
257
  | `https://github.com/org/repo` | (PUBLIC_DOMAINS list) | Pass through |
258
258
 
259
+ ### LLM agent guidance
260
+
261
+ Because Shroud replaces URLs before they reach the LLM, the LLM may see unfamiliar or fake-looking domains in the conversation context. Tool calls (fetch, read, etc.) are deobfuscated automatically before execution, so they work correctly even when the LLM sees a fake URL.
262
+
263
+ **If you are building an agent that uses Shroud, add the following to your agent's system prompt or instruction files:**
264
+
265
+ > Shroud privacy is active. URLs and domains in the conversation may appear different from what the user sent — internal URLs are replaced with fake domains to protect infrastructure. If a URL looks unfamiliar or doesn't resolve, it has likely been obfuscated. The tool call pipeline deobfuscates automatically. Do NOT tell the user a URL is invalid just because you see an unfamiliar domain. If a fetch or read tool succeeded with the URL, trust the result.
266
+
267
+ This prevents the LLM from questioning obfuscated URLs or telling the user their link is broken.
268
+
259
269
  ---
260
270
 
261
271
  ## Redaction levels
@@ -113,6 +113,38 @@ export function isDocExample(value, category) {
113
113
  case Category.BGP_ASN:
114
114
  // Private ASNs are real infra identifiers — don't skip them
115
115
  return false;
116
+ case Category.FILE_PATH: {
117
+ // Skip paths that are clearly URL path components from public domains.
118
+ // e.g., /www.npmjs.com/package/shroud-privacy, /github.com/org/repo
119
+ // This is a safety net — the span fix in detect() should prevent these,
120
+ // but production environments may have edge cases we can't reproduce.
121
+ if (value.startsWith("/")) {
122
+ const pathLower = value.toLowerCase();
123
+ for (const d of PUBLIC_DOMAINS) {
124
+ if (pathLower.startsWith(`/${d}/`) || pathLower.startsWith(`/${d}`)
125
+ || pathLower.startsWith(`/www.${d}/`) || pathLower.startsWith(`/www.${d}`)) {
126
+ return true;
127
+ }
128
+ }
129
+ for (const d of DOC_DOMAINS) {
130
+ if (pathLower.startsWith(`/${d}/`) || pathLower.startsWith(`/${d}`)
131
+ || pathLower.startsWith(`/www.${d}/`) || pathLower.startsWith(`/www.${d}`)) {
132
+ return true;
133
+ }
134
+ }
135
+ // DNS cache check — if the first path segment is a public domain
136
+ const dnsCache = globalThis.__shroudDnsCache;
137
+ if (dnsCache) {
138
+ const firstSeg = value.slice(1).split("/")[0];
139
+ if (firstSeg && firstSeg.includes(".")) {
140
+ const isPublic = dnsCache.isPublic("https://" + firstSeg + "/");
141
+ if (isPublic === true)
142
+ return true;
143
+ }
144
+ }
145
+ }
146
+ return false;
147
+ }
116
148
  case Category.HOSTNAME:
117
149
  if (DOC_HOSTNAMES.has(value) || DOC_HOSTNAMES.has(value.toUpperCase()))
118
150
  return true;
package/dist/hooks.js CHANGED
@@ -194,7 +194,32 @@ export function registerHooks(api, obfuscator) {
194
194
  }
195
195
  // DNS cache for public URL detection — shared across plugin instances
196
196
  if (!g.__shroudDnsCache) {
197
- g.__shroudDnsCache = new DnsCache();
197
+ const cache = new DnsCache();
198
+ g.__shroudDnsCache = cache;
199
+ // Pre-warm with well-known public domains so first-turn URLs pass through
200
+ // without waiting for async DNS resolution. These domains are guaranteed
201
+ // public — no lookup needed.
202
+ const publicDomains = [
203
+ "youtube.com", "youtu.be", "m.youtube.com",
204
+ "google.com", "google.co.uk", "google.de", "google.fr",
205
+ "github.com", "gitlab.com", "bitbucket.org",
206
+ "stackoverflow.com", "stackexchange.com",
207
+ "wikipedia.org", "wikimedia.org",
208
+ "twitter.com", "x.com",
209
+ "reddit.com",
210
+ "linkedin.com",
211
+ "medium.com",
212
+ "npmjs.com", "www.npmjs.com", "pypi.org", "crates.io",
213
+ "docker.com", "hub.docker.com",
214
+ "microsoft.com", "apple.com",
215
+ "mozilla.org",
216
+ "w3.org",
217
+ "archive.org",
218
+ ];
219
+ for (const d of publicDomains) {
220
+ cache.seed(d, "0.0.0.1", true); // address doesn't matter, isPublic=true
221
+ cache.seed("www." + d, "0.0.0.1", true);
222
+ }
198
223
  }
199
224
  }
200
225
  // All hook closures must use the shared obfuscator, not the local parameter.
@@ -215,12 +240,24 @@ export function registerHooks(api, obfuscator) {
215
240
  // Extract all URLs from the prompt and messages, resolve their FQDNs
216
241
  // to determine public vs private. This runs BEFORE obfuscation so
217
242
  // the sync pipeline's isDocExample() can check the cache.
243
+ //
244
+ // Slack wraps URLs as <https://url|display> or <https://url>.
245
+ // We must strip this markup BEFORE extracting URLs, otherwise the
246
+ // regex won't match and the DNS cache won't warm for Slack messages.
218
247
  const dnsCache = globalThis.__shroudDnsCache;
219
248
  if (dnsCache) {
220
249
  const urlRe = /https?:\/\/[^\s<>"')\]]+[^\s<>"')\].,;:!?]/g;
221
250
  const allUrls = [];
251
+ // Strip Slack link markup so URL regex can match cleanly
252
+ function stripSlackForDns(text) {
253
+ text = text.replace(/<mailto:[^|>]+\|([^>]*)>/g, "$1");
254
+ text = text.replace(/<(https?:\/\/[^|>]+)\|[^>]*>/g, "$1");
255
+ text = text.replace(/<(https?:\/\/[^>]+)>/g, "$1");
256
+ return text;
257
+ }
222
258
  if (typeof event?.prompt === "string") {
223
- for (const m of event.prompt.matchAll(urlRe))
259
+ const cleaned = stripSlackForDns(event.prompt);
260
+ for (const m of cleaned.matchAll(urlRe))
224
261
  allUrls.push(m[0]);
225
262
  }
226
263
  if (Array.isArray(event?.messages)) {
@@ -235,7 +272,8 @@ export function registerHooks(api, obfuscator) {
235
272
  }
236
273
  }
237
274
  for (const text of texts) {
238
- for (const m of text.matchAll(urlRe))
275
+ const cleaned = stripSlackForDns(text);
276
+ for (const m of cleaned.matchAll(urlRe))
239
277
  allUrls.push(m[0]);
240
278
  }
241
279
  }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "id": "shroud-privacy",
3
3
  "name": "Shroud",
4
- "version": "2.2.7",
4
+ "version": "2.2.8",
5
5
  "description": "Privacy obfuscation with deterministic fake values and deobfuscation — PII never reaches the LLM, tool calls still work",
6
6
  "configSchema": {
7
7
  "type": "object",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shroud-privacy",
3
- "version": "2.2.7",
3
+ "version": "2.2.8",
4
4
  "description": "Privacy and infrastructure protection for AI agents — detects sensitive data (PII, network topology, credentials, OT/SCADA) and replaces with deterministic fakes before anything reaches the LLM.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",