tooldock-cli 1.0.0 → 1.1.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/README.md +14 -0
- package/bin/tooldock-ext.js +165 -10
- package/lib/find-app.js +10 -3
- package/lib/pack.js +2 -0
- package/lib/sign.js +119 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -16,7 +16,11 @@ npm install -D tooldock-cli
|
|
|
16
16
|
| `tooldock-ext dev --fresh` | 使用全新的暫存資料目錄 |
|
|
17
17
|
| `tooldock-ext validate` | 檢查 manifest、進入點、畫面檔、指令註冊、設定型別、相依是否已安裝 |
|
|
18
18
|
| `tooldock-ext pack [--out dir]` | 打包成 `.tbx`,只含 `dependencies` 的完整相依樹,並套用 `.tbxignore` |
|
|
19
|
+
| `tooldock-ext pack --sign [--key 檔案]` | 打包並以 Ed25519 簽章,同時產出 `.tbx.sha256` 與 `.tbx.sig`。私鑰依序取自 `--key`、環境變數 `TOOLDOCK_SIGNING_KEY` |
|
|
20
|
+
| `tooldock-ext pack --checksum` | 打包並只產出 `.tbx.sha256`(不簽章) |
|
|
19
21
|
| `tooldock-ext install` | 打包並安裝到本機的 ToolDock |
|
|
22
|
+
| `tooldock-ext keygen [--out dir] [--force]` | 產生簽章金鑰:私鑰存成 `tooldock-signing-key.pem`(權限 600,預設放在 `~/.tooldock/keys`),並印出公鑰字串 |
|
|
23
|
+
| `tooldock-ext verify <tbx> --public-key <字串>` | 驗證 `.tbx` 的 SHA-256(有 `.sha256` 檔時)與簽章(`.sig` 檔),失敗時結束代碼為 1。公鑰也可用環境變數 `TOOLDOCK_PUBLIC_KEY` 提供 |
|
|
20
24
|
|
|
21
25
|
**ToolDock 位置**
|
|
22
26
|
|
|
@@ -29,3 +33,13 @@ npm install -D tooldock-cli
|
|
|
29
33
|
- Linux:`/opt/ToolDock`
|
|
30
34
|
|
|
31
35
|
路徑可以指向 `.app`、執行檔,或平台原始碼目錄。
|
|
36
|
+
|
|
37
|
+
**發佈與簽章**
|
|
38
|
+
|
|
39
|
+
在 GitHub Actions 自動發佈、金鑰管理與發佈檔格式,請參考 ToolDock repo 的 `docs/RELEASE.md`。簡要流程:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npx tooldock-ext keygen # 產生金鑰,記下公鑰字串
|
|
43
|
+
TOOLDOCK_SIGNING_KEY="$(cat ~/.tooldock/keys/tooldock-signing-key.pem)" npx tooldock-ext pack --sign
|
|
44
|
+
npx tooldock-ext verify dist/<id>-<版本>.tbx --public-key <公鑰字串>
|
|
45
|
+
```
|
package/bin/tooldock-ext.js
CHANGED
|
@@ -7,6 +7,7 @@ const { spawn } = require('child_process');
|
|
|
7
7
|
const { validate } = require('../lib/manifest');
|
|
8
8
|
const { pack } = require('../lib/pack');
|
|
9
9
|
const { findApp } = require('../lib/find-app');
|
|
10
|
+
const sign = require('../lib/sign');
|
|
10
11
|
|
|
11
12
|
const tty = process.stdout.isTTY;
|
|
12
13
|
const color = (n) => (s) => (tty ? `\x1b[${n}m${s}\x1b[0m` : String(s));
|
|
@@ -30,22 +31,34 @@ ${bold('tooldock-ext')} — ToolDock 擴充開發工具
|
|
|
30
31
|
validate 檢查 manifest、檔案與相依套件
|
|
31
32
|
pack 打包成 .tbx(只含正式相依)
|
|
32
33
|
--out <資料夾> 輸出目錄(預設 dist)
|
|
34
|
+
--sign 簽章,同時產出 .tbx.sha256 與 .tbx.sig
|
|
35
|
+
--key <檔案> 私鑰檔(未指定時讀環境變數 TOOLDOCK_SIGNING_KEY)
|
|
36
|
+
--checksum 只產出 .tbx.sha256(不簽章)
|
|
37
|
+
keygen 產生 Ed25519 簽章金鑰
|
|
38
|
+
--out <資料夾> 私鑰存放位置(預設 ~/.tooldock/keys)
|
|
39
|
+
--force 覆寫已存在的金鑰
|
|
40
|
+
verify 驗證 .tbx 的 SHA-256 與簽章
|
|
41
|
+
tooldock-ext verify <檔案.tbx> --public-key <公鑰字串>
|
|
42
|
+
(公鑰也可用環境變數 TOOLDOCK_PUBLIC_KEY 提供)
|
|
33
43
|
install 打包並安裝到本機的 ToolDock(平台執行中時會轉交給執行中的視窗)
|
|
34
44
|
--app <路徑>
|
|
35
45
|
help 顯示說明
|
|
36
46
|
|
|
37
|
-
環境變數:
|
|
47
|
+
環境變數:
|
|
48
|
+
TOOLDOCK_PATH ToolDock 位置
|
|
49
|
+
TOOLDOCK_SIGNING_KEY pack --sign 使用的私鑰(PEM 內容)
|
|
50
|
+
TOOLDOCK_PUBLIC_KEY verify 使用的公鑰字串
|
|
38
51
|
`;
|
|
39
52
|
|
|
40
53
|
function parse(argv) {
|
|
41
54
|
const [cmd = 'help', ...rest] = argv;
|
|
42
|
-
const opts = {};
|
|
55
|
+
const opts = { _: [] };
|
|
43
56
|
for (let i = 0; i < rest.length; i++) {
|
|
44
|
-
const m = rest[i].match(/^--([a-
|
|
45
|
-
if (!m) continue;
|
|
57
|
+
const m = rest[i].match(/^--([a-z0-9-]+)(?:=(.*))?$/);
|
|
58
|
+
if (!m) { opts._.push(rest[i]); continue; }
|
|
46
59
|
const [, k, v] = m;
|
|
47
60
|
if (v !== undefined) opts[k] = v;
|
|
48
|
-
else if (['app', 'out'].includes(k) && rest[i + 1] && !rest[i + 1].startsWith('--')) opts[k] = rest[++i];
|
|
61
|
+
else if (['app', 'out', 'key', 'public-key', 'sig', 'sha256'].includes(k) && rest[i + 1] && !rest[i + 1].startsWith('--')) opts[k] = rest[++i];
|
|
49
62
|
else opts[k] = true;
|
|
50
63
|
}
|
|
51
64
|
return { cmd, opts };
|
|
@@ -67,6 +80,53 @@ function runValidate(root, { quiet } = {}) {
|
|
|
67
80
|
return r;
|
|
68
81
|
}
|
|
69
82
|
|
|
83
|
+
/** 平台支援 --extension-dev-path 的最低版本 */
|
|
84
|
+
const MIN_DEV_PLATFORM = '1.1.0';
|
|
85
|
+
|
|
86
|
+
function cmpVer(a, b) {
|
|
87
|
+
const x = String(a).split('.').map(Number);
|
|
88
|
+
const y = String(b).split('.').map(Number);
|
|
89
|
+
for (let i = 0; i < 3; i++) if ((x[i] || 0) !== (y[i] || 0)) return (x[i] || 0) - (y[i] || 0);
|
|
90
|
+
return 0;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
/**
|
|
94
|
+
* 啟動平台並轉送輸出;若平台沒有印出「以開發模式載入 <id>」,代表平台不支援或沒有載入擴充,給出明確提示。
|
|
95
|
+
* (例如舊版平台會忽略 --extension-dev-path,或把啟動轉交給已在執行的舊版視窗後直接結束)
|
|
96
|
+
*/
|
|
97
|
+
function runDev(command, args, id) {
|
|
98
|
+
return new Promise((resolve) => {
|
|
99
|
+
const child = spawn(command, args, { stdio: ['inherit', 'pipe', 'pipe'] });
|
|
100
|
+
const marker = `以開發模式載入 ${id}`;
|
|
101
|
+
let loaded = false;
|
|
102
|
+
let tail = '';
|
|
103
|
+
const watch = (stream, out) => stream.on('data', (d) => {
|
|
104
|
+
out.write(d);
|
|
105
|
+
if (!loaded) {
|
|
106
|
+
tail = (tail + d).slice(-4000);
|
|
107
|
+
if (tail.includes(marker)) loaded = true;
|
|
108
|
+
}
|
|
109
|
+
});
|
|
110
|
+
watch(child.stdout, process.stdout);
|
|
111
|
+
watch(child.stderr, process.stderr);
|
|
112
|
+
const hint = () => console.log(yellow(`
|
|
113
|
+
⚠ ToolDock 沒有以開發模式載入「${id}」。常見原因:
|
|
114
|
+
1. 安裝的 ToolDock 版本太舊(需要 ${MIN_DEV_PLATFORM} 以上),請更新後再試
|
|
115
|
+
2. --app / TOOLDOCK_PATH 指向了別的程式
|
|
116
|
+
`));
|
|
117
|
+
const timer = setTimeout(() => { if (!loaded) hint(); }, 20000);
|
|
118
|
+
const forward = (sig) => () => child.kill(sig);
|
|
119
|
+
process.on('SIGINT', forward('SIGINT'));
|
|
120
|
+
process.on('SIGTERM', forward('SIGTERM'));
|
|
121
|
+
child.on('exit', (code) => {
|
|
122
|
+
clearTimeout(timer);
|
|
123
|
+
if (!loaded) hint();
|
|
124
|
+
resolve(code ?? 0);
|
|
125
|
+
});
|
|
126
|
+
child.on('error', (err) => { clearTimeout(timer); console.error(red(err.message)); resolve(1); });
|
|
127
|
+
});
|
|
128
|
+
}
|
|
129
|
+
|
|
70
130
|
function run(command, args) {
|
|
71
131
|
return new Promise((resolve) => {
|
|
72
132
|
const child = spawn(command, args, { stdio: 'inherit' });
|
|
@@ -81,6 +141,9 @@ function run(command, args) {
|
|
|
81
141
|
async function cmdDev(root, opts) {
|
|
82
142
|
const r = runValidate(root, { quiet: true });
|
|
83
143
|
const app = findApp(opts.app);
|
|
144
|
+
if (app.version && cmpVer(app.version, MIN_DEV_PLATFORM) < 0) {
|
|
145
|
+
throw new Error(`${app.label} 的版本是 ${app.version},不支援擴充開發模式;請更新 ToolDock 到 ${MIN_DEV_PLATFORM} 以上`);
|
|
146
|
+
}
|
|
84
147
|
const args = [...app.baseArgs, `--extension-dev-path=${root}`];
|
|
85
148
|
const inspect = opts['inspect-brk'] || opts.inspect;
|
|
86
149
|
// --inspect 不帶值時為 true,使用預設 9229
|
|
@@ -91,25 +154,115 @@ async function cmdDev(root, opts) {
|
|
|
91
154
|
if (opts.fresh) args.push(`--user-data-dir=${fs.mkdtempSync(path.join(os.tmpdir(), 'tooldock-dev-'))}`);
|
|
92
155
|
console.log(`${bold('ToolDock 擴充開發模式')}
|
|
93
156
|
擴充 ${r.manifest.displayName || r.id} ${dim(`(${r.id}@${r.pkg.version})`)}
|
|
94
|
-
平台 ${app.label}
|
|
157
|
+
平台 ${app.label}${app.version ? dim(` v${app.version}`) : ''}
|
|
95
158
|
重新載入 存檔後自動重新載入後端與畫面${inspect ? `
|
|
96
159
|
偵錯 後端 inspector 127.0.0.1:${port}${opts['inspect-brk'] ? '(暫停中,請附加除錯器)' : ''}
|
|
97
160
|
VS Code:執行「附加到擴充後端」,或在 Chrome 開啟 chrome://inspect` : ''}
|
|
98
161
|
畫面偵錯 在分頁上按右鍵 →「檢查此畫面」
|
|
99
162
|
${dim('按 Ctrl+C 結束')}
|
|
100
163
|
`);
|
|
101
|
-
process.exitCode = await
|
|
164
|
+
process.exitCode = await runDev(app.command, args, r.id);
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
const shownPath = (file) => {
|
|
168
|
+
const rel = path.relative(process.cwd(), file);
|
|
169
|
+
return rel.startsWith('..') || path.isAbsolute(rel) ? file : rel;
|
|
170
|
+
};
|
|
171
|
+
|
|
172
|
+
/** 私鑰來源:--key <檔案> 優先,其次環境變數 TOOLDOCK_SIGNING_KEY */
|
|
173
|
+
function resolveSigningKey(opts) {
|
|
174
|
+
if (typeof opts.key === 'string') {
|
|
175
|
+
const file = path.resolve(opts.key);
|
|
176
|
+
if (!fs.existsSync(file)) throw new Error(`找不到私鑰檔:${file}`);
|
|
177
|
+
return sign.loadPrivateKey(fs.readFileSync(file, 'utf8'), `私鑰檔 ${file}`);
|
|
178
|
+
}
|
|
179
|
+
if (opts.key === true) throw new Error('--key 需要指定私鑰檔路徑');
|
|
180
|
+
if (process.env.TOOLDOCK_SIGNING_KEY && process.env.TOOLDOCK_SIGNING_KEY.trim()) {
|
|
181
|
+
return sign.loadPrivateKey(process.env.TOOLDOCK_SIGNING_KEY, '環境變數 TOOLDOCK_SIGNING_KEY');
|
|
182
|
+
}
|
|
183
|
+
throw new Error('pack --sign 需要私鑰:請用 --key <檔案> 指定,或設定環境變數 TOOLDOCK_SIGNING_KEY(可用 tooldock-ext keygen 產生)');
|
|
102
184
|
}
|
|
103
185
|
|
|
104
186
|
function cmdPack(root, opts) {
|
|
105
187
|
const r = runValidate(root, { quiet: true });
|
|
106
|
-
|
|
188
|
+
// 先讀私鑰,避免打包完才發現金鑰有問題
|
|
189
|
+
const key = opts.sign ? resolveSigningKey(opts) : null;
|
|
190
|
+
const outDir = path.resolve(root, typeof opts.out === 'string' ? opts.out : 'dist');
|
|
107
191
|
const res = pack(root, { outDir, id: r.id, version: r.pkg.version });
|
|
108
|
-
|
|
109
|
-
|
|
192
|
+
console.log(green(`✔ 已打包 ${shownPath(res.file)}`) + dim(`(${res.count} 個檔案,${(res.size / 1024).toFixed(1)} KB)`));
|
|
193
|
+
if (key) {
|
|
194
|
+
const s = sign.signFile(res.file, key);
|
|
195
|
+
console.log(green(`✔ 已產生 ${shownPath(s.sha256File)}`) + dim(`(${s.sha256})`));
|
|
196
|
+
console.log(green(`✔ 已簽章 ${shownPath(s.sigFile)}`));
|
|
197
|
+
console.log(dim(` 公鑰 ${s.publicKey}`));
|
|
198
|
+
Object.assign(res, s);
|
|
199
|
+
} else if (opts.checksum) {
|
|
200
|
+
const c = sign.writeChecksum(res.file);
|
|
201
|
+
console.log(green(`✔ 已產生 ${shownPath(c.file)}`) + dim(`(${c.hex})`));
|
|
202
|
+
res.sha256File = c.file;
|
|
203
|
+
res.sha256 = c.hex;
|
|
204
|
+
}
|
|
110
205
|
return res;
|
|
111
206
|
}
|
|
112
207
|
|
|
208
|
+
function cmdKeygen(opts) {
|
|
209
|
+
const dir = path.resolve(typeof opts.out === 'string' ? opts.out : path.join(os.homedir(), '.tooldock', 'keys'));
|
|
210
|
+
const keyFile = path.join(dir, sign.KEY_FILE);
|
|
211
|
+
const pubFile = path.join(dir, sign.PUB_FILE);
|
|
212
|
+
if (fs.existsSync(keyFile) && !opts.force) {
|
|
213
|
+
throw new Error(`私鑰已存在:${keyFile}\n 換金鑰後,商店索引裡的公鑰也要一起更新。確定要覆寫請加上 --force`);
|
|
214
|
+
}
|
|
215
|
+
const { privateKeyPem, publicKey } = sign.generateKeyPair();
|
|
216
|
+
fs.mkdirSync(dir, { recursive: true, mode: 0o700 });
|
|
217
|
+
fs.writeFileSync(keyFile, privateKeyPem, { mode: 0o600 });
|
|
218
|
+
fs.chmodSync(keyFile, 0o600); // 覆寫既有檔案時 mode 不會生效
|
|
219
|
+
fs.writeFileSync(pubFile, `${publicKey}\n`);
|
|
220
|
+
console.log(`${green('✔ 已產生 Ed25519 簽章金鑰')}
|
|
221
|
+
私鑰 ${keyFile} ${dim('(權限 600,請勿提交到 git 或分享給他人)')}
|
|
222
|
+
公鑰 ${pubFile}
|
|
223
|
+
|
|
224
|
+
${bold('公鑰字串')}
|
|
225
|
+
${publicKey}
|
|
226
|
+
|
|
227
|
+
${bold('接下來')}
|
|
228
|
+
1. 把私鑰加入擴充 repo 的 GitHub secret ${bold('TOOLDOCK_SIGNING_KEY')}:
|
|
229
|
+
gh secret set TOOLDOCK_SIGNING_KEY < "${keyFile}"
|
|
230
|
+
(或到 GitHub repo → Settings → Secrets and variables → Actions 貼上私鑰檔的完整內容)
|
|
231
|
+
2. 把上面的公鑰字串提交到 ToolDock 商店索引,商店會用它驗證你發佈的 .tbx。
|
|
232
|
+
3. 選用:把公鑰設為 repo variable ${bold('TOOLDOCK_PUBLIC_KEY')},CI 會在發佈前用它再驗證一次:
|
|
233
|
+
gh variable set TOOLDOCK_PUBLIC_KEY --body "${publicKey}"
|
|
234
|
+
${dim('請另外備份私鑰;遺失後只能產生新金鑰並更新商店索引裡的公鑰。')}
|
|
235
|
+
`);
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
function cmdVerify(opts) {
|
|
239
|
+
const target = opts._[0];
|
|
240
|
+
if (!target) throw new Error('用法:tooldock-ext verify <檔案.tbx> --public-key <公鑰字串>');
|
|
241
|
+
const file = path.resolve(target);
|
|
242
|
+
if (!fs.existsSync(file)) throw new Error(`找不到檔案:${file}`);
|
|
243
|
+
const publicKey = typeof opts['public-key'] === 'string' ? opts['public-key'] : process.env.TOOLDOCK_PUBLIC_KEY;
|
|
244
|
+
if (!publicKey || !publicKey.trim()) throw new Error('缺少公鑰:請用 --public-key <公鑰字串> 指定,或設定環境變數 TOOLDOCK_PUBLIC_KEY');
|
|
245
|
+
const res = sign.verifyFile(file, {
|
|
246
|
+
publicKey,
|
|
247
|
+
sigPath: typeof opts.sig === 'string' ? path.resolve(opts.sig) : undefined,
|
|
248
|
+
sha256Path: typeof opts.sha256 === 'string' ? path.resolve(opts.sha256) : undefined,
|
|
249
|
+
});
|
|
250
|
+
console.log(bold(shownPath(file)));
|
|
251
|
+
for (const c of res.checks) {
|
|
252
|
+
const mark = c.skipped ? yellow('-') : c.ok ? green('✔') : red('✘');
|
|
253
|
+
console.log(` ${mark} ${c.name} ${dim(c.detail)}`);
|
|
254
|
+
}
|
|
255
|
+
if (!res.ok) {
|
|
256
|
+
const missing = res.checks.some((c) => c.missing);
|
|
257
|
+
console.log(red(missing
|
|
258
|
+
? '\n驗證失敗:缺少發佈檔(未簽章的 .tbx 不會被商店收錄)'
|
|
259
|
+
: '\n驗證失敗:檔案可能被竄改,或公鑰與簽章用的私鑰不是同一組'));
|
|
260
|
+
process.exitCode = 1;
|
|
261
|
+
} else {
|
|
262
|
+
console.log(green('\n✔ 驗證通過'));
|
|
263
|
+
}
|
|
264
|
+
}
|
|
265
|
+
|
|
113
266
|
async function cmdInstall(root, opts) {
|
|
114
267
|
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'tooldock-pack-'));
|
|
115
268
|
const res = cmdPack(root, { out: tmp });
|
|
@@ -128,6 +281,8 @@ async function cmdInstall(root, opts) {
|
|
|
128
281
|
case 'validate': runValidate(root); break;
|
|
129
282
|
case 'pack': cmdPack(root, opts); break;
|
|
130
283
|
case 'install': await cmdInstall(root, opts); break;
|
|
284
|
+
case 'keygen': cmdKeygen(opts); break;
|
|
285
|
+
case 'verify': cmdVerify(opts); break;
|
|
131
286
|
case 'help': case '--help': case '-h': console.log(HELP); break;
|
|
132
287
|
default:
|
|
133
288
|
console.log(red(`未知的指令:${cmd}`));
|
package/lib/find-app.js
CHANGED
|
@@ -33,7 +33,14 @@ function resolveTarget(p) {
|
|
|
33
33
|
const st = fs.statSync(p);
|
|
34
34
|
if (st.isDirectory() && p.endsWith('.app')) {
|
|
35
35
|
const exe = path.join(p, 'Contents', 'MacOS', 'ToolDock');
|
|
36
|
-
|
|
36
|
+
if (!fs.existsSync(exe)) return null;
|
|
37
|
+
let version = null;
|
|
38
|
+
try {
|
|
39
|
+
const plist = fs.readFileSync(path.join(p, 'Contents', 'Info.plist'), 'utf8');
|
|
40
|
+
const m = plist.match(/<key>CFBundleShortVersionString<\/key>\s*<string>([^<]+)<\/string>/);
|
|
41
|
+
if (m) version = m[1];
|
|
42
|
+
} catch { /* 無法讀取版本 */ }
|
|
43
|
+
return { command: exe, baseArgs: [], label: p, version };
|
|
37
44
|
}
|
|
38
45
|
if (st.isDirectory()) {
|
|
39
46
|
const pkgFile = path.join(p, 'package.json');
|
|
@@ -46,9 +53,9 @@ function resolveTarget(p) {
|
|
|
46
53
|
} catch {
|
|
47
54
|
throw new Error(`${p} 是平台原始碼,但尚未安裝相依套件(請先在該目錄執行 npm install)`);
|
|
48
55
|
}
|
|
49
|
-
return { command: electron, baseArgs: [p], label: `${p}
|
|
56
|
+
return { command: electron, baseArgs: [p], label: `${p}(原始碼)`, version: pkg.version };
|
|
50
57
|
}
|
|
51
|
-
return { command: p, baseArgs: [], label: p };
|
|
58
|
+
return { command: p, baseArgs: [], label: p, version: null };
|
|
52
59
|
}
|
|
53
60
|
|
|
54
61
|
function findApp(explicit) {
|
package/lib/pack.js
CHANGED
|
@@ -9,6 +9,8 @@ const DEFAULT_IGNORE = [
|
|
|
9
9
|
'.git', '.github', '.vscode', '.idea', '.DS_Store', 'Thumbs.db',
|
|
10
10
|
'*.tbx', '*.log', '.tbxignore', '.gitignore', 'dist/', 'node_modules/.bin', 'node_modules/.cache',
|
|
11
11
|
'node_modules/.package-lock.json', 'package-lock.json', '*.map',
|
|
12
|
+
// 簽章私鑰(tooldock-ext keygen 的預設檔名)絕不打包
|
|
13
|
+
'tooldock-signing-key*.pem',
|
|
12
14
|
];
|
|
13
15
|
|
|
14
16
|
/** 簡易 gitignore 風格比對:不含 / 的樣式比對任何層級的名稱;以 / 結尾只比對資料夾 */
|
package/lib/sign.js
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
/**
|
|
3
|
+
* 發佈檔簽章(Ed25519,只用 Node 內建 crypto)
|
|
4
|
+
*
|
|
5
|
+
* 約定(商店依此驗證,請勿更改):
|
|
6
|
+
* 私鑰 PKCS8 PEM
|
|
7
|
+
* 公鑰 SPKI DER 的 base64 字串
|
|
8
|
+
* <tbx>.sha256 .tbx 的小寫 hex SHA-256,只有這一行,結尾不加換行
|
|
9
|
+
* <tbx>.sig crypto.sign(null, <.tbx 原始位元組>, privateKey) 的 base64,結尾不加換行
|
|
10
|
+
*/
|
|
11
|
+
const crypto = require('crypto');
|
|
12
|
+
const fs = require('fs');
|
|
13
|
+
const path = require('path');
|
|
14
|
+
|
|
15
|
+
const KEY_FILE = 'tooldock-signing-key.pem';
|
|
16
|
+
const PUB_FILE = 'tooldock-signing-key.pub';
|
|
17
|
+
|
|
18
|
+
function publicKeyString(key) {
|
|
19
|
+
return crypto.createPublicKey(key).export({ type: 'spki', format: 'der' }).toString('base64');
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
function generateKeyPair() {
|
|
23
|
+
const { privateKey } = crypto.generateKeyPairSync('ed25519');
|
|
24
|
+
return {
|
|
25
|
+
privateKeyPem: privateKey.export({ type: 'pkcs8', format: 'pem' }),
|
|
26
|
+
publicKey: publicKeyString(privateKey),
|
|
27
|
+
};
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/** 讀取 PEM 私鑰;容許 secret 內的換行被存成字面上的 \n */
|
|
31
|
+
function loadPrivateKey(pem, source) {
|
|
32
|
+
let text = String(pem || '').trim();
|
|
33
|
+
if (!text.includes('\n') && text.includes('\\n')) text = text.replace(/\\n/g, '\n');
|
|
34
|
+
if (!text.includes('-----BEGIN')) throw new Error(`${source} 不是 PEM 格式的私鑰(應以 -----BEGIN PRIVATE KEY----- 開頭)`);
|
|
35
|
+
let key;
|
|
36
|
+
try {
|
|
37
|
+
key = crypto.createPrivateKey(text);
|
|
38
|
+
} catch (err) {
|
|
39
|
+
throw new Error(`${source} 無法讀取為私鑰:${err.message}`);
|
|
40
|
+
}
|
|
41
|
+
if (key.asymmetricKeyType !== 'ed25519') throw new Error(`${source} 不是 Ed25519 私鑰(是 ${key.asymmetricKeyType}),請用 tooldock-ext keygen 產生`);
|
|
42
|
+
return key;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
function loadPublicKey(str) {
|
|
46
|
+
const b64 = String(str || '').trim();
|
|
47
|
+
if (!b64) throw new Error('缺少公鑰字串');
|
|
48
|
+
let key;
|
|
49
|
+
try {
|
|
50
|
+
key = crypto.createPublicKey({ key: Buffer.from(b64, 'base64'), format: 'der', type: 'spki' });
|
|
51
|
+
} catch (err) {
|
|
52
|
+
throw new Error(`公鑰字串無法解析(應為 SPKI DER 的 base64):${err.message}`);
|
|
53
|
+
}
|
|
54
|
+
if (key.asymmetricKeyType !== 'ed25519') throw new Error(`公鑰不是 Ed25519(是 ${key.asymmetricKeyType})`);
|
|
55
|
+
return key;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
function sha256Hex(buf) {
|
|
59
|
+
return crypto.createHash('sha256').update(buf).digest('hex');
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/** 產生 <tbx>.sha256 */
|
|
63
|
+
function writeChecksum(tbxPath) {
|
|
64
|
+
const hex = sha256Hex(fs.readFileSync(tbxPath));
|
|
65
|
+
const file = `${tbxPath}.sha256`;
|
|
66
|
+
fs.writeFileSync(file, hex);
|
|
67
|
+
return { file, hex };
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
/** 產生 <tbx>.sha256 與 <tbx>.sig,並用對應公鑰自我驗證一次 */
|
|
71
|
+
function signFile(tbxPath, privateKey) {
|
|
72
|
+
const data = fs.readFileSync(tbxPath);
|
|
73
|
+
const sig = crypto.sign(null, data, privateKey);
|
|
74
|
+
if (!crypto.verify(null, data, crypto.createPublicKey(privateKey), sig)) throw new Error('簽章自我驗證失敗');
|
|
75
|
+
const checksum = writeChecksum(tbxPath);
|
|
76
|
+
const sigFile = `${tbxPath}.sig`;
|
|
77
|
+
fs.writeFileSync(sigFile, sig.toString('base64'));
|
|
78
|
+
return { sha256File: checksum.file, sha256: checksum.hex, sigFile, publicKey: publicKeyString(privateKey) };
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* 驗證 .tbx。回傳每個檢查項目的結果,任一 ok=false 即為失敗。
|
|
83
|
+
* @param {string} tbxPath
|
|
84
|
+
* @param {{ publicKey: string, sigPath?: string, sha256Path?: string }} opts
|
|
85
|
+
*/
|
|
86
|
+
function verifyFile(tbxPath, { publicKey, sigPath, sha256Path }) {
|
|
87
|
+
const key = loadPublicKey(publicKey);
|
|
88
|
+
const data = fs.readFileSync(tbxPath);
|
|
89
|
+
const checks = [];
|
|
90
|
+
const hex = sha256Hex(data);
|
|
91
|
+
|
|
92
|
+
const shaFile = sha256Path || `${tbxPath}.sha256`;
|
|
93
|
+
if (fs.existsSync(shaFile)) {
|
|
94
|
+
const expected = fs.readFileSync(shaFile, 'utf8').trim();
|
|
95
|
+
const ok = /^[0-9a-f]{64}$/.test(expected) && expected === hex;
|
|
96
|
+
checks.push({ name: 'SHA-256', ok, detail: ok ? hex : `檔案實際為 ${hex},${path.basename(shaFile)} 記載 ${expected || '(空白)'}` });
|
|
97
|
+
} else if (sha256Path) {
|
|
98
|
+
checks.push({ name: 'SHA-256', ok: false, missing: true, detail: `找不到 ${path.basename(shaFile)}` });
|
|
99
|
+
} else {
|
|
100
|
+
checks.push({ name: 'SHA-256', ok: true, skipped: true, detail: `${hex}(沒有 .sha256 檔,未比對)` });
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
const sigFile = sigPath || `${tbxPath}.sig`;
|
|
104
|
+
if (!fs.existsSync(sigFile)) {
|
|
105
|
+
checks.push({ name: '簽章', ok: false, missing: true, detail: `找不到 ${path.basename(sigFile)}` });
|
|
106
|
+
} else {
|
|
107
|
+
const b64 = fs.readFileSync(sigFile, 'utf8').trim();
|
|
108
|
+
const sig = Buffer.from(b64, 'base64');
|
|
109
|
+
const ok = sig.length === 64 && crypto.verify(null, data, key, sig);
|
|
110
|
+
checks.push({ name: '簽章', ok, detail: ok ? 'Ed25519 簽章正確' : '簽章與檔案或公鑰不符' });
|
|
111
|
+
}
|
|
112
|
+
return { ok: checks.every((c) => c.ok), checks, sha256: hex };
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
module.exports = {
|
|
116
|
+
KEY_FILE, PUB_FILE,
|
|
117
|
+
generateKeyPair, loadPrivateKey, loadPublicKey, publicKeyString,
|
|
118
|
+
sha256Hex, writeChecksum, signFile, verifyFile,
|
|
119
|
+
};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tooldock-cli",
|
|
3
|
-
"version": "1.
|
|
4
|
-
"description": "ToolDock 擴充開發工具:dev(開發模式啟動並偵錯)、validate、pack、
|
|
3
|
+
"version": "1.1.0",
|
|
4
|
+
"description": "ToolDock 擴充開發工具:dev(開發模式啟動並偵錯)、validate、pack(含簽章)、install、keygen、verify",
|
|
5
5
|
"bin": {
|
|
6
6
|
"tooldock-ext": "bin/tooldock-ext.js"
|
|
7
7
|
},
|