@ecubelabs/mysql-mcp 1.0.0 → 1.1.0-next.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +60 -45
- package/dist/src/config/index.js +61 -4
- package/dist/src/ssh/tunnel.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,17 +4,17 @@ SSH bastion을 거쳐야만 닿을 수 있는 MySQL을 위한 읽기 전용 MCP
|
|
|
4
4
|
이름 붙은 profile 하나씩을 둡니다.
|
|
5
5
|
|
|
6
6
|
Tunnel은 서버가 직접 엽니다. 이미 쓰고 있는 `~/.ssh/config` alias 하나만 가리켜
|
|
7
|
-
주면 forwarding, connection pool, teardown까지 알아서 처리합니다. `prod
|
|
7
|
+
주면 forwarding, connection pool, teardown까지 알아서 처리합니다. `prod`로 시작하는 이름의 profile은
|
|
8
8
|
쓰기가 불가능하며, 이는 설정이 아니라 코드에서 결정됩니다.
|
|
9
9
|
|
|
10
10
|
## 제공하는 것
|
|
11
11
|
|
|
12
12
|
- **SSH tunnel.** Connection pool이 생기기 전에 열리고, 종료 시 닫힙니다. 각 서버가
|
|
13
13
|
자기 tunnel을 소유하므로 instance끼리 간섭하지 않습니다.
|
|
14
|
-
- **Profile.**
|
|
15
|
-
|
|
16
|
-
- **기본 읽기 전용, prod는 깨뜨릴 수 없음.** `prod
|
|
17
|
-
무관하게 모든 쓰기를 거부합니다.
|
|
14
|
+
- **Profile.** `--profile`이 환경 이름을 정합니다. 모든 응답이 어느 환경에서 온
|
|
15
|
+
답인지 밝힙니다.
|
|
16
|
+
- **기본 읽기 전용, prod는 깨뜨릴 수 없음.** `prod`로 시작하는 profile(`prod`,
|
|
17
|
+
`production`, `prod-ccn2`)은 설정과 무관하게 모든 쓰기를 거부합니다.
|
|
18
18
|
- **DB에 물을 수 없는 사실은 사용자가 확인해 기록.** 어떤 schema가 어느 저장소의
|
|
19
19
|
어느 앱 것인지(owner), 데이터가 저장소마다 어느 git branch에 대응하는지는 사용자가
|
|
20
20
|
한 번 확인해 catalog에 기록합니다.
|
|
@@ -66,43 +66,36 @@ ssh ecubelabs2-prod-db "echo ok"
|
|
|
66
66
|
|
|
67
67
|
### 2. MCP 클라이언트에 등록하기
|
|
68
68
|
|
|
69
|
-
-
|
|
69
|
+
- `--profile`은 빼지 마세요. prod 쓰기 금지를 이 값이 정합니다.
|
|
70
|
+
- profile과 alias는 실행 인자로, credential은 env로 넘깁니다.
|
|
70
71
|
- 나머지 변수는 [환경 변수](#환경-변수) 절에 있습니다.
|
|
71
72
|
|
|
72
73
|
#### Claude Code
|
|
73
74
|
|
|
74
75
|
```bash
|
|
75
76
|
claude mcp add mysql-stage -s user \
|
|
76
|
-
-e MYSQL_PROFILE=stage \
|
|
77
|
-
-e MYSQL_SSH_CONFIG_HOST=ecubelabs2-stage-db \
|
|
78
77
|
-e MYSQL_USER=<user> \
|
|
79
78
|
-e MYSQL_PASS=<password> \
|
|
80
|
-
-- npx -y @ecubelabs/mysql-mcp
|
|
79
|
+
-- npx -y @ecubelabs/mysql-mcp --profile stage --ssh-config-host ecubelabs2-stage-db
|
|
81
80
|
|
|
82
81
|
claude mcp add mysql-prod -s user \
|
|
83
|
-
-e MYSQL_PROFILE=prod \
|
|
84
|
-
-e MYSQL_SSH_CONFIG_HOST=ecubelabs2-prod-db \
|
|
85
82
|
-e MYSQL_USER=<user> \
|
|
86
83
|
-e MYSQL_PASS=<password> \
|
|
87
|
-
-- npx -y @ecubelabs/mysql-mcp
|
|
84
|
+
-- npx -y @ecubelabs/mysql-mcp --profile prod --ssh-config-host ecubelabs2-prod-db
|
|
88
85
|
```
|
|
89
86
|
|
|
90
87
|
#### Codex
|
|
91
88
|
|
|
92
89
|
```bash
|
|
93
90
|
codex mcp add mysql-stage \
|
|
94
|
-
--env MYSQL_PROFILE=stage \
|
|
95
|
-
--env MYSQL_SSH_CONFIG_HOST=ecubelabs2-stage-db \
|
|
96
91
|
--env MYSQL_USER=<user> \
|
|
97
92
|
--env MYSQL_PASS=<password> \
|
|
98
|
-
-- npx -y @ecubelabs/mysql-mcp
|
|
93
|
+
-- npx -y @ecubelabs/mysql-mcp --profile stage --ssh-config-host ecubelabs2-stage-db
|
|
99
94
|
|
|
100
95
|
codex mcp add mysql-prod \
|
|
101
|
-
--env MYSQL_PROFILE=prod \
|
|
102
|
-
--env MYSQL_SSH_CONFIG_HOST=ecubelabs2-prod-db \
|
|
103
96
|
--env MYSQL_USER=<user> \
|
|
104
97
|
--env MYSQL_PASS=<password> \
|
|
105
|
-
-- npx -y @ecubelabs/mysql-mcp
|
|
98
|
+
-- npx -y @ecubelabs/mysql-mcp --profile prod --ssh-config-host ecubelabs2-prod-db
|
|
106
99
|
```
|
|
107
100
|
|
|
108
101
|
### 3. table과 문서 연결하기 (선택)
|
|
@@ -399,30 +392,43 @@ Catalog에는 schema metadata와 사용 기록만 들어갑니다.
|
|
|
399
392
|
경로를 담는 변수는 절대 경로로 쓰세요. npx는 클라이언트가 열어 둔 프로젝트를
|
|
400
393
|
작업 디렉터리로 서버를 띄우므로, 상대 경로는 프로젝트마다 다른 곳을 가리킵니다.
|
|
401
394
|
|
|
395
|
+
### 실행 인자
|
|
396
|
+
|
|
397
|
+
profile과 alias는 환경 변수가 아니라 서버 실행 인자로 받습니다.
|
|
398
|
+
|
|
399
|
+
| 인자 | 기본값 | 의미 |
|
|
400
|
+
| --------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
401
|
+
| `--profile <label>` | _(미설정)_ | 환경 label. `prod`로 시작하는 label은 읽기 전용을 강제합니다. |
|
|
402
|
+
| `--ssh-config-host <alias>` | _(미설정)_ | `HostName`, `User`, `Port`, `IdentityFile`, `UserKnownHostsFile`, `HostKeyAlias`, 첫 `LocalForward`를 읽어올 `~/.ssh/config`의 Host alias. |
|
|
403
|
+
|
|
404
|
+
- `--name value`와 `--name=value`를 모두 받습니다. 빈 값은 주지 않은 것으로 봅니다.
|
|
405
|
+
- 모르는 인자, 값 없는 인자, 같은 인자를 두 번 주면 서버가 시작하지 않습니다.
|
|
406
|
+
- credential은 인자로 받지 않습니다.
|
|
407
|
+
|
|
402
408
|
### Profile
|
|
403
409
|
|
|
404
|
-
| 변수 | 기본값 | 의미
|
|
405
|
-
| ------------------------- | ---------------------------- |
|
|
406
|
-
| `MYSQL_PROFILE` | _(미설정)_ | 환경 label. `prod
|
|
407
|
-
| `MYSQL_CATALOG_ENABLED` | `true` | 로컬 schema catalog를 켭니다. `false`이면 `mysql_catalog` 툴과 `mysql://schemas`가 제공되지 않습니다.
|
|
408
|
-
| `MYSQL_CATALOG_PATH` | `~/.cache/mysql-mcp/catalog` | profile·대상·user별 JSON 파일을 둘 directory입니다.
|
|
409
|
-
| `MYSQL_CATALOG_TTL_HOURS` | `24` | DB metadata를 stale로 보는 시간입니다.
|
|
410
|
+
| 변수 | 기본값 | 의미 |
|
|
411
|
+
| ------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
412
|
+
| `MYSQL_PROFILE` | _(미설정)_ | **Deprecated.** `--profile`을 쓰세요. 인자가 없을 때만 읽고, 읽으면 stderr에 알립니다. 환경 label. `prod`로 시작하는 label은 읽기 전용을 강제합니다. |
|
|
413
|
+
| `MYSQL_CATALOG_ENABLED` | `true` | 로컬 schema catalog를 켭니다. `false`이면 `mysql_catalog` 툴과 `mysql://schemas`가 제공되지 않습니다. |
|
|
414
|
+
| `MYSQL_CATALOG_PATH` | `~/.cache/mysql-mcp/catalog` | profile·대상·user별 JSON 파일을 둘 directory입니다. |
|
|
415
|
+
| `MYSQL_CATALOG_TTL_HOURS` | `24` | DB metadata를 stale로 보는 시간입니다. |
|
|
410
416
|
|
|
411
417
|
### SSH tunnel
|
|
412
418
|
|
|
413
|
-
| 변수 | 기본값 | 의미
|
|
414
|
-
| ---------------------------- | -------------------------------------------- |
|
|
415
|
-
| `MYSQL_SSH_CONFIG_HOST` | _(미설정)_ |
|
|
416
|
-
| `MYSQL_SSH_HOST` | alias에서 | bastion 호스트명.
|
|
417
|
-
| `MYSQL_SSH_PORT` | alias `Port`, 없으면 `22` | bastion SSH 포트.
|
|
418
|
-
| `MYSQL_SSH_USER` | alias에서 | bastion 사용자.
|
|
419
|
-
| `MYSQL_SSH_PRIVATE_KEY_PATH` | alias `IdentityFile`, 없으면 `~/.ssh/id_rsa` | bastion 인증에 쓰는 키.
|
|
420
|
-
| `MYSQL_SSH_PASSPHRASE` | _(미설정)_ | 암호화된 키일 때만 필요합니다.
|
|
421
|
-
| `MYSQL_SSH_LOCAL_PORT` | alias `LocalForward`, 없으면 `0` | 선호하는 loopback 포트. `0`은 자동 할당. 포트가 이미 쓰이고 있으면 자동 할당된 포트를 대신 씁니다.
|
|
422
|
-
| `MYSQL_SSH_REUSE_EXISTING` | `false` | 직접 열지 않고 해당 포트에 이미 떠 있는 forward에 붙습니다. 아래 경고를 참고하세요.
|
|
423
|
-
|
|
424
|
-
- `
|
|
425
|
-
다 없으면 tunnel 없이 `MYSQL_HOST`로 직접 접속합니다.
|
|
419
|
+
| 변수 | 기본값 | 의미 |
|
|
420
|
+
| ---------------------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
421
|
+
| `MYSQL_SSH_CONFIG_HOST` | _(미설정)_ | **Deprecated.** `--ssh-config-host`를 쓰세요. 인자가 없을 때만 읽고, 읽으면 stderr에 알립니다. |
|
|
422
|
+
| `MYSQL_SSH_HOST` | alias에서 | bastion 호스트명. |
|
|
423
|
+
| `MYSQL_SSH_PORT` | alias `Port`, 없으면 `22` | bastion SSH 포트. |
|
|
424
|
+
| `MYSQL_SSH_USER` | alias에서 | bastion 사용자. |
|
|
425
|
+
| `MYSQL_SSH_PRIVATE_KEY_PATH` | alias `IdentityFile`, 없으면 `~/.ssh/id_rsa` | bastion 인증에 쓰는 키. |
|
|
426
|
+
| `MYSQL_SSH_PASSPHRASE` | _(미설정)_ | 암호화된 키일 때만 필요합니다. |
|
|
427
|
+
| `MYSQL_SSH_LOCAL_PORT` | alias `LocalForward`, 없으면 `0` | 선호하는 loopback 포트. `0`은 자동 할당. 포트가 이미 쓰이고 있으면 자동 할당된 포트를 대신 씁니다. |
|
|
428
|
+
| `MYSQL_SSH_REUSE_EXISTING` | `false` | 직접 열지 않고 해당 포트에 이미 떠 있는 forward에 붙습니다. 아래 경고를 참고하세요. |
|
|
429
|
+
|
|
430
|
+
- alias(`--ssh-config-host`)나 `MYSQL_SSH_HOST`가 있으면 접속
|
|
431
|
+
전에 tunnel을 엽니다. 둘 다 없으면 tunnel 없이 `MYSQL_HOST`로 직접 접속합니다.
|
|
426
432
|
- 위 표의 변수를 명시하면 alias 값보다 우선하므로, `~/.ssh/config`를 건드리지 않고
|
|
427
433
|
한 profile에서 필드 하나만 덮어쓸 수 있습니다.
|
|
428
434
|
- forwarding 대상만은 반대로 alias의 `LocalForward`가 `MYSQL_HOST`/`MYSQL_PORT`보다
|
|
@@ -482,7 +488,8 @@ Catalog에는 schema metadata와 사용 기록만 들어갑니다.
|
|
|
482
488
|
|
|
483
489
|
## 읽기 전용 강제
|
|
484
490
|
|
|
485
|
-
Profile 이름이 `prod`
|
|
491
|
+
Profile 이름이 `prod`로 시작하면(`prod`, `production`, `prod-ccn2`) `src/config/index.ts`가
|
|
492
|
+
두 가지를 합니다. `--profile`이 있으면 그 값으로, 없으면 deprecated `MYSQL_PROFILE`로 판정합니다.
|
|
486
493
|
|
|
487
494
|
- `ALLOW_INSERT_OPERATION`, `ALLOW_UPDATE_OPERATION`, `ALLOW_DELETE_OPERATION`,
|
|
488
495
|
`ALLOW_DDL_OPERATION`을 `false`로 강제합니다.
|
|
@@ -493,10 +500,15 @@ Profile 이름이 `prod` 또는 `production`이면 `src/config/index.ts`가 두
|
|
|
493
500
|
거부로 닫은 문을 다시 열어버립니다. routing logic이 앞으로 refactoring될 경우를
|
|
494
501
|
대비한 2차 방어선으로, `executeWriteQuery`도 별도로 거부합니다.
|
|
495
502
|
|
|
496
|
-
실질적인 귀결: 어떤 env 파일도, shell export도, MCP 클라이언트 설정도
|
|
497
|
-
profile이 쓰게 만들 수 없습니다. 시도하면 무시된 flag를 stderr에 기록하고
|
|
503
|
+
실질적인 귀결: 어떤 env 파일도, shell export도, 실행 인자도, MCP 클라이언트 설정도
|
|
504
|
+
prod profile이 쓰게 만들 수 없습니다. 시도하면 무시된 flag를 stderr에 기록하고
|
|
498
505
|
읽기 전용으로 계속 동작합니다.
|
|
499
506
|
|
|
507
|
+
- 정확히 `prod`일 때만이 아니라 `prod`로 시작하면 막는 이유: 인스턴스를 구분하려고
|
|
508
|
+
`prod-ccn2` 같은 label을 붙이는 순간 금지가 빠지기 때문입니다.
|
|
509
|
+
- `--profile`과 `MYSQL_PROFILE`이 다르면 표시·catalog·쓰기 판정 모두 `--profile`을
|
|
510
|
+
따르고, stderr에 알립니다.
|
|
511
|
+
|
|
500
512
|
다른 profile은 기본적으로 읽기 전용이지만 켤 수 있습니다. 그쪽의 `ALLOW_*`
|
|
501
513
|
flag는 평범한 설정이기 때문입니다.
|
|
502
514
|
|
|
@@ -768,8 +780,8 @@ stderr로 보내므로, 시작할 때 뭔가를 출력하는 shell profile(`~/.z
|
|
|
768
780
|
띄워 stdout을 보세요:
|
|
769
781
|
|
|
770
782
|
```bash
|
|
771
|
-
|
|
772
|
-
|
|
783
|
+
MYSQL_USER=<user> MYSQL_PASS=<password> \
|
|
784
|
+
npx -y @ecubelabs/mysql-mcp --profile stage --ssh-config-host ecubelabs2-stage-db < /dev/null | head
|
|
773
785
|
```
|
|
774
786
|
|
|
775
787
|
출력이 조금이라도 있다면 그것이 버그입니다.
|
|
@@ -822,14 +834,17 @@ bastion에 닿을 수 있게 되면 서버를 재시작하세요.
|
|
|
822
834
|
|
|
823
835
|
### 서버가 즉시 종료됨
|
|
824
836
|
|
|
825
|
-
등록할 때와 같은 env
|
|
837
|
+
등록할 때와 같은 env와 인자로 직접 띄워 보세요. 시작 실패는 `ENABLE_LOGGING`과 무관하게
|
|
826
838
|
이유를 stderr에 찍습니다:
|
|
827
839
|
|
|
828
840
|
```bash
|
|
829
|
-
|
|
830
|
-
|
|
841
|
+
MYSQL_USER=<user> MYSQL_PASS=<password> \
|
|
842
|
+
npx -y @ecubelabs/mysql-mcp --profile stage --ssh-config-host ecubelabs2-stage-db
|
|
831
843
|
```
|
|
832
844
|
|
|
845
|
+
- `invalid server arguments`가 보이면 실행 인자가 틀렸습니다. 받는 인자는
|
|
846
|
+
`--profile`과 `--ssh-config-host` 둘뿐이고, 각각 값이 하나씩 있어야 합니다.
|
|
847
|
+
|
|
833
848
|
### `PROTOCOL_CONNECTION_LOST` 또는 `Connection lost`로 쿼리가 실패함
|
|
834
849
|
|
|
835
850
|
쿼리 도중 tunnel이 사라졌습니다.
|
package/dist/src/config/index.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import * as fs from 'fs';
|
|
2
2
|
import * as path from 'path';
|
|
3
3
|
import { fileURLToPath } from 'url';
|
|
4
|
+
import { parseArgs } from 'util';
|
|
4
5
|
function parseSchemaPermissions(permissionsString) {
|
|
5
6
|
const permissions = {};
|
|
6
7
|
if (!permissionsString) {
|
|
@@ -57,9 +58,63 @@ export function readPackageVersion(startDir) {
|
|
|
57
58
|
dir = parent;
|
|
58
59
|
}
|
|
59
60
|
}
|
|
60
|
-
export
|
|
61
|
-
|
|
62
|
-
|
|
61
|
+
export function parseServerArgs(argv) {
|
|
62
|
+
let parsed;
|
|
63
|
+
try {
|
|
64
|
+
parsed = parseServerArgv(argv);
|
|
65
|
+
}
|
|
66
|
+
catch (error) {
|
|
67
|
+
const reason = (error instanceof Error ? error.message : String(error)).replace(/\.?$/, '.');
|
|
68
|
+
throw new Error(`invalid server arguments: ${reason} ` +
|
|
69
|
+
`Supported: --profile <label>, --ssh-config-host <~/.ssh/config Host alias>.`);
|
|
70
|
+
}
|
|
71
|
+
const seen = new Set();
|
|
72
|
+
for (const token of parsed.tokens) {
|
|
73
|
+
if (token.kind !== 'option') {
|
|
74
|
+
continue;
|
|
75
|
+
}
|
|
76
|
+
if (seen.has(token.name)) {
|
|
77
|
+
throw new Error(`invalid server arguments: --${token.name} was given more than once.`);
|
|
78
|
+
}
|
|
79
|
+
seen.add(token.name);
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
profile: parsed.values.profile?.trim() || undefined,
|
|
83
|
+
sshConfigHost: parsed.values['ssh-config-host']?.trim() || undefined,
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
function parseServerArgv(argv) {
|
|
87
|
+
return parseArgs({
|
|
88
|
+
args: [...argv],
|
|
89
|
+
options: {
|
|
90
|
+
profile: { type: 'string' },
|
|
91
|
+
'ssh-config-host': { type: 'string' },
|
|
92
|
+
},
|
|
93
|
+
strict: true,
|
|
94
|
+
allowPositionals: false,
|
|
95
|
+
tokens: true,
|
|
96
|
+
});
|
|
97
|
+
}
|
|
98
|
+
const SERVER_ARGS = parseServerArgs(process.argv.slice(2));
|
|
99
|
+
function readDeprecatedEnv(name, replacement) {
|
|
100
|
+
const value = process.env[name]?.trim() || undefined;
|
|
101
|
+
if (value) {
|
|
102
|
+
console.error(`[config] ${name} is deprecated; pass ${replacement} as a server argument instead.`);
|
|
103
|
+
}
|
|
104
|
+
return value;
|
|
105
|
+
}
|
|
106
|
+
function normalizeProfile(raw) {
|
|
107
|
+
return (raw ?? '').trim().toLowerCase();
|
|
108
|
+
}
|
|
109
|
+
const ENV_PROFILE = normalizeProfile(readDeprecatedEnv('MYSQL_PROFILE', '--profile <label>'));
|
|
110
|
+
export const MYSQL_PROFILE = SERVER_ARGS.profile ? normalizeProfile(SERVER_ARGS.profile) : ENV_PROFILE;
|
|
111
|
+
export function isWriteForbiddenProfile(profile) {
|
|
112
|
+
return normalizeProfile(profile).startsWith('prod');
|
|
113
|
+
}
|
|
114
|
+
export const IS_WRITE_FORBIDDEN_PROFILE = isWriteForbiddenProfile(MYSQL_PROFILE);
|
|
115
|
+
if (SERVER_ARGS.profile && ENV_PROFILE && ENV_PROFILE !== MYSQL_PROFILE) {
|
|
116
|
+
console.error(`[config] --profile "${MYSQL_PROFILE}" overrides MYSQL_PROFILE="${ENV_PROFILE}".`);
|
|
117
|
+
}
|
|
63
118
|
export const PROFILE_LABEL = MYSQL_PROFILE ? MYSQL_PROFILE.toUpperCase() : 'UNSPECIFIED';
|
|
64
119
|
export const MYSQL_CATALOG_ENABLED = process.env.MYSQL_CATALOG_ENABLED !== 'false';
|
|
65
120
|
export const MYSQL_CATALOG_PATH = process.env.MYSQL_CATALOG_PATH?.trim() || undefined;
|
|
@@ -142,7 +197,9 @@ export const MYSQL_TIMEZONE = process.env.MYSQL_TIMEZONE?.trim() || undefined;
|
|
|
142
197
|
export const MYSQL_DATE_STRINGS = process.env.MYSQL_DATE_STRINGS === 'true';
|
|
143
198
|
export const MYSQL_BIG_NUMBER_STRINGS = process.env.MYSQL_BIG_NUMBER_STRINGS === 'true';
|
|
144
199
|
export const SSH_REUSE_EXISTING = process.env.MYSQL_SSH_REUSE_EXISTING === 'true';
|
|
145
|
-
|
|
200
|
+
const ENV_SSH_CONFIG_HOST = readDeprecatedEnv('MYSQL_SSH_CONFIG_HOST', '--ssh-config-host <alias>');
|
|
201
|
+
export const SSH_CONFIG_HOST = SERVER_ARGS.sshConfigHost ?? ENV_SSH_CONFIG_HOST;
|
|
202
|
+
export const SSH_CONFIG_HOST_SOURCE = SERVER_ARGS.sshConfigHost ? '--ssh-config-host' : ENV_SSH_CONFIG_HOST ? 'MYSQL_SSH_CONFIG_HOST' : undefined;
|
|
146
203
|
export const SSH_HOST = process.env.MYSQL_SSH_HOST?.trim() || undefined;
|
|
147
204
|
export const SSH_USER = process.env.MYSQL_SSH_USER?.trim() || undefined;
|
|
148
205
|
export const SSH_PORT = parsePortEnv('MYSQL_SSH_PORT', process.env.MYSQL_SSH_PORT);
|
package/dist/src/ssh/tunnel.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as fs from 'fs';
|
|
2
2
|
import * as net from 'net';
|
|
3
3
|
import { Client as SSHClient } from 'ssh2';
|
|
4
|
-
import { MYSQL_HOST, MYSQL_PORT, SSH_CONFIG_HOST, SSH_ENABLED, SSH_HOST, SSH_LOCAL_PORT, SSH_PASSPHRASE, SSH_PORT, SSH_PRIVATE_KEY_PATH, SSH_REUSE_EXISTING, SSH_USER, } from '../config/index.js';
|
|
4
|
+
import { MYSQL_HOST, MYSQL_PORT, SSH_CONFIG_HOST, SSH_CONFIG_HOST_SOURCE, SSH_ENABLED, SSH_HOST, SSH_LOCAL_PORT, SSH_PASSPHRASE, SSH_PORT, SSH_PRIVATE_KEY_PATH, SSH_REUSE_EXISTING, SSH_USER, } from '../config/index.js';
|
|
5
5
|
import { log } from '../utils/index.js';
|
|
6
6
|
import { expandHome, readSSHConfigHost } from './config.js';
|
|
7
7
|
import { DEFAULT_USER_KNOWN_HOSTS_FILES, hostKeyAlgorithms, isKnownHostKey, knownHostsName, lookupKnownHosts, } from './known-hosts.js';
|
|
@@ -21,7 +21,7 @@ export function resolveTunnelConfig() {
|
|
|
21
21
|
if (configHost) {
|
|
22
22
|
fromConfig = readSSHConfigHost(configHost);
|
|
23
23
|
if (!fromConfig) {
|
|
24
|
-
throw new Error(
|
|
24
|
+
throw new Error(`${SSH_CONFIG_HOST_SOURCE ?? 'MYSQL_SSH_CONFIG_HOST'}="${configHost}" was not found as a Host alias in ~/.ssh/config. ` +
|
|
25
25
|
`Either add the alias or set MYSQL_SSH_HOST / MYSQL_SSH_USER explicitly.`);
|
|
26
26
|
}
|
|
27
27
|
log('info', `[ssh] resolved alias "${configHost}" from ~/.ssh/config: ` +
|
package/package.json
CHANGED