sekant-intercept-js 1.0.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 ADDED
@@ -0,0 +1,231 @@
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.
202
+
203
+ --------------------------------------------------------------------------------
204
+ THIRD-PARTY COMPONENTS
205
+
206
+ Sekant Intercept.js includes the following components which are licensed under
207
+ the MIT License. A copy of the MIT License is included below.
208
+
209
+ - pe-library (https://www.npmjs.com/package/pe-library)
210
+ - spark-md5 (https://www.npmjs.com/package/spark-md5)
211
+
212
+ ---
213
+ MIT License
214
+
215
+ Permission is hereby granted, free of charge, to any person obtaining a copy
216
+ of this software and associated documentation files (the "Software"), to deal
217
+ in the Software without restriction, including without limitation the rights
218
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
219
+ copies of the Software, and to permit persons to whom the Software is
220
+ furnished to do so, subject to the following conditions:
221
+
222
+ The above copyright notice and this permission notice shall be included in
223
+ all copies or substantial portions of the Software.
224
+
225
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
226
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
227
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
228
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
229
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
230
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
231
+ THE SOFTWARE.
package/NOTICE ADDED
@@ -0,0 +1,15 @@
1
+ Sekant Intercept.js
2
+ Copyright 2026 Rishi Kant (Sekant Security Inc.)
3
+
4
+ This product includes software developed by Rishi Kant and Sekant Security Inc.
5
+ (https://github.com/rishi-sekantsec/sekant-intercept-js).
6
+
7
+ This product includes the following third-party software:
8
+
9
+ * pe-library
10
+ Copyright (c) 2018-2025 jet (ジェット)
11
+ Licensed under the MIT License.
12
+
13
+ * spark-md5
14
+ Copyright (c) 2015 André Cruz <amdfcruz@gmail.com>
15
+ Licensed under the MIT License.
package/README.md ADDED
@@ -0,0 +1,327 @@
1
+ # Intercept.js: Context-Aware YARA Runtime Detection for JavaScript Environments
2
+
3
+ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
4
+ [![Platform](https://img.shields.io/badge/Platform-Browser%20%7C%20Node%20%7C%20Edge-green.svg)](https://github.com/sekantsec/sekant-intercept-js)
5
+ <!-- [![Modern JS](https://img.shields.io/badge/ECMAScript-2024%2B-yellow.svg)](https://github.com/sekantsec/sekant-intercept-js) -->
6
+
7
+ **Intercept.js** is a pure JavaScript, YARA-compatible detection engine that combines byte-level pattern matching with runtime context inside sandboxed JavaScript environments (browsers, serverless runtimes, Electron). It is designed for application-layer inspection where traditional OS-level security tools lack visibility.
8
+
9
+ While compatible with standard YARA syntax and modules (PE, ELF, Math, Hash, String, Time), Intercept.js extends detection beyond traditional file scanning by allowing rules to **combine content inspection with contextual metadata**, such as domain novelty, sender reputation, MIME discrepancies, user gesture state, referrer, and runtime origin.
10
+
11
+ This enables expressive logic such as:
12
+ - Executable header and downloaded from a newly observed domain
13
+ - Suspicious document with macro and received from unknown sender
14
+ - Script payload and inserted via clipboard without user interaction
15
+ - Binary content and MIME type mismatch
16
+
17
+ The repository includes 900+ unit and integration tests and documentation detailing grammar support and differences from libyara.
18
+
19
+ ## Use-Cases (MITRE ATT&CK)
20
+
21
+ * **Neutralize Malicious Paste (T1204.004):** Detect malicious blobs in clipboard buffers before they reach the OS shell.
22
+ * **Secure Ingress (T1105):** Block unsafe binary blobs and downloads within browsers.
23
+ * **Phishing Mitigation (T1566.001):** Perform EDR-like email attachment scanning with email metadata context.
24
+ * **Data Loss Prevention (T1020 / T1115):** Monitor application buffers for PII, secret keys, or exfiltration patterns.
25
+
26
+ ## Examples
27
+
28
+ ### Running in a webpage without network access (Video)
29
+ See `examples/browser/`
30
+
31
+ [![Watch: Running in a webpage](https://img.youtube.com/vi/w8wsU_hWOz8/0.jpg)](https://youtu.be/w8wsU_hWOz8 "Watch Intercept.js run in a webpage without NW access")
32
+
33
+
34
+ ### Running in a browser extension to scan downloads (Video)
35
+
36
+ [![Watch: Blocking Downloads](https://img.youtube.com/vi/92jDpF19Eso/0.jpg)](https://youtu.be/92jDpF19Eso "Watch Intercept.js block downloads in the browser")
37
+
38
+ ### Running in Cloudflare Worker (Live) - [Click Here](https://intercept-js-worker.sekantsec.workers.dev/)
39
+ See `examples/worker/`
40
+
41
+ ## Technical Overview
42
+
43
+ Intercept.js avoids native bindings and instead leverages V8’s optimized RegExp engine and JavaScript runtime characteristics:
44
+
45
+ * **Aho-Corasick Engine:** High-efficiency multi-pattern string matching for thousands of rules in O(n) time.
46
+ * **Hex-to-Regex JIT:** Translates YARA hex strings (with wildcards and jumps) into optimized V8 Regular Expressions for efficient execution.
47
+ * **AST Evaluation:** Uses a custom Lexer and Parser to convert YARA conditions into an Abstract Syntax Tree with short-circuit logic.
48
+ * **Resource Safety:** Strict match caps to defend against "ReDoS" (Regex Denial of Service) and memory exhaustion.
49
+ * **Common Module Support:** Native JS implementation of pe, elf, math, hash, time, and string modules.
50
+ * **Custom Modules:** Plugin architecture enables use-case specific contextual information to be used in evaluation (e.g. domain reputation for download source).
51
+
52
+ ---
53
+
54
+ ## ⚡ Quick Start
55
+
56
+ ### Installation
57
+
58
+ ```bash
59
+ git clone https://github.com/sekantsec/sekant-intercept-js.git
60
+ cd sekant-intercept-js
61
+ npm install
62
+ npm run build
63
+ npm run example:scanner
64
+ ```
65
+
66
+ ### Run Examples
67
+
68
+ Quickly verify the engine with built-in examples:
69
+
70
+ | Command | Description |
71
+ | :--- | :--- |
72
+ | `npm run example:scanner` | Basic scanning demonstration. |
73
+ | `npm run example:modules` | Demonstrates PE, ELF, Math, and Hash modules. |
74
+ | `npm run example:advanced` | Advanced logic (boolean literals, conditions, filesize). |
75
+
76
+
77
+ #### Example output for `example:scanner`
78
+ ```
79
+
80
+ > sekant-intercept-js@1.0.0 example:scanner
81
+ > node examples/exampleYaraScanner.mjs
82
+
83
+ ======================================================================
84
+ YARA Scanner End-to-End Examples
85
+ ======================================================================
86
+
87
+ --- Example 1: Simple Malware Detection ---
88
+
89
+ Detected rules: [ 'SuspiciousExecutable' ]
90
+ Tags: []
91
+ Matched strings:
92
+ $api1: 1 occurrence(s)
93
+ $api2: 1 occurrence(s)
94
+
95
+ --- Example 2: Document Analysis ---
96
+
97
+ Document analysis results:
98
+ Detected rules: [ 'SuspiciousDocument' ]
99
+ File size: 1024 bytes
100
+ Entropy (0-1000): 5.172002498773881
101
+
102
+ ...
103
+
104
+ Combined module analysis:
105
+ File size: 512 bytes
106
+ Entropy: 6.99
107
+ MD5: 415a38bfcba9069445293e4db8bb0e82
108
+ Scan time: 2026-02-21T14:54:04.247Z
109
+ Detected rules: ComplexAnalysis
110
+
111
+ ======================================================================
112
+ Examples complete!
113
+ ======================================================================
114
+
115
+ ```
116
+
117
+ ### Basic Usage (InterceptScanner)
118
+
119
+ ```javascript
120
+ import { InterceptScanner } from './src/interceptScanner.mjs';
121
+
122
+ const rules = 'rule Suspicious_Stager { strings: $ps = "powershell.exe" nocase condition: $ps }';
123
+ const scanner = new InterceptScanner(rules);
124
+
125
+ // Scan clipboard data (as Uint8Array)
126
+ const clipboardData = new TextEncoder().encode(await navigator.clipboard.readText());
127
+ const results = await scanner.scan(clipboardData);
128
+
129
+ if (results.length > 0) {
130
+ console.warn("Security Alert: Malicious paste blocked!");
131
+ }
132
+ ```
133
+
134
+ ---
135
+
136
+ ## Architecture & Deployment
137
+
138
+ Intercept.js is optimized for modern, "OS-less" deployment.
139
+
140
+ | Target | Environment | Use Case |
141
+ | :--- | :--- | :--- |
142
+ | **Browsers** | Chrome/Edge/Safari | Real-time clipboard & download protection. |
143
+ | **Email Clients** | Outlook / Apple Mail | Configurable attachment scanning. |
144
+ | **Serverless** | Cloudflare Workers | Edge-based payload sanitization. |
145
+ | **Electron** | Main/Preload Script | In-app protection for Slack/VS Code forks. |
146
+ | **Automation** | macOS JXA / GNOME | Low-overhead desktop security services. |
147
+
148
+ ---
149
+
150
+ ## Supported Modules & Extensibility
151
+
152
+ Intercept.js includes native JavaScript implementations of standard YARA modules, ensuring compatibility without external dependencies.
153
+
154
+ * **PE Module**: Parse Windows PE headers, sections, imports, and exports.
155
+ * **ELF Module**: Analyze Linux/Unix ELF headers and sections.
156
+ * **Math Module**: Entropy calculation, min/max, and statistical functions.
157
+ * **Hash Module**: MD5, SHA1, SHA256, and CRC32 calculation.
158
+ * **Time Module**: Date/time comparisons.
159
+ * **String Module**: String length and transformation utilities.
160
+
161
+ ### Custom Modules
162
+ You can easily extend the engine by injecting custom JS objects as modules. This allows rules to query application-specific context (e.g., `http.url`, `user.role`, `browser.userAgent`) without modifying the core engine.
163
+
164
+ See [Custom Module Overview](docs/developer/CUSTOM_MODULE_OVERVIEW.md) for implementation details.
165
+
166
+ ---
167
+
168
+ ## Documentation Map
169
+
170
+ We provide detailed documentation for different audiences:
171
+
172
+ ### General Usage
173
+ * **[YARA Grammar Support](docs/general/YARA_GRAMMAR_SUPPORT.md)**: What features (hex, loops, regex) are supported.
174
+ * **[Engine Differences](docs/general/ENGINE_DIFFERENCES.md)**: Critical differences between this JS engine and C-based libyara.
175
+
176
+ ### Developer & Architecture
177
+ * **[Architecture Overview](docs/developer/0_GENERAL_OVERVIEW.md)**: High-level design of the scanning pipeline.
178
+ * **[AST Reference](docs/developer/AST_REFERENCE.md)**: Internal structure of parsed conditions.
179
+ * **[Output Reference](docs/developer/SCAN_OUTPUT_REFERENCE.md)**: Structure of scanner output.
180
+
181
+
182
+ ### Module Reference
183
+ * **[Standard Modules](docs/modules/STANDARD_MODULES.md)**: API reference for built-in modules.
184
+ * **[PE Module Details](docs/modules/PE_MODULE.md)**: Specifics of the PE parser.
185
+ * **[Custom Module Details](docs/modules/CUSTOM_MODULE_OVERVIEW.md)**: Overview of Custom Modules.
186
+
187
+ ---
188
+
189
+ ## Testing
190
+
191
+ We utilize **Vitest** for component testing and integration validation. The repository includes 900+ tests covering several layers:
192
+
193
+ ### Run All Tests
194
+ To execute the full test suite:
195
+ ```bash
196
+ npm run vitest
197
+ ```
198
+
199
+ ### Test Categories
200
+
201
+ **1. Core Engine (Unit Tests)**
202
+ Validate individual components like string matching, condition parsing, and the Aho-Corasick automaton.
203
+ ```bash
204
+ npm run vitest vitest/testComprehensiveStringMatcher.test.mjs
205
+ npm run vitest vitest/testConditionsMatch.test.mjs
206
+ npm run vitest vitest/testAhoCorasickComprehensive.test.mjs
207
+ ```
208
+
209
+ **2. Module Verification**
210
+ Ensure that built-in modules (PE, ELF, Math, Hash) correctly parse file formats and calculate values.
211
+ ```bash
212
+ npm run vitest vitest/testPEModule.test.mjs
213
+ npm run vitest vitest/testELFModule.test.mjs
214
+ npm run vitest vitest/testMathModule.test.mjs
215
+ ```
216
+
217
+ **3. Advanced Logic**
218
+ Test complex YARA features like loops, bitwise operations, and boolean logic.
219
+ ```bash
220
+ npm run vitest vitest/testForLoopsComprehensive.test.mjs
221
+ npm run vitest vitest/testBitwiseOperators.test.mjs
222
+ ```
223
+
224
+ **4. End-to-End Integration**
225
+ Validators for the full `YaraScanner` pipeline against realistic rules and payloads.
226
+ ```bash
227
+ npm run vitest vitest/testYaraScanner.test.mjs
228
+ npm run vitest vitest/testComprehensive.test.mjs
229
+ ```
230
+
231
+ ### Run Benchmarks
232
+
233
+ Check the performance of the scanner across various scenarios:
234
+
235
+ ```bash
236
+ npm run benchmark
237
+ ```
238
+
239
+ This runs a basic benchmark suite testing simple string matching, complex conditions, quantifier heavy rules, and module usage.
240
+
241
+ ### Compare Implementations
242
+
243
+ Verify correctness against the reference YARA implementation (requires Python and `yara-python`):
244
+
245
+ ```bash
246
+ npm run compare
247
+ ```
248
+
249
+ This script runs a direct comparison between Intercept.js and the native YARA engine on a variety of rule files and test data.
250
+
251
+ ---
252
+
253
+ ## ⚡ Performance & Limitations
254
+
255
+ Intercept.js is designed for **safety and portability**, not raw throughput supremacy over C-based YARA.
256
+
257
+ - **Partial YARA Compatibility** - Not all YARA condition constructs are fully implemented. Gaps and edge-cases are documented [Engine Differences](docs/general/ENGINE_DIFFERENCES.md).
258
+ - **In-Memory Scanning** - The engine operates on fully loaded byte buffers making extremely large files impractical to scan. Stream support is planned.
259
+ - **Module Evaluation Scope** - Custom Modules currently receive raw content and context, but not the intermediate scan facts during pattern matching. Support is planned.
260
+ - **Execution Speed**: Although V8's JIT compiler optimizes RegEx heavy rules significantly, it is not meant to match C-based YARA performance.
261
+
262
+ ---
263
+
264
+ ## FAQ
265
+
266
+ ### Why not compile libyara to WebAssembly (WASM)?
267
+
268
+ Intercept.js intentionally avoids native bindings and WebAssembly. While compiling libyara to WASM is technically possible, the primary constraints in sandboxed JavaScript environments are portability, memory bounds, and integration with runtime metadata — not raw CPU throughput.
269
+
270
+ A pure JavaScript implementation:
271
+
272
+ - Simplifies auditing and embedding in browsers, serverless runtimes, and extensions
273
+ - Avoids cross-environment WASM compatibility issues
274
+ - Integrates naturally with host-provided runtime context
275
+ - Reduces debugging and operational complexity
276
+
277
+ ### How complete is YARA compatibility?
278
+
279
+ Intercept.js supports the majority of commonly used YARA condition constructs, including literal, regex, and hex strings, along with common modules (PE, ELF, Math, Hash, String, Time). Some advanced or less commonly used constructs are not yet implemented. Documented differences are available in the [Engine Differences](docs/general/ENGINE_DIFFERENCES.md) guide.
280
+
281
+ ### How does performance compare to C-based YARA?
282
+
283
+ Intercept.js is not intended to outperform native C-based libyara in raw throughput. It is optimized for practical performance within JavaScript runtimes using Aho-Corasick multi-pattern matching and V8’s optimized RegExp engine. The goal is predictable, efficient evaluation inside application-layer environments where native engines may not be practical to deploy.
284
+
285
+ ### Is rule evaluation deterministic?
286
+
287
+ Yes. Rule evaluation is deterministic and side-effect free. Custom modules expose structured metadata to the rule engine but do not execute arbitrary code defined inside rules.
288
+
289
+ ---
290
+
291
+ ## Real-World Usage
292
+
293
+ ### Intercept.js is used by **Sekant Security** to secure browsers:
294
+ - **Download Protection** - Intercept.js inspects file downloads in-flight to identify malicious artifacts before they are written to disk.
295
+ - **Clipboard Sanitization** - Intercept.js scans clipboard content copied within browsers in real-time, detecting obfuscated / malicious payloads before execution.
296
+
297
+ ### Please let us know if you use Intercept.js in your project!
298
+
299
+ ---
300
+
301
+ ## Contributing
302
+
303
+ We welcome contributions! Please see [CONTRIBUTION_GUIDELINES.md](docs/developer/CONTRIBUTION_GUIDELINES.md) for details on how to get started.
304
+
305
+ 1. Fork the repository.
306
+ 2. Create your feature branch (`git checkout -b feature/amazing-feature`).
307
+ 3. Commit your changes (`git commit -m 'Add some amazing feature'`).
308
+ 4. Push to the branch (`git push origin feature/amazing-feature`).
309
+ 5. Open a Pull Request.
310
+
311
+ ## Security Policy
312
+
313
+ If you discover a security vulnerability within Intercept.js (e.g., a way to bypass detection or cause a Denial of Service via a crafted rule), please report it privately to `support@sekantsecurity.com` rather than opening a public issue.
314
+
315
+ ---
316
+
317
+ ## License & Attribution
318
+
319
+ This project is licensed under the **Apache License 2.0**.
320
+
321
+ **Copyright 2026 Rishi Kant (Sekant Security Inc.)**
322
+
323
+ Included Third-Party Software:
324
+ * **pe-library** (MIT License) - Used for PE header parsing.
325
+ * **spark-md5** (MIT License) - Used for Hash support.
326
+
327
+ See the LICENSE and NOTICE files for full details.