Compare commits

..

2 Commits

Author SHA1 Message Date
eric sciple 8b396d5a81
Merge eddff1118c into ff7abcd0c3 2025-10-17 19:00:14 +00:00
eric sciple eddff1118c Persist creds to a separate file 2025-10-17 19:00:01 +00:00
7 changed files with 169 additions and 94 deletions

View File

@ -299,7 +299,7 @@ jobs:
test-output: test-output:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
# Download the action at the current ref # Clone this repo
- name: Checkout - name: Checkout
uses: actions/checkout@v4.1.6 uses: actions/checkout@v4.1.6
with: with:

View File

@ -769,19 +769,43 @@ describe('git-auth-helper tests', () => {
// Arrange // Arrange
await setup(testCredentialsConfigPath_matchesCredentialsConfigPaths) await setup(testCredentialsConfigPath_matchesCredentialsConfigPaths)
const authHelper = gitAuthHelper.createAuthHelper(git, settings) const authHelper = gitAuthHelper.createAuthHelper(git, settings)
// Get a real credentials config path // Get a real credentials config path
const credentialsConfigPath = await (authHelper as any).getCredentialsConfigPath() const credentialsConfigPath = await (
authHelper as any
).getCredentialsConfigPath()
// Act & Assert // Act & Assert
expect((authHelper as any).testCredentialsConfigPath(credentialsConfigPath)).toBe(true) expect(
expect((authHelper as any).testCredentialsConfigPath('/some/path/git-credentials-12345678-abcd-1234-5678-123456789012.config')).toBe(true) (authHelper as any).testCredentialsConfigPath(credentialsConfigPath)
expect((authHelper as any).testCredentialsConfigPath('/some/path/git-credentials-abcdef12-3456-7890-abcd-ef1234567890.config')).toBe(true) ).toBe(true)
expect(
(authHelper as any).testCredentialsConfigPath(
'/some/path/git-credentials-12345678-abcd-1234-5678-123456789012.config'
)
).toBe(true)
expect(
(authHelper as any).testCredentialsConfigPath(
'/some/path/git-credentials-abcdef12-3456-7890-abcd-ef1234567890.config'
)
).toBe(true)
// Test invalid paths // Test invalid paths
expect((authHelper as any).testCredentialsConfigPath('/some/path/other-config.config')).toBe(false) expect(
expect((authHelper as any).testCredentialsConfigPath('/some/path/git-credentials-invalid.config')).toBe(false) (authHelper as any).testCredentialsConfigPath(
expect((authHelper as any).testCredentialsConfigPath('/some/path/git-credentials-.config')).toBe(false) '/some/path/other-config.config'
)
).toBe(false)
expect(
(authHelper as any).testCredentialsConfigPath(
'/some/path/git-credentials-invalid.config'
)
).toBe(false)
expect(
(authHelper as any).testCredentialsConfigPath(
'/some/path/git-credentials-.config'
)
).toBe(false)
expect((authHelper as any).testCredentialsConfigPath('')).toBe(false) expect((authHelper as any).testCredentialsConfigPath('')).toBe(false)
}) })
}) })
@ -890,7 +914,11 @@ async function setup(testName: string): Promise<void> {
} }
), ),
tryConfigUnsetValue: jest.fn( tryConfigUnsetValue: jest.fn(
async (key: string, value: string, globalConfig?: boolean): Promise<boolean> => { async (
key: string,
value: string,
globalConfig?: boolean
): Promise<boolean> => {
const configPath = globalConfig const configPath = globalConfig
? path.join(git.env['HOME'] || tempHomedir, '.gitconfig') ? path.join(git.env['HOME'] || tempHomedir, '.gitconfig')
: localGitConfigPath : localGitConfigPath

View File

@ -17,7 +17,7 @@ fi
echo "Testing persisted credential" echo "Testing persisted credential"
pushd ./submodules-recursive/submodule-level-1/submodule-level-2 pushd ./submodules-recursive/submodule-level-1/submodule-level-2
git config --local --name-only --get-regexp http.+extraheader && git fetch git config --local --includes --name-only --get-regexp http.+extraheader && git fetch
if [ "$?" != "0" ]; then if [ "$?" != "0" ]; then
echo "Failed to validate persisted credential" echo "Failed to validate persisted credential"
popd popd

View File

@ -17,7 +17,7 @@ fi
echo "Testing persisted credential" echo "Testing persisted credential"
pushd ./submodules-true/submodule-level-1 pushd ./submodules-true/submodule-level-1
git config --local --name-only --get-regexp http.+extraheader && git fetch git config --local --includes --name-only --get-regexp http.+extraheader && git fetch
if [ "$?" != "0" ]; then if [ "$?" != "0" ]; then
echo "Failed to validate persisted credential" echo "Failed to validate persisted credential"
popd popd

81
dist/index.js vendored
View File

@ -238,7 +238,9 @@ class GitAuthHelper {
yield this.git.tryConfigUnset(this.insteadOfKey, true); yield this.git.tryConfigUnset(this.insteadOfKey, true);
if (!this.settings.sshKey) { if (!this.settings.sshKey) {
for (const insteadOfValue of this.insteadOfValues) { for (const insteadOfValue of this.insteadOfValues) {
yield this.git.config(this.insteadOfKey, insteadOfValue, true, true); yield this.git.config(this.insteadOfKey, insteadOfValue, true, // globalConfig?
true // add?
);
} }
} }
} }
@ -255,17 +257,10 @@ class GitAuthHelper {
// Remove possible previous HTTPS instead of SSH // Remove possible previous HTTPS instead of SSH
yield this.removeSubmoduleGitConfig(this.insteadOfKey); yield this.removeSubmoduleGitConfig(this.insteadOfKey);
if (this.settings.persistCredentials) { if (this.settings.persistCredentials) {
// Credentials config path // Get the credentials config file path in RUNNER_TEMP
const credentialsConfigPath = yield this.getCredentialsConfigPath(); const credentialsConfigPath = this.getCredentialsConfigPath();
// Container credentials config path // Container credentials config path
const containerCredentialsPath = path.posix.join('/github/runner_temp', path.basename(credentialsConfigPath)); const containerCredentialsPath = path.posix.join('/github/runner_temp', path.basename(credentialsConfigPath));
// Container repo path
const workingDirectory = this.git.getWorkingDirectory();
const githubWorkspace = process.env['GITHUB_WORKSPACE'];
assert.ok(githubWorkspace, 'GITHUB_WORKSPACE is not defined');
let relativePath = path.relative(githubWorkspace, workingDirectory);
relativePath = relativePath.replace(/\\/g, '/');
const containerRepoPath = path.posix.join('/github/workspace', relativePath);
// Get submodule config file paths. // Get submodule config file paths.
const configPaths = yield this.git.getSubmoduleConfigPaths(this.settings.nestedSubmodules); const configPaths = yield this.git.getSubmoduleConfigPaths(this.settings.nestedSubmodules);
// For each submodule, configure includeIf entries pointing to the shared credentials file. // For each submodule, configure includeIf entries pointing to the shared credentials file.
@ -275,12 +270,19 @@ class GitAuthHelper {
let submoduleGitDir = path.dirname(configPath); // The config file is at .git/modules/submodule-name/config let submoduleGitDir = path.dirname(configPath); // The config file is at .git/modules/submodule-name/config
submoduleGitDir = submoduleGitDir.replace(/\\/g, '/'); // Use forward slashes, even on Windows submoduleGitDir = submoduleGitDir.replace(/\\/g, '/'); // Use forward slashes, even on Windows
// Configure host includeIf // Configure host includeIf
yield this.git.config(`includeIf.gitdir:${submoduleGitDir}.path`, credentialsConfigPath, false, false, configPath); yield this.git.config(`includeIf.gitdir:${submoduleGitDir}.path`, credentialsConfigPath, false, // globalConfig?
// Configure container includeIf false, // add?
configPath);
// Container submodule git directory
const githubWorkspace = process.env['GITHUB_WORKSPACE'];
assert.ok(githubWorkspace, 'GITHUB_WORKSPACE is not defined');
let relativeSubmoduleGitDir = path.relative(githubWorkspace, submoduleGitDir); let relativeSubmoduleGitDir = path.relative(githubWorkspace, submoduleGitDir);
relativeSubmoduleGitDir = relativeSubmoduleGitDir.replace(/\\/g, '/'); // Use forward slashes, even on Windows relativeSubmoduleGitDir = relativeSubmoduleGitDir.replace(/\\/g, '/'); // Use forward slashes, even on Windows
const containerSubmoduleGitDir = path.posix.join('/github/workspace', relativeSubmoduleGitDir); const containerSubmoduleGitDir = path.posix.join('/github/workspace', relativeSubmoduleGitDir);
yield this.git.config(`includeIf.gitdir:${containerSubmoduleGitDir}.path`, containerCredentialsPath, false, false, configPath); // Configure container includeIf
yield this.git.config(`includeIf.gitdir:${containerSubmoduleGitDir}.path`, containerCredentialsPath, false, // globalConfig?
false, // add?
configPath);
} }
if (this.settings.sshKey) { if (this.settings.sshKey) {
// Configure core.sshCommand // Configure core.sshCommand
@ -379,12 +381,14 @@ class GitAuthHelper {
configureToken(globalConfig) { configureToken(globalConfig) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
// Get the credentials config file path in RUNNER_TEMP // Get the credentials config file path in RUNNER_TEMP
const credentialsConfigPath = yield this.getCredentialsConfigPath(); const credentialsConfigPath = this.getCredentialsConfigPath();
// Write placeholder to the separate credentials config file using git config. // Write placeholder to the separate credentials config file using git config.
// This approach avoids the credential being captured by process creation audit events, // This approach avoids the credential being captured by process creation audit events,
// which are commonly logged. For more information, refer to // which are commonly logged. For more information, refer to
// https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/manage/component-updates/command-line-process-auditing // https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/manage/component-updates/command-line-process-auditing
yield this.git.config(this.tokenConfigKey, this.tokenPlaceholderConfigValue, false, false, credentialsConfigPath); yield this.git.config(this.tokenConfigKey, this.tokenPlaceholderConfigValue, false, // globalConfig?
false, // add?
credentialsConfigPath);
// Replace the placeholder in the credentials config file // Replace the placeholder in the credentials config file
let content = (yield fs.promises.readFile(credentialsConfigPath)).toString(); let content = (yield fs.promises.readFile(credentialsConfigPath)).toString();
const placeholderIndex = content.indexOf(this.tokenPlaceholderConfigValue); const placeholderIndex = content.indexOf(this.tokenPlaceholderConfigValue);
@ -398,7 +402,8 @@ class GitAuthHelper {
// Add include or includeIf to reference the credentials config // Add include or includeIf to reference the credentials config
if (globalConfig) { if (globalConfig) {
// Global config file is temporary // Global config file is temporary
yield this.git.config('include.path', credentialsConfigPath, true); yield this.git.config('include.path', credentialsConfigPath, true // globalConfig?
);
} }
else { else {
// Host git directory // Host git directory
@ -408,9 +413,9 @@ class GitAuthHelper {
const hostIncludeKey = `includeIf.gitdir:${gitDir}.path`; const hostIncludeKey = `includeIf.gitdir:${gitDir}.path`;
yield this.git.config(hostIncludeKey, credentialsConfigPath); yield this.git.config(hostIncludeKey, credentialsConfigPath);
// Container git directory // Container git directory
const workingDirectory = this.git.getWorkingDirectory();
const githubWorkspace = process.env['GITHUB_WORKSPACE']; const githubWorkspace = process.env['GITHUB_WORKSPACE'];
assert.ok(githubWorkspace, 'GITHUB_WORKSPACE is not defined'); assert.ok(githubWorkspace, 'GITHUB_WORKSPACE is not defined');
const workingDirectory = this.git.getWorkingDirectory();
let relativePath = path.relative(githubWorkspace, workingDirectory); let relativePath = path.relative(githubWorkspace, workingDirectory);
relativePath = relativePath.replace(/\\/g, '/'); // Use forward slashes, even on Windows relativePath = relativePath.replace(/\\/g, '/'); // Use forward slashes, even on Windows
const containerGitDir = path.posix.join('/github/workspace', relativePath, '.git'); const containerGitDir = path.posix.join('/github/workspace', relativePath, '.git');
@ -427,18 +432,16 @@ class GitAuthHelper {
* @returns The absolute path to the credentials config file * @returns The absolute path to the credentials config file
*/ */
getCredentialsConfigPath() { getCredentialsConfigPath() {
return __awaiter(this, void 0, void 0, function* () { if (this.credentialsConfigPath) {
if (this.credentialsConfigPath) {
return this.credentialsConfigPath;
}
const runnerTemp = process.env['RUNNER_TEMP'] || '';
assert.ok(runnerTemp, 'RUNNER_TEMP is not defined');
// Create a unique filename for this checkout instance
const configFileName = `git-credentials-${(0, uuid_1.v4)()}.config`;
this.credentialsConfigPath = path.join(runnerTemp, configFileName);
core.debug(`Credentials config path: ${this.credentialsConfigPath}`);
return this.credentialsConfigPath; return this.credentialsConfigPath;
}); }
const runnerTemp = process.env['RUNNER_TEMP'] || '';
assert.ok(runnerTemp, 'RUNNER_TEMP is not defined');
// Create a unique filename for this checkout instance
const configFileName = `git-credentials-${(0, uuid_1.v4)()}.config`;
this.credentialsConfigPath = path.join(runnerTemp, configFileName);
core.debug(`Credentials config path: ${this.credentialsConfigPath}`);
return this.credentialsConfigPath;
} }
/** /**
* Removes SSH authentication configuration by cleaning up SSH keys, * Removes SSH authentication configuration by cleaning up SSH keys,
@ -472,7 +475,7 @@ class GitAuthHelper {
} }
} }
// SSH command // SSH command
core.info("Removing SSH command configuration"); core.info('Removing SSH command configuration');
yield this.removeGitConfig(SSH_COMMAND_KEY); yield this.removeGitConfig(SSH_COMMAND_KEY);
yield this.removeSubmoduleGitConfig(SSH_COMMAND_KEY); yield this.removeSubmoduleGitConfig(SSH_COMMAND_KEY);
}); });
@ -485,13 +488,13 @@ class GitAuthHelper {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
var _a; var _a;
// Remove HTTP extra header // Remove HTTP extra header
core.info("Removing HTTP extra header"); core.info('Removing HTTP extra header');
yield this.removeGitConfig(this.tokenConfigKey); yield this.removeGitConfig(this.tokenConfigKey);
yield this.removeSubmoduleGitConfig(this.tokenConfigKey); yield this.removeSubmoduleGitConfig(this.tokenConfigKey);
// Collect credentials config paths that need to be removed // Collect credentials config paths that need to be removed
const credentialsPaths = new Set(); const credentialsPaths = new Set();
// Remove includeIf entries that point to git-credentials-*.config files // Remove includeIf entries that point to git-credentials-*.config files
core.info("Removing includeIf entries pointing to credentials config files"); core.info('Removing includeIf entries pointing to credentials config files');
const mainCredentialsPaths = yield this.removeIncludeIfCredentials(); const mainCredentialsPaths = yield this.removeIncludeIfCredentials();
mainCredentialsPaths.forEach(path => credentialsPaths.add(path)); mainCredentialsPaths.forEach(path => credentialsPaths.add(path));
// Remove submodule includeIf entries that point to git-credentials-*.config files // Remove submodule includeIf entries that point to git-credentials-*.config files
@ -556,10 +559,12 @@ class GitAuthHelper {
const credentialsPaths = new Set(); const credentialsPaths = new Set();
try { try {
// Get all includeIf.gitdir keys // Get all includeIf.gitdir keys
const keys = yield this.git.tryGetConfigKeys('^includeIf\\.gitdir:', false, configPath); const keys = yield this.git.tryGetConfigKeys('^includeIf\\.gitdir:', false, // globalConfig?
configPath);
for (const key of keys) { for (const key of keys) {
// Get all values for this key // Get all values for this key
const values = yield this.git.tryGetConfigValues(key, false, configPath); const values = yield this.git.tryGetConfigValues(key, false, // globalConfig?
configPath);
if (values.length > 0) { if (values.length > 0) {
// Remove only values that match git-credentials-<uuid>.config pattern // Remove only values that match git-credentials-<uuid>.config pattern
for (const value of values) { for (const value of values) {
@ -1060,7 +1065,10 @@ class GitCommandManager {
if (output.exitCode !== 0) { if (output.exitCode !== 0) {
return []; return [];
} }
return output.stdout.trim().split('\n').filter(value => value.trim()); return output.stdout
.trim()
.split('\n')
.filter(value => value.trim());
}); });
} }
tryGetConfigKeys(pattern, globalConfig, configFile) { tryGetConfigKeys(pattern, globalConfig, configFile) {
@ -1077,7 +1085,10 @@ class GitCommandManager {
if (output.exitCode !== 0) { if (output.exitCode !== 0) {
return []; return [];
} }
return output.stdout.trim().split('\n').filter(key => key.trim()); return output.stdout
.trim()
.split('\n')
.filter(key => key.trim());
}); });
} }
tryReset() { tryReset() {

View File

@ -136,7 +136,12 @@ class GitAuthHelper {
await this.git.tryConfigUnset(this.insteadOfKey, true) await this.git.tryConfigUnset(this.insteadOfKey, true)
if (!this.settings.sshKey) { if (!this.settings.sshKey) {
for (const insteadOfValue of this.insteadOfValues) { for (const insteadOfValue of this.insteadOfValues) {
await this.git.config(this.insteadOfKey, insteadOfValue, true, true) await this.git.config(
this.insteadOfKey,
insteadOfValue,
true, // globalConfig?
true // add?
)
} }
} }
} catch (err) { } catch (err) {
@ -154,8 +159,8 @@ class GitAuthHelper {
await this.removeSubmoduleGitConfig(this.insteadOfKey) await this.removeSubmoduleGitConfig(this.insteadOfKey)
if (this.settings.persistCredentials) { if (this.settings.persistCredentials) {
// Credentials config path // Get the credentials config file path in RUNNER_TEMP
const credentialsConfigPath = await this.getCredentialsConfigPath() const credentialsConfigPath = this.getCredentialsConfigPath()
// Container credentials config path // Container credentials config path
const containerCredentialsPath = path.posix.join( const containerCredentialsPath = path.posix.join(
@ -163,17 +168,6 @@ class GitAuthHelper {
path.basename(credentialsConfigPath) path.basename(credentialsConfigPath)
) )
// Container repo path
const workingDirectory = this.git.getWorkingDirectory()
const githubWorkspace = process.env['GITHUB_WORKSPACE']
assert.ok(githubWorkspace, 'GITHUB_WORKSPACE is not defined')
let relativePath = path.relative(githubWorkspace, workingDirectory)
relativePath = relativePath.replace(/\\/g, '/')
const containerRepoPath = path.posix.join(
'/github/workspace',
relativePath
)
// Get submodule config file paths. // Get submodule config file paths.
const configPaths = await this.git.getSubmoduleConfigPaths( const configPaths = await this.git.getSubmoduleConfigPaths(
this.settings.nestedSubmodules this.settings.nestedSubmodules
@ -190,12 +184,14 @@ class GitAuthHelper {
await this.git.config( await this.git.config(
`includeIf.gitdir:${submoduleGitDir}.path`, `includeIf.gitdir:${submoduleGitDir}.path`,
credentialsConfigPath, credentialsConfigPath,
false, false, // globalConfig?
false, false, // add?
configPath configPath
) )
// Configure container includeIf // Container submodule git directory
const githubWorkspace = process.env['GITHUB_WORKSPACE']
assert.ok(githubWorkspace, 'GITHUB_WORKSPACE is not defined')
let relativeSubmoduleGitDir = path.relative( let relativeSubmoduleGitDir = path.relative(
githubWorkspace, githubWorkspace,
submoduleGitDir submoduleGitDir
@ -205,11 +201,13 @@ class GitAuthHelper {
'/github/workspace', '/github/workspace',
relativeSubmoduleGitDir relativeSubmoduleGitDir
) )
// Configure container includeIf
await this.git.config( await this.git.config(
`includeIf.gitdir:${containerSubmoduleGitDir}.path`, `includeIf.gitdir:${containerSubmoduleGitDir}.path`,
containerCredentialsPath, containerCredentialsPath,
false, false, // globalConfig?
false, false, // add?
configPath configPath
) )
} }
@ -327,7 +325,7 @@ class GitAuthHelper {
*/ */
private async configureToken(globalConfig?: boolean): Promise<void> { private async configureToken(globalConfig?: boolean): Promise<void> {
// Get the credentials config file path in RUNNER_TEMP // Get the credentials config file path in RUNNER_TEMP
const credentialsConfigPath = await this.getCredentialsConfigPath() const credentialsConfigPath = this.getCredentialsConfigPath()
// Write placeholder to the separate credentials config file using git config. // Write placeholder to the separate credentials config file using git config.
// This approach avoids the credential being captured by process creation audit events, // This approach avoids the credential being captured by process creation audit events,
@ -336,8 +334,8 @@ class GitAuthHelper {
await this.git.config( await this.git.config(
this.tokenConfigKey, this.tokenConfigKey,
this.tokenPlaceholderConfigValue, this.tokenPlaceholderConfigValue,
false, false, // globalConfig?
false, false, // add?
credentialsConfigPath credentialsConfigPath
) )
@ -348,7 +346,9 @@ class GitAuthHelper {
placeholderIndex < 0 || placeholderIndex < 0 ||
placeholderIndex != content.lastIndexOf(this.tokenPlaceholderConfigValue) placeholderIndex != content.lastIndexOf(this.tokenPlaceholderConfigValue)
) { ) {
throw new Error(`Unable to replace auth placeholder in ${credentialsConfigPath}`) throw new Error(
`Unable to replace auth placeholder in ${credentialsConfigPath}`
)
} }
assert.ok(this.tokenConfigValue, 'tokenConfigValue is not defined') assert.ok(this.tokenConfigValue, 'tokenConfigValue is not defined')
content = content.replace( content = content.replace(
@ -360,7 +360,11 @@ class GitAuthHelper {
// Add include or includeIf to reference the credentials config // Add include or includeIf to reference the credentials config
if (globalConfig) { if (globalConfig) {
// Global config file is temporary // Global config file is temporary
await this.git.config('include.path', credentialsConfigPath, true) await this.git.config(
'include.path',
credentialsConfigPath,
true // globalConfig?
)
} else { } else {
// Host git directory // Host git directory
let gitDir = path.join(this.git.getWorkingDirectory(), '.git') let gitDir = path.join(this.git.getWorkingDirectory(), '.git')
@ -371,9 +375,9 @@ class GitAuthHelper {
await this.git.config(hostIncludeKey, credentialsConfigPath) await this.git.config(hostIncludeKey, credentialsConfigPath)
// Container git directory // Container git directory
const workingDirectory = this.git.getWorkingDirectory()
const githubWorkspace = process.env['GITHUB_WORKSPACE'] const githubWorkspace = process.env['GITHUB_WORKSPACE']
assert.ok(githubWorkspace, 'GITHUB_WORKSPACE is not defined') assert.ok(githubWorkspace, 'GITHUB_WORKSPACE is not defined')
const workingDirectory = this.git.getWorkingDirectory()
let relativePath = path.relative(githubWorkspace, workingDirectory) let relativePath = path.relative(githubWorkspace, workingDirectory)
relativePath = relativePath.replace(/\\/g, '/') // Use forward slashes, even on Windows relativePath = relativePath.replace(/\\/g, '/') // Use forward slashes, even on Windows
const containerGitDir = path.posix.join( const containerGitDir = path.posix.join(
@ -398,7 +402,7 @@ class GitAuthHelper {
* Gets or creates the path to the credentials config file in RUNNER_TEMP. * Gets or creates the path to the credentials config file in RUNNER_TEMP.
* @returns The absolute path to the credentials config file * @returns The absolute path to the credentials config file
*/ */
private async getCredentialsConfigPath(): Promise<string> { private getCredentialsConfigPath(): string {
if (this.credentialsConfigPath) { if (this.credentialsConfigPath) {
return this.credentialsConfigPath return this.credentialsConfigPath
} }
@ -445,7 +449,7 @@ class GitAuthHelper {
} }
// SSH command // SSH command
core.info("Removing SSH command configuration") core.info('Removing SSH command configuration')
await this.removeGitConfig(SSH_COMMAND_KEY) await this.removeGitConfig(SSH_COMMAND_KEY)
await this.removeSubmoduleGitConfig(SSH_COMMAND_KEY) await this.removeSubmoduleGitConfig(SSH_COMMAND_KEY)
} }
@ -456,7 +460,7 @@ class GitAuthHelper {
*/ */
private async removeToken(): Promise<void> { private async removeToken(): Promise<void> {
// Remove HTTP extra header // Remove HTTP extra header
core.info("Removing HTTP extra header") core.info('Removing HTTP extra header')
await this.removeGitConfig(this.tokenConfigKey) await this.removeGitConfig(this.tokenConfigKey)
await this.removeSubmoduleGitConfig(this.tokenConfigKey) await this.removeSubmoduleGitConfig(this.tokenConfigKey)
@ -464,14 +468,15 @@ class GitAuthHelper {
const credentialsPaths = new Set<string>() const credentialsPaths = new Set<string>()
// Remove includeIf entries that point to git-credentials-*.config files // Remove includeIf entries that point to git-credentials-*.config files
core.info("Removing includeIf entries pointing to credentials config files") core.info('Removing includeIf entries pointing to credentials config files')
const mainCredentialsPaths = await this.removeIncludeIfCredentials() const mainCredentialsPaths = await this.removeIncludeIfCredentials()
mainCredentialsPaths.forEach(path => credentialsPaths.add(path)) mainCredentialsPaths.forEach(path => credentialsPaths.add(path))
// Remove submodule includeIf entries that point to git-credentials-*.config files // Remove submodule includeIf entries that point to git-credentials-*.config files
const submoduleConfigPaths = await this.git.getSubmoduleConfigPaths(true) const submoduleConfigPaths = await this.git.getSubmoduleConfigPaths(true)
for (const configPath of submoduleConfigPaths) { for (const configPath of submoduleConfigPaths) {
const submoduleCredentialsPaths = await this.removeIncludeIfCredentials(configPath) const submoduleCredentialsPaths =
await this.removeIncludeIfCredentials(configPath)
submoduleCredentialsPaths.forEach(path => credentialsPaths.add(path)) submoduleCredentialsPaths.forEach(path => credentialsPaths.add(path))
} }
@ -491,7 +496,9 @@ class GitAuthHelper {
) )
} }
} else { } else {
core.debug(`Skipping removal of credentials config '${credentialsPath}' - not under RUNNER_TEMP`) core.debug(
`Skipping removal of credentials config '${credentialsPath}' - not under RUNNER_TEMP`
)
} }
} }
} }
@ -528,16 +535,26 @@ class GitAuthHelper {
* @param configPath Optional path to a specific git config file to operate on * @param configPath Optional path to a specific git config file to operate on
* @returns Array of unique credentials config file paths that were found and removed * @returns Array of unique credentials config file paths that were found and removed
*/ */
private async removeIncludeIfCredentials(configPath?: string): Promise<string[]> { private async removeIncludeIfCredentials(
configPath?: string
): Promise<string[]> {
const credentialsPaths = new Set<string>() const credentialsPaths = new Set<string>()
try { try {
// Get all includeIf.gitdir keys // Get all includeIf.gitdir keys
const keys = await this.git.tryGetConfigKeys('^includeIf\\.gitdir:', false, configPath) const keys = await this.git.tryGetConfigKeys(
'^includeIf\\.gitdir:',
false, // globalConfig?
configPath
)
for (const key of keys) { for (const key of keys) {
// Get all values for this key // Get all values for this key
const values = await this.git.tryGetConfigValues(key, false, configPath) const values = await this.git.tryGetConfigValues(
key,
false, // globalConfig?
configPath
)
if (values.length > 0) { if (values.length > 0) {
// Remove only values that match git-credentials-<uuid>.config pattern // Remove only values that match git-credentials-<uuid>.config pattern
for (const value of values) { for (const value of values) {
@ -556,7 +573,7 @@ class GitAuthHelper {
core.debug(`Error during includeIf cleanup: ${err}`) core.debug(`Error during includeIf cleanup: ${err}`)
} }
} }
return Array.from(credentialsPaths) return Array.from(credentialsPaths)
} }

View File

@ -61,11 +61,24 @@ export interface IGitCommandManager {
tagExists(pattern: string): Promise<boolean> tagExists(pattern: string): Promise<boolean>
tryClean(): Promise<boolean> tryClean(): Promise<boolean>
tryConfigUnset(configKey: string, globalConfig?: boolean): Promise<boolean> tryConfigUnset(configKey: string, globalConfig?: boolean): Promise<boolean>
tryConfigUnsetValue(configKey: string, configValue: string, globalConfig?: boolean, configFile?: string): Promise<boolean> tryConfigUnsetValue(
configKey: string,
configValue: string,
globalConfig?: boolean,
configFile?: string
): Promise<boolean>
tryDisableAutomaticGarbageCollection(): Promise<boolean> tryDisableAutomaticGarbageCollection(): Promise<boolean>
tryGetFetchUrl(): Promise<string> tryGetFetchUrl(): Promise<string>
tryGetConfigValues(configKey: string, globalConfig?: boolean, configFile?: string): Promise<string[]> tryGetConfigValues(
tryGetConfigKeys(pattern: string, globalConfig?: boolean, configFile?: string): Promise<string[]> configKey: string,
globalConfig?: boolean,
configFile?: string
): Promise<string[]>
tryGetConfigKeys(
pattern: string,
globalConfig?: boolean,
configFile?: string
): Promise<string[]>
tryReset(): Promise<boolean> tryReset(): Promise<boolean>
version(): Promise<GitVersion> version(): Promise<GitVersion>
} }
@ -494,7 +507,7 @@ class GitCommandManager {
args.push(globalConfig ? '--global' : '--local') args.push(globalConfig ? '--global' : '--local')
} }
args.push('--unset', configKey, configValue) args.push('--unset', configKey, configValue)
const output = await this.execGit(args, true) const output = await this.execGit(args, true)
return output.exitCode === 0 return output.exitCode === 0
} }
@ -537,14 +550,17 @@ class GitCommandManager {
args.push(globalConfig ? '--global' : '--local') args.push(globalConfig ? '--global' : '--local')
} }
args.push('--get-all', configKey) args.push('--get-all', configKey)
const output = await this.execGit(args, true) const output = await this.execGit(args, true)
if (output.exitCode !== 0) { if (output.exitCode !== 0) {
return [] return []
} }
return output.stdout.trim().split('\n').filter(value => value.trim()) return output.stdout
.trim()
.split('\n')
.filter(value => value.trim())
} }
async tryGetConfigKeys( async tryGetConfigKeys(
@ -559,14 +575,17 @@ class GitCommandManager {
args.push(globalConfig ? '--global' : '--local') args.push(globalConfig ? '--global' : '--local')
} }
args.push('--name-only', '--get-regexp', pattern) args.push('--name-only', '--get-regexp', pattern)
const output = await this.execGit(args, true) const output = await this.execGit(args, true)
if (output.exitCode !== 0) { if (output.exitCode !== 0) {
return [] return []
} }
return output.stdout.trim().split('\n').filter(key => key.trim()) return output.stdout
.trim()
.split('\n')
.filter(key => key.trim())
} }
async tryReset(): Promise<boolean> { async tryReset(): Promise<boolean> {