Class GithubExchanger

Exchanger of GitHub tokens for VeraId credentials.

Hierarchy (View Summary)

JwtExchanger
- GithubExchanger

Index

Constructors

Properties

requestUrl token

Methods

exchange fetchJwt generateVauthAuthHeader initFromEnv

Constructors

constructor

new GithubExchanger(requestUrl: string, token: string): GithubExchanger
Create a new GitHub exchanger.
Parameters
- requestUrl: string
  The URL of the GitHub token endpoint (ACTIONS_ID_TOKEN_REQUEST_URL).
- token: string
  The GitHub token to use (ACTIONS_ID_TOKEN_REQUEST_TOKEN).
Returns GithubExchanger
Overrides JwtExchanger.constructor
- Defined in integrations/GithubExchanger.ts:15

Properties

`Protected` `Readonly`requestUrl

requestUrl: string

The URL of the GitHub token endpoint (ACTIONS_ID_TOKEN_REQUEST_URL).

`Protected` `Readonly`token

token: string

The GitHub token to use (ACTIONS_ID_TOKEN_REQUEST_TOKEN).

Methods

exchange

exchange(
vauthCredentialUrl: URL,
options?: Partial<ExchangeOptions>,
): Promise<VeraidCredential>
Exchange the credentials for a VeraId credential.
Parameters
- vauthCredentialUrl: URL
  The VeraId Authority endpoint to obtain the credential.
- options: Partial<ExchangeOptions> = {}
Returns Promise<VeraidCredential>
The credential if successful.
Inherited from JwtExchanger.exchange
- Defined in Exchanger.ts:17

`Protected`fetchJwt

fetchJwt(audience: string, timeoutMs: number): Promise<string>
Fetch the JWT from the hosting service.
Parameters
- audience: string
  The audience of the JWT.
- timeoutMs: number
  The timeout for in milliseconds.
Returns Promise<string>
The JWT.
Overrides JwtExchanger.fetchJwt
- Defined in integrations/GithubExchanger.ts:41

`Protected`generateVauthAuthHeader

generateVauthAuthHeader(
vauthCredentialUrl: URL,
timeoutMs: number,
): Promise<string>
Generate the Authorization request header for the VeraId Authority credential endpoint.
Parameters
- vauthCredentialUrl: URL
  The VeraId Authority endpoint to obtain the credential.
- timeoutMs: number
  The timeout (in milliseconds) to obtain the original credential.
Returns Promise<string>
The authorization header.
Inherited from JwtExchanger.generateVauthAuthHeader
- Defined in JwtExchanger.ts:15

`Static`initFromEnv

initFromEnv(): GithubExchanger
Create a new GitHub exchanger from environment variables.

Returns GithubExchanger
A new GitHub exchanger.

Throws
If ACTIONS_ID_TOKEN_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_TOKEN is not set.
- Defined in integrations/GithubExchanger.ts:27