@crewhaus/tool-web 0.7.0 → 0.8.0
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/LICENSE +201 -0
- package/NOTICE +9 -0
- package/README.md +11 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +72 -61
- package/package.json +12 -6
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
CrewHaus Factory
|
|
2
|
+
Copyright 2026 Max Meier
|
|
3
|
+
|
|
4
|
+
This product includes software developed by Max Meier
|
|
5
|
+
(operating as StudioMax — https://studiomax.io) and contributors.
|
|
6
|
+
|
|
7
|
+
The CrewHaus name and logo are trademarks of Max Meier. See
|
|
8
|
+
https://github.com/crewhaus/factory/blob/main/TRADEMARK.md for the
|
|
9
|
+
use-of-marks policy.
|
package/README.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# @crewhaus/tool-web
|
|
2
|
+
|
|
3
|
+
WebFetch (URL → markdown via cheerio + turndown) and WebSearch (provider dispatch)
|
|
4
|
+
|
|
5
|
+
Part of [CrewHaus](https://github.com/crewhaus/factory). Most people install the CLI (`npm install -g crewhaus`) rather than this package.
|
|
6
|
+
|
|
7
|
+
Which tools a spec can turn on, and how: [tools reference](https://github.com/crewhaus/docs/blob/main/TOOLS-REFERENCE.md).
|
|
8
|
+
|
|
9
|
+
Requires [Bun](https://bun.sh) `>=1.3.14`; plain Node is not supported.
|
|
10
|
+
|
|
11
|
+
[Source](https://github.com/crewhaus/factory/tree/main/packages/tool-web)
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import { CrewhausError } from "@crewhaus/errors";
|
|
2
2
|
import type { RegisteredTool } from "@crewhaus/tool-catalog";
|
|
3
|
+
/** Test-only — shorten the per-call deadline; `undefined` restores 30 s. */
|
|
4
|
+
export declare function _setTimeoutMsForTest(ms: number | undefined): void;
|
|
3
5
|
export declare class WebFetchPermissionError extends CrewhausError {
|
|
4
6
|
readonly name = "WebFetchPermissionError";
|
|
5
7
|
constructor(message: string);
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { lookup as dnsLookup } from "node:dns/promises";
|
|
2
2
|
import { CrewhausError } from "@crewhaus/errors";
|
|
3
3
|
import { buildTool } from "@crewhaus/tool-builder";
|
|
4
|
+
import { preferIdentity, readBodyBounded, withRawBody } from "@crewhaus/tool-fetch/body";
|
|
4
5
|
import { load as loadHtml } from "cheerio";
|
|
5
6
|
import TurndownService from "turndown";
|
|
6
7
|
import { z } from "zod";
|
|
@@ -14,9 +15,15 @@ import { z } from "zod";
|
|
|
14
15
|
* - SSRF guard (independent of the allow-list, re-checked on every
|
|
15
16
|
* redirect hop): rejects loopback, link-local / 169.254.0.0/16,
|
|
16
17
|
* RFC1918, CGNAT, *.local / *.localhost, and DNS-rebinding targets.
|
|
17
|
-
* - Manual redirect handling, max 5; allow-list re-checked at every hop
|
|
18
|
-
*
|
|
19
|
-
* -
|
|
18
|
+
* - Manual redirect handling, max 5; allow-list re-checked at every hop,
|
|
19
|
+
* BEFORE any DNS resolution, so a host outside it is never looked up.
|
|
20
|
+
* - 30 s default timeout (`AbortController`, honours `ctx.signal`),
|
|
21
|
+
* covering the body as well as the request.
|
|
22
|
+
* - 5 MB response body cap, on the DECODED body: the body is fetched raw
|
|
23
|
+
* and decoded under the cap by @crewhaus/tool-fetch/body (edge-safe;
|
|
24
|
+
* this package is bundled into workerd), so a compressed reply cannot
|
|
25
|
+
* inflate past it in the runtime first. WebSearch's provider replies
|
|
26
|
+
* are read the same way.
|
|
20
27
|
* - HTML pages run through cheerio + turndown to produce markdown that
|
|
21
28
|
* compresses well in the model's context. Plain text and JSON pass
|
|
22
29
|
* through. Other content types are summarised in one line.
|
|
@@ -41,6 +48,11 @@ import { z } from "zod";
|
|
|
41
48
|
* `webSearch: { ... }` (no init — uses env-only config).
|
|
42
49
|
*/
|
|
43
50
|
const DEFAULT_TIMEOUT_MS = 30_000;
|
|
51
|
+
let timeoutMs = DEFAULT_TIMEOUT_MS;
|
|
52
|
+
/** Test-only — shorten the per-call deadline; `undefined` restores 30 s. */
|
|
53
|
+
export function _setTimeoutMsForTest(ms) {
|
|
54
|
+
timeoutMs = ms ?? DEFAULT_TIMEOUT_MS;
|
|
55
|
+
}
|
|
44
56
|
const MAX_REDIRECTS = 5;
|
|
45
57
|
const MAX_BODY_BYTES = 5 * 1024 * 1024;
|
|
46
58
|
export class WebFetchPermissionError extends CrewhausError {
|
|
@@ -345,7 +357,8 @@ function pinnedFetch(req, pinnedIp) {
|
|
|
345
357
|
const host = original.hostname;
|
|
346
358
|
const hostUnbracketed = host.replace(/^\[/, "").replace(/\]$/, "");
|
|
347
359
|
if (pinnedIp === "" || hostUnbracketed === pinnedIp) {
|
|
348
|
-
|
|
360
|
+
// Raw body on the FINAL call: Bun ignores `decompress` in a Request's init.
|
|
361
|
+
return globalThis.fetch(req, withRawBody({}));
|
|
349
362
|
}
|
|
350
363
|
const hostForUrl = pinnedIp.includes(":") ? `[${pinnedIp}]` : pinnedIp;
|
|
351
364
|
const pinnedUrl = new URL(original.toString());
|
|
@@ -363,7 +376,7 @@ function pinnedFetch(req, pinnedIp) {
|
|
|
363
376
|
init.body = req.body;
|
|
364
377
|
init.duplex = "half";
|
|
365
378
|
}
|
|
366
|
-
return globalThis.fetch(pinnedUrl.toString(), init);
|
|
379
|
+
return globalThis.fetch(pinnedUrl.toString(), withRawBody(init));
|
|
367
380
|
}
|
|
368
381
|
// Production default — one named fetcher shared by the initial binding and the
|
|
369
382
|
// `_setRawFetch(undefined)` reset path (see defaultDnsLookup for rationale).
|
|
@@ -372,64 +385,47 @@ let rawFetch = defaultRawFetch;
|
|
|
372
385
|
export function _setRawFetch(fn) {
|
|
373
386
|
rawFetch = fn ?? defaultRawFetch;
|
|
374
387
|
}
|
|
388
|
+
/** The body, decoded under {@link MAX_BODY_BYTES}; a refusal quotes nothing it held. */
|
|
375
389
|
async function readBodyCapped(res) {
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
if (done)
|
|
385
|
-
break;
|
|
386
|
-
total += value.byteLength;
|
|
387
|
-
if (total > MAX_BODY_BYTES) {
|
|
388
|
-
try {
|
|
389
|
-
await reader.cancel();
|
|
390
|
-
}
|
|
391
|
-
catch {
|
|
392
|
-
/* ignore */
|
|
393
|
-
}
|
|
394
|
-
throw new WebFetchPermissionError(`response body exceeded ${MAX_BODY_BYTES} bytes — aborted`);
|
|
395
|
-
}
|
|
396
|
-
chunks.push(value);
|
|
397
|
-
}
|
|
398
|
-
}
|
|
399
|
-
finally {
|
|
400
|
-
try {
|
|
401
|
-
reader.releaseLock();
|
|
402
|
-
}
|
|
403
|
-
catch {
|
|
404
|
-
/* ignore */
|
|
405
|
-
}
|
|
406
|
-
}
|
|
407
|
-
const merged = new Uint8Array(total);
|
|
408
|
-
let offset = 0;
|
|
409
|
-
for (const chunk of chunks) {
|
|
410
|
-
merged.set(chunk, offset);
|
|
411
|
-
offset += chunk.byteLength;
|
|
412
|
-
}
|
|
413
|
-
return new TextDecoder("utf-8", { fatal: false }).decode(merged);
|
|
390
|
+
const read = await readBodyBounded(res, MAX_BODY_BYTES);
|
|
391
|
+
if (!read.ok)
|
|
392
|
+
throw new WebFetchPermissionError(read.reason);
|
|
393
|
+
return new TextDecoder("utf-8", { fatal: false }).decode(read.bytes);
|
|
394
|
+
}
|
|
395
|
+
/** A provider's JSON reply, read under the same cap. */
|
|
396
|
+
async function readJsonCapped(res) {
|
|
397
|
+
return JSON.parse(await readBodyCapped(res));
|
|
414
398
|
}
|
|
399
|
+
/**
|
|
400
|
+
* Fetch `initialUrl`, following at most {@link MAX_REDIRECTS} redirects with
|
|
401
|
+
* every guard on every hop. Returns the final response and the URL it came
|
|
402
|
+
* from: the page the body is, which the result names first (`URL:`), so a
|
|
403
|
+
* citation of the page as it was served resolves (provability's
|
|
404
|
+
* `webFetchHeader` reads it, design §5.2).
|
|
405
|
+
*/
|
|
415
406
|
async function performWebFetch(initialUrl, signal, cfg) {
|
|
416
407
|
let currentUrl = initialUrl;
|
|
417
408
|
for (let hop = 0; hop <= MAX_REDIRECTS; hop++) {
|
|
418
409
|
if (currentUrl.protocol !== "http:" && currentUrl.protocol !== "https:") {
|
|
419
410
|
throw new WebFetchPermissionError(`WebFetch denied: scheme "${currentUrl.protocol}" — only http/https allowed`);
|
|
420
411
|
}
|
|
421
|
-
//
|
|
422
|
-
//
|
|
423
|
-
//
|
|
424
|
-
const pinnedIp = await assertNotSsrf(currentUrl.hostname);
|
|
412
|
+
// The allow-list comes first, on every hop: a DNS lookup is itself egress
|
|
413
|
+
// (a label like `<hex-of-a-secret>.attacker.test` reaches the attacker's
|
|
414
|
+
// name server), so a host the operator did not allow is never resolved.
|
|
425
415
|
if (!isHostAllowed(currentUrl.hostname, cfg)) {
|
|
426
416
|
throw new WebFetchPermissionError(`WebFetch denied: host "${currentUrl.hostname}" is not in allowed_domains`);
|
|
427
417
|
}
|
|
418
|
+
// SSRF guard — independent of the allow-list, enforced on every allowed
|
|
419
|
+
// hop. The returned IP pins the socket so a rebinding resolver can't swap
|
|
420
|
+
// in a private address between this check and connect.
|
|
421
|
+
const pinnedIp = await assertNotSsrf(currentUrl.hostname);
|
|
422
|
+
const headers = new Headers({ "user-agent": "crewhaus-tool-web/0.1" });
|
|
423
|
+
preferIdentity(headers);
|
|
428
424
|
const res = await rawFetch(new Request(currentUrl.toString(), {
|
|
429
425
|
method: "GET",
|
|
430
426
|
redirect: "manual",
|
|
431
427
|
signal,
|
|
432
|
-
headers
|
|
428
|
+
headers,
|
|
433
429
|
}), pinnedIp);
|
|
434
430
|
if (res.status >= 300 && res.status < 400 && res.headers.has("location")) {
|
|
435
431
|
const loc = res.headers.get("location") ?? "";
|
|
@@ -449,7 +445,7 @@ async function performWebFetch(initialUrl, signal, cfg) {
|
|
|
449
445
|
}
|
|
450
446
|
continue;
|
|
451
447
|
}
|
|
452
|
-
return res;
|
|
448
|
+
return { res, finalUrl: currentUrl };
|
|
453
449
|
}
|
|
454
450
|
throw new WebFetchPermissionError(`too many redirects (>${MAX_REDIRECTS})`);
|
|
455
451
|
}
|
|
@@ -482,6 +478,7 @@ export const webFetch = buildTool({
|
|
|
482
478
|
inputSchema: webFetchSchema,
|
|
483
479
|
readOnly: true,
|
|
484
480
|
concurrencySafe: true,
|
|
481
|
+
operativeArgs: [{ field: "url", kind: "url" }],
|
|
485
482
|
// Pillar 3 sink-side: URL parameters can encode exfiltrated data ("Safe URL"
|
|
486
483
|
// pattern from OpenAI's 2026-05 prompt-injection paper).
|
|
487
484
|
scope: "external",
|
|
@@ -496,7 +493,9 @@ export const webFetch = buildTool({
|
|
|
496
493
|
throw new WebFetchPermissionError(`invalid URL "${input.url}"`);
|
|
497
494
|
}
|
|
498
495
|
const ctrl = new AbortController();
|
|
499
|
-
|
|
496
|
+
// Not "fetch timeout": a result whose last line starts with "fetch" is
|
|
497
|
+
// what the prompt-injection detector flags as a trailing order.
|
|
498
|
+
const timer = setTimeout(() => ctrl.abort(new Error(`the request timed out after ${timeoutMs}ms`)), timeoutMs);
|
|
500
499
|
if (ctx?.signal !== undefined) {
|
|
501
500
|
if (ctx.signal.aborted)
|
|
502
501
|
ctrl.abort(ctx.signal.reason);
|
|
@@ -506,13 +505,17 @@ export const webFetch = buildTool({
|
|
|
506
505
|
});
|
|
507
506
|
}
|
|
508
507
|
let res;
|
|
508
|
+
let finalUrl;
|
|
509
|
+
let body;
|
|
509
510
|
try {
|
|
510
|
-
res = await performWebFetch(url, ctrl.signal, resolveWebFetchConfig(ctx?.toolConfig));
|
|
511
|
+
({ res, finalUrl } = await performWebFetch(url, ctrl.signal, resolveWebFetchConfig(ctx?.toolConfig)));
|
|
512
|
+
// Inside the deadline: a server that sends the head and then drips the
|
|
513
|
+
// body is stopped by the same 30 s as one that never answers.
|
|
514
|
+
body = await readBodyCapped(res);
|
|
511
515
|
}
|
|
512
516
|
finally {
|
|
513
517
|
clearTimeout(timer);
|
|
514
518
|
}
|
|
515
|
-
const body = await readBodyCapped(res);
|
|
516
519
|
const ct = (res.headers.get("content-type") ?? "").toLowerCase();
|
|
517
520
|
let content;
|
|
518
521
|
if (ct.includes("text/html") || ct.includes("application/xhtml")) {
|
|
@@ -527,7 +530,11 @@ export const webFetch = buildTool({
|
|
|
527
530
|
else {
|
|
528
531
|
content = `[non-textual content: ${ct}, ${body.length} bytes — not displayed]`;
|
|
529
532
|
}
|
|
530
|
-
|
|
533
|
+
// The page the body is comes first; the URL asked for follows only when
|
|
534
|
+
// a redirect led elsewhere (the header grammar provability reads).
|
|
535
|
+
const final = finalUrl.toString();
|
|
536
|
+
const asked = url.toString();
|
|
537
|
+
const header = `URL: ${final}\n${final !== asked ? `Requested: ${asked}\n` : ""}Status: ${res.status}\nContent-Type: ${ct}\n\n`;
|
|
531
538
|
if (input.prompt !== undefined && input.prompt !== "") {
|
|
532
539
|
return `${header}[user prompt: ${input.prompt}]\n\n${content}`;
|
|
533
540
|
}
|
|
@@ -566,23 +573,25 @@ async function braveSearch(query, apiKey, allowed, blocked, signal) {
|
|
|
566
573
|
// (the provider doesn't enforce them server-side).
|
|
567
574
|
const url = `https://api.search.brave.com/res/v1/web/search?${params.toString()}`;
|
|
568
575
|
// Fixed, trusted API host — not model-controlled, so no SSRF pin needed.
|
|
569
|
-
const
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
}), "");
|
|
576
|
+
const headers = new Headers({ accept: "application/json", "x-subscription-token": apiKey });
|
|
577
|
+
preferIdentity(headers);
|
|
578
|
+
const res = await rawFetch(new Request(url, { headers, signal }), "");
|
|
573
579
|
if (!res.ok) {
|
|
580
|
+
await res.body?.cancel().catch(() => undefined);
|
|
574
581
|
throw new WebFetchPermissionError(`Brave search failed: HTTP ${res.status}`);
|
|
575
582
|
}
|
|
576
|
-
const json = (await res
|
|
583
|
+
const json = (await readJsonCapped(res));
|
|
577
584
|
const raw = json.web?.results ?? [];
|
|
578
585
|
return raw
|
|
579
586
|
.map((r) => ({ title: r.title ?? "", url: r.url ?? "", snippet: r.description ?? "" }))
|
|
580
587
|
.filter((h) => filterByDomains(h.url, allowed, blocked));
|
|
581
588
|
}
|
|
582
589
|
async function tavilySearch(query, apiKey, allowed, blocked, signal) {
|
|
590
|
+
const headers = new Headers({ "content-type": "application/json" });
|
|
591
|
+
preferIdentity(headers);
|
|
583
592
|
const res = await rawFetch(new Request("https://api.tavily.com/search", {
|
|
584
593
|
method: "POST",
|
|
585
|
-
headers
|
|
594
|
+
headers,
|
|
586
595
|
body: JSON.stringify({
|
|
587
596
|
api_key: apiKey,
|
|
588
597
|
query,
|
|
@@ -595,9 +604,10 @@ async function tavilySearch(query, apiKey, allowed, blocked, signal) {
|
|
|
595
604
|
// Fixed, trusted API host — not model-controlled, so no SSRF pin needed.
|
|
596
605
|
"");
|
|
597
606
|
if (!res.ok) {
|
|
607
|
+
await res.body?.cancel().catch(() => undefined);
|
|
598
608
|
throw new WebFetchPermissionError(`Tavily search failed: HTTP ${res.status}`);
|
|
599
609
|
}
|
|
600
|
-
const json = (await res
|
|
610
|
+
const json = (await readJsonCapped(res));
|
|
601
611
|
const raw = json.results ?? [];
|
|
602
612
|
return raw
|
|
603
613
|
.map((r) => ({ title: r.title ?? "", url: r.url ?? "", snippet: r.content ?? "" }))
|
|
@@ -630,13 +640,14 @@ export const webSearch = buildTool({
|
|
|
630
640
|
inputSchema: webSearchSchema,
|
|
631
641
|
readOnly: true,
|
|
632
642
|
concurrencySafe: true,
|
|
643
|
+
operativeArgs: [{ field: "query", kind: "text" }],
|
|
633
644
|
// Pillar 3 sink-side: search-query parameter is an exfiltration vector.
|
|
634
645
|
scope: "external",
|
|
635
646
|
// FR-002 — declare the io-capability fact (remote search API) for the audit.
|
|
636
647
|
ioCapability: "network",
|
|
637
648
|
execute: async (input, ctx) => {
|
|
638
649
|
const ctrl = new AbortController();
|
|
639
|
-
const timer = setTimeout(() => ctrl.abort(new Error("search timeout")),
|
|
650
|
+
const timer = setTimeout(() => ctrl.abort(new Error("search timeout")), timeoutMs);
|
|
640
651
|
if (ctx?.signal !== undefined) {
|
|
641
652
|
if (ctx.signal.aborted)
|
|
642
653
|
ctrl.abort(ctx.signal.reason);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@crewhaus/tool-web",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "WebFetch (URL → markdown via cheerio + turndown) and WebSearch (provider dispatch)",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -8,21 +8,24 @@
|
|
|
8
8
|
"exports": {
|
|
9
9
|
".": {
|
|
10
10
|
"types": "./dist/index.d.ts",
|
|
11
|
-
"import": "./dist/index.js"
|
|
11
|
+
"import": "./dist/index.js",
|
|
12
|
+
"default": "./dist/index.js"
|
|
12
13
|
}
|
|
13
14
|
},
|
|
14
15
|
"scripts": {
|
|
15
16
|
"test": "bun test src"
|
|
16
17
|
},
|
|
17
18
|
"dependencies": {
|
|
18
|
-
"@crewhaus/errors": "0.
|
|
19
|
-
"@crewhaus/tool-builder": "0.
|
|
20
|
-
"@crewhaus/tool-catalog": "0.
|
|
19
|
+
"@crewhaus/errors": "0.8.0",
|
|
20
|
+
"@crewhaus/tool-builder": "0.8.0",
|
|
21
|
+
"@crewhaus/tool-catalog": "0.8.0",
|
|
22
|
+
"@crewhaus/tool-fetch": "0.8.0",
|
|
21
23
|
"cheerio": "^1.0.0",
|
|
22
24
|
"turndown": "^7.2.0",
|
|
23
25
|
"zod": "^3.23.8"
|
|
24
26
|
},
|
|
25
27
|
"devDependencies": {
|
|
28
|
+
"@crewhaus/prompt-injection-detector": "workspace:*",
|
|
26
29
|
"@crewhaus/tool-executor": "workspace:*",
|
|
27
30
|
"@crewhaus/tool-permission-matcher": "workspace:*",
|
|
28
31
|
"@crewhaus/tool-validate": "workspace:*",
|
|
@@ -46,5 +49,8 @@
|
|
|
46
49
|
"publishConfig": {
|
|
47
50
|
"access": "public"
|
|
48
51
|
},
|
|
49
|
-
"files": ["dist", "README.md", "LICENSE", "NOTICE"]
|
|
52
|
+
"files": ["dist", "README.md", "LICENSE", "NOTICE"],
|
|
53
|
+
"engines": {
|
|
54
|
+
"bun": ">=1.3.14"
|
|
55
|
+
}
|
|
50
56
|
}
|