mirror of
https://github.com/google-github-actions/auth.git
synced 2026-06-07 07:47:07 +00:00
7c4e01fd00This adds support for making the action "universe" aware, so it will be usable for TPC and GDCH.
106 lines
3.3 KiB
TypeScript
106 lines
3.3 KiB
TypeScript
// Copyright 2023 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
import { HttpClient } from '@actions/http-client';
|
|
|
|
import { Logger } from '../logger';
|
|
import { userAgent } from '../utils';
|
|
|
|
/**
|
|
* AuthClient is the default HTTP client for interacting with the IAM credentials
|
|
* API.
|
|
*/
|
|
export interface AuthClient {
|
|
/**
|
|
* getToken() gets or generates the best token for the auth client.
|
|
*/
|
|
getToken(): Promise<string>;
|
|
|
|
/**
|
|
* createCredentialsFile creates a credential file (for use with gcloud and
|
|
* other Google Cloud tools) that instructs the tool how to perform identity
|
|
* federation.
|
|
*/
|
|
createCredentialsFile(outputPath: string): Promise<string>;
|
|
|
|
/**
|
|
* signJWT signs a JWT using the auth provider.
|
|
*/
|
|
signJWT(claims: any): Promise<string>;
|
|
}
|
|
|
|
export interface ClientParameters {
|
|
logger: Logger;
|
|
universe: string;
|
|
child: string;
|
|
}
|
|
|
|
export class Client {
|
|
protected readonly _logger: Logger;
|
|
protected readonly _httpClient: HttpClient;
|
|
|
|
protected readonly _endpoints = {
|
|
iam: 'https://iam.{universe}/v1',
|
|
iamcredentials: 'https://iamcredentials.{universe}/v1',
|
|
oauth2: 'https://oauth2.{universe}',
|
|
sts: 'https://sts.{universe}/v1',
|
|
www: 'https://www.{universe}',
|
|
};
|
|
protected readonly _universe;
|
|
|
|
constructor(opts: ClientParameters) {
|
|
this._logger = opts.logger.withNamespace(opts.child);
|
|
|
|
// Create the http client with our user agent.
|
|
this._httpClient = new HttpClient(userAgent, undefined, {
|
|
allowRedirects: true,
|
|
allowRetries: true,
|
|
keepAlive: true,
|
|
maxRedirects: 5,
|
|
maxRetries: 3,
|
|
});
|
|
|
|
// Expand universe to support TPC and custom endpoints.
|
|
this._universe = opts.universe;
|
|
for (const key of Object.keys(this._endpoints) as Array<keyof typeof this._endpoints>) {
|
|
this._endpoints[key] = this.expandEndpoint(key);
|
|
}
|
|
this._logger.debug(`Computed endpoints for universe ${this._universe}`, this._endpoints);
|
|
}
|
|
|
|
expandEndpoint(key: keyof typeof this._endpoints): string {
|
|
const envOverrideKey = `GHA_ENDPOINT_OVERRIDE_${key}`;
|
|
const envOverrideValue = process.env[envOverrideKey];
|
|
if (envOverrideValue && envOverrideValue !== '') {
|
|
this._logger.debug(
|
|
`Overriding API endpoint for ${key} because ${envOverrideKey} is set`,
|
|
envOverrideValue,
|
|
);
|
|
return envOverrideValue.replace(/\/+$/, '');
|
|
}
|
|
|
|
return (this._endpoints[key] || '').replace(/{universe}/g, this._universe).replace(/\/+$/, '');
|
|
}
|
|
}
|
|
export { IAMCredentialsClient, IAMCredentialsClientParameters } from './iamcredentials';
|
|
|
|
export {
|
|
ServiceAccountKeyClient,
|
|
ServiceAccountKeyClientParameters,
|
|
} from './service_account_key_json';
|
|
|
|
export {
|
|
WorkloadIdentityFederationClient,
|
|
WorkloadIdentityFederationClientParameters,
|
|
} from './workload_identity_federation';
|