kxco-pq-scan 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,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,139 @@
1
+ # kxco-pq-scan
2
+
3
+ [![npm](https://img.shields.io/npm/v/kxco-pq-scan?label=npm&color=b0964f)](https://www.npmjs.com/package/kxco-pq-scan)
4
+ [![license](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
5
+ [![node](https://img.shields.io/node/v/kxco-pq-scan.svg)](https://nodejs.org)
6
+
7
+ Find the cryptography in your dependency tree that a quantum computer breaks.
8
+
9
+ ```
10
+ npx kxco-pq-scan
11
+ ```
12
+
13
+ No install, no account, no upload. It reads `package-lock.json` on your machine
14
+ and prints what it finds.
15
+
16
+ ## What it actually tells you
17
+
18
+ ```
19
+ typical-app: 25 packages installed
20
+
21
+ QUANTUM-VULNERABLE (6)
22
+ elliptic@6.6.1 ECDSA, ECDH
23
+ pulled in by: (root)
24
+ jws@4.0.1 RSA, ECDSA
25
+ pulled in by: jsonwebtoken
26
+ ecdsa-sig-formatter@1.0.11 ECDSA
27
+ pulled in by: jwa
28
+ ...
29
+
30
+ NOT AFFECTED, symmetric and hashing (2)
31
+ bcryptjs, hash.js
32
+ ```
33
+
34
+ Two things there are the point.
35
+
36
+ **It names who pulled each one in.** Classical cryptography is nearly always
37
+ transitive. You did not choose `ecdsa-sig-formatter`; `jsonwebtoken` did, three
38
+ levels down. Knowing that is the difference between a finding you can act on and
39
+ a list you file.
40
+
41
+ **It refuses to pad the count.** AES and SHA-2 are not broken by a quantum
42
+ computer. Grover's algorithm halves the effective key length and nothing else,
43
+ so AES-256 stands at 128 bits and is fine. They are named so you can see they
44
+ were considered, and kept out of the findings so the findings mean something.
45
+
46
+ ## Hybrids are not findings
47
+
48
+ The current advice from NIST and the IETF is to migrate through hybrids: a
49
+ post-quantum algorithm paired with a classical one, so a break in either leaves
50
+ you standing. A scanner that reports the classical half as a vulnerability is
51
+ telling you to undo the recommended migration.
52
+
53
+ This one recognises two cases and marks them for review rather than as broken:
54
+ a package that declares the pairing, and a classical library reachable only
55
+ through post-quantum packages, where no consumer depends on the classical part.
56
+
57
+ ```
58
+ WORTH A LOOK, PROBABLY FINE (1)
59
+ @noble/curves@2.3.0 ECDSA, ECDH, Ed25519, X25519
60
+ reached only through post-quantum packages (@noble/post-quantum,
61
+ kxco-pq-tls), so this is likely the classical half of a hybrid
62
+ ```
63
+
64
+ ## In CI
65
+
66
+ ```yaml
67
+ - run: npx kxco-pq-scan --strict
68
+ ```
69
+
70
+ Exit `0` when there is nothing to act on, `1` on findings, `2` when it could not
71
+ scan. `--strict` also fails on the review cases, for a policy that wants a human
72
+ to sign off on every hybrid.
73
+
74
+ ## As a library
75
+
76
+ ```js
77
+ import { scan } from 'kxco-pq-scan'
78
+
79
+ const { findings, pq, reduced, total } = scan('.')
80
+ ```
81
+
82
+ `scan()` returns the same data the CLI prints. `--json` gives you it from the
83
+ command line.
84
+
85
+ ## What it cannot see
86
+
87
+ Stated here rather than left for you to discover:
88
+
89
+ - Cryptography inside a native addon or WebAssembly module
90
+ - A library loaded through a computed `require()` or a dynamic import
91
+ - **Which algorithm your code actually selects**, where a package offers
92
+ several. `jsonwebtoken` signing with `HS256` is HMAC and is fine; the same
93
+ package signing with `RS256` is not. No static read of a lock file can tell
94
+ those apart, so the package is reported and the note says so
95
+ - Anything outside the JavaScript tree: your TLS terminator, your database
96
+ driver, the certificate on your load balancer
97
+
98
+ It reads a lock file rather than `package.json` on purpose, because the lock
99
+ file records what was installed rather than what was asked for, and the
100
+ classical cryptography is nearly always transitive.
101
+
102
+ Somewhere to start looking. Not an inventory.
103
+
104
+ ## What to do with a finding
105
+
106
+ There may be nothing to upgrade to. That is the ordinary case rather than the
107
+ exception, and it is why a scan is the start of the work: for a great many
108
+ libraries the post-quantum replacement has not been written, and somebody
109
+ upstream has to write it.
110
+
111
+ Where you have to build the replacement yourself, the primitives are in
112
+ [`kxco-post-quantum`](https://www.npmjs.com/package/kxco-post-quantum):
113
+ ML-KEM-768/1024, ML-DSA-65/87 and SLH-DSA-SHA2-192s, on the OpenSSL 3.5
114
+ primitives where the runtime provides them.
115
+
116
+ | Instead of | Look at |
117
+ |---|---|
118
+ | HMAC or RSA-signed webhooks | [`kxco-post-quantum-webhook`](https://www.npmjs.com/package/kxco-post-quantum-webhook) |
119
+ | An ECDH-secured channel | [`kxco-pq-tls`](https://www.npmjs.com/package/kxco-pq-tls), ML-KEM-768 with X25519 |
120
+ | RSA or ECDSA document signing | [`kxco-pq-attest`](https://www.npmjs.com/package/kxco-pq-attest) |
121
+ | Keys in an HSM | [`kxco-pq-hsm`](https://www.npmjs.com/package/kxco-pq-hsm) |
122
+
123
+ ## The catalogue
124
+
125
+ Classification is a curated list, not a guess from the package name, because
126
+ the name carries no signal: `@noble/curves` is elliptic-curve and breaks,
127
+ `@noble/ciphers` is AES and does not. It is a plain object in
128
+ [`src/catalogue.js`](./src/catalogue.js) — read it, disagree with it, open a
129
+ pull request.
130
+
131
+ Missing a package you depend on? That is a bug worth reporting.
132
+
133
+ ## License
134
+
135
+ Apache-2.0 © 2026 KXCO by Knightsbridge
136
+
137
+ ## Maintainers
138
+
139
+ Shayne Heffernan · John Heffernan — [KXCO by Knightsbridge](https://kxco.ai)
@@ -0,0 +1,83 @@
1
+ #!/usr/bin/env node
2
+ import { scan } from '../src/index.js'
3
+
4
+ const args = process.argv.slice(2)
5
+ if (args.includes('-h') || args.includes('--help')) {
6
+ console.log(`kxco-pq-scan [dir] [--json] [--strict]
7
+
8
+ Reads package-lock.json in <dir> (default: the current directory) and reports
9
+ which of your dependencies use cryptography a quantum computer breaks.
10
+
11
+ --json machine-readable output
12
+ --strict exit 1 on anything needing review, not only on broken findings
13
+
14
+ Exit codes: 0 nothing to act on, 1 findings, 2 could not scan.`)
15
+ process.exit(0)
16
+ }
17
+
18
+ const json = args.includes('--json')
19
+ const strict = args.includes('--strict')
20
+ const dir = args.find((a) => !a.startsWith('-')) ?? process.cwd()
21
+
22
+ let result
23
+ try {
24
+ result = scan(dir)
25
+ } catch (e) {
26
+ if (json) console.log(JSON.stringify({ ok: false, code: e.code, error: e.message }, null, 2))
27
+ else console.error(`kxco-pq-scan: ${e.message}`)
28
+ process.exit(2)
29
+ }
30
+
31
+ if (json) {
32
+ console.log(JSON.stringify({ ok: true, ...result }, null, 2))
33
+ } else {
34
+ const broken = result.findings.filter((f) => f.severity === 'broken')
35
+ const review = result.findings.filter((f) => f.severity === 'review')
36
+
37
+ console.log(`\n ${result.root}: ${result.total} packages installed\n`)
38
+
39
+ if (broken.length) {
40
+ console.log(` QUANTUM-VULNERABLE (${broken.length})`)
41
+ for (const f of broken) {
42
+ console.log(` ${f.name}@${f.version} ${f.algorithms.join(', ')}`)
43
+ console.log(` pulled in by: ${f.dependents.join(', ') || 'your package directly'}`)
44
+ if (f.note) console.log(` note: ${f.note}`)
45
+ }
46
+ console.log('')
47
+ }
48
+
49
+ if (review.length) {
50
+ console.log(` WORTH A LOOK, PROBABLY FINE (${review.length})`)
51
+ for (const f of review) {
52
+ console.log(` ${f.name}@${f.version} ${f.algorithms.join(', ')}`)
53
+ console.log(` ${f.context}`)
54
+ }
55
+ console.log('')
56
+ }
57
+
58
+ if (result.pq.length) {
59
+ console.log(` ALREADY POST-QUANTUM (${result.pq.length})`)
60
+ for (const p of result.pq) console.log(` ${p.name}@${p.version} ${p.algorithms.join(', ')}`)
61
+ console.log('')
62
+ }
63
+
64
+ if (result.reduced.length) {
65
+ // Named, not counted as findings. Grover halves the effective key length
66
+ // and nothing more, so AES-256 and SHA-2 are not a migration problem, and
67
+ // a scanner that lists them as one trains its reader to ignore it.
68
+ console.log(` NOT AFFECTED, symmetric and hashing (${result.reduced.length})`)
69
+ console.log(` ${result.reduced.map((r) => r.name).join(', ')}\n`)
70
+ }
71
+
72
+ if (!broken.length && !review.length) {
73
+ console.log(' No quantum-vulnerable cryptography found in the dependency tree.\n')
74
+ }
75
+
76
+ console.log(' This reads a lock file. It cannot see cryptography in native addons or')
77
+ console.log(' WebAssembly, behind a dynamic import, or which algorithm your code picks')
78
+ console.log(' at runtime where a package offers several. Somewhere to start, not an inventory.\n')
79
+ }
80
+
81
+ const fail = result.findings.some((f) => f.severity === 'broken') ||
82
+ (strict && result.findings.length > 0)
83
+ process.exit(fail ? 1 : 0)
package/package.json ADDED
@@ -0,0 +1,51 @@
1
+ {
2
+ "name": "kxco-pq-scan",
3
+ "version": "1.0.0",
4
+ "description": "Find quantum-vulnerable cryptography in a JavaScript dependency tree. Separates what Shor's algorithm breaks from what Grover's only weakens, recognises hybrid constructions, and says what it cannot see.",
5
+ "keywords": [
6
+ "post-quantum",
7
+ "pqc",
8
+ "quantum",
9
+ "cryptography",
10
+ "dependency",
11
+ "audit",
12
+ "supply-chain",
13
+ "migration",
14
+ "sbom",
15
+ "ml-kem",
16
+ "ml-dsa"
17
+ ],
18
+ "type": "module",
19
+ "exports": {
20
+ ".": {
21
+ "types": "./src/index.d.ts",
22
+ "import": "./src/index.js"
23
+ }
24
+ },
25
+ "bin": {
26
+ "kxco-pq-scan": "./bin/kxco-pq-scan.js"
27
+ },
28
+ "files": [
29
+ "src",
30
+ "bin",
31
+ "README.md",
32
+ "LICENSE"
33
+ ],
34
+ "scripts": {
35
+ "test": "node --test test/scan.test.js"
36
+ },
37
+ "engines": {
38
+ "node": ">=20.19"
39
+ },
40
+ "license": "Apache-2.0",
41
+ "author": "KXCO by Knightsbridge",
42
+ "repository": {
43
+ "type": "git",
44
+ "url": "git+https://github.com/KnightsbridgeAIQ/kxco-pq-scan.git"
45
+ },
46
+ "homepage": "https://kxco.ai",
47
+ "publishConfig": {
48
+ "access": "public",
49
+ "provenance": true
50
+ }
51
+ }
@@ -0,0 +1,81 @@
1
+ // What a package brings to a dependency tree, cryptographically.
2
+ //
3
+ // Curated by hand rather than guessed from names, because the naming gives no
4
+ // signal: `@noble/curves` is elliptic-curve and quantum-vulnerable, while
5
+ // `@noble/ciphers` is AES and ChaCha and is not. A scanner that matched on
6
+ // "crypto" in the name would report both, and be wrong half the time.
7
+ //
8
+ // Three classifications, and the middle one is the one most tools get wrong.
9
+ //
10
+ // 'broken' Shor's algorithm breaks it outright. RSA, finite-field
11
+ // Diffie-Hellman, and everything on an elliptic curve,
12
+ // including Ed25519 and X25519.
13
+ //
14
+ // 'reduced' Grover's algorithm halves the effective key length and
15
+ // nothing else. AES-256 stays at 128 bits, which is fine.
16
+ // SHA-2 and SHA-3 likewise. These are NOT findings, and
17
+ // reporting them as such is how a scan loses its reader.
18
+ //
19
+ // 'pq' ML-KEM, ML-DSA, SLH-DSA. The replacement.
20
+ //
21
+ // A package can be more than one. `libsodium-wrappers` ships Ed25519 and
22
+ // XChaCha20 in the same box.
23
+
24
+ export const CATALOGUE = {
25
+ // --- elliptic curve and RSA: broken -------------------------------------
26
+ 'elliptic': { classes: ['broken'], algorithms: ['ECDSA', 'ECDH'] },
27
+ 'secp256k1': { classes: ['broken'], algorithms: ['ECDSA'] },
28
+ '@noble/secp256k1': { classes: ['broken'], algorithms: ['ECDSA'] },
29
+ '@noble/ed25519': { classes: ['broken'], algorithms: ['Ed25519'] },
30
+ '@noble/curves': { classes: ['broken'], algorithms: ['ECDSA', 'ECDH', 'Ed25519', 'X25519'] },
31
+ 'node-forge': { classes: ['broken', 'reduced'], algorithms: ['RSA', 'ECDSA', 'AES'] },
32
+ 'jsrsasign': { classes: ['broken', 'reduced'], algorithms: ['RSA', 'ECDSA', 'AES'] },
33
+ 'sshpk': { classes: ['broken'], algorithms: ['RSA', 'ECDSA', 'Ed25519'] },
34
+ 'tweetnacl': { classes: ['broken', 'reduced'], algorithms: ['Ed25519', 'X25519', 'Salsa20'] },
35
+ 'libsodium-wrappers': { classes: ['broken', 'reduced'], algorithms: ['Ed25519', 'X25519', 'XChaCha20'] },
36
+ 'libsodium': { classes: ['broken', 'reduced'], algorithms: ['Ed25519', 'X25519', 'XChaCha20'] },
37
+ 'eciesjs': { classes: ['broken'], algorithms: ['ECIES'] },
38
+ 'ecdsa-sig-formatter': { classes: ['broken'], algorithms: ['ECDSA'] },
39
+ 'jsonwebtoken': { classes: ['broken'], algorithms: ['RSA', 'ECDSA'],
40
+ note: 'only when signing with RS*, PS* or ES*; HS* is HMAC and is not broken' },
41
+ 'jose': { classes: ['broken'], algorithms: ['RSA', 'ECDSA', 'ECDH-ES'],
42
+ note: 'depends which JWA the caller selects' },
43
+ 'node-jose': { classes: ['broken'], algorithms: ['RSA', 'ECDSA'] },
44
+ 'jwa': { classes: ['broken'], algorithms: ['RSA', 'ECDSA'] },
45
+ 'jws': { classes: ['broken'], algorithms: ['RSA', 'ECDSA'] },
46
+ 'ethers': { classes: ['broken'], algorithms: ['ECDSA secp256k1'] },
47
+ 'web3': { classes: ['broken'], algorithms: ['ECDSA secp256k1'] },
48
+ 'bitcoinjs-lib': { classes: ['broken'], algorithms: ['ECDSA secp256k1'] },
49
+ '@peculiar/webcrypto': { classes: ['broken', 'reduced'], algorithms: ['RSA', 'ECDSA', 'AES'] },
50
+ 'crypto-js': { classes: ['reduced'], algorithms: ['AES', 'SHA-2'],
51
+ note: 'symmetric only, but unmaintained and worth replacing on other grounds' },
52
+
53
+ // --- symmetric and hashing: reduced, not broken -------------------------
54
+ '@noble/ciphers': { classes: ['reduced'], algorithms: ['AES', 'ChaCha20'] },
55
+ '@noble/hashes': { classes: ['reduced'], algorithms: ['SHA-2', 'SHA-3', 'BLAKE'] },
56
+ 'bcrypt': { classes: ['reduced'], algorithms: ['bcrypt'] },
57
+ 'bcryptjs': { classes: ['reduced'], algorithms: ['bcrypt'] },
58
+ 'argon2': { classes: ['reduced'], algorithms: ['Argon2'] },
59
+ 'scrypt-js': { classes: ['reduced'], algorithms: ['scrypt'] },
60
+ 'hash.js': { classes: ['reduced'], algorithms: ['SHA-2'] },
61
+
62
+ // --- post-quantum --------------------------------------------------------
63
+ '@noble/post-quantum': { classes: ['pq'], algorithms: ['ML-KEM', 'ML-DSA', 'SLH-DSA'] },
64
+ 'kxco-post-quantum': { classes: ['pq'], algorithms: ['ML-KEM', 'ML-DSA', 'SLH-DSA'] },
65
+ 'kxco-pq-tls': { classes: ['pq', 'broken'], algorithms: ['ML-KEM-768', 'X25519'],
66
+ note: 'X25519 is the classical half of a deliberate hybrid' },
67
+ 'kxco-pq-attest': { classes: ['pq'], algorithms: ['ML-DSA-65'] },
68
+ 'kxco-pq-hsm': { classes: ['pq'], algorithms: ['ML-DSA-65', 'ML-KEM-768'] },
69
+ 'kxco-pq-sdk': { classes: ['pq'], algorithms: ['ML-DSA-65', 'ML-KEM-768'] },
70
+ 'liboqs-node': { classes: ['pq'], algorithms: ['ML-KEM', 'ML-DSA'] },
71
+ 'pqclean': { classes: ['pq'], algorithms: ['ML-KEM', 'ML-DSA'] },
72
+ }
73
+
74
+ // Packages that are arithmetic rather than cryptography. They turn up in every
75
+ // scan because curve libraries depend on them, and reporting them as findings
76
+ // is noise: a big-integer library is not a algorithm choice.
77
+ export const ENABLERS = new Set(['bn.js', 'bigi', 'elliptic-curve', 'asn1.js', 'safe-buffer'])
78
+
79
+ export function classify(name) {
80
+ return CATALOGUE[name] ?? null
81
+ }
package/src/index.d.ts ADDED
@@ -0,0 +1,31 @@
1
+ export type CryptoClass = 'broken' | 'reduced' | 'pq'
2
+
3
+ export interface CatalogueEntry {
4
+ classes: CryptoClass[]
5
+ algorithms: string[]
6
+ note?: string
7
+ }
8
+
9
+ export interface Finding {
10
+ name: string
11
+ version: string
12
+ algorithms: string[]
13
+ dependents: string[]
14
+ severity: 'broken' | 'review'
15
+ context: string | null
16
+ note?: string
17
+ }
18
+
19
+ export interface ScanResult {
20
+ lockfileVersion: number
21
+ root: string
22
+ total: number
23
+ findings: Finding[]
24
+ pq: Array<Finding & { classes: CryptoClass[] }>
25
+ reduced: Array<Omit<Finding, 'severity' | 'context'>>
26
+ }
27
+
28
+ export declare function scan(dir?: string): ScanResult
29
+ export declare function classify(name: string): CatalogueEntry | null
30
+ export declare const CATALOGUE: Record<string, CatalogueEntry>
31
+ export declare const ENABLERS: Set<string>
package/src/index.js ADDED
@@ -0,0 +1,19 @@
1
+ // kxco-pq-scan — find quantum-vulnerable cryptography in a dependency tree.
2
+ //
3
+ // What this can see: every package in package-lock.json that is a known
4
+ // cryptographic library, and which algorithm families it brings.
5
+ //
6
+ // What it cannot see, stated here rather than left to be discovered:
7
+ // - cryptography called through a native addon or WebAssembly
8
+ // - a library loaded by a computed require() or a dynamic import
9
+ // - which algorithm your code actually selects at runtime, where a package
10
+ // offers several. `jsonwebtoken` signing with HS256 is HMAC and is fine;
11
+ // the same package signing with RS256 is not, and no static read of a
12
+ // lock file can tell those apart
13
+ // - anything outside the JavaScript tree: your TLS terminator, your database
14
+ // driver, the certificate on your load balancer
15
+ //
16
+ // Treat the output as a place to start looking, not as an inventory.
17
+
18
+ export { scan } from './scan.js'
19
+ export { CATALOGUE, ENABLERS, classify } from './catalogue.js'
package/src/scan.js ADDED
@@ -0,0 +1,128 @@
1
+ // Walk a dependency tree and say which parts of it a quantum computer breaks.
2
+ //
3
+ // Reads package-lock.json, which is the only file that records what was
4
+ // actually installed rather than what was asked for. A scan of package.json
5
+ // sees direct dependencies and misses the transitive ones, and in practice the
6
+ // classical cryptography is nearly always transitive.
7
+
8
+ import { readFileSync, existsSync } from 'node:fs'
9
+ import { join, basename } from 'node:path'
10
+
11
+ import { classify, ENABLERS } from './catalogue.js'
12
+
13
+ /** @typedef {'broken'|'reduced'|'pq'} CryptoClass */
14
+
15
+ /**
16
+ * @param {string} dir — a directory containing package-lock.json
17
+ * @returns {{ lockfileVersion: number, root: string, total: number,
18
+ * findings: object[], pq: object[], reduced: object[],
19
+ * unknownDepth: boolean }}
20
+ */
21
+ export function scan(dir = process.cwd()) {
22
+ const lockPath = join(dir, 'package-lock.json')
23
+ if (!existsSync(lockPath)) {
24
+ const err = new Error(
25
+ `no package-lock.json in ${dir}. This reads the lock file because it is ` +
26
+ 'the only record of what was actually installed; package.json lists ' +
27
+ 'what was requested and misses transitive dependencies, which is where ' +
28
+ 'classical cryptography usually is.',
29
+ )
30
+ err.code = 'ERR_NO_LOCKFILE'
31
+ throw err
32
+ }
33
+
34
+ const lock = JSON.parse(readFileSync(lockPath, 'utf8'))
35
+ if (!lock.packages) {
36
+ const err = new Error(
37
+ `package-lock.json is lockfileVersion ${lock.lockfileVersion ?? 1}, which ` +
38
+ 'does not record the full tree. Run `npm install` on npm 7 or later to ' +
39
+ 'upgrade it, then scan again.',
40
+ )
41
+ err.code = 'ERR_OLD_LOCKFILE'
42
+ throw err
43
+ }
44
+
45
+ // name -> { version, paths[], dependents:Set }
46
+ const installed = new Map()
47
+ for (const [path, meta] of Object.entries(lock.packages)) {
48
+ if (path === '') continue
49
+ const name = meta.name ?? nameFromPath(path)
50
+ if (!name) continue
51
+ const entry = installed.get(name) ?? { name, version: meta.version, paths: [], dependents: new Set() }
52
+ entry.paths.push(path)
53
+ if (!entry.version) entry.version = meta.version
54
+ installed.set(name, entry)
55
+ }
56
+
57
+ // Who pulls each package in. Used to tell a classical primitive sitting
58
+ // inside a post-quantum package (the classical half of a hybrid) from one a
59
+ // consumer is relying on directly.
60
+ for (const [path, meta] of Object.entries(lock.packages)) {
61
+ const parent = path === '' ? '(root)' : (meta.name ?? nameFromPath(path))
62
+ for (const dep of Object.keys({ ...meta.dependencies, ...meta.peerDependencies })) {
63
+ installed.get(dep)?.dependents.add(parent)
64
+ }
65
+ }
66
+
67
+ const findings = []
68
+ const pq = []
69
+ const reduced = []
70
+
71
+ for (const entry of installed.values()) {
72
+ if (ENABLERS.has(entry.name)) continue
73
+ const c = classify(entry.name)
74
+ if (!c) continue
75
+
76
+ const record = {
77
+ name: entry.name,
78
+ version: entry.version,
79
+ algorithms: c.algorithms,
80
+ dependents: [...entry.dependents],
81
+ ...(c.note ? { note: c.note } : {}),
82
+ }
83
+
84
+ if (c.classes.includes('pq')) pq.push({ ...record, classes: c.classes })
85
+ if (c.classes.includes('reduced') && !c.classes.includes('broken')) reduced.push(record)
86
+
87
+ if (c.classes.includes('broken')) {
88
+ const context = hybridContext(entry, c)
89
+ findings.push({ ...record, severity: context ? 'review' : 'broken', context })
90
+ }
91
+ }
92
+
93
+ const order = { broken: 0, review: 1 }
94
+ findings.sort((a, b) => order[a.severity] - order[b.severity] || a.name.localeCompare(b.name))
95
+
96
+ return {
97
+ lockfileVersion: lock.lockfileVersion,
98
+ root: lock.name ?? basename(dir),
99
+ total: installed.size,
100
+ findings,
101
+ pq,
102
+ reduced,
103
+ }
104
+ }
105
+
106
+ // A classical primitive is not automatically a problem. It is the expected
107
+ // other half of a hybrid construction, which is what NIST and the IETF
108
+ // currently recommend for migration. Two ways to recognise one: the catalogue
109
+ // says so for that package, or every package pulling it in is itself
110
+ // post-quantum, which means no consumer is depending on the classical part.
111
+ function hybridContext(entry, c) {
112
+ if (c.classes.includes('pq')) {
113
+ return 'declared hybrid: the classical algorithm is paired with a post-quantum one'
114
+ }
115
+ const dependents = [...entry.dependents].filter((d) => d !== '(root)')
116
+ if (dependents.length === 0) return null
117
+ const allPq = dependents.every((d) => classify(d)?.classes.includes('pq'))
118
+ if (allPq) {
119
+ return `reached only through post-quantum packages (${dependents.join(', ')}), ` +
120
+ 'so this is likely the classical half of a hybrid rather than a dependency you rely on'
121
+ }
122
+ return null
123
+ }
124
+
125
+ function nameFromPath(path) {
126
+ const i = path.lastIndexOf('node_modules/')
127
+ return i === -1 ? null : path.slice(i + 'node_modules/'.length)
128
+ }