regula-wasi 3.2.2

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,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/README.md ADDED
@@ -0,0 +1,225 @@
1
+ # Regula (nonfx fork)
2
+
3
+ > **Note:** This is a maintained fork of [fugue/regula](https://github.com/fugue/regula), which is now archived. This fork includes security patches, dependency upgrades, and WASI/npm support.
4
+
5
+ ## What's Different in This Fork
6
+
7
+ ### Security Patches & Upgrades
8
+ - **OPA upgraded** from v0.45.1 to v1.12.2 (latest)
9
+ - **Go upgraded** to 1.24.11 with stdlib CVE fixes
10
+ - **AWS SDK** migrated to maintained fork
11
+ - **go-getter** upgraded from 1.6.2 to 1.7.0
12
+ - **golang.org/x/net** upgraded to fix vulnerabilities
13
+ - **google.golang.org/grpc** upgraded to 1.56.3
14
+
15
+ ### WASI/WebAssembly Support
16
+ This fork can be compiled to WASI (WebAssembly System Interface), allowing it to run in Node.js 18+ without native dependencies. This is useful for:
17
+ - Serverless environments
18
+ - Browser-based tools
19
+ - Cross-platform distribution via npm
20
+
21
+ ### Vendor Patches for WASI
22
+ The following vendor patches are applied during WASI builds:
23
+ - `spf13/afero` - WASI-compatible errno handling
24
+ - `sirupsen/logrus` - Terminal detection bypass for WASI
25
+ - `fsnotify/fsnotify` - No-op file watcher for WASI
26
+ - `chzyer/readline` - Terminal stubs for WASI
27
+
28
+ ---
29
+
30
+ ## Introduction
31
+
32
+ [Regula](https://regula.dev) is a tool that evaluates infrastructure as code files for potential AWS, Azure, Google Cloud, and Kubernetes security and compliance violations prior to deployment.
33
+
34
+ Regula supports the following file types:
35
+
36
+ - CloudFormation JSON/YAML templates
37
+ - Terraform source code
38
+ - Terraform JSON plans
39
+ - Kubernetes YAML manifests
40
+ - Azure Resource Manager (ARM) JSON templates
41
+
42
+ Regula includes a library of rules written in Rego, the policy language used by the [Open Policy Agent](https://www.openpolicyagent.org/) (OPA) project.
43
+
44
+ ---
45
+
46
+ ## Installation
47
+
48
+ ### npm (Node.js 18+)
49
+
50
+ The easiest way to use Regula in JavaScript/TypeScript projects:
51
+
52
+ ```bash
53
+ npm install regula-wasi
54
+ ```
55
+
56
+ #### CLI Usage
57
+
58
+ ```bash
59
+ # Run directly with npx
60
+ npx regula-wasi run ./terraform/
61
+
62
+ # Or install globally
63
+ npm install -g regula-wasi
64
+ regula run ./terraform/
65
+ ```
66
+
67
+ #### Programmatic Usage
68
+
69
+ ```javascript
70
+ import { runRegula, validate } from 'regula-wasi';
71
+
72
+ // Basic usage
73
+ const result = await runRegula('./terraform/');
74
+ console.log(result.summary);
75
+
76
+ // With options
77
+ const result = await runRegula('./main.tf', {
78
+ inputType: 'tf', // auto, tf, tf-plan, cfn, k8s, arm
79
+ include: ['./custom-rules/'],
80
+ only: ['FG_R00229'], // Only run specific rules
81
+ exclude: ['FG_R00100'], // Exclude specific rules
82
+ });
83
+
84
+ // Check for failures
85
+ if (result.summary.rule_results.FAIL > 0) {
86
+ console.error('Security violations found!');
87
+ process.exit(1);
88
+ }
89
+ ```
90
+
91
+ ### Prebuilt Binary
92
+
93
+ Download from [Releases](https://github.com/nonfx/regula/releases) for your platform.
94
+
95
+ ### From Source
96
+
97
+ Requires Go 1.21+
98
+
99
+ ```bash
100
+ # Build native binary
101
+ make binary # outputs to ./bin/regula
102
+ make install # installs to /usr/local/bin/regula
103
+
104
+ # Build WASI binary (requires Go 1.25+)
105
+ ./build-wasi.sh # outputs regula.wasm
106
+ ```
107
+
108
+ ### Docker
109
+
110
+ ```bash
111
+ docker run --rm -v $(pwd):/workspace ghcr.io/nonfx/regula run /workspace
112
+ ```
113
+
114
+ ---
115
+
116
+ ## Usage
117
+
118
+ ### Basic Commands
119
+
120
+ ```bash
121
+ # Scan Terraform directory
122
+ regula run ./terraform/
123
+
124
+ # Scan with specific input type
125
+ regula run --input-type tf ./main.tf
126
+
127
+ # Output as JSON
128
+ regula run --format json ./terraform/
129
+
130
+ # Include custom rules
131
+ regula run --include ./custom-rules/ ./terraform/
132
+
133
+ # Run only specific rules
134
+ regula run --only FG_R00229 ./terraform/
135
+ ```
136
+
137
+ ### Output Formats
138
+
139
+ - `text` (default) - Human-readable output
140
+ - `json` - JSON output for programmatic use
141
+ - `table` - Tabular output
142
+ - `sarif` - SARIF format for GitHub Code Scanning
143
+ - `junit` - JUnit XML for CI/CD integration
144
+ - `tap` - Test Anything Protocol
145
+
146
+ ### Exit Codes
147
+
148
+ - `0` - No violations found
149
+ - `1` - Violations found or error occurred
150
+
151
+ ---
152
+
153
+ ## Available Commands
154
+
155
+ ```
156
+ regula [command]
157
+
158
+ Commands:
159
+ run Evaluate rules against infrastructure as code
160
+ test Run OPA test with Regula
161
+ repl Start an interactive session for testing rules
162
+ init Create a new Regula configuration file
163
+ show Show debug information
164
+ version Print version information
165
+ completion Generate shell autocompletion script
166
+
167
+ Flags:
168
+ -h, --help Help for regula
169
+ -v, --verbose Verbose output
170
+ ```
171
+
172
+ ---
173
+
174
+ ## Building
175
+
176
+ ### Native Binary
177
+
178
+ ```bash
179
+ # Standard build
180
+ go build -mod vendor -o bin/regula .
181
+
182
+ # Or use make
183
+ make binary
184
+ ```
185
+
186
+ ### WASI Binary
187
+
188
+ Requires Go 1.25+ for large binary WASM linking.
189
+
190
+ ```bash
191
+ ./build-wasi.sh
192
+ ```
193
+
194
+ This will:
195
+ 1. Vendor dependencies (`go mod vendor`)
196
+ 2. Apply WASI patches from `patches/` directory
197
+ 3. Build `regula.wasm` (121MB)
198
+
199
+ ### Running Tests
200
+
201
+ ```bash
202
+ # Go tests
203
+ make test
204
+
205
+ # npm tests (requires WASI build)
206
+ npm test # Basic API tests
207
+ npm run test:wasi # Parity tests vs native binary
208
+ ```
209
+
210
+ ---
211
+
212
+ ## License
213
+
214
+ Apache 2.0 - See [LICENSE](LICENSE)
215
+
216
+ Originally created by [Fugue, Inc.](https://fugue.co)
217
+
218
+ ---
219
+
220
+ ## Links
221
+
222
+ - [Original Documentation](https://regula.dev) (may be outdated)
223
+ - [Original Repository](https://github.com/fugue/regula) (archived)
224
+ - [This Fork](https://github.com/nonfx/regula)
225
+ - [npm Package](https://www.npmjs.com/package/regula-wasi)
package/cli.js ADDED
@@ -0,0 +1,32 @@
1
+ #!/usr/bin/env node
2
+
3
+ import { WASI } from "wasi";
4
+ import { readFile } from "fs/promises";
5
+ import { fileURLToPath } from "url";
6
+ import { dirname, join } from "path";
7
+
8
+ const __filename = fileURLToPath(import.meta.url);
9
+ const __dirname = dirname(__filename);
10
+
11
+ const args = process.argv.slice(2);
12
+
13
+ const wasi = new WASI({
14
+ version: "preview1",
15
+ args: ["regula", ...args],
16
+ env: process.env,
17
+ preopens: { "/": "/" },
18
+ returnOnExit: true,
19
+ });
20
+
21
+ try {
22
+ const wasmPath = join(__dirname, "regula.wasm");
23
+ const wasm = await readFile(wasmPath);
24
+ const { instance } = await WebAssembly.instantiate(wasm, wasi.getImportObject());
25
+ wasi.start(instance);
26
+ } catch (err) {
27
+ if (err.code === "ERR_WASI_EXITED") {
28
+ process.exit(err.exitCode);
29
+ }
30
+ console.error("Error:", err.message);
31
+ process.exit(1);
32
+ }
package/index.js ADDED
@@ -0,0 +1,83 @@
1
+ import { execFile } from "child_process";
2
+ import { fileURLToPath } from "url";
3
+ import { dirname, join } from "path";
4
+
5
+ const __filename = fileURLToPath(import.meta.url);
6
+ const __dirname = dirname(__filename);
7
+
8
+ /**
9
+ * Run regula on the specified path(s)
10
+ * @param {string|string[]} paths - Path(s) to IaC files or directories
11
+ * @param {Object} options - Optional configuration
12
+ * @param {string} options.inputType - Input type: auto, tf, tf-plan, cfn, k8s, arm
13
+ * @param {string} options.format - Output format: json, text, table, sarif, junit, tap
14
+ * @param {string[]} options.include - Additional rego files to include
15
+ * @param {string[]} options.only - Only run specific rules
16
+ * @param {string[]} options.exclude - Exclude specific rules
17
+ * @returns {Promise<Object>} - Regula output
18
+ */
19
+ export async function runRegula(paths, options = {}) {
20
+ const pathArray = Array.isArray(paths) ? paths : [paths];
21
+
22
+ const args = ["run", "--format", "json"];
23
+
24
+ if (options.inputType) {
25
+ args.push("--input-type", options.inputType);
26
+ }
27
+
28
+ if (options.include) {
29
+ const includes = Array.isArray(options.include) ? options.include : [options.include];
30
+ for (const inc of includes) {
31
+ args.push("--include", inc);
32
+ }
33
+ }
34
+
35
+ if (options.only) {
36
+ const onlyRules = Array.isArray(options.only) ? options.only : [options.only];
37
+ for (const rule of onlyRules) {
38
+ args.push("--only", rule);
39
+ }
40
+ }
41
+
42
+ if (options.exclude) {
43
+ const excludeRules = Array.isArray(options.exclude) ? options.exclude : [options.exclude];
44
+ for (const rule of excludeRules) {
45
+ args.push("--exclude", rule);
46
+ }
47
+ }
48
+
49
+ args.push(...pathArray);
50
+
51
+ return new Promise((resolve, reject) => {
52
+ const cliPath = join(__dirname, "cli.js");
53
+
54
+ execFile("node", [cliPath, ...args], { maxBuffer: 50 * 1024 * 1024 }, (error, stdout, stderr) => {
55
+ if (stderr) {
56
+ console.error(stderr);
57
+ }
58
+
59
+ try {
60
+ const result = JSON.parse(stdout);
61
+ resolve(result);
62
+ } catch (parseError) {
63
+ if (error) {
64
+ reject(new Error(`Regula failed: ${error.message}\nOutput: ${stdout}`));
65
+ } else {
66
+ reject(new Error(`Failed to parse regula output: ${stdout}`));
67
+ }
68
+ }
69
+ });
70
+ });
71
+ }
72
+
73
+ /**
74
+ * Validate IaC files and return rule results
75
+ * @param {string|string[]} paths - Path(s) to IaC files or directories
76
+ * @param {Object} options - Optional configuration
77
+ * @returns {Promise<Object>} - Object with rule_results and summary
78
+ */
79
+ export async function validate(paths, options = {}) {
80
+ return runRegula(paths, options);
81
+ }
82
+
83
+ export default { runRegula, validate };
package/package.json ADDED
@@ -0,0 +1,46 @@
1
+ {
2
+ "name": "regula-wasi",
3
+ "version": "3.2.2",
4
+ "description": "Infrastructure as Code security and compliance evaluation tool (WASI build). Fork of fugue/regula with security patches.",
5
+ "type": "module",
6
+ "main": "index.js",
7
+ "bin": {
8
+ "regula": "cli.js"
9
+ },
10
+ "scripts": {
11
+ "build": "./build-wasi.sh",
12
+ "test": "node test/test.js",
13
+ "test:wasi": "node test/test-wasi.js",
14
+ "prepublishOnly": "npm run build"
15
+ },
16
+ "files": [
17
+ "index.js",
18
+ "cli.js",
19
+ "regula.wasm",
20
+ "README.md",
21
+ "LICENSE"
22
+ ],
23
+ "keywords": [
24
+ "regula",
25
+ "iac",
26
+ "infrastructure-as-code",
27
+ "terraform",
28
+ "cloudformation",
29
+ "kubernetes",
30
+ "security",
31
+ "compliance",
32
+ "opa",
33
+ "rego",
34
+ "wasi",
35
+ "wasm"
36
+ ],
37
+ "author": "Fugue, Inc.",
38
+ "license": "Apache-2.0",
39
+ "repository": {
40
+ "type": "git",
41
+ "url": "git+https://github.com/nonfx/regula.git"
42
+ },
43
+ "engines": {
44
+ "node": ">=18.0.0"
45
+ }
46
+ }
package/regula.wasm ADDED
Binary file