rulestamp-openapi-security-contract-lint 1.0.6__tar.gz
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.
- rulestamp_openapi_security_contract_lint-1.0.6/LICENSE.txt +15 -0
- rulestamp_openapi_security_contract_lint-1.0.6/PKG-INFO +81 -0
- rulestamp_openapi_security_contract_lint-1.0.6/README.md +61 -0
- rulestamp_openapi_security_contract_lint-1.0.6/pyproject.toml +29 -0
- rulestamp_openapi_security_contract_lint-1.0.6/setup.cfg +4 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint/__init__.py +1 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint/__main__.py +12 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint/js/cli.js +161 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint/js/engine.js +154 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint/js/license.js +103 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint/js/package.json +41 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint/js/rules.json +110 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint/js/strings.json +10 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint.egg-info/PKG-INFO +81 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint.egg-info/SOURCES.txt +17 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint.egg-info/dependency_links.txt +1 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint.egg-info/entry_points.txt +2 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint.egg-info/requires.txt +1 -0
- rulestamp_openapi_security_contract_lint-1.0.6/src/rulestamp_openapi_security_contract_lint.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
OpenAPI Security Contract Lint — Licence
|
|
2
|
+
|
|
3
|
+
Free scope
|
|
4
|
+
Audit the OpenAPI file open in the editor, line by line is free for any use, personal or commercial, for as long as you keep the
|
|
5
|
+
extension installed, and the online check at the product page is free without registration.
|
|
6
|
+
|
|
7
|
+
Paid scope
|
|
8
|
+
Sweep every OpenAPI file in the workspace and keep a dated report (CSV/JSON/HTML) as release evidence is the paid part. It asks for a licence key issued at purchase (one seat, one key). The key is checked against the payment provider and
|
|
9
|
+
cached locally for 30 days so it keeps working offline.
|
|
10
|
+
|
|
11
|
+
Redistribution
|
|
12
|
+
You may not resell, re-host or bundle this extension or its rule set. The rule set and the
|
|
13
|
+
engine are provided as-is; check results are advisory and do not constitute legal advice.
|
|
14
|
+
|
|
15
|
+
(c) ReadyStack — https://getreadystack.com
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: rulestamp-openapi-security-contract-lint
|
|
3
|
+
Version: 1.0.6
|
|
4
|
+
Summary: Finds the lines in an OpenAPI file that publish an endpoint with no authentication, an API key in the query string, or an OAuth grant RFC 9700 forbids. (bundled Node.js runtime)
|
|
5
|
+
Author-email: Rulestamp <support@getreadystack.com>
|
|
6
|
+
License: Proprietary - see LICENSE.txt
|
|
7
|
+
Project-URL: Homepage, https://getreadystack.com/tools/openapi-security-contract-lint?ref=pypi
|
|
8
|
+
Project-URL: Documentation, https://getreadystack.com/tools/openapi-security-contract-lint?ref=pypi
|
|
9
|
+
Project-URL: Support, https://getreadystack.com/support
|
|
10
|
+
Keywords: openapi,swagger,api-security,owasp-api-top-10,oauth,rfc9700,linter
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Environment :: Console
|
|
13
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Requires-Python: >=3.9
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE.txt
|
|
18
|
+
Requires-Dist: nodejs-wheel-binaries>=20
|
|
19
|
+
Dynamic: license-file
|
|
20
|
+
|
|
21
|
+
# OpenAPI Security Contract Lint
|
|
22
|
+
|
|
23
|
+
> Runs the same checker as our npm package on a Node.js runtime that pip installs for you (`nodejs-wheel-binaries`) - no system Node.js needed. Your files are checked locally.
|
|
24
|
+
|
|
25
|
+
Finds the lines in an OpenAPI file that publish an endpoint with no authentication, an API key in the query string, or an OAuth grant RFC 9700 forbids.
|
|
26
|
+
|
|
27
|
+
## Install
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
openapi-security-contract-lint file
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Node 18+. The same 18 rules as the VS Code extension, from a terminal or CI.
|
|
34
|
+
|
|
35
|
+
## Free
|
|
36
|
+
|
|
37
|
+
- Audit the OpenAPI file open in the editor against all 18 rules - every finding, every line number, every rule reference, nothing withheld
|
|
38
|
+
- `--rules` lists every rule
|
|
39
|
+
|
|
40
|
+
## With a licence ($29 once)
|
|
41
|
+
|
|
42
|
+
- Sweep every OpenAPI document in the workspace, not just the open tab, and write a dated CSV/JSON/HTML report you keep with the release as evidence
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
openapi-security-contract-lint --dir ./templates --report html --out report.html
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
An application-security consultant reading the same contract by hand bills $150-$250 an hour
|
|
49
|
+
|
|
50
|
+
## Use from an AI agent (MCP)
|
|
51
|
+
|
|
52
|
+
Claude Code · Cursor · Windsurf · any MCP client - add to your MCP config:
|
|
53
|
+
|
|
54
|
+
```json
|
|
55
|
+
{ "mcpServers": { "openapi-security-contract-lint": { "command": "openapi-security-contract-lint", "args": ["--mcp"] } } }
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Tools: `check_text` and `check_file` (free) · `check_dir` (licence). The agent gets every finding with the line number.
|
|
59
|
+
|
|
60
|
+
## Use in CI
|
|
61
|
+
|
|
62
|
+
```yaml
|
|
63
|
+
- name: OpenAPI Security Contract Lint
|
|
64
|
+
run: pip install rulestamp-openapi-security-contract-lint && openapi-security-contract-lint --dir . --ci
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
The folder sweep, reports and CI mode need one licence — one payment, no subscription. Set `READYSTACK_LICENSE=<key>` or run `--license <key>` once.
|
|
69
|
+
|
|
70
|
+
[Get a licence](https://getreadystack.com/api/buy/cl/polar_cl_nXjacvEwIBQ8xjkXZXDymfZbCc9cnushVFkc83YVTJW)
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
<!-- openapi security contract lint -->
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
## Install (PyPI)
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
pip install rulestamp-openapi-security-contract-lint
|
|
80
|
+
openapi-security-contract-lint --help
|
|
81
|
+
```
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# OpenAPI Security Contract Lint
|
|
2
|
+
|
|
3
|
+
> Runs the same checker as our npm package on a Node.js runtime that pip installs for you (`nodejs-wheel-binaries`) - no system Node.js needed. Your files are checked locally.
|
|
4
|
+
|
|
5
|
+
Finds the lines in an OpenAPI file that publish an endpoint with no authentication, an API key in the query string, or an OAuth grant RFC 9700 forbids.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
openapi-security-contract-lint file
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Node 18+. The same 18 rules as the VS Code extension, from a terminal or CI.
|
|
14
|
+
|
|
15
|
+
## Free
|
|
16
|
+
|
|
17
|
+
- Audit the OpenAPI file open in the editor against all 18 rules - every finding, every line number, every rule reference, nothing withheld
|
|
18
|
+
- `--rules` lists every rule
|
|
19
|
+
|
|
20
|
+
## With a licence ($29 once)
|
|
21
|
+
|
|
22
|
+
- Sweep every OpenAPI document in the workspace, not just the open tab, and write a dated CSV/JSON/HTML report you keep with the release as evidence
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
openapi-security-contract-lint --dir ./templates --report html --out report.html
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
An application-security consultant reading the same contract by hand bills $150-$250 an hour
|
|
29
|
+
|
|
30
|
+
## Use from an AI agent (MCP)
|
|
31
|
+
|
|
32
|
+
Claude Code · Cursor · Windsurf · any MCP client - add to your MCP config:
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{ "mcpServers": { "openapi-security-contract-lint": { "command": "openapi-security-contract-lint", "args": ["--mcp"] } } }
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Tools: `check_text` and `check_file` (free) · `check_dir` (licence). The agent gets every finding with the line number.
|
|
39
|
+
|
|
40
|
+
## Use in CI
|
|
41
|
+
|
|
42
|
+
```yaml
|
|
43
|
+
- name: OpenAPI Security Contract Lint
|
|
44
|
+
run: pip install rulestamp-openapi-security-contract-lint && openapi-security-contract-lint --dir . --ci
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
The folder sweep, reports and CI mode need one licence — one payment, no subscription. Set `READYSTACK_LICENSE=<key>` or run `--license <key>` once.
|
|
49
|
+
|
|
50
|
+
[Get a licence](https://getreadystack.com/api/buy/cl/polar_cl_nXjacvEwIBQ8xjkXZXDymfZbCc9cnushVFkc83YVTJW)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
<!-- openapi security contract lint -->
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
## Install (PyPI)
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
pip install rulestamp-openapi-security-contract-lint
|
|
60
|
+
openapi-security-contract-lint --help
|
|
61
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=68"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "rulestamp-openapi-security-contract-lint"
|
|
7
|
+
version = "1.0.6"
|
|
8
|
+
description = "Finds the lines in an OpenAPI file that publish an endpoint with no authentication, an API key in the query string, or an OAuth grant RFC 9700 forbids. (bundled Node.js runtime)"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.9"
|
|
11
|
+
dependencies = ["nodejs-wheel-binaries>=20"]
|
|
12
|
+
license = {text = "Proprietary - see LICENSE.txt"}
|
|
13
|
+
keywords = ["openapi", "swagger", "api-security", "owasp-api-top-10", "oauth", "rfc9700", "linter"]
|
|
14
|
+
authors = [{name = "Rulestamp", email = "support@getreadystack.com"}]
|
|
15
|
+
classifiers = ["Programming Language :: Python :: 3", "Environment :: Console", "Topic :: Software Development :: Quality Assurance", "Operating System :: OS Independent"]
|
|
16
|
+
|
|
17
|
+
[project.urls]
|
|
18
|
+
Homepage = "https://getreadystack.com/tools/openapi-security-contract-lint?ref=pypi"
|
|
19
|
+
Documentation = "https://getreadystack.com/tools/openapi-security-contract-lint?ref=pypi"
|
|
20
|
+
Support = "https://getreadystack.com/support"
|
|
21
|
+
|
|
22
|
+
[project.scripts]
|
|
23
|
+
"openapi-security-contract-lint" = "rulestamp_openapi_security_contract_lint.__main__:main"
|
|
24
|
+
|
|
25
|
+
[tool.setuptools.packages.find]
|
|
26
|
+
where = ["src"]
|
|
27
|
+
|
|
28
|
+
[tool.setuptools.package-data]
|
|
29
|
+
"rulestamp_openapi_security_contract_lint" = ["js/*"]
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = '1.0.6'
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import os, sys
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
def main():
|
|
5
|
+
# Runs the same checker as the npm package on the Node.js runtime installed with this package (nodejs-wheel-binaries).
|
|
6
|
+
from nodejs_wheel import node
|
|
7
|
+
here = os.path.dirname(os.path.abspath(__file__))
|
|
8
|
+
return node([os.path.join(here, "js", "cli.js")] + sys.argv[1:])
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
if __name__ == "__main__":
|
|
12
|
+
sys.exit(main())
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
// cli.js — the same rules as the VS Code extension, run from a terminal or a container. Generated by adapters.py.
|
|
3
|
+
'use strict';
|
|
4
|
+
const fs = require('fs'), path = require('path');
|
|
5
|
+
const RULES = require('./rules.json');
|
|
6
|
+
const S = require('./strings.json');
|
|
7
|
+
const lic = require('./license.js');
|
|
8
|
+
const ENGINE = require('./engine.js'); // s144 — scaffold products: the same engine the VS Code extension runs
|
|
9
|
+
const RULE_LIST = Array.isArray(ENGINE.RULES) ? ENGINE.RULES : (Array.isArray(RULES) ? RULES : []);
|
|
10
|
+
const RULE_N = ENGINE.RULE_COUNT || RULE_LIST.length;
|
|
11
|
+
function scan(text, file) {
|
|
12
|
+
const r = ENGINE.engine.check(String(text), { today: new Date().toISOString().slice(0, 10), path: file || '' });
|
|
13
|
+
return (r && r.findings || []).map((f) => ({ line: parseInt(f.line, 10) || 1, msg: String(f.msg || f.message || f.check || ''), fix: f.fix || null, sev: (String(f.sev || 'error').toLowerCase().startsWith('err') ? 'error' : 'warn') }));
|
|
14
|
+
}
|
|
15
|
+
function isText(p) { try { const b = fs.readFileSync(p); if (b.length > 2 * 1024 * 1024) return false; const s = b.subarray(0, 4096); for (const x of s) if (x === 0) return false; return true; } catch (e) { return false; } }
|
|
16
|
+
function walk(dir, exts, out) {
|
|
17
|
+
let ents = []; try { ents = fs.readdirSync(dir, { withFileTypes: true }); } catch (e) { return out; }
|
|
18
|
+
for (const e of ents) {
|
|
19
|
+
if (['node_modules', '.git', '.hg', '.svn', '.venv', 'venv', '.tox', '.cache', '.next', '.nuxt', '.terraform', '__pycache__'].includes(e.name)) continue; // s158 — .github · .gitlab-ci.yml · .env · .well-known 은 본다 (옛 줄은 점으로 시작하는 것을 전부 건너뛰어 워크플로 검사기가 .github/workflows 를 못 봤다)
|
|
20
|
+
const p = path.join(dir, e.name);
|
|
21
|
+
if (e.isDirectory()) walk(p, exts, out);
|
|
22
|
+
else if ((!exts.length || exts.includes(path.extname(e.name).toLowerCase())) && isText(p)) out.push(p);
|
|
23
|
+
}
|
|
24
|
+
return out;
|
|
25
|
+
}
|
|
26
|
+
function esc(s) { return String(s).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>'); }
|
|
27
|
+
function csvq(s) { return '"' + String(s == null ? '' : s).replace(/"/g, '""') + '"'; }
|
|
28
|
+
function render(rows, fmt) {
|
|
29
|
+
if (fmt === 'json') return JSON.stringify({ tool: S.name, rules: RULE_N, files: rows }, null, 1);
|
|
30
|
+
if (fmt === 'csv') { const o = ['file,line,severity,message,fix']; for (const r of rows) for (const h of r.hits) o.push([csvq(r.file), h.line, h.sev, csvq(h.msg), csvq(h.fix)].join(',')); return o.join('\n') + '\n'; }
|
|
31
|
+
if (fmt === 'html') {
|
|
32
|
+
const n = rows.reduce((a, r) => a + r.hits.length, 0);
|
|
33
|
+
let o = '<!doctype html><meta charset="utf-8"><title>' + esc(S.name) + ' report</title><style>body{font:14px system-ui;margin:24px}table{border-collapse:collapse}td,th{border:1px solid #ddd;padding:4px 8px;font-size:13px}code{font-family:ui-monospace,monospace}</style>';
|
|
34
|
+
o += '<h1>' + esc(S.name) + '</h1><p>' + rows.length + ' files · ' + n + ' findings · ' + RULE_N + ' rules</p><table><tr><th>file</th><th>line</th><th>sev</th><th>message</th><th>fix</th></tr>';
|
|
35
|
+
for (const r of rows) for (const h of r.hits) o += '<tr><td><code>' + esc(r.file) + '</code></td><td>' + h.line + '</td><td>' + esc(h.sev) + '</td><td>' + esc(h.msg) + '</td><td>' + esc(h.fix || '') + '</td></tr>';
|
|
36
|
+
return o + '</table>';
|
|
37
|
+
}
|
|
38
|
+
let o = ''; for (const r of rows) { o += r.file + '\n'; for (const h of r.hits) o += ' ' + String(h.line).padStart(5) + ' ' + h.sev.padEnd(5) + ' ' + h.msg + (h.fix ? '\n -> ' + h.fix : '') + '\n'; if (!r.hits.length) o += ' (no findings)\n'; }
|
|
39
|
+
return o;
|
|
40
|
+
}
|
|
41
|
+
function trialState() {
|
|
42
|
+
// s158 — ⚑7일 무료 없음: 새 체험은 ⛔열지 않는다 · 이미 시작된 체험(trial.json)만 끝까지 지킨다 (읽기 전용)
|
|
43
|
+
if (process.env.READYSTACK_NO_TRIAL) return { active: false };
|
|
44
|
+
try {
|
|
45
|
+
const p = path.join(path.dirname(lic.storePath()), S.bin + '.trial.json');
|
|
46
|
+
const t = JSON.parse(fs.readFileSync(p, 'utf8'));
|
|
47
|
+
return { active: !!(t && t.until) && new Date(t.until + 'T23:59:59Z').getTime() > Date.now(), until: t && t.until };
|
|
48
|
+
} catch (e) { return { active: false }; }
|
|
49
|
+
}
|
|
50
|
+
// ★s158 2026-09-23 — the free run SPEAKS about the rest of the folder (vsix: auto.js · crx: welcome tab).
|
|
51
|
+
// The answer for the named files is complete and free; the next step is shown with the user's OWN numbers:
|
|
52
|
+
// "this folder has N more matching files - M issues in K of them" + the one command that sweeps them.
|
|
53
|
+
// Never blocks, never starts a trial (s158: no free trial - the free answer on the named files is the "try it"), human seat only, 400 files / 1.5 s cap.
|
|
54
|
+
function folderHint(done) {
|
|
55
|
+
if (!process.stderr.isTTY || process.env.CI || process.env.READYSTACK_NO_HINT || !done.length) return;
|
|
56
|
+
const base = path.dirname(path.resolve(done[0]));
|
|
57
|
+
const seen = new Set(done.map((f) => path.resolve(f)));
|
|
58
|
+
const all = walk(base, S.exts || [], []).filter((f) => !seen.has(path.resolve(f)));
|
|
59
|
+
if (!all.length) return;
|
|
60
|
+
const t0 = Date.now(); let issues = 0, hitFiles = 0, scanned = 0;
|
|
61
|
+
for (const f of all.slice(0, 400)) { if (Date.now() - t0 > 1500) break; let t = ''; try { t = fs.readFileSync(f, 'utf8'); } catch (e) { continue; } scanned++; const h = scan(t, f); if (h.length) { issues += h.length; hitFiles++; } }
|
|
62
|
+
const rel = path.relative(process.cwd(), base) || '.';
|
|
63
|
+
const tail = trialState().active ? 'free during your trial' : '$' + S.price + ' once';
|
|
64
|
+
const more = all.length + ' more matching file' + (all.length > 1 ? 's' : '');
|
|
65
|
+
const found = issues ? ' - ' + (scanned < all.length ? 'at least ' : '') + issues + ' issue' + (issues > 1 ? 's' : '') + ' in ' + hitFiles + ' of them' : ' - no issues found in them';
|
|
66
|
+
process.stderr.write('\n' + (rel === '.' ? 'This folder' : rel) + ' has ' + more + found + '.\n' + (issues ? 'Sweep them all: ' + S.bin + ' --dir ' + (/\s/.test(rel) ? JSON.stringify(rel) : rel) + ' (' + tail + ')\n' : ''));
|
|
67
|
+
}
|
|
68
|
+
let _usePinged = false;
|
|
69
|
+
function pingUse() {
|
|
70
|
+
try {
|
|
71
|
+
if (_usePinged) return; _usePinged = true;
|
|
72
|
+
if (process.env.DO_NOT_TRACK === '1' || process.env.READYSTACK_NO_TELEMETRY || process.env.CI) return;
|
|
73
|
+
if (!(process.stdout.isTTY || process.stdin.isTTY)) return; // human seat only (s152)
|
|
74
|
+
const https = require('https');
|
|
75
|
+
const body = JSON.stringify({ t: 'use', slug: S.bin, src: 'cli', why: 'free' });
|
|
76
|
+
const req = https.request({ hostname: 'getreadystack.com', path: '/api/ev', method: 'POST', timeout: 3000,
|
|
77
|
+
headers: { 'content-type': 'application/json', 'content-length': Buffer.byteLength(body), 'user-agent': 'readystack-cli/' + S.bin } }, function (res) { res.resume(); });
|
|
78
|
+
req.on('timeout', function () { req.destroy(); }); req.on('error', function () {});
|
|
79
|
+
req.write(body); req.end();
|
|
80
|
+
} catch (e) {}
|
|
81
|
+
}
|
|
82
|
+
function mcpServe() {
|
|
83
|
+
process.env.READYSTACK_MCP = '1'; // s152 - 에이전트(Claude Code·Cursor)가 부른 세션은 사람 자리다 · 키 판 핑 src=mcp
|
|
84
|
+
// s144 — MCP server over stdio (newline-delimited JSON-RPC · no dependencies). Free: check_text · check_file. Licence (s158: no free trial): check_dir.
|
|
85
|
+
const rl = require('readline').createInterface({ input: process.stdin });
|
|
86
|
+
const send = (o) => process.stdout.write(JSON.stringify(o) + '\n');
|
|
87
|
+
const tools = [
|
|
88
|
+
{ name: 'check_text', description: S.name + ' - run all ' + RULE_N + ' checks on a text (free)', inputSchema: { type: 'object', properties: { text: { type: 'string', description: 'file contents' }, path: { type: 'string', description: 'optional file name for context' } }, required: ['text'] } },
|
|
89
|
+
{ name: 'check_file', description: S.name + ' - run all checks on one file by path (free)', inputSchema: { type: 'object', properties: { path: { type: 'string' } }, required: ['path'] } },
|
|
90
|
+
{ name: 'check_dir', description: S.name + ' - sweep a folder and return every finding (licence; $' + S.price + ' once)', inputSchema: { type: 'object', properties: { dir: { type: 'string' }, ext: { type: 'string', description: 'optional extension filter, e.g. .html' } }, required: ['dir'] } }
|
|
91
|
+
];
|
|
92
|
+
const result = (id, rows) => send({ jsonrpc: '2.0', id, result: { content: [{ type: 'text', text: render(rows, 'text') }], structuredContent: { tool: S.name, rules: RULE_N, files: rows } } });
|
|
93
|
+
const fail = (id, text) => send({ jsonrpc: '2.0', id, result: { content: [{ type: 'text', text }], isError: true } });
|
|
94
|
+
rl.on('line', async (line) => {
|
|
95
|
+
let m; try { m = JSON.parse(line); } catch (e) { return; }
|
|
96
|
+
const id = m.id, method = m.method;
|
|
97
|
+
if (method === 'initialize') return send({ jsonrpc: '2.0', id, result: { protocolVersion: '2025-06-18', capabilities: { tools: {} }, serverInfo: { name: '@readystack/' + S.bin, version: '1.0.0' } } });
|
|
98
|
+
if (method === 'notifications/initialized' || method === 'ping') { if (id !== undefined) send({ jsonrpc: '2.0', id, result: {} }); return; }
|
|
99
|
+
if (method === 'tools/list') return send({ jsonrpc: '2.0', id, result: { tools } });
|
|
100
|
+
if (method === 'tools/call') {
|
|
101
|
+
const name = (m.params || {}).name, args = (m.params || {}).arguments || {};
|
|
102
|
+
try {
|
|
103
|
+
if (name === 'check_text') return result(id, [{ file: args.path || '(text)', hits: scan(String(args.text || ''), args.path || '') }]);
|
|
104
|
+
if (name === 'check_file') return result(id, [{ file: args.path, hits: scan(fs.readFileSync(args.path, 'utf8'), args.path) }]);
|
|
105
|
+
if (name === 'check_dir') {
|
|
106
|
+
const r = await lic.ensure();
|
|
107
|
+
if (!r.ok && !trialState().active) return fail(id, S.need_key + ' Get a licence ($' + S.price + ', once): ' + lic.BUY_URL);
|
|
108
|
+
const files = walk(args.dir, args.ext ? [args.ext] : (S.exts || []), []);
|
|
109
|
+
return result(id, files.map((f) => { let t = ''; try { t = fs.readFileSync(f, 'utf8'); } catch (e) { return { file: f, hits: [], error: String(e.message) }; } return { file: f, hits: scan(t, f) }; }));
|
|
110
|
+
}
|
|
111
|
+
return send({ jsonrpc: '2.0', id, error: { code: -32601, message: 'unknown tool ' + name } });
|
|
112
|
+
} catch (e) { return fail(id, String(e && e.message || e)); }
|
|
113
|
+
}
|
|
114
|
+
if (id !== undefined) send({ jsonrpc: '2.0', id, error: { code: -32601, message: 'method not found: ' + method } });
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
function help() {
|
|
118
|
+
return [S.name + ' - ' + S.subtitle, '', 'Usage: ' + S.bin + ' <file> [more files] check the files you name (free, every rule)',
|
|
119
|
+
' ' + S.bin + ' --dir <folder> [--ext .html] scan a whole folder (licence)',
|
|
120
|
+
' ' + S.bin + ' ... --report csv|json|html [--out file] export a report (licence)',
|
|
121
|
+
' ' + S.bin + ' ... --ci exit 1 when an error-level finding exists (licence)',
|
|
122
|
+
' ' + S.bin + ' --license <key> store your licence key (or set READYSTACK_LICENSE)',
|
|
123
|
+
' ' + S.bin + ' --rules list the ' + RULE_N + ' rules',
|
|
124
|
+
' ' + S.bin + ' --mcp run as an MCP server (stdio) for Claude Code / Cursor / Windsurf - free checks, folder sweep needs a licence', '',
|
|
125
|
+
'Free: ' + S.free, 'Licence ($' + S.price + ', once): ' + S.paid, 'Get a licence: ' + lic.BUY_URL, ''].join('\n');
|
|
126
|
+
}
|
|
127
|
+
(async function main() {
|
|
128
|
+
try { const _feed = await lic.pullFeed(); if (_feed && Array.isArray(_feed.rules)) { if (Array.isArray(ENGINE.RULES)) for (const r of _feed.rules) ENGINE.RULES.push(r); } } catch (e) {} // ★s134 구독 피드 병합 (키 있는 손님만)
|
|
129
|
+
const a = process.argv.slice(2);
|
|
130
|
+
const get = (k) => { const i = a.indexOf(k); return i >= 0 ? a[i + 1] : null; };
|
|
131
|
+
if (a.includes('--mcp')) { mcpServe(); return; }
|
|
132
|
+
if (!a.length || a.includes('--help') || a.includes('-h')) { process.stdout.write(help()); return; }
|
|
133
|
+
if (a.includes('--rules')) { process.stdout.write((RULE_LIST.length ? RULE_LIST.map((r, i) => String(i + 1).padStart(3) + ' [' + (r.sev || 'warn') + '] ' + (r.message || r.msg || r.id || '')) : Array.from({ length: RULE_N }, (_, i) => String(i + 1).padStart(3) + ' [engine] check ' + (i + 1))).join('\n') + '\n'); return; }
|
|
134
|
+
if (a.includes('--license')) { const r = await lic.ensure(get('--license')); process.stdout.write(r.ok ? 'Licence stored: ' + lic.storePath() + '\n' : 'Licence not accepted (' + r.why + '). Get one: ' + lic.BUY_URL + '\n'); process.exit(r.ok ? 0 : 2); }
|
|
135
|
+
const dir = get('--dir'), fmt = get('--report'), out = get('--out'), ci = a.includes('--ci');
|
|
136
|
+
const exts = a.includes('--ext') ? [get('--ext')] : (S.exts || []);
|
|
137
|
+
const paid = !!(dir || fmt || ci);
|
|
138
|
+
if (paid) {
|
|
139
|
+
const r = await lic.ensure();
|
|
140
|
+
if (!r.ok) {
|
|
141
|
+
const t = trialState(); // s158 — ⚑7일 무료 없음 · 이미 시작된 체험만 지킨다
|
|
142
|
+
if (t.active) process.stderr.write('Trial: the full run is free until ' + t.until + ' — after that $' + S.price + ' once. Get a licence: ' + lic.BUY_URL + '\n');
|
|
143
|
+
else {
|
|
144
|
+
// s158 — the key is asked WITH the customer's own count (endowment · open loop): how many issues this folder holds.
|
|
145
|
+
let own = '';
|
|
146
|
+
if (dir) { try { const all = walk(dir, exts, []); let n = 0, k = 0, sc = 0; const t0 = Date.now();
|
|
147
|
+
for (const f of all.slice(0, 2000)) { if (Date.now() - t0 > 4000) break; let tx = ''; try { tx = fs.readFileSync(f, 'utf8'); } catch (e) { continue; } sc++; const h = scan(tx, f); if (h.length) { n += h.length; k++; } }
|
|
148
|
+
if (n) own = dir + ': ' + (sc < all.length ? 'at least ' : '') + n + ' issue' + (n > 1 ? 's' : '') + ' in ' + k + ' of ' + all.length + ' files.\n'; } catch (e) {} }
|
|
149
|
+
process.stderr.write(own + S.need_key + '\n set READYSTACK_LICENSE=<key> or ' + S.bin + ' --license <key>\n Get a licence ($' + S.price + ' once): ' + lic.BUY_URL + '\n'); process.exit(2);
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
const files = dir ? walk(dir, exts, []) : a.filter((x, i) => !x.startsWith('--') && !['--dir', '--report', '--out', '--ext', '--license'].includes(a[i - 1]));
|
|
154
|
+
if (!files.length) { process.stderr.write('No files. ' + S.bin + ' --help\n'); process.exit(2); }
|
|
155
|
+
const rows = files.map((f) => { let t = ''; try { t = fs.readFileSync(f, 'utf8'); } catch (e) { return { file: f, hits: [], error: String(e.message) }; } return { file: f, hits: scan(t) }; });
|
|
156
|
+
const text = render(rows, fmt || 'text');
|
|
157
|
+
if (out) fs.writeFileSync(out, text); else process.stdout.write(text.endsWith('\n') ? text : text + '\n');
|
|
158
|
+
if (!paid) { try { folderHint(files); } catch (e) {} pingUse(); } // s158 — a free run ends with the user's own folder count + one anonymous 'used' count (human seat only)
|
|
159
|
+
const errors = rows.reduce((n, r) => n + r.hits.filter((h) => h.sev === 'error').length, 0);
|
|
160
|
+
if (ci && errors) process.exit(1);
|
|
161
|
+
})().catch((e) => { process.stderr.write(String(e && e.stack || e) + '\n'); process.exit(3); });
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
// OpenAPI Security Contract Lint - one brain, used by the extension and by the free web page.
|
|
3
|
+
var RULES = (typeof module !== 'undefined' && module.exports) ? require('./rules.json') : window.OAS_RULES;
|
|
4
|
+
|
|
5
|
+
var BY_ID = {};
|
|
6
|
+
for (var i = 0; i < RULES.length; i++) BY_ID[RULES[i].id] = RULES[i];
|
|
7
|
+
|
|
8
|
+
function indentOf(line) { var m = line.match(/^(\s*)/); return m[1].replace(/\t/g, ' ').length; }
|
|
9
|
+
function esc(s) { return String(s).replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); }
|
|
10
|
+
|
|
11
|
+
// Collect the body lines of a block whose header sits at `line` (0-based) with indent `ind`.
|
|
12
|
+
function blockRange(lines, start, ind) {
|
|
13
|
+
var end = start + 1;
|
|
14
|
+
while (end < lines.length) {
|
|
15
|
+
var l = lines[end];
|
|
16
|
+
if (l.trim() !== '' && !/^\s*#/.test(l) && indentOf(l) <= ind) break;
|
|
17
|
+
end++;
|
|
18
|
+
}
|
|
19
|
+
return end;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
function check(text, opts) {
|
|
23
|
+
opts = opts || {};
|
|
24
|
+
var lines = String(text == null ? '' : text).split(/\r?\n/);
|
|
25
|
+
var findings = [];
|
|
26
|
+
function add(id, line, extra) {
|
|
27
|
+
var r = BY_ID[id];
|
|
28
|
+
if (!r) return;
|
|
29
|
+
findings.push({ check: id, sev: r.sev, msg: (extra ? extra + ' ' : '') + r.msg, line: line });
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
var hasPaths = false, pathsIndent = -1, pathsLine = 0;
|
|
33
|
+
var hasGlobalSecurity = false;
|
|
34
|
+
var serversSeen = false, httpsServerSeen = false;
|
|
35
|
+
var schemesStart = -1, schemesEnd = -1, schemesIndent = -1;
|
|
36
|
+
var deprecatedLines = [];
|
|
37
|
+
var sunsetSeen = /(^|[\s"'_-])sunset/i.test(text);
|
|
38
|
+
|
|
39
|
+
// ---- pass 1: structure ----
|
|
40
|
+
for (var n = 0; n < lines.length; n++) {
|
|
41
|
+
var raw = lines[n], t = raw.trim(), ind = indentOf(raw);
|
|
42
|
+
if (t === '' || t.charAt(0) === '#') continue;
|
|
43
|
+
if (ind === 0 && /^"?paths"?\s*:/.test(t)) { hasPaths = true; pathsIndent = ind; pathsLine = n + 1; }
|
|
44
|
+
if (ind === 0 && /^"?security"?\s*:/.test(t)) {
|
|
45
|
+
hasGlobalSecurity = true;
|
|
46
|
+
if (/^"?security"?\s*:\s*\[\s*\]\s*,?$/.test(t)) add('security_empty_global', n + 1);
|
|
47
|
+
}
|
|
48
|
+
if (ind === 0 && /^"?servers"?\s*:/.test(t)) serversSeen = true;
|
|
49
|
+
if (/^"?securitySchemes"?\s*:/.test(t) && schemesStart < 0) {
|
|
50
|
+
schemesStart = n; schemesIndent = ind; schemesEnd = blockRange(lines, n, ind);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
// ---- pass 2: line rules ----
|
|
55
|
+
var flowsIndent = -1, flowName = null, flowNameIndent = -1;
|
|
56
|
+
for (var n2 = 0; n2 < lines.length; n2++) {
|
|
57
|
+
var line = lines[n2], s = line.trim(), ind2 = indentOf(line), ln = n2 + 1;
|
|
58
|
+
if (s === '' || s.charAt(0) === '#') continue;
|
|
59
|
+
|
|
60
|
+
if (/^-?\s*"?url"?\s*:\s*["']?https:\/\//i.test(s)) httpsServerSeen = true;
|
|
61
|
+
if (/^-?\s*"?url"?\s*:\s*["']?http:\/\//i.test(s) && !/http:\/\/(localhost|127\.0\.0\.1|\[::1\])/i.test(s)) {
|
|
62
|
+
add('server_plaintext_http', ln);
|
|
63
|
+
}
|
|
64
|
+
if (/^"?(authorizationUrl|tokenUrl|refreshUrl)"?\s*:\s*["']?http:\/\//i.test(s) && !/http:\/\/(localhost|127\.0\.0\.1)/i.test(s)) {
|
|
65
|
+
add('oauth_url_plaintext', ln);
|
|
66
|
+
}
|
|
67
|
+
if (ind2 > 0 && /^"?security"?\s*:\s*\[\s*\]\s*,?$/.test(s)) add('security_empty_operation', ln);
|
|
68
|
+
if (/^"?in"?\s*:\s*["']?query["']?\s*,?$/.test(s) && schemesStart >= 0 && n2 > schemesStart && n2 < schemesEnd) {
|
|
69
|
+
add('apikey_in_query', ln);
|
|
70
|
+
}
|
|
71
|
+
if (/^"?scheme"?\s*:\s*["']?basic["']?\s*,?$/i.test(s) && schemesStart >= 0 && n2 > schemesStart && n2 < schemesEnd) {
|
|
72
|
+
add('basic_auth_scheme', ln);
|
|
73
|
+
}
|
|
74
|
+
if (/^"?flows"?\s*:/.test(s)) { flowsIndent = ind2; continue; }
|
|
75
|
+
if (flowsIndent >= 0) {
|
|
76
|
+
if (ind2 <= flowsIndent) { flowsIndent = -1; flowName = null; flowNameIndent = -1; }
|
|
77
|
+
else if (ind2 === flowsIndent + 2 || (flowNameIndent < 0 && ind2 > flowsIndent)) {
|
|
78
|
+
var fm = s.match(/^"?(implicit|password|clientCredentials|authorizationCode)"?\s*:/);
|
|
79
|
+
if (fm) {
|
|
80
|
+
flowName = fm[1]; flowNameIndent = ind2;
|
|
81
|
+
if (flowName === 'implicit') add('oauth_implicit_flow', ln);
|
|
82
|
+
if (flowName === 'password') add('oauth_password_flow', ln);
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
if (/^"?scopes"?\s*:\s*(\{\s*\}|)\s*,?$/.test(s)) {
|
|
87
|
+
var nx = lines[n2 + 1];
|
|
88
|
+
var emptyInline = /^"?scopes"?\s*:\s*\{\s*\}\s*,?$/.test(s);
|
|
89
|
+
var nothingUnder = !nx || nx.trim() === '' || indentOf(nx) <= ind2;
|
|
90
|
+
if (emptyInline || nothingUnder) add('oauth_scopes_empty', ln);
|
|
91
|
+
}
|
|
92
|
+
if (/^['"]?(\*|all|admin:\*|\*:\*|full_access)['"]?\s*:/.test(s) && schemesStart >= 0 && n2 > schemesStart && n2 < schemesEnd) {
|
|
93
|
+
add('scope_wildcard', ln);
|
|
94
|
+
}
|
|
95
|
+
if (/^"?additionalProperties"?\s*:\s*true\s*,?$/.test(s)) add('additional_properties_open', ln);
|
|
96
|
+
if (/^"?deprecated"?\s*:\s*true\s*,?$/.test(s)) deprecatedLines.push(ln);
|
|
97
|
+
if (/^"?\/[^\s:"']*"?\s*:\s*\{?\s*,?$/.test(s) && /\/(debug|trace|actuator|internal|_dump|_debug|env)(\/|"|:|$)/i.test(s)) {
|
|
98
|
+
add('internal_path_published', ln);
|
|
99
|
+
}
|
|
100
|
+
if (/^-?\s*"?(example|default)"?\s*:/.test(s) &&
|
|
101
|
+
/(sk_live_[A-Za-z0-9]{6,}|ghp_[A-Za-z0-9]{16,}|github_pat_[A-Za-z0-9_]{20,}|AKIA[0-9A-Z]{12,}|xox[baprs]-[A-Za-z0-9-]{8,}|eyJ[A-Za-z0-9_-]{12,}\.[A-Za-z0-9_-]{8,}|BEGIN [A-Z ]*PRIVATE KEY)/.test(s)) {
|
|
102
|
+
add('secret_in_example', ln);
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
// ---- document-level ----
|
|
107
|
+
if (hasPaths && !hasGlobalSecurity) add('no_global_security', pathsLine);
|
|
108
|
+
if (serversSeen && !httpsServerSeen) add('no_https_server', 1);
|
|
109
|
+
for (var d = 0; d < deprecatedLines.length; d++) {
|
|
110
|
+
if (!sunsetSeen) add('deprecated_without_sunset', deprecatedLines[d]);
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
// ---- unused security schemes ----
|
|
114
|
+
if (schemesStart >= 0) {
|
|
115
|
+
var names = [];
|
|
116
|
+
for (var k = schemesStart + 1; k < schemesEnd; k++) {
|
|
117
|
+
var kl = lines[k];
|
|
118
|
+
if (kl.trim() === '' || /^\s*#/.test(kl)) continue;
|
|
119
|
+
if (indentOf(kl) === schemesIndent + 2) {
|
|
120
|
+
var nm = kl.trim().match(/^"?([A-Za-z0-9_.-]+)"?\s*:/);
|
|
121
|
+
if (nm) names.push({ name: nm[1], line: k + 1 });
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
for (var q = 0; q < names.length; q++) {
|
|
125
|
+
var re = new RegExp('^-?\\s*"?' + esc(names[q].name) + '"?\\s*:');
|
|
126
|
+
var used = false;
|
|
127
|
+
for (var z = 0; z < lines.length; z++) {
|
|
128
|
+
if (z > schemesStart && z < schemesEnd) continue;
|
|
129
|
+
if (re.test(lines[z].trim())) { used = true; break; }
|
|
130
|
+
}
|
|
131
|
+
if (!used) add('scheme_defined_unused', names[q].line, 'Scheme "' + names[q].name + '":');
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
// ---- per-operation: missing 429 ----
|
|
136
|
+
if (hasPaths) {
|
|
137
|
+
for (var p = 0; p < lines.length; p++) {
|
|
138
|
+
var pl = lines[p], ps = pl.trim();
|
|
139
|
+
if (ps === '' || ps.charAt(0) === '#') continue;
|
|
140
|
+
var om = ps.match(/^"?(get|post|put|patch|delete|head|options)"?\s*:\s*\{?\s*$/i);
|
|
141
|
+
if (!om || indentOf(pl) <= pathsIndent) continue;
|
|
142
|
+
var oEnd = blockRange(lines, p, indentOf(pl));
|
|
143
|
+
var body = lines.slice(p, oEnd).join('\n');
|
|
144
|
+
if (!/^\s*"?'?429'?"?\s*:/m.test(body)) add('missing_429', p + 1, 'Operation "' + om[1].toLowerCase() + '":');
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
findings.sort(function (a, b) { return (a.line || 0) - (b.line || 0); });
|
|
149
|
+
return { findings: findings };
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
var API = { engine: { check: check }, RULES: RULES, RULE_COUNT: RULES.length };
|
|
153
|
+
if (typeof module !== 'undefined' && module.exports) module.exports = API;
|
|
154
|
+
if (typeof window !== 'undefined') window.OASENGINE = API;
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
// license.js — Polar licence check for the CLI / container. Generated by adapters.py; do not edit by hand.
|
|
2
|
+
'use strict';
|
|
3
|
+
const https = require('https'), fs = require('fs'), path = require('path'), os = require('os');
|
|
4
|
+
const ORG_ID = 'a5cdf664-d8e7-4f87-8895-056717aaba17';
|
|
5
|
+
const BENEFIT_ID = 'e0f2cfb5-81de-404f-84c3-d2398a10faf6'; // s142 — this product's Polar benefit (s140 law: ask with benefit_id, or one key opens every product)
|
|
6
|
+
const BUY_URL = 'https://getreadystack.com/api/buy/cl/polar_cl_nXjacvEwIBQ8xjkXZXDymfZbCc9cnushVFkc83YVTJW';
|
|
7
|
+
const SLUG = 'openapi-security-contract-lint';
|
|
8
|
+
const GRACE_MS = 30 * 24 * 3600 * 1000; // after a successful check, 30 days work offline
|
|
9
|
+
const RECHECK_MS = 7 * 24 * 3600 * 1000; // re-ask Polar every 7 days (refunds / cancellations)
|
|
10
|
+
function storePath() { return path.join(process.env.READYSTACK_HOME || path.join(os.homedir(), '.config', 'readystack'), SLUG + '.json'); }
|
|
11
|
+
function load() { try { return JSON.parse(fs.readFileSync(storePath(), 'utf8')); } catch (e) { return {}; } }
|
|
12
|
+
function save(o) { try { fs.mkdirSync(path.dirname(storePath()), { recursive: true }); fs.writeFileSync(storePath(), JSON.stringify(o)); } catch (e) { /* read-only home: still works for this run */ } }
|
|
13
|
+
const ALL_BENEFIT_ID = '22692551-5203-4467-b1a3-e33cdba6589d'; // s149 2026-09-17 — 팀 키(전 린터 한 키 · Polar benefit) · 상품 benefit 다음에 한 번 더 묻는다
|
|
14
|
+
// s170 2026-09-29 — ask OUR worker first (/api/lic): keys bought on Whop open here (a price-tier key binds to the first tool it opens · the team key opens every tool). Then the old Polar check.
|
|
15
|
+
function validate(key) {
|
|
16
|
+
return validateHub(key).then(function (h) {
|
|
17
|
+
if (h.ok) return h;
|
|
18
|
+
return validate1(key, BENEFIT_ID).then(function (r) { return (r.ok || r.offline || !/^[0-9a-f-]{36}$/.test(ALL_BENEFIT_ID)) ? r : validate1(key, ALL_BENEFIT_ID); })
|
|
19
|
+
.then(function (r) { return r.ok ? r : { ok: false, offline: !!(h.offline || r.offline) }; });
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
function validateHub(key) {
|
|
23
|
+
return new Promise(function (resolve) {
|
|
24
|
+
const req = https.request({ hostname: 'getreadystack.com', path: '/api/lic?key=' + encodeURIComponent(key) + '&slug=' + encodeURIComponent(SLUG),
|
|
25
|
+
method: 'GET', timeout: 8000, headers: { 'accept': 'application/json', 'user-agent': 'readystack-cli/' + SLUG } }, function (res) {
|
|
26
|
+
let buf = ''; res.on('data', function (d) { buf += d; });
|
|
27
|
+
res.on('end', function () {
|
|
28
|
+
if (res.statusCode !== 200) return resolve({ ok: false, offline: res.statusCode >= 500 });
|
|
29
|
+
try { const j = JSON.parse(buf); resolve({ ok: !!(j && j.ok), offline: false }); } catch (e) { resolve({ ok: false, offline: false }); }
|
|
30
|
+
});
|
|
31
|
+
});
|
|
32
|
+
req.on('timeout', function () { req.destroy(); resolve({ ok: false, offline: true }); });
|
|
33
|
+
req.on('error', function () { resolve({ ok: false, offline: true }); });
|
|
34
|
+
req.end();
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
function validate1(key, ben) {
|
|
38
|
+
return new Promise(function (resolve) {
|
|
39
|
+
if (!ORG_ID) return resolve({ ok: false, offline: false });
|
|
40
|
+
const body = JSON.stringify(/^[0-9a-f-]{36}$/.test(ben) ? { key: key, organization_id: ORG_ID, benefit_id: ben } : { key: key, organization_id: ORG_ID });
|
|
41
|
+
const req = https.request({ hostname: 'api.polar.sh', path: '/v1/customer-portal/license-keys/validate', method: 'POST', timeout: 8000,
|
|
42
|
+
headers: { 'content-type': 'application/json', 'polar-version': '2026-04', 'content-length': Buffer.byteLength(body) } }, function (res) {
|
|
43
|
+
let buf = ''; res.on('data', function (d) { buf += d; });
|
|
44
|
+
res.on('end', function () {
|
|
45
|
+
if (res.statusCode !== 200) return resolve({ ok: false, offline: false });
|
|
46
|
+
try { const j = JSON.parse(buf); resolve({ ok: j && (j.status === 'granted' || j.valid === true || !!j.id), offline: false }); }
|
|
47
|
+
catch (e) { resolve({ ok: false, offline: false }); }
|
|
48
|
+
});
|
|
49
|
+
});
|
|
50
|
+
req.on('timeout', function () { req.destroy(); resolve({ ok: false, offline: true }); });
|
|
51
|
+
req.on('error', function () { resolve({ ok: false, offline: true }); });
|
|
52
|
+
req.write(body); req.end();
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
// ★s151 2026-09-19 — 키 판(키가 없거나 거절된 순간)을 익명으로 센다 (슬러그·출처·이유만) · DO_NOT_TRACK=1 · READYSTACK_NO_TELEMETRY 면 안 보낸다 · 실패는 조용히 · 프로세스당 한 번.
|
|
56
|
+
let _pinged = false;
|
|
57
|
+
function pingPaywall(why) {
|
|
58
|
+
try {
|
|
59
|
+
if (_pinged) return; _pinged = true;
|
|
60
|
+
if (process.env.DO_NOT_TRACK === '1' || process.env.READYSTACK_NO_TELEMETRY || process.env.CI) return; // s151: CI(깃허브 액션 등)와 우리 빌드는 손님이 아니다
|
|
61
|
+
if (!(process.stdout.isTTY || process.stdin.isTTY || process.env.READYSTACK_MCP === '1')) return; // s152: 사람 자리(터미널·MCP 세션)에서만 센다 - 발행 1분 뒤 남의 실행기(JP · 우리 3대는 US)가 돌린 no_key 13건은 손님이 아니다
|
|
62
|
+
const body = JSON.stringify({ t: 'paywall', slug: SLUG, src: process.env.READYSTACK_MCP === '1' ? 'mcp' : 'cli', why: why || 'no_key' });
|
|
63
|
+
const req = https.request({ hostname: 'getreadystack.com', path: '/api/ev', method: 'POST', timeout: 3000,
|
|
64
|
+
headers: { 'content-type': 'application/json', 'content-length': Buffer.byteLength(body), 'user-agent': 'readystack-cli/' + SLUG } }, function (res) { res.resume(); });
|
|
65
|
+
req.on('timeout', function () { req.destroy(); }); req.on('error', function () {});
|
|
66
|
+
req.write(body); req.end();
|
|
67
|
+
} catch (e) { /* 세는 것이 실패해도 상품은 돈다 */ }
|
|
68
|
+
}
|
|
69
|
+
async function ensure(explicitKey) {
|
|
70
|
+
const st = load();
|
|
71
|
+
const key = explicitKey || process.env.READYSTACK_LICENSE || st.key;
|
|
72
|
+
if (!key) { pingPaywall('no_key'); return { ok: false, why: 'no_key' }; } // s151
|
|
73
|
+
const age = Date.now() - (st.okAt || 0);
|
|
74
|
+
if (!explicitKey && st.key === key && age < RECHECK_MS) return { ok: true, cached: true };
|
|
75
|
+
const r = await validate(String(key).trim());
|
|
76
|
+
if (r.ok) { save({ key: String(key).trim(), okAt: Date.now() }); return { ok: true }; }
|
|
77
|
+
if (r.offline && st.key === key && age < GRACE_MS) return { ok: true, offline: true };
|
|
78
|
+
if (!r.offline) pingPaywall('invalid'); // s151
|
|
79
|
+
return { ok: false, why: r.offline ? 'offline' : 'invalid' };
|
|
80
|
+
}
|
|
81
|
+
// ★s134 — 구독 규칙 피드(층3 "바뀌면 업데이트"): 키 있는 손님만 · 7일마다 · 오프라인은 캐시. 워커 GET /api/rules/<slug>?key=
|
|
82
|
+
const FEED_URL = 'https://getreadystack.com/api/rules/';
|
|
83
|
+
function pullFeed() {
|
|
84
|
+
const st = load(); const key = process.env.READYSTACK_LICENSE || st.key; const cached = st.feed || null;
|
|
85
|
+
if (!key) return Promise.resolve(cached);
|
|
86
|
+
if (cached && (Date.now() - (st.feedAt || 0)) < RECHECK_MS) return Promise.resolve(cached);
|
|
87
|
+
return new Promise(function (resolve) {
|
|
88
|
+
let req;
|
|
89
|
+
try {
|
|
90
|
+
req = https.get(FEED_URL + encodeURIComponent(SLUG) + '?key=' + encodeURIComponent(key), { timeout: 8000, headers: { 'user-agent': 'readystack-cli' } }, function (res) {
|
|
91
|
+
let buf = ''; res.on('data', function (d) { buf += d; });
|
|
92
|
+
res.on('end', function () {
|
|
93
|
+
if (res.statusCode !== 200) return resolve(cached);
|
|
94
|
+
try { const j = JSON.parse(buf); if (!j || !Array.isArray(j.rules)) return resolve(cached); save(Object.assign(load(), { feed: j, feedAt: Date.now() })); resolve(j); }
|
|
95
|
+
catch (e) { resolve(cached); }
|
|
96
|
+
});
|
|
97
|
+
});
|
|
98
|
+
} catch (e) { return resolve(cached); }
|
|
99
|
+
req.on('timeout', function () { req.destroy(); resolve(cached); });
|
|
100
|
+
req.on('error', function () { resolve(cached); });
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
module.exports = { ensure, BUY_URL, storePath, pullFeed };
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@readystack/openapi-security-contract-lint",
|
|
3
|
+
"version": "1.0.6",
|
|
4
|
+
"description": "Finds the lines in an OpenAPI file that publish an endpoint with no authentication, an API key in the query string, or an OAuth grant RFC 9700 forbids.",
|
|
5
|
+
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
|
+
"publishConfig": {
|
|
7
|
+
"access": "public"
|
|
8
|
+
},
|
|
9
|
+
"keywords": [
|
|
10
|
+
"openapi",
|
|
11
|
+
"swagger",
|
|
12
|
+
"api-security",
|
|
13
|
+
"owasp-api-top-10",
|
|
14
|
+
"oauth",
|
|
15
|
+
"rfc9700",
|
|
16
|
+
"linter"
|
|
17
|
+
],
|
|
18
|
+
"homepage": "https://getreadystack.com",
|
|
19
|
+
"funding": "https://getreadystack.com/api/buy/cl/polar_cl_nXjacvEwIBQ8xjkXZXDymfZbCc9cnushVFkc83YVTJW",
|
|
20
|
+
"bin": {
|
|
21
|
+
"openapi-security-contract-lint": "cli.js"
|
|
22
|
+
},
|
|
23
|
+
"engines": {
|
|
24
|
+
"node": ">=18"
|
|
25
|
+
},
|
|
26
|
+
"mcpName": "io.github.jmshinhwa/openapi-security-contract-lint",
|
|
27
|
+
"repository": {
|
|
28
|
+
"type": "git",
|
|
29
|
+
"url": "https://github.com/jmshinhwa/readystack-themes.git",
|
|
30
|
+
"directory": "openapi-security-contract-lint"
|
|
31
|
+
},
|
|
32
|
+
"files": [
|
|
33
|
+
"cli.js",
|
|
34
|
+
"license.js",
|
|
35
|
+
"rules.json",
|
|
36
|
+
"strings.json",
|
|
37
|
+
"README.md",
|
|
38
|
+
"LICENSE.txt",
|
|
39
|
+
"engine.js"
|
|
40
|
+
]
|
|
41
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"id": "security_empty_operation",
|
|
4
|
+
"sev": "error",
|
|
5
|
+
"msg": "security: [] on an operation means \"no authentication required\". A gateway that imports this spec publishes the endpoint open.",
|
|
6
|
+
"ref": "OWASP API Security Top 10 2023 - API1 / API5"
|
|
7
|
+
},
|
|
8
|
+
{
|
|
9
|
+
"id": "security_empty_global",
|
|
10
|
+
"sev": "error",
|
|
11
|
+
"msg": "Top-level security: [] declares the whole API public. Every operation that does not override it is unauthenticated.",
|
|
12
|
+
"ref": "OWASP API Security Top 10 2023 - API5"
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"id": "no_global_security",
|
|
16
|
+
"sev": "warning",
|
|
17
|
+
"msg": "This document has paths but no top-level security block. Authentication is then opt-in per operation, so any operation you forget ships open.",
|
|
18
|
+
"ref": "OpenAPI 3.1 section 4.8.1 - Security Requirement Object"
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"id": "apikey_in_query",
|
|
22
|
+
"sev": "error",
|
|
23
|
+
"msg": "An apiKey carried in the query string is written to proxy logs, browser history and Referer headers. Move it to a header.",
|
|
24
|
+
"ref": "OWASP API Security Top 10 2023 - API2"
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"id": "oauth_implicit_flow",
|
|
28
|
+
"sev": "error",
|
|
29
|
+
"msg": "The OAuth 2.0 implicit grant returns the token in the URL fragment. RFC 9700 (BCP 240, January 2025) says clients MUST NOT use it.",
|
|
30
|
+
"ref": "RFC 9700 section 2.1.2"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"id": "oauth_password_flow",
|
|
34
|
+
"sev": "error",
|
|
35
|
+
"msg": "The resource owner password credentials grant hands the user's password to the client. RFC 9700 (BCP 240, January 2025) says it MUST NOT be used.",
|
|
36
|
+
"ref": "RFC 9700 section 2.4"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"id": "oauth_url_plaintext",
|
|
40
|
+
"sev": "error",
|
|
41
|
+
"msg": "An OAuth endpoint reached over http:// exposes the authorization code or token to anyone on the path.",
|
|
42
|
+
"ref": "RFC 9700 section 2.6"
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"id": "server_plaintext_http",
|
|
46
|
+
"sev": "error",
|
|
47
|
+
"msg": "A server entry on http:// tells every generated client and gateway to send credentials in the clear.",
|
|
48
|
+
"ref": "OWASP API Security Top 10 2023 - API8"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"id": "no_https_server",
|
|
52
|
+
"sev": "warning",
|
|
53
|
+
"msg": "No server in this document uses https://. There is no transport-secured base URL for a generated client to pick.",
|
|
54
|
+
"ref": "OWASP API Security Top 10 2023 - API8"
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"id": "basic_auth_scheme",
|
|
58
|
+
"sev": "warning",
|
|
59
|
+
"msg": "HTTP Basic replays a static credential on every call, so it cannot be revoked per session and shows up in memory dumps and logs.",
|
|
60
|
+
"ref": "OWASP API Security Top 10 2023 - API2"
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"id": "oauth_scopes_empty",
|
|
64
|
+
"sev": "warning",
|
|
65
|
+
"msg": "An OAuth flow with no scopes issues one all-or-nothing token, so a read client holds write rights.",
|
|
66
|
+
"ref": "OWASP API Security Top 10 2023 - API5"
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"id": "scope_wildcard",
|
|
70
|
+
"sev": "warning",
|
|
71
|
+
"msg": "A wildcard or catch-all scope defeats the point of scopes: every token that asks for it gets the whole API.",
|
|
72
|
+
"ref": "OWASP API Security Top 10 2023 - API5"
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"id": "scheme_defined_unused",
|
|
76
|
+
"sev": "warning",
|
|
77
|
+
"msg": "This security scheme is defined but never referenced by any security block, so nothing in the document actually requires it.",
|
|
78
|
+
"ref": "OpenAPI 3.1 section 4.8.1"
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"id": "missing_429",
|
|
82
|
+
"sev": "warning",
|
|
83
|
+
"msg": "This operation documents no 429 response, so generated clients and the gateway have no agreed throttling contract.",
|
|
84
|
+
"ref": "OWASP API Security Top 10 2023 - API4"
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"id": "additional_properties_open",
|
|
88
|
+
"sev": "warning",
|
|
89
|
+
"msg": "additionalProperties: true on a request schema lets a caller post fields you never declared - the classic mass-assignment route.",
|
|
90
|
+
"ref": "OWASP API Security Top 10 2023 - API6"
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"id": "deprecated_without_sunset",
|
|
94
|
+
"sev": "warning",
|
|
95
|
+
"msg": "An operation is marked deprecated but the document names no sunset date, so callers have no removal date to plan against.",
|
|
96
|
+
"ref": "RFC 8594 - The Sunset HTTP Header Field"
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"id": "internal_path_published",
|
|
100
|
+
"sev": "warning",
|
|
101
|
+
"msg": "A debug, trace or actuator path is published in the same document you hand to external callers.",
|
|
102
|
+
"ref": "OWASP API Security Top 10 2023 - API9"
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"id": "secret_in_example",
|
|
106
|
+
"sev": "error",
|
|
107
|
+
"msg": "This example or default value carries a live-looking credential. Examples are copied into docs, SDKs and test fixtures.",
|
|
108
|
+
"ref": "OWASP API Security Top 10 2023 - API8"
|
|
109
|
+
}
|
|
110
|
+
]
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "OpenAPI Security Contract Lint",
|
|
3
|
+
"subtitle": "Finds the lines in an OpenAPI file that publish an endpoint with no authentication, an API key in the query string, or an OAuth grant RFC 9700 forbids.",
|
|
4
|
+
"bin": "openapi-security-contract-lint",
|
|
5
|
+
"price": 29,
|
|
6
|
+
"free": "Audit the OpenAPI file open in the editor against all 18 rules - every finding, every line number, every rule reference, nothing withheld",
|
|
7
|
+
"paid": "Sweep every OpenAPI document in the workspace, not just the open tab, and write a dated CSV/JSON/HTML report you keep with the release as evidence",
|
|
8
|
+
"need_key": "This option needs a licence (OpenAPI Security Contract Lint).",
|
|
9
|
+
"exts": []
|
|
10
|
+
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: rulestamp-openapi-security-contract-lint
|
|
3
|
+
Version: 1.0.6
|
|
4
|
+
Summary: Finds the lines in an OpenAPI file that publish an endpoint with no authentication, an API key in the query string, or an OAuth grant RFC 9700 forbids. (bundled Node.js runtime)
|
|
5
|
+
Author-email: Rulestamp <support@getreadystack.com>
|
|
6
|
+
License: Proprietary - see LICENSE.txt
|
|
7
|
+
Project-URL: Homepage, https://getreadystack.com/tools/openapi-security-contract-lint?ref=pypi
|
|
8
|
+
Project-URL: Documentation, https://getreadystack.com/tools/openapi-security-contract-lint?ref=pypi
|
|
9
|
+
Project-URL: Support, https://getreadystack.com/support
|
|
10
|
+
Keywords: openapi,swagger,api-security,owasp-api-top-10,oauth,rfc9700,linter
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Environment :: Console
|
|
13
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Requires-Python: >=3.9
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE.txt
|
|
18
|
+
Requires-Dist: nodejs-wheel-binaries>=20
|
|
19
|
+
Dynamic: license-file
|
|
20
|
+
|
|
21
|
+
# OpenAPI Security Contract Lint
|
|
22
|
+
|
|
23
|
+
> Runs the same checker as our npm package on a Node.js runtime that pip installs for you (`nodejs-wheel-binaries`) - no system Node.js needed. Your files are checked locally.
|
|
24
|
+
|
|
25
|
+
Finds the lines in an OpenAPI file that publish an endpoint with no authentication, an API key in the query string, or an OAuth grant RFC 9700 forbids.
|
|
26
|
+
|
|
27
|
+
## Install
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
openapi-security-contract-lint file
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Node 18+. The same 18 rules as the VS Code extension, from a terminal or CI.
|
|
34
|
+
|
|
35
|
+
## Free
|
|
36
|
+
|
|
37
|
+
- Audit the OpenAPI file open in the editor against all 18 rules - every finding, every line number, every rule reference, nothing withheld
|
|
38
|
+
- `--rules` lists every rule
|
|
39
|
+
|
|
40
|
+
## With a licence ($29 once)
|
|
41
|
+
|
|
42
|
+
- Sweep every OpenAPI document in the workspace, not just the open tab, and write a dated CSV/JSON/HTML report you keep with the release as evidence
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
openapi-security-contract-lint --dir ./templates --report html --out report.html
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
An application-security consultant reading the same contract by hand bills $150-$250 an hour
|
|
49
|
+
|
|
50
|
+
## Use from an AI agent (MCP)
|
|
51
|
+
|
|
52
|
+
Claude Code · Cursor · Windsurf · any MCP client - add to your MCP config:
|
|
53
|
+
|
|
54
|
+
```json
|
|
55
|
+
{ "mcpServers": { "openapi-security-contract-lint": { "command": "openapi-security-contract-lint", "args": ["--mcp"] } } }
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Tools: `check_text` and `check_file` (free) · `check_dir` (licence). The agent gets every finding with the line number.
|
|
59
|
+
|
|
60
|
+
## Use in CI
|
|
61
|
+
|
|
62
|
+
```yaml
|
|
63
|
+
- name: OpenAPI Security Contract Lint
|
|
64
|
+
run: pip install rulestamp-openapi-security-contract-lint && openapi-security-contract-lint --dir . --ci
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
The folder sweep, reports and CI mode need one licence — one payment, no subscription. Set `READYSTACK_LICENSE=<key>` or run `--license <key>` once.
|
|
69
|
+
|
|
70
|
+
[Get a licence](https://getreadystack.com/api/buy/cl/polar_cl_nXjacvEwIBQ8xjkXZXDymfZbCc9cnushVFkc83YVTJW)
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
<!-- openapi security contract lint -->
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
## Install (PyPI)
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
pip install rulestamp-openapi-security-contract-lint
|
|
80
|
+
openapi-security-contract-lint --help
|
|
81
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
LICENSE.txt
|
|
2
|
+
README.md
|
|
3
|
+
pyproject.toml
|
|
4
|
+
src/rulestamp_openapi_security_contract_lint/__init__.py
|
|
5
|
+
src/rulestamp_openapi_security_contract_lint/__main__.py
|
|
6
|
+
src/rulestamp_openapi_security_contract_lint.egg-info/PKG-INFO
|
|
7
|
+
src/rulestamp_openapi_security_contract_lint.egg-info/SOURCES.txt
|
|
8
|
+
src/rulestamp_openapi_security_contract_lint.egg-info/dependency_links.txt
|
|
9
|
+
src/rulestamp_openapi_security_contract_lint.egg-info/entry_points.txt
|
|
10
|
+
src/rulestamp_openapi_security_contract_lint.egg-info/requires.txt
|
|
11
|
+
src/rulestamp_openapi_security_contract_lint.egg-info/top_level.txt
|
|
12
|
+
src/rulestamp_openapi_security_contract_lint/js/cli.js
|
|
13
|
+
src/rulestamp_openapi_security_contract_lint/js/engine.js
|
|
14
|
+
src/rulestamp_openapi_security_contract_lint/js/license.js
|
|
15
|
+
src/rulestamp_openapi_security_contract_lint/js/package.json
|
|
16
|
+
src/rulestamp_openapi_security_contract_lint/js/rules.json
|
|
17
|
+
src/rulestamp_openapi_security_contract_lint/js/strings.json
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
nodejs-wheel-binaries>=20
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
rulestamp_openapi_security_contract_lint
|