mirror of
https://github.com/affaan-m/ECC.git
synced 2026-11-17 13:32:18 +00:00
Merge reviewed PR #3864
This commit is contained in:
8 files changed
+231
-5
No files matched your search
@@ -15,6 +15,7 @@
|
||||
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const { showRecoveryHints } = require('../lib/hooks/recovery-hints');
|
||||
|
||||
const MAX_STDIN = 1024 * 1024;
|
||||
let raw = '';
|
||||
@@ -152,7 +153,9 @@ function run(inputOrRaw, options = {}) {
|
||||
stderr:
|
||||
`BLOCKED: Hook input exceeded ${options.maxStdin || MAX_STDIN} bytes. ` +
|
||||
'Refusing to bypass config-protection on a truncated payload. ' +
|
||||
'Retry with a smaller edit or disable the config-protection hook temporarily.'
|
||||
(showRecoveryHints()
|
||||
? 'Retry with a smaller edit or disable the config-protection hook temporarily.'
|
||||
: 'Retry with a smaller edit.')
|
||||
};
|
||||
}
|
||||
|
||||
@@ -221,8 +224,10 @@ function checkTarget(filePath) {
|
||||
stderr:
|
||||
`BLOCKED: Modifying ${basename} is not allowed. ` +
|
||||
'Fix the source code to satisfy linter/formatter rules instead of ' +
|
||||
'weakening the config. If this is a legitimate config change, ' +
|
||||
'disable the config-protection hook temporarily.'
|
||||
'weakening the config.' +
|
||||
(showRecoveryHints()
|
||||
? ' If this is a legitimate config change, disable the config-protection hook temporarily.'
|
||||
: '')
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -25,6 +25,7 @@
|
||||
const crypto = require('crypto');
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const { showRecoveryHints } = require('../lib/hooks/recovery-hints');
|
||||
const { extractCommandSubstitutions, extractSubshellGroups, extractBraceGroups } = require('../lib/shell-substitution');
|
||||
const { classifyPowerShellDestructiveCommand } = require('../lib/powershell-destructive-command');
|
||||
const { stripHeredocBodies } = require('./gateguard-heredoc');
|
||||
@@ -2102,7 +2103,9 @@ function condensedGateMsg(action, filePath, ordinal, { cls = 'code', targetNote
|
||||
`${batchSiblingWarning(safe)} ` +
|
||||
(missNote ? `${missNote} ` : '') +
|
||||
(targetNote ? `${targetNote} ` : '') +
|
||||
'(Use GATEGUARD_EXEMPT_GLOBS for path-scoped exemptions; GATEGUARD_FACT_FORCE_MAX_DENIALS caps denials per session; ECC_GATEGUARD=off disables this gate.)'
|
||||
(showRecoveryHints()
|
||||
? '(Use GATEGUARD_EXEMPT_GLOBS for path-scoped exemptions; GATEGUARD_FACT_FORCE_MAX_DENIALS caps denials per session; ECC_GATEGUARD=off disables this gate.)'
|
||||
: '')
|
||||
);
|
||||
}
|
||||
|
||||
@@ -2177,6 +2180,7 @@ function routineShellMsg(toolName) {
|
||||
}
|
||||
|
||||
function withRecoveryHint(message, hookIds = [EDIT_WRITE_HOOK_ID], narrowRecoveryHint = '') {
|
||||
if (!showRecoveryHints()) return message;
|
||||
const disableTargets = hookIds.map(hookId => `\`${hookId}\``).join(' or ');
|
||||
const recoveryLines = narrowRecoveryHint ? [narrowRecoveryHint, ''] : [];
|
||||
return [
|
||||
|
||||
Executable → Regular
+4
-1
@@ -13,6 +13,7 @@ const path = require('path');
|
||||
const { spawnSync } = require('child_process');
|
||||
const { StringDecoder } = require('string_decoder');
|
||||
const { isHookEnabled, isDryRun } = require('../lib/hook-flags');
|
||||
const { showRecoveryHints } = require('../lib/hooks/recovery-hints');
|
||||
const { readStdinRaw: readBoundedStdin, resolveMaxStdin } = require('./hook-input');
|
||||
const { installHookWatchdog } = require('./hook-watchdog');
|
||||
const { buildPreToolUseAdditionalContext } = require('./pretooluse-visible-output');
|
||||
@@ -141,7 +142,9 @@ function truncatedInputResult(hookId, maxStdin) {
|
||||
|
||||
return {
|
||||
stdout: '',
|
||||
stderr: `BLOCKED: Hook input exceeded ${maxStdin} bytes, so ${hookId} could not safely inspect the complete request. Retry with a smaller tool input or explicitly disable this hook.`,
|
||||
stderr: showRecoveryHints()
|
||||
? `BLOCKED: Hook input exceeded ${maxStdin} bytes, so ${hookId} could not safely inspect the complete request. Retry with a smaller tool input or explicitly disable this hook.`
|
||||
: `BLOCKED: Hook input exceeded ${maxStdin} bytes, so ${hookId} could not safely inspect the complete request. Retry with a smaller tool input.`,
|
||||
exitCode: 2
|
||||
};
|
||||
}
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
'use strict';
|
||||
|
||||
// Denial text is tool output the guarded agent reads. Naming the env vars that
|
||||
// disable a hook hands it a bypass, so recovery instructions are opt-in for
|
||||
// human operators (#3844). Every hook must parse the switch the same way.
|
||||
const ENABLE_VALUES = new Set(['1', 'true', 'on', 'enabled', 'enable', 'yes']);
|
||||
|
||||
function showRecoveryHints(value = process.env.ECC_SHOW_RECOVERY_HINTS) {
|
||||
return ENABLE_VALUES.has(String(value || '').trim().toLowerCase());
|
||||
}
|
||||
|
||||
module.exports = { showRecoveryHints };
|
||||
@@ -164,6 +164,55 @@ function runTests() {
|
||||
})
|
||||
);
|
||||
|
||||
results.push(
|
||||
test('hides the config-protection recovery hint by default', () => {
|
||||
return withOwnedDirectory(fs.mkdtempSync(path.join(os.tmpdir(), 'ecc-config-protect-')), tmpDir => {
|
||||
const absPath = path.join(tmpDir, '.eslintrc.js');
|
||||
fs.writeFileSync(absPath, 'module.exports = {};');
|
||||
const result = runHook(
|
||||
{ tool_name: 'Write', tool_input: { file_path: absPath, content: '{}' } },
|
||||
{ ECC_SHOW_RECOVERY_HINTS: '' }
|
||||
);
|
||||
assert.strictEqual(result.code, 2);
|
||||
assert.ok(!result.stderr.includes('disable the config-protection hook temporarily'), result.stderr);
|
||||
});
|
||||
})
|
||||
);
|
||||
|
||||
results.push(
|
||||
test('restores the config-protection recovery hint for normalized truthy values', () => {
|
||||
return withOwnedDirectory(fs.mkdtempSync(path.join(os.tmpdir(), 'ecc-config-protect-')), tmpDir => {
|
||||
const absPath = path.join(tmpDir, '.eslintrc.js');
|
||||
fs.writeFileSync(absPath, 'module.exports = {};');
|
||||
for (const value of [' true ', 'enable']) {
|
||||
const result = runHook(
|
||||
{ tool_name: 'Write', tool_input: { file_path: absPath, content: '{}' } },
|
||||
{ ECC_SHOW_RECOVERY_HINTS: value }
|
||||
);
|
||||
assert.strictEqual(result.code, 2);
|
||||
assert.ok(result.stderr.includes('disable the config-protection hook temporarily'), `${value}: ${result.stderr}`);
|
||||
}
|
||||
});
|
||||
})
|
||||
);
|
||||
|
||||
results.push(
|
||||
test('hides the truncated-payload recovery hint by default and restores it on demand', () => {
|
||||
const rawInput = JSON.stringify({
|
||||
tool_name: 'Write',
|
||||
tool_input: { file_path: '.eslintrc.js', content: 'x'.repeat(1024 * 1024 + 2048) }
|
||||
});
|
||||
|
||||
const hidden = runHook(rawInput, { ECC_SHOW_RECOVERY_HINTS: '' });
|
||||
assert.strictEqual(hidden.code, 2);
|
||||
assert.ok(!hidden.stderr.includes('disable the config-protection hook temporarily'), hidden.stderr);
|
||||
|
||||
const shown = runHook(rawInput, { ECC_SHOW_RECOVERY_HINTS: ' true ' });
|
||||
assert.strictEqual(shown.code, 2);
|
||||
assert.ok(shown.stderr.includes('disable the config-protection hook temporarily'), shown.stderr);
|
||||
})
|
||||
);
|
||||
|
||||
results.push(
|
||||
test('allows first-time creation of a protected config file', () => {
|
||||
return withOwnedDirectory(fs.mkdtempSync(path.join(os.tmpdir(), 'ecc-config-protect-')), tmpDir => {
|
||||
|
||||
@@ -7,6 +7,10 @@ const fs = require('fs');
|
||||
const path = require('path');
|
||||
const { spawnSync } = require('child_process');
|
||||
|
||||
// These assertions cover the opt-in human-operator hint text (#3844): the
|
||||
// default denial no longer names the env vars that disable the guard.
|
||||
process.env.ECC_SHOW_RECOVERY_HINTS = '1';
|
||||
|
||||
const runner = path.join(__dirname, '..', '..', 'scripts', 'hooks', 'run-with-flags.js');
|
||||
const hookScript = path.join(__dirname, '..', '..', 'scripts', 'hooks', 'gateguard-fact-force.js');
|
||||
const externalStateDir = process.env.GATEGUARD_STATE_DIR;
|
||||
@@ -7718,6 +7722,63 @@ function runTests() {
|
||||
else failed++;
|
||||
}
|
||||
|
||||
// --- Test N: the default denial never names the controls that disable the hook (#3844) ---
|
||||
clearState();
|
||||
if (
|
||||
test('default denial does not name recovery bypass controls', () => {
|
||||
const input = {
|
||||
session_id: TEST_SESSION_ID,
|
||||
tool_name: 'Edit',
|
||||
tool_input: { file_path: '/workspace/app/src/recovery-hint.js', old_string: 'a', new_string: 'b' }
|
||||
};
|
||||
const result = runHook(input, { ECC_SHOW_RECOVERY_HINTS: '' });
|
||||
const output = parseOutput(result.stdout);
|
||||
assert.ok(output && output.hookSpecificOutput, 'expected a denial');
|
||||
assert.strictEqual(output.hookSpecificOutput.permissionDecision, 'deny');
|
||||
const reason = output.hookSpecificOutput.permissionDecisionReason;
|
||||
for (const leaked of [
|
||||
'ECC_GATEGUARD=off',
|
||||
'ECC_DISABLED_HOOKS',
|
||||
'GATEGUARD_EXEMPT_GLOBS',
|
||||
'GATEGUARD_BASH_ROUTINE_DISABLED'
|
||||
]) {
|
||||
assert.ok(!reason.includes(leaked), `default denial must not name ${leaked}`);
|
||||
}
|
||||
})
|
||||
)
|
||||
passed++;
|
||||
else failed++;
|
||||
|
||||
clearState();
|
||||
writeState({ checked: [], last_active: Date.now(), fact_force_denials: 3 });
|
||||
if (
|
||||
test('condensed default denial omits recovery markers and bypass controls', () => {
|
||||
const input = {
|
||||
session_id: TEST_SESSION_ID,
|
||||
tool_name: 'Edit',
|
||||
tool_input: { file_path: '/workspace/app/src/recovery-condensed.js', old_string: 'a', new_string: 'b' }
|
||||
};
|
||||
const result = runHook(input, { ECC_SHOW_RECOVERY_HINTS: '' });
|
||||
const output = parseOutput(result.stdout);
|
||||
assert.ok(output && output.hookSpecificOutput, 'expected the condensed denial');
|
||||
assert.strictEqual(output.hookSpecificOutput.permissionDecision, 'deny');
|
||||
const reason = output.hookSpecificOutput.permissionDecisionReason;
|
||||
assert.ok(reason.includes('denial #4'), 'expected the condensed denial ordinal');
|
||||
for (const leaked of [
|
||||
'Narrow recovery:',
|
||||
'Recovery:',
|
||||
'ECC_GATEGUARD=off',
|
||||
'ECC_DISABLED_HOOKS',
|
||||
'GATEGUARD_EXEMPT_GLOBS',
|
||||
'GATEGUARD_BASH_ROUTINE_DISABLED'
|
||||
]) {
|
||||
assert.ok(!reason.includes(leaked), `condensed default denial must not contain ${leaked}`);
|
||||
}
|
||||
})
|
||||
)
|
||||
passed++;
|
||||
else failed++;
|
||||
|
||||
const ddResults = runDdRegressionTests();
|
||||
passed += ddResults.passed;
|
||||
failed += ddResults.failed;
|
||||
|
||||
@@ -198,6 +198,36 @@ for (const [hookId, toolName, toolInput] of GATEGUARD_TRUNCATION_CASES) {
|
||||
}
|
||||
}
|
||||
|
||||
if (
|
||||
test('fail-closed truncation hides the disable-hook hint by default', () => {
|
||||
const result = runRunner(
|
||||
['pre:edit-write:gateguard-fact-force', 'scripts/hooks/gateguard-fact-force.js', 'standard,strict'],
|
||||
oversizedPayload(),
|
||||
{ ...GATEGUARD_ENV_BASELINE, ECC_GATEGUARD: 'on', ECC_SHOW_RECOVERY_HINTS: '' }
|
||||
);
|
||||
assert.strictEqual(result.status, 2);
|
||||
assert.doesNotMatch(result.stderr, /explicitly disable this hook/);
|
||||
})
|
||||
)
|
||||
passed++;
|
||||
else failed++;
|
||||
|
||||
if (
|
||||
test('fail-closed truncation restores the disable-hook hint for normalized truthy values', () => {
|
||||
for (const value of [' true ', 'enable']) {
|
||||
const result = runRunner(
|
||||
['pre:edit-write:gateguard-fact-force', 'scripts/hooks/gateguard-fact-force.js', 'standard,strict'],
|
||||
oversizedPayload(),
|
||||
{ ...GATEGUARD_ENV_BASELINE, ECC_GATEGUARD: 'on', ECC_SHOW_RECOVERY_HINTS: value }
|
||||
);
|
||||
assert.strictEqual(result.status, 2);
|
||||
assert.match(result.stderr, /explicitly disable this hook/, `${value}: ${result.stderr}`);
|
||||
}
|
||||
})
|
||||
)
|
||||
passed++;
|
||||
else failed++;
|
||||
|
||||
console.log(`\nPassed: ${passed}`);
|
||||
console.log(`Failed: ${failed}\n`);
|
||||
process.exit(failed > 0 ? 1 : 0);
|
||||
@@ -0,0 +1,62 @@
|
||||
'use strict';
|
||||
|
||||
const assert = require('assert');
|
||||
const { showRecoveryHints } = require('../../../scripts/lib/hooks/recovery-hints');
|
||||
|
||||
function test(name, fn) {
|
||||
try {
|
||||
fn();
|
||||
console.log(` ✓ ${name}`);
|
||||
return true;
|
||||
} catch (error) {
|
||||
console.log(` ✗ ${name}`);
|
||||
console.log(` Error: ${error.message}`);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
let passed = 0;
|
||||
let failed = 0;
|
||||
|
||||
if (
|
||||
test('truthy values enable hints, trimming case-insensitive whitespace', () => {
|
||||
for (const value of ['1', 'true', 'on', 'enabled', 'enable', 'yes', ' TRUE ', ' enable ']) {
|
||||
assert.strictEqual(showRecoveryHints(value), true, `expected truthy: ${JSON.stringify(value)}`);
|
||||
}
|
||||
})
|
||||
)
|
||||
passed++;
|
||||
else failed++;
|
||||
|
||||
if (
|
||||
test('unset, empty and non-listed values keep hints hidden', () => {
|
||||
for (const value of ['', '0', 'false', 'off', 'disabled', 'disable', 'no', 'random']) {
|
||||
assert.strictEqual(showRecoveryHints(value), false, `expected falsy: ${JSON.stringify(value)}`);
|
||||
}
|
||||
})
|
||||
)
|
||||
passed++;
|
||||
else failed++;
|
||||
|
||||
if (
|
||||
test('the default argument reads ECC_SHOW_RECOVERY_HINTS', () => {
|
||||
const saved = process.env.ECC_SHOW_RECOVERY_HINTS;
|
||||
try {
|
||||
process.env.ECC_SHOW_RECOVERY_HINTS = ' enable ';
|
||||
assert.strictEqual(showRecoveryHints(), true);
|
||||
process.env.ECC_SHOW_RECOVERY_HINTS = '';
|
||||
assert.strictEqual(showRecoveryHints(), false);
|
||||
delete process.env.ECC_SHOW_RECOVERY_HINTS;
|
||||
assert.strictEqual(showRecoveryHints(), false);
|
||||
} finally {
|
||||
if (saved === undefined) delete process.env.ECC_SHOW_RECOVERY_HINTS;
|
||||
else process.env.ECC_SHOW_RECOVERY_HINTS = saved;
|
||||
}
|
||||
})
|
||||
)
|
||||
passed++;
|
||||
else failed++;
|
||||
|
||||
console.log(`\nPassed: ${passed}`);
|
||||
console.log(`Failed: ${failed}\n`);
|
||||
process.exit(failed > 0 ? 1 : 0);
|
||||
Reference in new issue
Block a user