Add secret and signature masking for cache and artifact packages
This commit is contained in:
1 parent
8a4fdf5d3c
commit
10e284a34d
3 files changed
+122
-2
No files matched your search
@@ -0,0 +1,98 @@
|
|||||||
|
import {
|
||||||
|
CreateCacheEntryResponse,
|
||||||
|
GetCacheEntryDownloadURLResponse
|
||||||
|
} from '../src/generated/results/api/v1/cache'
|
||||||
|
import {CacheServiceClient} from '../src/internal/shared/cacheTwirpClient'
|
||||||
|
import {setSecret, debug} from '@actions/core'
|
||||||
|
|
||||||
|
jest.mock('@actions/core', () => ({
|
||||||
|
setSecret: jest.fn(),
|
||||||
|
info: jest.fn(),
|
||||||
|
debug: jest.fn()
|
||||||
|
}))
|
||||||
|
|
||||||
|
describe('CacheServiceClient', () => {
|
||||||
|
let client: CacheServiceClient
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
jest.clearAllMocks()
|
||||||
|
process.env['ACTIONS_RUNTIME_TOKEN'] = 'test-token' // <-- set the required env variable
|
||||||
|
client = new CacheServiceClient('test-agent')
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
delete process.env['ACTIONS_RUNTIME_TOKEN'] // <-- clean up after tests
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('maskSecretUrls', () => {
|
||||||
|
it('should mask signedUploadUrl', () => {
|
||||||
|
const response = {
|
||||||
|
ok: true,
|
||||||
|
signedUploadUrl:
|
||||||
|
'https://example.com/upload?se=2025-03-05T16%3A47%3A23Z&sig=secret-token'
|
||||||
|
} as CreateCacheEntryResponse
|
||||||
|
|
||||||
|
client.maskSecretUrls(response)
|
||||||
|
|
||||||
|
expect(setSecret).toHaveBeenCalledWith('secret-token')
|
||||||
|
expect(debug).toHaveBeenCalledWith(
|
||||||
|
'Masked signedUploadUrl: https://example.com/upload?se=2025-03-05T16%3A47%3A23Z&sig=***'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should mask signedDownloadUrl', () => {
|
||||||
|
const response = {
|
||||||
|
ok: true,
|
||||||
|
signedDownloadUrl:
|
||||||
|
'https://example.com/download?se=2025-03-05T16%3A47%3A23Z&sig=secret-token',
|
||||||
|
matchedKey: 'cache-key'
|
||||||
|
} as GetCacheEntryDownloadURLResponse
|
||||||
|
|
||||||
|
client.maskSecretUrls(response)
|
||||||
|
|
||||||
|
expect(setSecret).toHaveBeenCalledWith('secret-token')
|
||||||
|
expect(debug).toHaveBeenCalledWith(
|
||||||
|
'Masked signedDownloadUrl: https://example.com/download?se=2025-03-05T16%3A47%3A23Z&sig=***'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should not call setSecret if URLs are missing', () => {
|
||||||
|
const response = {ok: true} as CreateCacheEntryResponse
|
||||||
|
|
||||||
|
client.maskSecretUrls(response)
|
||||||
|
|
||||||
|
expect(setSecret).not.toHaveBeenCalled()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should mask only the sensitive token part of signedUploadUrl', () => {
|
||||||
|
const response = {
|
||||||
|
ok: true,
|
||||||
|
signedUploadUrl:
|
||||||
|
'https://example.com/upload?se=2025-03-05T16%3A47%3A23Z&sig=secret-token'
|
||||||
|
} as CreateCacheEntryResponse
|
||||||
|
|
||||||
|
client.maskSecretUrls(response)
|
||||||
|
|
||||||
|
expect(setSecret).toHaveBeenCalledWith('secret-token')
|
||||||
|
expect(debug).toHaveBeenCalledWith(
|
||||||
|
'Masked signedUploadUrl: https://example.com/upload?se=2025-03-05T16%3A47%3A23Z&sig=***'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should mask only the sensitive token part of signedDownloadUrl', () => {
|
||||||
|
const response = {
|
||||||
|
ok: true,
|
||||||
|
signedDownloadUrl:
|
||||||
|
'https://example.com/download?se=2025-03-05T16%3A47%3A23Z&sig=secret-token',
|
||||||
|
matchedKey: 'cache-key'
|
||||||
|
} as GetCacheEntryDownloadURLResponse
|
||||||
|
|
||||||
|
client.maskSecretUrls(response)
|
||||||
|
|
||||||
|
expect(setSecret).toHaveBeenCalledWith('secret-token')
|
||||||
|
expect(debug).toHaveBeenCalledWith(
|
||||||
|
'Masked signedDownloadUrl: https://example.com/download?se=2025-03-05T16%3A47%3A23Z&sig=***'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -8,10 +8,16 @@ import * as tar from '../src/internal/tar'
|
|||||||
import {CacheServiceClientJSON} from '../src/generated/results/api/v1/cache.twirp-client'
|
import {CacheServiceClientJSON} from '../src/generated/results/api/v1/cache.twirp-client'
|
||||||
import * as cacheHttpClient from '../src/internal/cacheHttpClient'
|
import * as cacheHttpClient from '../src/internal/cacheHttpClient'
|
||||||
import {UploadOptions} from '../src/options'
|
import {UploadOptions} from '../src/options'
|
||||||
|
import {
|
||||||
|
CreateCacheEntryResponse,
|
||||||
|
GetCacheEntryDownloadURLResponse
|
||||||
|
} from '../src/generated/results/api/v1/cache'
|
||||||
|
import {CacheServiceClient} from '../src/internal/shared/cacheTwirpClient'
|
||||||
|
|
||||||
let logDebugMock: jest.SpyInstance
|
let logDebugMock: jest.SpyInstance
|
||||||
|
|
||||||
jest.mock('../src/internal/tar')
|
jest.mock('../src/internal/tar')
|
||||||
|
jest.mock('@actions/core')
|
||||||
|
|
||||||
const uploadFileMock = jest.fn()
|
const uploadFileMock = jest.fn()
|
||||||
const blockBlobClientMock = jest.fn().mockImplementation(() => ({
|
const blockBlobClientMock = jest.fn().mockImplementation(() => ({
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import {info, debug} from '@actions/core'
|
import {info, debug, maskSigUrl} from '@actions/core'
|
||||||
import {getUserAgentString} from './user-agent'
|
import {getUserAgentString} from './user-agent'
|
||||||
import {NetworkError, UsageError} from './errors'
|
import {NetworkError, UsageError} from './errors'
|
||||||
import {getCacheServiceURL} from '../config'
|
import {getCacheServiceURL} from '../config'
|
||||||
@@ -6,6 +6,10 @@ import {getRuntimeToken} from '../cacheUtils'
|
|||||||
import {BearerCredentialHandler} from '@actions/http-client/lib/auth'
|
import {BearerCredentialHandler} from '@actions/http-client/lib/auth'
|
||||||
import {HttpClient, HttpClientResponse, HttpCodes} from '@actions/http-client'
|
import {HttpClient, HttpClientResponse, HttpCodes} from '@actions/http-client'
|
||||||
import {CacheServiceClientJSON} from '../../generated/results/api/v1/cache.twirp-client'
|
import {CacheServiceClientJSON} from '../../generated/results/api/v1/cache.twirp-client'
|
||||||
|
import {
|
||||||
|
CreateCacheEntryResponse,
|
||||||
|
GetCacheEntryDownloadURLResponse
|
||||||
|
} from '../../generated/results/api/v1/cache'
|
||||||
|
|
||||||
// The twirp http client must implement this interface
|
// The twirp http client must implement this interface
|
||||||
interface Rpc {
|
interface Rpc {
|
||||||
@@ -24,7 +28,7 @@ interface Rpc {
|
|||||||
*
|
*
|
||||||
* This class is used to interact with cache service v2.
|
* This class is used to interact with cache service v2.
|
||||||
*/
|
*/
|
||||||
class CacheServiceClient implements Rpc {
|
export class CacheServiceClient implements Rpc {
|
||||||
private httpClient: HttpClient
|
private httpClient: HttpClient
|
||||||
private baseUrl: string
|
private baseUrl: string
|
||||||
private maxAttempts = 5
|
private maxAttempts = 5
|
||||||
@@ -94,6 +98,7 @@ class CacheServiceClient implements Rpc {
|
|||||||
debug(`[Response] - ${response.message.statusCode}`)
|
debug(`[Response] - ${response.message.statusCode}`)
|
||||||
debug(`Headers: ${JSON.stringify(response.message.headers, null, 2)}`)
|
debug(`Headers: ${JSON.stringify(response.message.headers, null, 2)}`)
|
||||||
const body = JSON.parse(rawBody)
|
const body = JSON.parse(rawBody)
|
||||||
|
this.maskSecretUrls(body)
|
||||||
debug(`Body: ${JSON.stringify(body, null, 2)}`)
|
debug(`Body: ${JSON.stringify(body, null, 2)}`)
|
||||||
if (this.isSuccessStatusCode(statusCode)) {
|
if (this.isSuccessStatusCode(statusCode)) {
|
||||||
return {response, body}
|
return {response, body}
|
||||||
@@ -148,6 +153,17 @@ class CacheServiceClient implements Rpc {
|
|||||||
throw new Error(`Request failed`)
|
throw new Error(`Request failed`)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
maskSecretUrls(
|
||||||
|
body: CreateCacheEntryResponse | GetCacheEntryDownloadURLResponse
|
||||||
|
): void {
|
||||||
|
if ('signedUploadUrl' in body && body.signedUploadUrl) {
|
||||||
|
maskSigUrl(body.signedUploadUrl, 'signedUploadUrl')
|
||||||
|
}
|
||||||
|
if ('signedDownloadUrl' in body && body.signedDownloadUrl) {
|
||||||
|
maskSigUrl(body.signedDownloadUrl, 'signedDownloadUrl')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
isSuccessStatusCode(statusCode?: number): boolean {
|
isSuccessStatusCode(statusCode?: number): boolean {
|
||||||
if (!statusCode) return false
|
if (!statusCode) return false
|
||||||
return statusCode >= 200 && statusCode < 300
|
return statusCode >= 200 && statusCode < 300
|
||||||
|
|||||||
Reference in new issue
Block a user