@q32/signal-scanner 0.1.0 → 0.2.0

package/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -109,27 +109,44 @@ the rendered DOM.
 import { renderAndScan } from "@q32/signal-scanner/render";
 ```
 
+This is the core of the scanner. Static crawling and URL extraction just feed
+bytes in; the signal that matters comes from rendering a page in a real DOM,
+executing its inline and external scripts under instrumentation, and folding the
+rendered DOM plus recorded behaviors (exfil/redirect/eval, surfaced URLs) back
+into the report. That catches credential forms injected by external scripts,
+`document.write` payloads, and cloaking bouncers that inline-only analysis can't
+see.
+
 `renderAndScan` runs in-process by default and is intended for trusted or
 synthetic inputs unless you provide an isolate. The included Node CLI runs this
 render step in `isolated-vm`, so untrusted page JavaScript cannot reach host
-`fetch`, `process`, or `fs`.
+`fetch`, `process`, or `fs`. That sandbox guarantee is covered by an integration
+test (`npm run test:isolate`).
 
 Cloudflare users can provide their own isolate or Worker-based invocation when
 embedding the library, but that is separate from the CLI.
 
 ## Node CLI
 
-The package includes a Node CLI for local URL checks, bounded crawling, and
-artifact/file scanning.
+The package ships a `signal-scanner` binary for local URL checks, bounded
+crawling, and artifact/file scanning.
 
 ```bash
-npm run scan -- crawl https://example.com
-npm run scan -- crawl --no-robots --parallel 10 --max-urls 50 --max-depth 2 https://example.com
-npm run scan -- files ./samples
+npx @q32/signal-scanner crawl https://example.com
+npx @q32/signal-scanner crawl --no-robots --parallel 10 --max-urls 50 --max-depth 2 https://example.com
+npx @q32/signal-scanner files ./samples
 ```
 
-The CLI uses Node APIs for fetching and file IO. For dynamic rendering, it uses
-`isolated-vm`.
+After a global install (`npm i -g @q32/signal-scanner`) the same commands are
+available as `signal-scanner crawl …`. Inside this repo, `npm run scan -- …`
+runs the CLI from source.
+
+The CLI uses Node APIs for fetching and file IO. Dynamic rendering runs page
+JavaScript inside `isolated-vm`; `isolated-vm` and `esbuild` are
+**optional dependencies**. A default `npm install` pulls them in, but if they
+are unavailable (e.g. installed with `--no-optional`, or a build toolchain for
+the `isolated-vm` native addon is missing) the CLI logs a notice and continues
+with static analysis only.
 
 Crawler behavior:
 
@@ -158,6 +175,9 @@ The CLI prints a normalized JSON summary to stdout.
 
 ## Rule Coverage
 
+See [`docs/rule-packs.md`](docs/rule-packs.md) for the rule model (pattern vs.
+analyzer-emitted rules), the score/tag system, and how to add a rule.
+
 - HTML signals for forms, password/payment fields, scripts, links, iframes,
   meta refresh redirects, hidden iframe patterns, login/payment language,
   page-model screenshot/login cues, crypto/DeFi landing language,
@@ -196,6 +216,34 @@ policy, and then applies explicit tag-based context multipliers such as
 credential plus suspicious hosting, wallet/payment plus exfiltration/redirect,
 decoded artifact plus script behavior, or binary plus URL evidence.
 
+## Development
+
+Build and test:
+
+```bash
+npm run build
+npm test             # unit suite (bun)
+npm run coverage     # unit suite + an 80% line-coverage gate
+npm run test:isolate # the isolated-vm dynamic-render path, under Node
+```
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the full workflow,
+[`docs/rule-packs.md`](docs/rule-packs.md) for the rule system, and
+[`CHANGELOG.md`](CHANGELOG.md) for release history.
+
+The eval harness (`npm run eval`) measures the detector against a labeled corpus
+of live known-good and known-bad sites. It is dev-only and not shipped in the
+package. Because many ISPs intercept known-bad hosts (which tanks recall), it
+can route its crawl through an outbound proxy configured via a local `.env`.
+Copy `.env.example` to `.env` and fill in proxy credentials if you need this;
+leave it unset to crawl directly. `.env` is gitignored — never commit
+credentials.
+
 ## License
 
-MIT
+[GNU Lesser General Public License v3.0 or later](COPYING.LESSER) (LGPL-3.0-or-later).
+
+Application code may link and use this library without itself becoming
+LGPL/GPL; modifications to the library must be released under the LGPL. The
+LGPL builds on the [GPL-3.0](COPYING); both license texts ship with the
+package.

package/dist/cli.d.ts

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+import { type ScannerReport } from "./index.js";
+export declare const DEFAULT_CRAWL_OPTIONS: CrawlOptions;
+export interface TargetReport {
+    target: string;
+    kind: "url" | "file";
+    status?: number;
+    bytes: number;
+    report: ScannerReport;
+    error?: string;
+    /** Forced-navigation targets (location.href/assign/replace) — followed cross-origin. */
+    forcedNavUrls?: string[];
+}
+export interface CrawlOptions {
+    parallel: number;
+    maxUrls: number;
+    maxDepth: number;
+    maxBytes: number;
+    maxTotalBytes: number;
+    maxSitemapUrls: number;
+    timeoutMs: number;
+    robots: boolean;
+    userAgent: string;
+}
+export declare function crawlTargets(startUrls: string[], options: CrawlOptions): Promise<TargetReport[]>;
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAMA,OAAO,EAAiF,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AA+F/H,eAAO,MAAM,qBAAqB,EAAE,YAUnC,CAAC;AAEF,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,aAAa,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wFAAwF;IACxF,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAwDD,wBAAsB,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAmEtG"}