-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #887 from souravchanduka/main-oidc-client
Added OIDC client functionality in core package
- Loading branch information
Showing
7 changed files
with
223 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
/* eslint-disable @typescript-eslint/no-extraneous-class */ | ||
import * as actions_http_client from '@actions/http-client' | ||
import {IRequestOptions} from '@actions/http-client/interfaces' | ||
import {HttpClient} from '@actions/http-client' | ||
import {BearerCredentialHandler} from '@actions/http-client/auth' | ||
import {debug, setSecret} from './core' | ||
|
||
interface TokenRequest { | ||
aud?: string | ||
} | ||
|
||
interface TokenResponse { | ||
value?: string | ||
} | ||
|
||
export class OidcClient { | ||
private static createHttpClient( | ||
allowRetry = true, | ||
maxRetry = 10 | ||
): actions_http_client.HttpClient { | ||
const requestOptions: IRequestOptions = { | ||
allowRetries: allowRetry, | ||
maxRetries: maxRetry | ||
} | ||
|
||
return new HttpClient( | ||
'actions/oidc-client', | ||
[new BearerCredentialHandler(OidcClient.getRuntimeToken())], | ||
requestOptions | ||
) | ||
} | ||
|
||
private static getApiVersion(): string { | ||
return '2.0' | ||
} | ||
|
||
private static getRuntimeToken(): string { | ||
const token = process.env['ACTIONS_RUNTIME_TOKEN'] | ||
if (!token) { | ||
throw new Error('Unable to get ACTIONS_RUNTIME_TOKEN env variable') | ||
} | ||
return token | ||
} | ||
|
||
private static getIDTokenUrl(): string { | ||
const runtimeUrl = process.env['ACTIONS_ID_TOKEN_REQUEST_URL'] | ||
if (!runtimeUrl) { | ||
throw new Error('Unable to get ACTIONS_ID_TOKEN_REQUEST_URL env variable') | ||
} | ||
return `${runtimeUrl}?api-version=${OidcClient.getApiVersion()}` | ||
} | ||
|
||
private static async postCall( | ||
id_token_url: string, | ||
data: TokenRequest | ||
): Promise<string> { | ||
const httpclient = OidcClient.createHttpClient() | ||
|
||
const res = await httpclient | ||
.postJson<TokenResponse>(id_token_url, data) | ||
.catch(error => { | ||
throw new Error( | ||
`Failed to get ID Token. \n | ||
Error Code : ${error.statusCode}\n | ||
Error Message: ${error.result.message}` | ||
) | ||
}) | ||
|
||
const id_token = res.result?.value | ||
if (!id_token) { | ||
throw new Error('Response json body do not have ID Token field') | ||
} | ||
return id_token | ||
} | ||
|
||
static async getIDToken(audience?: string): Promise<string> { | ||
try { | ||
// New ID Token is requested from action service | ||
const id_token_url: string = OidcClient.getIDTokenUrl() | ||
|
||
debug(`ID token url is ${id_token_url}`) | ||
|
||
const data: TokenRequest = {aud: audience} | ||
|
||
debug(`audience is ${audience ? audience : 'not defined'}`) | ||
|
||
const id_token = await OidcClient.postCall(id_token_url, data) | ||
setSecret(id_token) | ||
return id_token | ||
} catch (error) { | ||
throw new Error(`Error message: ${error.message}`) | ||
} | ||
} | ||
} |