dsh-git-branch-manage 1.1.0 → 1.3.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/CHANGELOG.md +34 -0
- package/lib/client.js +271 -29
- package/lib/credential-service.d.ts +32 -38
- package/lib/credential-service.js +56 -27
- package/lib/credentials.d.ts +145 -40
- package/lib/credentials.js +398 -70
- package/lib/git.d.ts +82 -9
- package/lib/git.js +260 -24
- package/lib/index.d.ts +11 -0
- package/lib/index.js +56 -19
- package/lib/local-import.d.ts +68 -0
- package/lib/local-import.js +151 -0
- package/lib/network-ip.d.ts +99 -0
- package/lib/network-ip.js +206 -0
- package/lib/network-probe.d.ts +28 -0
- package/lib/network-probe.js +47 -0
- package/lib/network-proxy.d.ts +35 -0
- package/lib/network-proxy.js +55 -0
- package/lib/network-tool.d.ts +5 -8
- package/lib/network-tool.js +17 -20
- package/lib/network.d.ts +58 -0
- package/lib/network.js +128 -0
- package/lib/normalize.d.ts +14 -2
- package/lib/normalize.js +38 -2
- package/lib/routes.d.ts +41 -3
- package/lib/routes.js +159 -27
- package/lib/shell-bridge.d.ts +57 -115
- package/lib/shell-bridge.js +96 -170
- package/lib/tool.js +2 -2
- package/lib/wire.d.ts +64 -0
- package/lib/wire.js +5 -0
- package/package.json +1 -1
- package/lib/helpers/git-credential-bridge.d.ts +0 -37
- package/lib/helpers/git-credential-bridge.js +0 -119
package/lib/shell-bridge.js
CHANGED
|
@@ -1,217 +1,143 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Shell credential
|
|
3
|
-
* credential panel stores one token per remote host, but 0029 could only
|
|
4
|
-
* inject it into the panel's own routes and the `git_network` tool; a plain
|
|
5
|
-
* `git push` run in a shell authenticated as whatever the machine's
|
|
6
|
-
* credential helper held — often a different account — or hung on an
|
|
7
|
-
* interactive prompt nobody could answer.
|
|
2
|
+
* Shell credential setup (host half) — decision 0037.
|
|
8
3
|
*
|
|
9
|
-
*
|
|
10
|
-
* `
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* in the shell, not only the networked ones (0034).
|
|
4
|
+
* Before 0037 the panel's token only reached commands the plugin itself ran;
|
|
5
|
+
* a plain `git push` in a shell authenticated as whatever the machine's
|
|
6
|
+
* helper held (often a different account) or hung on a prompt nobody could
|
|
7
|
+
* answer. 0032/0034 tried to bridge that through the process environment
|
|
8
|
+
* (`GIT_CONFIG_COUNT`, then a generated `GIT_CONFIG_GLOBAL` session file) —
|
|
9
|
+
* both channels existed only in the host process's own environment, so a
|
|
10
|
+
* shell that received a different environment snapshot saw nothing.
|
|
17
11
|
*
|
|
18
|
-
*
|
|
19
|
-
* git at it with `GIT_CONFIG_GLOBAL` — a name the scrubber keeps. The file:
|
|
12
|
+
* 0037 stops fighting the environment and uses git's own mechanisms:
|
|
20
13
|
*
|
|
21
|
-
* 1.
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
* helper (`helpers/git-credential-bridge.js`) as a `!`-shell command.
|
|
14
|
+
* 1. `<dsh-home>/git-credentials.include.gitconfig` is generated with one
|
|
15
|
+
* URL-scoped section per managed host;
|
|
16
|
+
* 2. `~/.gitconfig` gains exactly one `[include] path = <that file>` line
|
|
17
|
+
* (idempotent; see `ensureGitconfigInclude` in `credentials.ts`);
|
|
18
|
+
* 3. every git process — the plugin's own routes, `git_network`, and a
|
|
19
|
+
* plain shell — reads that include and therefore resolves the host
|
|
20
|
+
* through `credential-store`, i.e. `~/.git-credentials`.
|
|
29
21
|
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
22
|
+
* Nothing rides the process environment any more, which is why the module is
|
|
23
|
+
* now only a gitconfig-install + fail-fast switch manager. `GIT_TERMINAL_PROMPT=0`
|
|
24
|
+
* and `GCM_INTERACTIVE=never` stay: a host without a stored credential should
|
|
25
|
+
* fail at once instead of parking an agent shell on a GUI dialog.
|
|
34
26
|
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* The file is re-derived whenever the credential store changes
|
|
42
|
-
* (`src/routes.ts` calls the bridge after every save / delete / sign-in).
|
|
43
|
-
*/
|
|
44
|
-
import { chmodSync, mkdirSync, renameSync, rmSync, writeFileSync } from 'node:fs';
|
|
45
|
-
import { tmpdir } from 'node:os';
|
|
46
|
-
import { dirname, join } from 'node:path';
|
|
47
|
-
import { fileURLToPath } from 'node:url';
|
|
48
|
-
import { credentialFilePath, createCredentialStore, } from './credentials.js';
|
|
49
|
-
/** Env var carrying the credential file path to the helper script. */
|
|
50
|
-
export const BRIDGE_HELPER_ENV = 'DGB_BRIDGE_HELPER';
|
|
51
|
-
/** Env var carrying a debug log path to the helper script (unset by default). */
|
|
52
|
-
export const BRIDGE_DEBUG_ENV = 'DGB_BRIDGE_DEBUG';
|
|
53
|
-
/** Env var pointing git at the generated session configuration file. */
|
|
54
|
-
export const SESSION_GITCONFIG_ENV = 'GIT_CONFIG_GLOBAL';
|
|
55
|
-
/**
|
|
56
|
-
* Quote one executable or path for git's `!` shell command. Backslashes are
|
|
57
|
-
* normalized to forward slashes first: git runs `!` helpers through `sh`,
|
|
58
|
-
* where `C:\\…` would be read as escape sequences.
|
|
59
|
-
* @param value - an absolute path.
|
|
60
|
-
*/
|
|
61
|
-
export function shellQuote(value) {
|
|
62
|
-
return `"${value.replace(/\\/g, '/')}"`;
|
|
63
|
-
}
|
|
64
|
-
/**
|
|
65
|
-
* The helper command git runs for one configured host: a `!`-prefixed shell
|
|
66
|
-
* command, because git does not word-split a helper value by itself (a bare
|
|
67
|
-
* `node "C:/…/bridge.js"` is looked up as the program `git-credential-node`).
|
|
68
|
-
* @param nodePath - the node executable.
|
|
69
|
-
* @param helperPath - the compiled helper script.
|
|
70
|
-
*/
|
|
71
|
-
export function bridgeCommand(nodePath, helperPath) {
|
|
72
|
-
return `!${shellQuote(nodePath)} ${shellQuote(helperPath)}`;
|
|
73
|
-
}
|
|
74
|
-
/**
|
|
75
|
-
* Escape one value for a gitconfig line: a literal `"` becomes `\"`, which is
|
|
76
|
-
* how a quoted path survives git's config parser and still reaches `sh`
|
|
77
|
-
* intact. Without this the quotes are eaten and `sh` splits
|
|
78
|
-
* `C:/Program Files/…` on the space.
|
|
79
|
-
* @param value - the raw helper command.
|
|
80
|
-
*/
|
|
81
|
-
export function gitconfigEscape(value) {
|
|
82
|
-
return value.replace(/"/g, '\\"');
|
|
83
|
-
}
|
|
84
|
-
/**
|
|
85
|
-
* The session gitconfig body for the given hosts: the user's own config
|
|
86
|
-
* included (read-only), the whole machine helper list reset to empty, and per
|
|
87
|
-
* host a URL-scoped reset followed by the bridge command. The empty value
|
|
88
|
-
* before each command is what cuts the included `gh` helper (and any other
|
|
89
|
-
* helper the user configures for that URL) out of that scope.
|
|
90
|
-
* @param hosts - normalized hosts with a stored credential.
|
|
91
|
-
* @param options - the node/helper pair and the user config to include.
|
|
27
|
+
* `apply`/`dispose` still delete the retired 0032 channel's leftovers
|
|
28
|
+
* (`GIT_CONFIG_COUNT` with a broken `GIT_CONFIG_KEY_n` / `GIT_CONFIG_VALUE_n`
|
|
29
|
+
* set). The DSH subprocess scrubber strips the KEY names while the count and
|
|
30
|
+
* values survive, so a half-injected channel — left behind by an upgrade from
|
|
31
|
+
* 1.0.10 — makes git abort every command; see `legacyConfigNames` (0036).
|
|
92
32
|
*/
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
// (`helper-selector` → GCM), which raises a GUI prompt no agent shell can
|
|
107
|
-
// answer. With it, such a host fails at once with "terminal prompts
|
|
108
|
-
// disabled", and the URL-scoped pairs below are the only way credentials
|
|
109
|
-
// get back into a shell.
|
|
110
|
-
lines.push('[credential]', '\thelper =');
|
|
111
|
-
const command = gitconfigEscape(bridgeCommand(options.nodePath, options.helperPath));
|
|
112
|
-
for (const host of unique) {
|
|
113
|
-
lines.push(`[credential "https://${host}/"]`,
|
|
114
|
-
// Empty first: it resets whatever helper list the included user config
|
|
115
|
-
// accumulated for this URL (the local `gh` helper), or git would answer
|
|
116
|
-
// with that account before the bridge is ever consulted.
|
|
117
|
-
'\thelper =', `\thelper = ${command}`);
|
|
118
|
-
}
|
|
119
|
-
return `${lines.join('\n')}\n`;
|
|
120
|
-
}
|
|
33
|
+
import { rm } from 'node:fs/promises';
|
|
34
|
+
import { join } from 'node:path';
|
|
35
|
+
import { credentialIncludeBody, credentialIncludeFile, createLocalCredentialStore, ensureGitconfigInclude, removeGitconfigInclude, writeFileAtomic, } from './credentials.js';
|
|
36
|
+
/** The retired 0032 channel's count variable. */
|
|
37
|
+
export const LEGACY_COUNT_ENV = 'GIT_CONFIG_COUNT';
|
|
38
|
+
/** Names of the retired 0032 channel's per-entry pairs. */
|
|
39
|
+
const LEGACY_KEY_NAME = /^GIT_CONFIG_KEY_\d+$/;
|
|
40
|
+
const LEGACY_VALUE_NAME = /^GIT_CONFIG_VALUE_\d+$/;
|
|
41
|
+
/** Fail fast instead of parking a shell on a prompt or a GUI dialog. */
|
|
42
|
+
const FAIL_FAST = [
|
|
43
|
+
['GIT_TERMINAL_PROMPT', '0'],
|
|
44
|
+
['GCM_INTERACTIVE', 'never'],
|
|
45
|
+
];
|
|
121
46
|
/**
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
47
|
+
* Environment names left over from the retired 0032 channel that would make
|
|
48
|
+
* git abort with `fatal: unable to parse command-line config`.
|
|
49
|
+
*
|
|
50
|
+
* The DSH subprocess scrubber deletes every `GIT_CONFIG_KEY_<n>` (the name
|
|
51
|
+
* contains `KEY`) while `GIT_CONFIG_COUNT` / `GIT_CONFIG_VALUE_<n>` survive, so
|
|
52
|
+
* the channel is injected half-way and git can no longer parse it. Those
|
|
53
|
+
* leftovers outlive the code that wrote them: upgrading the plugin from 1.0.10
|
|
54
|
+
* leaves them in the host process environment, where they break every `git`
|
|
55
|
+
* command in every derived shell until someone deletes them by hand.
|
|
56
|
+
*
|
|
57
|
+
* A count whose pairs are all present is valid git input (a caller may set the
|
|
58
|
+
* channel deliberately), so it is left untouched; only a broken channel — or a
|
|
59
|
+
* non-numeric count — is reported for removal.
|
|
60
|
+
* @param env - the environment to inspect.
|
|
126
61
|
*/
|
|
127
|
-
export function
|
|
128
|
-
|
|
129
|
-
[
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
62
|
+
export function legacyConfigNames(env) {
|
|
63
|
+
if (env[LEGACY_COUNT_ENV] === undefined)
|
|
64
|
+
return [];
|
|
65
|
+
const count = Number(env[LEGACY_COUNT_ENV]);
|
|
66
|
+
const paired = Number.isInteger(count) && count >= 0
|
|
67
|
+
&& Array.from({ length: count }, (_, index) => `GIT_CONFIG_KEY_${index}`)
|
|
68
|
+
.every(name => env[name] !== undefined);
|
|
69
|
+
if (paired)
|
|
70
|
+
return [];
|
|
71
|
+
return Object.keys(env).filter(name => name === LEGACY_COUNT_ENV || LEGACY_KEY_NAME.test(name) || LEGACY_VALUE_NAME.test(name));
|
|
135
72
|
}
|
|
136
73
|
/**
|
|
137
|
-
* Build the
|
|
138
|
-
* rewrites the
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
* unauthenticated at worst) while the fail-fast switches still go out.
|
|
74
|
+
* Build the setup over one host process. Every {@link ShellBridge.apply}
|
|
75
|
+
* rewrites the include for the current store, so a deleted host loses its
|
|
76
|
+
* helper scope just like a freshly added one gains it. A failing write never
|
|
77
|
+
* throws: the worst case is a stale include until the next credential save,
|
|
78
|
+
* and git keeps working with the machine's own configuration.
|
|
143
79
|
* @param deps - host seams.
|
|
144
80
|
*/
|
|
145
81
|
export function createShellBridge(deps) {
|
|
146
82
|
const env = deps.env ?? process.env;
|
|
147
|
-
const
|
|
148
|
-
|
|
83
|
+
const includePath = credentialIncludeFile(deps.home(), deps.envHome());
|
|
84
|
+
const gitconfig = () => deps.userGitconfig ?? join(deps.home(), '.gitconfig');
|
|
85
|
+
const store = () => deps.store ?? createLocalCredentialStore(deps.home(), deps.envHome());
|
|
149
86
|
let applied = [];
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
writeFileSync(partial, body, { encoding: 'utf8', mode: 0o600 });
|
|
156
|
-
renameSync(partial, configPath);
|
|
157
|
-
try {
|
|
158
|
-
chmodSync(configPath, 0o600);
|
|
159
|
-
}
|
|
160
|
-
catch {
|
|
161
|
-
// Best effort: Windows ignores the mode, the file holds no secret.
|
|
87
|
+
/** Delete the retired 0032 channel's leftovers before git can see them. */
|
|
88
|
+
const dropLegacy = () => {
|
|
89
|
+
for (const key of legacyConfigNames(env)) {
|
|
90
|
+
delete env[key];
|
|
91
|
+
applied.push(key);
|
|
162
92
|
}
|
|
163
93
|
};
|
|
164
94
|
return {
|
|
165
|
-
configPath: () =>
|
|
95
|
+
configPath: () => includePath,
|
|
166
96
|
async apply() {
|
|
167
97
|
let hosts = [];
|
|
168
98
|
try {
|
|
169
|
-
hosts = (await
|
|
99
|
+
hosts = (await store().load()).map(entry => entry.host);
|
|
170
100
|
}
|
|
171
101
|
catch {
|
|
172
|
-
// An unreadable store means no host can be
|
|
173
|
-
//
|
|
174
|
-
//
|
|
102
|
+
// An unreadable store means no host can be scoped. The include file
|
|
103
|
+
// is still rewritten empty, so a stale host does not keep a helper
|
|
104
|
+
// pointing at a file that no longer holds its credential.
|
|
175
105
|
hosts = [];
|
|
176
106
|
}
|
|
177
|
-
const helperPath = deps.helperPath
|
|
178
|
-
?? fileURLToPath(new URL('./helpers/git-credential-bridge.js', import.meta.url));
|
|
179
|
-
const body = sessionGitconfigBody(hosts, {
|
|
180
|
-
nodePath: deps.nodePath ?? process.execPath,
|
|
181
|
-
helperPath,
|
|
182
|
-
userGitconfig: deps.userGitconfig ?? join(deps.home(), '.gitconfig'),
|
|
183
|
-
});
|
|
184
|
-
let assignments = [
|
|
185
|
-
['GIT_TERMINAL_PROMPT', '0'],
|
|
186
|
-
['GCM_INTERACTIVE', 'never'],
|
|
187
|
-
];
|
|
188
107
|
try {
|
|
189
|
-
|
|
190
|
-
|
|
108
|
+
// Write the include first: if `~/.gitconfig` cannot be updated, the
|
|
109
|
+
// file it already points at is at least current.
|
|
110
|
+
await writeFileAtomic(includePath, credentialIncludeBody(hosts), 0o600);
|
|
111
|
+
await ensureGitconfigInclude(gitconfig(), includePath);
|
|
191
112
|
}
|
|
192
113
|
catch {
|
|
193
|
-
//
|
|
194
|
-
// GIT_CONFIG_GLOBAL at a missing file (that would drop the reset and
|
|
195
|
-
// let the machine chain pop a dialog); only the fail-fast switches
|
|
196
|
-
// remain, so a shell git runs unauthenticated but never hangs.
|
|
114
|
+
// Deliberately swallowed; see the contract above.
|
|
197
115
|
}
|
|
116
|
+
dropLegacy();
|
|
198
117
|
for (const key of applied)
|
|
199
118
|
delete env[key];
|
|
200
119
|
applied = [];
|
|
201
|
-
for (const [key, value] of
|
|
120
|
+
for (const [key, value] of FAIL_FAST) {
|
|
202
121
|
env[key] = value;
|
|
203
122
|
applied.push(key);
|
|
204
123
|
}
|
|
205
124
|
},
|
|
206
125
|
async dispose() {
|
|
126
|
+
dropLegacy();
|
|
207
127
|
for (const key of applied)
|
|
208
128
|
delete env[key];
|
|
209
129
|
applied = [];
|
|
210
130
|
try {
|
|
211
|
-
|
|
131
|
+
await removeGitconfigInclude(gitconfig(), includePath);
|
|
132
|
+
}
|
|
133
|
+
catch {
|
|
134
|
+
// Best effort: a leftover include still points at the file below.
|
|
135
|
+
}
|
|
136
|
+
try {
|
|
137
|
+
await rm(includePath, { force: true });
|
|
212
138
|
}
|
|
213
139
|
catch {
|
|
214
|
-
// Best effort:
|
|
140
|
+
// Best effort: the file holds no secret and `apply` rewrites it.
|
|
215
141
|
}
|
|
216
142
|
},
|
|
217
143
|
};
|
package/lib/tool.js
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
*
|
|
15
15
|
* @module dsh-git-branch/tool
|
|
16
16
|
*/
|
|
17
|
-
import { basicUsername,
|
|
17
|
+
import { basicUsername, createLocalCredentialStore, maskSecret, } from './credentials.js';
|
|
18
18
|
/** Model-facing tool name. */
|
|
19
19
|
export const GIT_CREDENTIALS_TOOL_NAME = 'git_credentials';
|
|
20
20
|
/** Project one stored entry onto its model-facing row. */
|
|
@@ -48,7 +48,7 @@ export function renderGitCredentials(value) {
|
|
|
48
48
|
* @returns a definition ready for `ctx.tools.register`.
|
|
49
49
|
*/
|
|
50
50
|
export function gitCredentialsTool(deps) {
|
|
51
|
-
const storeOf = () => deps.credentialsService?.store ?? deps.store ??
|
|
51
|
+
const storeOf = () => deps.credentialsService?.store ?? deps.store ?? createLocalCredentialStore(deps.home(), deps.envHome());
|
|
52
52
|
/** Read the store, folding a read failure into the result value. */
|
|
53
53
|
const read = async (args) => {
|
|
54
54
|
const store = storeOf();
|
package/lib/wire.d.ts
CHANGED
|
@@ -57,6 +57,8 @@ export declare const ROUTE_COMMIT_FILES = "/plugin/git-worktree/commit-files";
|
|
|
57
57
|
export declare const ROUTE_TAG = "/plugin/git-worktree/tag";
|
|
58
58
|
/** POST ROUTE_PREFIX/tag-push — push ONE existing local tag to its remote. */
|
|
59
59
|
export declare const ROUTE_TAG_PUSH = "/plugin/git-worktree/tag-push";
|
|
60
|
+
/** POST ROUTE_PREFIX/network-probe — read the endpoint through every configured channel (diagnostics; no state change). */
|
|
61
|
+
export declare const ROUTE_NETWORK_PROBE = "/plugin/git-worktree/network-probe";
|
|
60
62
|
/** POST ROUTE_PREFIX/credentials — the global per-host credentials, secrets
|
|
61
63
|
* masked (the stored secret never leaves the host). */
|
|
62
64
|
export declare const ROUTE_CREDENTIALS = "/plugin/git-worktree/credentials";
|
|
@@ -70,6 +72,9 @@ export declare const ROUTE_CREDENTIALS_OAUTH_START = "/plugin/git-worktree/crede
|
|
|
70
72
|
/** POST ROUTE_PREFIX/credentials-oauth-poll — poll a started browser sign-in;
|
|
71
73
|
* stores the token and answers the fresh masked list once the user approves. */
|
|
72
74
|
export declare const ROUTE_CREDENTIALS_OAUTH_POLL = "/plugin/git-worktree/credentials-oauth-poll";
|
|
75
|
+
/** POST ROUTE_PREFIX/credentials-import — copy the credentials the machine's
|
|
76
|
+
* own helpers already answer for into the managed store (decision 0038). */
|
|
77
|
+
export declare const ROUTE_CREDENTIALS_IMPORT = "/plugin/git-worktree/credentials-import";
|
|
73
78
|
/** POST ROUTE_PREFIX/remotes — the repository's configured remotes. */
|
|
74
79
|
export declare const ROUTE_REMOTES = "/plugin/git-worktree/remotes";
|
|
75
80
|
/** POST ROUTE_PREFIX/remote — add, re-point or remove ONE remote. */
|
|
@@ -267,6 +272,9 @@ export interface PushResult {
|
|
|
267
272
|
branch: string;
|
|
268
273
|
/** False when the upstream already contained the branch (nothing moved). */
|
|
269
274
|
pushed: boolean;
|
|
275
|
+
/** Set when the push timed out but the remote ref already matched HEAD:
|
|
276
|
+
* the push landed and only the confirmation was lost. */
|
|
277
|
+
note?: 'timed-out-but-landed';
|
|
270
278
|
}
|
|
271
279
|
/** Error envelope every non-2xx response carries. */
|
|
272
280
|
export interface RouteError {
|
|
@@ -543,6 +551,9 @@ export interface PushTagResult {
|
|
|
543
551
|
/** False when the remote already carried this exact tag object — nothing
|
|
544
552
|
* was sent. True once the push command actually ran. */
|
|
545
553
|
pushed: boolean;
|
|
554
|
+
/** Set when the push timed out but the remote tag already named the local
|
|
555
|
+
* object: the tag landed and only the confirmation was lost. */
|
|
556
|
+
note?: 'timed-out-but-landed';
|
|
546
557
|
}
|
|
547
558
|
/** One file row of POST commit-files. */
|
|
548
559
|
export interface CommitFileEntry {
|
|
@@ -626,6 +637,32 @@ export interface CredentialDeleteBody {
|
|
|
626
637
|
}
|
|
627
638
|
/** POST credentials-delete response body: the updated masked list. */
|
|
628
639
|
export type CredentialDeleteResult = CredentialsResult;
|
|
640
|
+
/** POST credentials-import request body — absent hosts means "whatever the
|
|
641
|
+
* machine's gitconfig points git at". */
|
|
642
|
+
export interface CredentialImportBody {
|
|
643
|
+
/** Explicit hosts to probe; omitted, the gitconfig's URL-scoped hosts are
|
|
644
|
+
* the candidates. */
|
|
645
|
+
hosts?: string[];
|
|
646
|
+
}
|
|
647
|
+
/** One host the import copied into the store (secret never included). */
|
|
648
|
+
export interface CredentialImportEntry {
|
|
649
|
+
host: string;
|
|
650
|
+
/** `oauth2` for a token credential, the helper's user name otherwise. */
|
|
651
|
+
username: string;
|
|
652
|
+
method: CredentialMethod;
|
|
653
|
+
}
|
|
654
|
+
/** One host whose machine helper had nothing to give; the store is untouched. */
|
|
655
|
+
export interface CredentialImportFailure {
|
|
656
|
+
host: string;
|
|
657
|
+
error: string;
|
|
658
|
+
}
|
|
659
|
+
/** POST credentials-import response body: the fresh masked list plus what the
|
|
660
|
+
* import did per host. */
|
|
661
|
+
export interface CredentialImportResult extends CredentialsResult {
|
|
662
|
+
imported: CredentialImportEntry[];
|
|
663
|
+
skipped: string[];
|
|
664
|
+
failed: CredentialImportFailure[];
|
|
665
|
+
}
|
|
629
666
|
/** POST credentials-oauth-start request body. */
|
|
630
667
|
export interface CredentialOAuthStartBody {
|
|
631
668
|
/** Remote host whose browser sign-in to start (must support device flow). */
|
|
@@ -702,3 +739,30 @@ export interface RemoteMutationBody {
|
|
|
702
739
|
}
|
|
703
740
|
/** POST remote response body: the repository's remotes after the change. */
|
|
704
741
|
export type RemoteMutationResult = RemotesResult;
|
|
742
|
+
/** The network channels a probe can report, in the order they are tried. */
|
|
743
|
+
export type NetworkChannelId = 'direct' | 'proxy' | 'ip';
|
|
744
|
+
/** One channel's verdict from ROUTE_NETWORK_PROBE. */
|
|
745
|
+
export interface NetworkChannelReport {
|
|
746
|
+
/** Which channel was attempted. */
|
|
747
|
+
channel: NetworkChannelId;
|
|
748
|
+
/** Whether an ls-remote answered within the probe budget. */
|
|
749
|
+
ok: boolean;
|
|
750
|
+
/** Wall-clock milliseconds the attempt took. */
|
|
751
|
+
elapsedMs: number;
|
|
752
|
+
/** Why it failed, trimmed for display; absent when ok. */
|
|
753
|
+
detail?: string;
|
|
754
|
+
}
|
|
755
|
+
/** POST network-probe request body. */
|
|
756
|
+
export interface NetworkProbeBody {
|
|
757
|
+
/** Any directory inside the repository. */
|
|
758
|
+
repoPath: string;
|
|
759
|
+
}
|
|
760
|
+
/** POST network-probe response body: one verdict per configured channel. */
|
|
761
|
+
export interface NetworkProbeResult {
|
|
762
|
+
/** The endpoint that was probed (the push URL when the branch has one). */
|
|
763
|
+
url: string;
|
|
764
|
+
/** One entry per configured channel. */
|
|
765
|
+
channels: NetworkChannelReport[];
|
|
766
|
+
/** The WinINET proxy when one is enabled but not configured in the plugin. */
|
|
767
|
+
systemProxy?: string;
|
|
768
|
+
}
|
package/lib/wire.js
CHANGED
|
@@ -57,6 +57,8 @@ export const ROUTE_COMMIT_FILES = `${ROUTE_PREFIX}/commit-files`;
|
|
|
57
57
|
export const ROUTE_TAG = `${ROUTE_PREFIX}/tag`;
|
|
58
58
|
/** POST ROUTE_PREFIX/tag-push — push ONE existing local tag to its remote. */
|
|
59
59
|
export const ROUTE_TAG_PUSH = `${ROUTE_PREFIX}/tag-push`;
|
|
60
|
+
/** POST ROUTE_PREFIX/network-probe — read the endpoint through every configured channel (diagnostics; no state change). */
|
|
61
|
+
export const ROUTE_NETWORK_PROBE = `${ROUTE_PREFIX}/network-probe`;
|
|
60
62
|
/** POST ROUTE_PREFIX/credentials — the global per-host credentials, secrets
|
|
61
63
|
* masked (the stored secret never leaves the host). */
|
|
62
64
|
export const ROUTE_CREDENTIALS = `${ROUTE_PREFIX}/credentials`;
|
|
@@ -70,6 +72,9 @@ export const ROUTE_CREDENTIALS_OAUTH_START = `${ROUTE_PREFIX}/credentials-oauth-
|
|
|
70
72
|
/** POST ROUTE_PREFIX/credentials-oauth-poll — poll a started browser sign-in;
|
|
71
73
|
* stores the token and answers the fresh masked list once the user approves. */
|
|
72
74
|
export const ROUTE_CREDENTIALS_OAUTH_POLL = `${ROUTE_PREFIX}/credentials-oauth-poll`;
|
|
75
|
+
/** POST ROUTE_PREFIX/credentials-import — copy the credentials the machine's
|
|
76
|
+
* own helpers already answer for into the managed store (decision 0038). */
|
|
77
|
+
export const ROUTE_CREDENTIALS_IMPORT = `${ROUTE_PREFIX}/credentials-import`;
|
|
73
78
|
/** POST ROUTE_PREFIX/remotes — the repository's configured remotes. */
|
|
74
79
|
export const ROUTE_REMOTES = `${ROUTE_PREFIX}/remotes`;
|
|
75
80
|
/** POST ROUTE_PREFIX/remote — add, re-point or remove ONE remote. */
|
package/package.json
CHANGED
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Standalone git credential helper shipped with the dsh-git-branch plugin.
|
|
3
|
-
*
|
|
4
|
-
* The panel's credential file (`~/.dsh/git-credentials.json`) normally rides
|
|
5
|
-
* `-c http.<url>.extraHeader` config on the routes and the `git_network` tool.
|
|
6
|
-
* This helper extends that coverage to a plain shell `git push`: the plugin's
|
|
7
|
-
* host process writes a session gitconfig (see `src/shell-bridge.ts`) that
|
|
8
|
-
* installs this script as a URL-scoped credential helper for every stored
|
|
9
|
-
* host, so commands the model runs in the shell authenticate as the
|
|
10
|
-
* configured account too.
|
|
11
|
-
*
|
|
12
|
-
* Design constraints (see docs/decisions/0029, 0032 and 0034):
|
|
13
|
-
* - The user's global git config and credential helpers are never written;
|
|
14
|
-
* the injection lives in one generated session config plus the process
|
|
15
|
-
* environment only.
|
|
16
|
-
* - The token never enters the conversation: this script reads the
|
|
17
|
-
* credential file directly on the host and answers git on stdout.
|
|
18
|
-
* - URL scope (`credential.https://<host>/`) confines the helper to hosts
|
|
19
|
-
* with a stored credential. The host half also clears the machine helper
|
|
20
|
-
* list, so a host this script cannot answer fails fast instead of opening
|
|
21
|
-
* an interactive credential dialog.
|
|
22
|
-
* - `get` is silent on a miss (git falls through to the next helper);
|
|
23
|
-
* `store`/`erase` are pass-through by decision — writing back would race
|
|
24
|
-
* the panel's atomic save and leak the file shape.
|
|
25
|
-
*
|
|
26
|
-
* Environment contract (set by src/shell-bridge.ts). The names carry no
|
|
27
|
-
* KEY/PASSWORD/SECRET/TOKEN substring and no `DSH_` prefix, because the DSH
|
|
28
|
-
* subprocess scrubber strips exactly those from inherited environments
|
|
29
|
-
* (decision 0034; a stripped path made this helper read the wrong file):
|
|
30
|
-
* - `DGB_BRIDGE_HELPER` — credential file path (required).
|
|
31
|
-
* - `DGB_BRIDGE_HOME` — user home directory (fallback resolution).
|
|
32
|
-
* - `DGB_BRIDGE_DSH_HOME` — `$DSH_HOME` override (optional).
|
|
33
|
-
* - `DGB_BRIDGE_DEBUG` — when non-blank, a debug log path (optional).
|
|
34
|
-
*
|
|
35
|
-
* @module dsh-git-branch/git-credential-bridge
|
|
36
|
-
*/
|
|
37
|
-
export {};
|
|
@@ -1,119 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Standalone git credential helper shipped with the dsh-git-branch plugin.
|
|
3
|
-
*
|
|
4
|
-
* The panel's credential file (`~/.dsh/git-credentials.json`) normally rides
|
|
5
|
-
* `-c http.<url>.extraHeader` config on the routes and the `git_network` tool.
|
|
6
|
-
* This helper extends that coverage to a plain shell `git push`: the plugin's
|
|
7
|
-
* host process writes a session gitconfig (see `src/shell-bridge.ts`) that
|
|
8
|
-
* installs this script as a URL-scoped credential helper for every stored
|
|
9
|
-
* host, so commands the model runs in the shell authenticate as the
|
|
10
|
-
* configured account too.
|
|
11
|
-
*
|
|
12
|
-
* Design constraints (see docs/decisions/0029, 0032 and 0034):
|
|
13
|
-
* - The user's global git config and credential helpers are never written;
|
|
14
|
-
* the injection lives in one generated session config plus the process
|
|
15
|
-
* environment only.
|
|
16
|
-
* - The token never enters the conversation: this script reads the
|
|
17
|
-
* credential file directly on the host and answers git on stdout.
|
|
18
|
-
* - URL scope (`credential.https://<host>/`) confines the helper to hosts
|
|
19
|
-
* with a stored credential. The host half also clears the machine helper
|
|
20
|
-
* list, so a host this script cannot answer fails fast instead of opening
|
|
21
|
-
* an interactive credential dialog.
|
|
22
|
-
* - `get` is silent on a miss (git falls through to the next helper);
|
|
23
|
-
* `store`/`erase` are pass-through by decision — writing back would race
|
|
24
|
-
* the panel's atomic save and leak the file shape.
|
|
25
|
-
*
|
|
26
|
-
* Environment contract (set by src/shell-bridge.ts). The names carry no
|
|
27
|
-
* KEY/PASSWORD/SECRET/TOKEN substring and no `DSH_` prefix, because the DSH
|
|
28
|
-
* subprocess scrubber strips exactly those from inherited environments
|
|
29
|
-
* (decision 0034; a stripped path made this helper read the wrong file):
|
|
30
|
-
* - `DGB_BRIDGE_HELPER` — credential file path (required).
|
|
31
|
-
* - `DGB_BRIDGE_HOME` — user home directory (fallback resolution).
|
|
32
|
-
* - `DGB_BRIDGE_DSH_HOME` — `$DSH_HOME` override (optional).
|
|
33
|
-
* - `DGB_BRIDGE_DEBUG` — when non-blank, a debug log path (optional).
|
|
34
|
-
*
|
|
35
|
-
* @module dsh-git-branch/git-credential-bridge
|
|
36
|
-
*/
|
|
37
|
-
import { appendFileSync, readFileSync } from 'node:fs';
|
|
38
|
-
import { homedir } from 'node:os';
|
|
39
|
-
import { join } from 'node:path';
|
|
40
|
-
/** git helpers receive exactly one argument: the operation. */
|
|
41
|
-
const OPERATION = process.argv[2] ?? 'get';
|
|
42
|
-
/** The credential file this helper reads (`DGB_BRIDGE_HELPER` wins). */
|
|
43
|
-
const DEFAULT_CREDENTIAL_FILE = 'git-credentials.json';
|
|
44
|
-
/** The dsh home directory below the user profile when `$DSH_HOME` is unset. */
|
|
45
|
-
const PACKAGE_HOME = '.dsh';
|
|
46
|
-
/** The Basic-auth name a token without a username is sent under. */
|
|
47
|
-
const TOKEN_USERNAME = 'oauth2';
|
|
48
|
-
/**
|
|
49
|
-
* Append one debug line behind the user's back; a broken log path must never
|
|
50
|
-
* break the credential lookup.
|
|
51
|
-
*/
|
|
52
|
-
function debug(line) {
|
|
53
|
-
const path = process.env.DGB_BRIDGE_DEBUG;
|
|
54
|
-
if (path === undefined || path.trim() === '')
|
|
55
|
-
return;
|
|
56
|
-
try {
|
|
57
|
-
appendFileSync(path, `${line}\n`, 'utf8');
|
|
58
|
-
}
|
|
59
|
-
catch {
|
|
60
|
-
// Deliberately swallowed: debugging is best-effort.
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
/** The credential file this helper reads (`DGB_BRIDGE_HELPER` wins). */
|
|
64
|
-
function credentialFile() {
|
|
65
|
-
const helper = process.env.DGB_BRIDGE_HELPER;
|
|
66
|
-
if (helper !== undefined && helper.trim() !== '')
|
|
67
|
-
return helper;
|
|
68
|
-
const dshHome = process.env.DGB_BRIDGE_DSH_HOME;
|
|
69
|
-
const home = dshHome !== undefined && dshHome.trim() !== ''
|
|
70
|
-
? dshHome
|
|
71
|
-
: process.env.DGB_BRIDGE_HOME ?? homedir();
|
|
72
|
-
return join(home, PACKAGE_HOME, DEFAULT_CREDENTIAL_FILE);
|
|
73
|
-
}
|
|
74
|
-
/** One `key=value` request from git on stdin. */
|
|
75
|
-
function readRequest() {
|
|
76
|
-
const text = readFileSync(0, 'utf8');
|
|
77
|
-
const request = new Map();
|
|
78
|
-
for (const line of text.split('\n')) {
|
|
79
|
-
const at = line.indexOf('=');
|
|
80
|
-
if (at > 0)
|
|
81
|
-
request.set(line.slice(0, at), line.slice(at + 1));
|
|
82
|
-
}
|
|
83
|
-
return request;
|
|
84
|
-
}
|
|
85
|
-
/** The stored credential for one host, or undefined when there is none. */
|
|
86
|
-
function readCredential(host) {
|
|
87
|
-
let parsed;
|
|
88
|
-
try {
|
|
89
|
-
parsed = JSON.parse(readFileSync(credentialFile(), 'utf8'));
|
|
90
|
-
}
|
|
91
|
-
catch (error) {
|
|
92
|
-
debug(`read failed: ${String(error)}`);
|
|
93
|
-
return undefined;
|
|
94
|
-
}
|
|
95
|
-
const credentials = parsed.credentials;
|
|
96
|
-
if (!Array.isArray(credentials))
|
|
97
|
-
return undefined;
|
|
98
|
-
const entry = credentials.find((item) => typeof item === 'object' && item !== null && item.host === host);
|
|
99
|
-
if (entry === undefined)
|
|
100
|
-
return undefined;
|
|
101
|
-
const secret = typeof entry.secret === 'string' ? entry.secret : '';
|
|
102
|
-
if (secret === '')
|
|
103
|
-
return undefined;
|
|
104
|
-
const username = typeof entry.username === 'string' && entry.username.trim() !== ''
|
|
105
|
-
? entry.username
|
|
106
|
-
: TOKEN_USERNAME;
|
|
107
|
-
return { username, secret };
|
|
108
|
-
}
|
|
109
|
-
if (OPERATION === 'get') {
|
|
110
|
-
const request = readRequest();
|
|
111
|
-
const host = request.get('host') ?? '';
|
|
112
|
-
debug(`get host=${host} protocol=${request.get('protocol') ?? ''}`);
|
|
113
|
-
const credential = readCredential(host);
|
|
114
|
-
if (credential !== undefined) {
|
|
115
|
-
process.stdout.write(`username=${credential.username}\npassword=${credential.secret}\n`);
|
|
116
|
-
}
|
|
117
|
-
// A miss stays silent: git tries the next helper in the chain.
|
|
118
|
-
}
|
|
119
|
-
// `store` / `erase` are deliberate no-ops (see the header comment).
|